Spotinst v3.74.1, Apr 11 24

Spotinst v3.74.1 published on Thursday, Apr 11, 2024 by Pulumi

spotinst.aws.Ocean

Explore with Pulumi AI

Spotinst v3.74.1 published on Thursday, Apr 11, 2024 by Pulumi

pulumi/pulumi-spotinst

Example Usage

Auto Scaler

autoscaler - (Optional) Describes the Ocean Kubernetes Auto Scaler.
- autoscale_is_enabled - (Optional, Default: true) Enable the Ocean Kubernetes Auto Scaler.
- autoscale_is_auto_config - (Optional, Default: true) Automatically configure and optimize headroom resources.
- autoscale_cooldown - (Optional, Default: null) Cooldown period between scaling actions.
- auto_headroom_percentage - (Optional) Set the auto headroom percentage (a number in the range [0, 200]) which controls the percentage of headroom from the cluster. Relevant only when autoscale_is_auto_config toggled on.
- enable_automatic_and_manual_headroom - (Optional, Default: false) enables automatic and manual headroom to work in parallel. When set to false, automatic headroom overrides all other headroom definitions manually configured, whether they are at cluster or VNG level.
- autoscale_headroom - (Optional) Spare resource capacity management enabling fast assignment of Pods without waiting for new resources to launch.
  - cpu_per_unit - (Optional) Optionally configure the number of CPUs to allocate the headroom. CPUs are denoted in millicores, where 1000 millicores = 1 vCPU.
  - gpu_per_unit - (Optional) Optionally configure the number of GPUs to allocate the headroom.
  - memory_per_unit - (Optional) Optionally configure the amount of memory (MB) to allocate the headroom.
  - num_of_units - (Optional) The number of units to retain as headroom, where each unit has the defined headroom CPU and memory.
- autoscale_down - (Optional) Auto Scaling scale down operations.
  - max_scale_down_percentage - (Optional) Would represent the maximum % to scale-down. Number between 1-100.
  - is_aggressive_scale_down_enabled - (Optional, Default: false) When set to ’true’, the Aggressive Scale Down feature is enabled.
- resource_limits - (Optional) Optionally set upper and lower bounds on the resource usage of the cluster.
  - max_vcpu - (Optional) The maximum cpu in vCPU units that can be allocated to the cluster.
  - max_memory_gib - (Optional) The maximum memory in GiB units that can be allocated to the cluster.
- extended_resource_definitions - (Optional) List of Ocean extended resource definitions to use in this cluster.

import * as pulumi from "@pulumi/pulumi";

import pulumi

package main

import (
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		return nil
	})
}

using System.Collections.Generic;
using System.Linq;
using Pulumi;

return await Deployment.RunAsync(() => 
{
});

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
    }
}

{}

Update Policy

update_policy - (Optional)
- should_roll - (Required) Enables the roll.
- conditioned_roll - (Optional, Default: false) Spot will perform a cluster Roll in accordance with a relevant modification of the cluster’s settings. When set to true , only specific changes in the cluster’s configuration will trigger a cluster roll (such as AMI, Key Pair, user data, instance types, load balancers, etc).
- conditioned_roll_params - (Optional) A custom list of attributes will trigger the cluster roll operation (overrides the predefined list of parameters). Valid only when the conditioned_roll parameter is set to true. (Valid values: "subnet_ids","whitelist","blacklist","user_data","image_id","security_groups","key_name","iam_instance_profile","associate_public_ip_address","load_balancers","instance_metadata_options","ebs_optimized","root_volume_size")
- auto_apply_tags - (Optional, Default: false) will update instance tags on the fly without rolling the cluster.
- roll_config - (Required) While used, you can control whether the group should perform a deployment after an update to the configuration.
  - batch_size_percentage - (Required) Sets the percentage of the instances to deploy in each batch.
  - launch_spec_ids - (Optional) List of virtual node group identifiers to be rolled.
  - batch_min_healthy_percentage - (Optional) Default: 50. Indicates the threshold of minimum healthy instances in single batch. If the amount of healthy instances in single batch is under the threshold, the cluster roll will fail. If exists, the parameter value will be in range of 1-100. In case of null as value, the default value in the backend will be 50%. Value of param should represent the number in percentage (%) of the batch.
  - respect_pdb - (Optional, Default: false) During the roll, if the parameter is set to True we honor PDB during the instance replacement.

import * as pulumi from "@pulumi/pulumi";

import pulumi

package main

import (
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		return nil
	})
}

using System.Collections.Generic;
using System.Linq;
using Pulumi;

return await Deployment.RunAsync(() => 
{
});

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
    }
}

{}

Scheduled Task

scheduled_task - (Optional) Set scheduling object.
- shutdown_hours - (Optional) Set shutdown hours for cluster object.
  - is_enabled - (Optional) Toggle the shutdown hours task. (Example: true).
  - time_windows - (Required) Set time windows for shutdown hours. Specify a list of timeWindows with at least one time window Each string is in the format of: ddd:hh:mm-ddd:hh:mm where ddd = day of week = Sun | Mon | Tue | Wed | Thu | Fri | Sat, hh = hour 24 = 0 -23, mm = minute = 0 - 59. Time windows should not overlap. Required if cluster.scheduling.isEnabled is true. (Example: Fri:15:30-Wed:14:30).
- tasks - (Optional) The scheduling tasks for the cluster.
  - is_enabled - (Required) Describes whether the task is enabled. When true the task should run when false it should not run. Required for cluster.scheduling.tasks object.
  - cron_expression - (Required) A valid cron expression. The cron is running in UTC time zone and is in Unix cron format Cron Expression Validator Script. Only one of frequency or cronExpression should be used at a time. Required for cluster.scheduling.tasks object. (Example: 0 1 * * *).
  - task_type - (Required) Valid values: clusterRoll amiAutoUpdate. Required for cluster.scheduling.tasks
  - parameters - (Optional) This filed will be compatible to the task_type field. If task_type is defined as clusterRoll, user cluster roll object in parameters.
    - ami_auto_update - (Optional) Set amiAutoUpdate object
      - apply_roll - (Optional, Default:false) When the AMI is updated according to the configuration set, a cluster roll can be triggered
      - ami_auto_update_cluster_roll - (Optional) Set clusterRoll object
        batch_min_healthy_percentage - (Optional, Default:50) Indicates the threshold of minimum healthy instances in single batch. If the amount of healthy instances in single batch is under the threshold, the cluster roll will fail. If exists, the parameter value will be in range of 1-100. In case of null as value, the default value in the backend will be 50%. Value of param should represent the number in percentage (%) of the batch.
        batch_size_percentage - (Optional) Value as a percent to set the size of a batch in a roll. Valid values are 0-100.
        comment - (Optional) Add a comment description for the roll. The comment is limited to 256 chars
        respect_pdb - (Optional, Default:false) During the roll, if the parameter is set to true we honor PDB during the instance replacement.
      - minor_version - (Optional, Default:false) When set to ’true’, the auto-update process will update the VNGs’ AMI with the AMI to match the Kubernetes control plane version. either “patch” or “minor_version” must be true.
      - patch - (Optional, Default:false) When set to ’true’, the auto-update process will update the VNGs’ images with the latest security patches. either “patch” or “minorVersion” must be true.
    - parameters_cluster_roll - (Optional) Set clusterRoll object
      - batch_min_healthy_percentage - (Optional, Default:50) Indicates the threshold of minimum healthy instances in single batch. If the amount of healthy instances in single batch is under the threshold, the cluster roll will fail. If exists, the parameter value will be in range of 1-100. In case of null as value, the default value in the backend will be 50%. Value of param should represent the number in percentage (%) of the batch.
      - batch_size_percentage - (Optional) Value as a percent to set the size of a batch in a roll. Valid values are 0-100.
      - comment - (Optional) Add a comment description for the roll. The comment is limited to 256 chars
      - respect_pdb - (Optional, Default:false) During the roll, if the parameter is set to true we honor PDB during the instance replacement.

import * as pulumi from "@pulumi/pulumi";

import pulumi

package main

import (
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		return nil
	})
}

using System.Collections.Generic;
using System.Linq;
using Pulumi;

return await Deployment.RunAsync(() => 
{
});

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
    }
}

{}

Create Ocean Resource

Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

Constructor syntax

new Ocean(name: string, args: OceanArgs, opts?: CustomResourceOptions);

@overload
def Ocean(resource_name: str,
          args: OceanArgs,
          opts: Optional[ResourceOptions] = None)

@overload
def Ocean(resource_name: str,
          opts: Optional[ResourceOptions] = None,
          security_groups: Optional[Sequence[str]] = None,
          subnet_ids: Optional[Sequence[str]] = None,
          load_balancers: Optional[Sequence[OceanLoadBalancerArgs]] = None,
          utilize_reserved_instances: Optional[bool] = None,
          block_device_mappings: Optional[Sequence[OceanBlockDeviceMappingArgs]] = None,
          max_size: Optional[int] = None,
          controller_id: Optional[str] = None,
          desired_capacity: Optional[int] = None,
          draining_timeout: Optional[int] = None,
          ebs_optimized: Optional[bool] = None,
          fallback_to_ondemand: Optional[bool] = None,
          filters: Optional[OceanFiltersArgs] = None,
          grace_period: Optional[int] = None,
          health_check_unhealthy_duration_before_replacement: Optional[int] = None,
          iam_instance_profile: Optional[str] = None,
          image_id: Optional[str] = None,
          instance_metadata_options: Optional[OceanInstanceMetadataOptionsArgs] = None,
          key_name: Optional[str] = None,
          associate_ipv6_address: Optional[bool] = None,
          logging: Optional[OceanLoggingArgs] = None,
          cluster_orientations: Optional[Sequence[OceanClusterOrientationArgs]] = None,
          blacklists: Optional[Sequence[str]] = None,
          name: Optional[str] = None,
          monitoring: Optional[bool] = None,
          region: Optional[str] = None,
          resource_tag_specifications: Optional[Sequence[OceanResourceTagSpecificationArgs]] = None,
          root_volume_size: Optional[int] = None,
          scheduled_tasks: Optional[Sequence[OceanScheduledTaskArgs]] = None,
          autoscaler: Optional[OceanAutoscalerArgs] = None,
          spot_percentage: Optional[int] = None,
          spread_nodes_by: Optional[str] = None,
          associate_public_ip_address: Optional[bool] = None,
          tags: Optional[Sequence[OceanTagArgs]] = None,
          update_policy: Optional[OceanUpdatePolicyArgs] = None,
          use_as_template_only: Optional[bool] = None,
          user_data: Optional[str] = None,
          utilize_commitments: Optional[bool] = None,
          min_size: Optional[int] = None,
          whitelists: Optional[Sequence[str]] = None)

func NewOcean(ctx *Context, name string, args OceanArgs, opts ...ResourceOption) (*Ocean, error)

public Ocean(string name, OceanArgs args, CustomResourceOptions? opts = null)

public Ocean(String name, OceanArgs args)
public Ocean(String name, OceanArgs args, CustomResourceOptions options)

type: spotinst:aws:Ocean
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name string: The unique name of the resource.
args OceanArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

resource_name str: The unique name of the resource.
args OceanArgs: The arguments to resource properties.
opts ResourceOptions: Bag of options to control resource's behavior.

ctx Context: Context object for the current deployment.
name string: The unique name of the resource.
args OceanArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

name string: The unique name of the resource.
args OceanArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

name String: The unique name of the resource.
args OceanArgs: The arguments to resource properties.
options CustomResourceOptions: Bag of options to control resource's behavior.

Example

The following reference example uses placeholder values for all input properties.

var oceanResource = new SpotInst.Aws.Ocean("oceanResource", new()
{
    SecurityGroups = new[]
    {
        "string",
    },
    SubnetIds = new[]
    {
        "string",
    },
    LoadBalancers = new[]
    {
        new SpotInst.Aws.Inputs.OceanLoadBalancerArgs
        {
            Arn = "string",
            Name = "string",
            Type = "string",
        },
    },
    UtilizeReservedInstances = false,
    BlockDeviceMappings = new[]
    {
        new SpotInst.Aws.Inputs.OceanBlockDeviceMappingArgs
        {
            DeviceName = "string",
            Ebs = new SpotInst.Aws.Inputs.OceanBlockDeviceMappingEbsArgs
            {
                DeleteOnTermination = false,
                DynamicIops = new SpotInst.Aws.Inputs.OceanBlockDeviceMappingEbsDynamicIopsArgs
                {
                    BaseSize = 0,
                    Resource = "string",
                    SizePerResourceUnit = 0,
                },
                DynamicVolumeSize = new SpotInst.Aws.Inputs.OceanBlockDeviceMappingEbsDynamicVolumeSizeArgs
                {
                    BaseSize = 0,
                    Resource = "string",
                    SizePerResourceUnit = 0,
                },
                Encrypted = false,
                Iops = 0,
                KmsKeyId = "string",
                SnapshotId = "string",
                Throughput = 0,
                VolumeSize = 0,
                VolumeType = "string",
            },
        },
    },
    MaxSize = 0,
    ControllerId = "string",
    DesiredCapacity = 0,
    DrainingTimeout = 0,
    EbsOptimized = false,
    FallbackToOndemand = false,
    Filters = new SpotInst.Aws.Inputs.OceanFiltersArgs
    {
        Architectures = new[]
        {
            "string",
        },
        Categories = new[]
        {
            "string",
        },
        DiskTypes = new[]
        {
            "string",
        },
        ExcludeFamilies = new[]
        {
            "string",
        },
        ExcludeMetal = false,
        Hypervisors = new[]
        {
            "string",
        },
        IncludeFamilies = new[]
        {
            "string",
        },
        IsEnaSupported = "string",
        MaxGpu = 0,
        MaxMemoryGib = 0,
        MaxNetworkPerformance = 0,
        MaxVcpu = 0,
        MinEnis = 0,
        MinGpu = 0,
        MinMemoryGib = 0,
        MinNetworkPerformance = 0,
        MinVcpu = 0,
        RootDeviceTypes = new[]
        {
            "string",
        },
        VirtualizationTypes = new[]
        {
            "string",
        },
    },
    GracePeriod = 0,
    HealthCheckUnhealthyDurationBeforeReplacement = 0,
    IamInstanceProfile = "string",
    ImageId = "string",
    InstanceMetadataOptions = new SpotInst.Aws.Inputs.OceanInstanceMetadataOptionsArgs
    {
        HttpTokens = "string",
        HttpPutResponseHopLimit = 0,
    },
    KeyName = "string",
    AssociateIpv6Address = false,
    Logging = new SpotInst.Aws.Inputs.OceanLoggingArgs
    {
        Export = new SpotInst.Aws.Inputs.OceanLoggingExportArgs
        {
            S3s = new[]
            {
                new SpotInst.Aws.Inputs.OceanLoggingExportS3Args
                {
                    Id = "string",
                },
            },
        },
    },
    ClusterOrientations = new[]
    {
        new SpotInst.Aws.Inputs.OceanClusterOrientationArgs
        {
            AvailabilityVsCost = "string",
        },
    },
    Blacklists = new[]
    {
        "string",
    },
    Name = "string",
    Monitoring = false,
    Region = "string",
    ResourceTagSpecifications = new[]
    {
        new SpotInst.Aws.Inputs.OceanResourceTagSpecificationArgs
        {
            ShouldTagVolumes = false,
        },
    },
    RootVolumeSize = 0,
    ScheduledTasks = new[]
    {
        new SpotInst.Aws.Inputs.OceanScheduledTaskArgs
        {
            ShutdownHours = new SpotInst.Aws.Inputs.OceanScheduledTaskShutdownHoursArgs
            {
                TimeWindows = new[]
                {
                    "string",
                },
                IsEnabled = false,
            },
            Tasks = new[]
            {
                new SpotInst.Aws.Inputs.OceanScheduledTaskTaskArgs
                {
                    CronExpression = "string",
                    IsEnabled = false,
                    TaskType = "string",
                    Parameters = new SpotInst.Aws.Inputs.OceanScheduledTaskTaskParametersArgs
                    {
                        AmiAutoUpdate = new SpotInst.Aws.Inputs.OceanScheduledTaskTaskParametersAmiAutoUpdateArgs
                        {
                            AmiAutoUpdateClusterRoll = new SpotInst.Aws.Inputs.OceanScheduledTaskTaskParametersAmiAutoUpdateAmiAutoUpdateClusterRollArgs
                            {
                                BatchMinHealthyPercentage = 0,
                                BatchSizePercentage = 0,
                                Comment = "string",
                                RespectPdb = false,
                            },
                            ApplyRoll = false,
                            MinorVersion = false,
                            Patch = false,
                        },
                        ParametersClusterRoll = new SpotInst.Aws.Inputs.OceanScheduledTaskTaskParametersParametersClusterRollArgs
                        {
                            BatchMinHealthyPercentage = 0,
                            BatchSizePercentage = 0,
                            Comment = "string",
                            RespectPdb = false,
                        },
                    },
                },
            },
        },
    },
    Autoscaler = new SpotInst.Aws.Inputs.OceanAutoscalerArgs
    {
        AutoHeadroomPercentage = 0,
        AutoscaleCooldown = 0,
        AutoscaleDown = new SpotInst.Aws.Inputs.OceanAutoscalerAutoscaleDownArgs
        {
            EvaluationPeriods = 0,
            IsAggressiveScaleDownEnabled = false,
            MaxScaleDownPercentage = 0,
        },
        AutoscaleHeadroom = new SpotInst.Aws.Inputs.OceanAutoscalerAutoscaleHeadroomArgs
        {
            CpuPerUnit = 0,
            GpuPerUnit = 0,
            MemoryPerUnit = 0,
            NumOfUnits = 0,
        },
        AutoscaleIsAutoConfig = false,
        AutoscaleIsEnabled = false,
        EnableAutomaticAndManualHeadroom = false,
        ExtendedResourceDefinitions = new[]
        {
            "string",
        },
        ResourceLimits = new SpotInst.Aws.Inputs.OceanAutoscalerResourceLimitsArgs
        {
            MaxMemoryGib = 0,
            MaxVcpu = 0,
        },
    },
    SpotPercentage = 0,
    SpreadNodesBy = "string",
    AssociatePublicIpAddress = false,
    Tags = new[]
    {
        new SpotInst.Aws.Inputs.OceanTagArgs
        {
            Key = "string",
            Value = "string",
        },
    },
    UpdatePolicy = new SpotInst.Aws.Inputs.OceanUpdatePolicyArgs
    {
        ShouldRoll = false,
        AutoApplyTags = false,
        ConditionedRoll = false,
        ConditionedRollParams = new[]
        {
            "string",
        },
        RollConfig = new SpotInst.Aws.Inputs.OceanUpdatePolicyRollConfigArgs
        {
            BatchSizePercentage = 0,
            BatchMinHealthyPercentage = 0,
            LaunchSpecIds = new[]
            {
                "string",
            },
            RespectPdb = false,
        },
    },
    UseAsTemplateOnly = false,
    UserData = "string",
    UtilizeCommitments = false,
    MinSize = 0,
    Whitelists = new[]
    {
        "string",
    },
});

example, err := aws.NewOcean(ctx, "oceanResource", &aws.OceanArgs{
	SecurityGroups: pulumi.StringArray{
		pulumi.String("string"),
	},
	SubnetIds: pulumi.StringArray{
		pulumi.String("string"),
	},
	LoadBalancers: aws.OceanLoadBalancerArray{
		&aws.OceanLoadBalancerArgs{
			Arn:  pulumi.String("string"),
			Name: pulumi.String("string"),
			Type: pulumi.String("string"),
		},
	},
	UtilizeReservedInstances: pulumi.Bool(false),
	BlockDeviceMappings: aws.OceanBlockDeviceMappingArray{
		&aws.OceanBlockDeviceMappingArgs{
			DeviceName: pulumi.String("string"),
			Ebs: &aws.OceanBlockDeviceMappingEbsArgs{
				DeleteOnTermination: pulumi.Bool(false),
				DynamicIops: &aws.OceanBlockDeviceMappingEbsDynamicIopsArgs{
					BaseSize:            pulumi.Int(0),
					Resource:            pulumi.String("string"),
					SizePerResourceUnit: pulumi.Int(0),
				},
				DynamicVolumeSize: &aws.OceanBlockDeviceMappingEbsDynamicVolumeSizeArgs{
					BaseSize:            pulumi.Int(0),
					Resource:            pulumi.String("string"),
					SizePerResourceUnit: pulumi.Int(0),
				},
				Encrypted:  pulumi.Bool(false),
				Iops:       pulumi.Int(0),
				KmsKeyId:   pulumi.String("string"),
				SnapshotId: pulumi.String("string"),
				Throughput: pulumi.Int(0),
				VolumeSize: pulumi.Int(0),
				VolumeType: pulumi.String("string"),
			},
		},
	},
	MaxSize:            pulumi.Int(0),
	ControllerId:       pulumi.String("string"),
	DesiredCapacity:    pulumi.Int(0),
	DrainingTimeout:    pulumi.Int(0),
	EbsOptimized:       pulumi.Bool(false),
	FallbackToOndemand: pulumi.Bool(false),
	Filters: &aws.OceanFiltersArgs{
		Architectures: pulumi.StringArray{
			pulumi.String("string"),
		},
		Categories: pulumi.StringArray{
			pulumi.String("string"),
		},
		DiskTypes: pulumi.StringArray{
			pulumi.String("string"),
		},
		ExcludeFamilies: pulumi.StringArray{
			pulumi.String("string"),
		},
		ExcludeMetal: pulumi.Bool(false),
		Hypervisors: pulumi.StringArray{
			pulumi.String("string"),
		},
		IncludeFamilies: pulumi.StringArray{
			pulumi.String("string"),
		},
		IsEnaSupported:        pulumi.String("string"),
		MaxGpu:                pulumi.Int(0),
		MaxMemoryGib:          pulumi.Float64(0),
		MaxNetworkPerformance: pulumi.Int(0),
		MaxVcpu:               pulumi.Int(0),
		MinEnis:               pulumi.Int(0),
		MinGpu:                pulumi.Int(0),
		MinMemoryGib:          pulumi.Float64(0),
		MinNetworkPerformance: pulumi.Int(0),
		MinVcpu:               pulumi.Int(0),
		RootDeviceTypes: pulumi.StringArray{
			pulumi.String("string"),
		},
		VirtualizationTypes: pulumi.StringArray{
			pulumi.String("string"),
		},
	},
	GracePeriod: pulumi.Int(0),
	HealthCheckUnhealthyDurationBeforeReplacement: pulumi.Int(0),
	IamInstanceProfile:                            pulumi.String("string"),
	ImageId:                                       pulumi.String("string"),
	InstanceMetadataOptions: &aws.OceanInstanceMetadataOptionsArgs{
		HttpTokens:              pulumi.String("string"),
		HttpPutResponseHopLimit: pulumi.Int(0),
	},
	KeyName:              pulumi.String("string"),
	AssociateIpv6Address: pulumi.Bool(false),
	Logging: &aws.OceanLoggingArgs{
		Export: &aws.OceanLoggingExportArgs{
			S3s: aws.OceanLoggingExportS3Array{
				&aws.OceanLoggingExportS3Args{
					Id: pulumi.String("string"),
				},
			},
		},
	},
	ClusterOrientations: aws.OceanClusterOrientationArray{
		&aws.OceanClusterOrientationArgs{
			AvailabilityVsCost: pulumi.String("string"),
		},
	},
	Blacklists: pulumi.StringArray{
		pulumi.String("string"),
	},
	Name:       pulumi.String("string"),
	Monitoring: pulumi.Bool(false),
	Region:     pulumi.String("string"),
	ResourceTagSpecifications: aws.OceanResourceTagSpecificationArray{
		&aws.OceanResourceTagSpecificationArgs{
			ShouldTagVolumes: pulumi.Bool(false),
		},
	},
	RootVolumeSize: pulumi.Int(0),
	ScheduledTasks: aws.OceanScheduledTaskArray{
		&aws.OceanScheduledTaskArgs{
			ShutdownHours: &aws.OceanScheduledTaskShutdownHoursArgs{
				TimeWindows: pulumi.StringArray{
					pulumi.String("string"),
				},
				IsEnabled: pulumi.Bool(false),
			},
			Tasks: aws.OceanScheduledTaskTaskArray{
				&aws.OceanScheduledTaskTaskArgs{
					CronExpression: pulumi.String("string"),
					IsEnabled:      pulumi.Bool(false),
					TaskType:       pulumi.String("string"),
					Parameters: &aws.OceanScheduledTaskTaskParametersArgs{
						AmiAutoUpdate: &aws.OceanScheduledTaskTaskParametersAmiAutoUpdateArgs{
							AmiAutoUpdateClusterRoll: &aws.OceanScheduledTaskTaskParametersAmiAutoUpdateAmiAutoUpdateClusterRollArgs{
								BatchMinHealthyPercentage: pulumi.Int(0),
								BatchSizePercentage:       pulumi.Int(0),
								Comment:                   pulumi.String("string"),
								RespectPdb:                pulumi.Bool(false),
							},
							ApplyRoll:    pulumi.Bool(false),
							MinorVersion: pulumi.Bool(false),
							Patch:        pulumi.Bool(false),
						},
						ParametersClusterRoll: &aws.OceanScheduledTaskTaskParametersParametersClusterRollArgs{
							BatchMinHealthyPercentage: pulumi.Int(0),
							BatchSizePercentage:       pulumi.Int(0),
							Comment:                   pulumi.String("string"),
							RespectPdb:                pulumi.Bool(false),
						},
					},
				},
			},
		},
	},
	Autoscaler: &aws.OceanAutoscalerArgs{
		AutoHeadroomPercentage: pulumi.Int(0),
		AutoscaleCooldown:      pulumi.Int(0),
		AutoscaleDown: &aws.OceanAutoscalerAutoscaleDownArgs{
			EvaluationPeriods:            pulumi.Int(0),
			IsAggressiveScaleDownEnabled: pulumi.Bool(false),
			MaxScaleDownPercentage:       pulumi.Float64(0),
		},
		AutoscaleHeadroom: &aws.OceanAutoscalerAutoscaleHeadroomArgs{
			CpuPerUnit:    pulumi.Int(0),
			GpuPerUnit:    pulumi.Int(0),
			MemoryPerUnit: pulumi.Int(0),
			NumOfUnits:    pulumi.Int(0),
		},
		AutoscaleIsAutoConfig:            pulumi.Bool(false),
		AutoscaleIsEnabled:               pulumi.Bool(false),
		EnableAutomaticAndManualHeadroom: pulumi.Bool(false),
		ExtendedResourceDefinitions: pulumi.StringArray{
			pulumi.String("string"),
		},
		ResourceLimits: &aws.OceanAutoscalerResourceLimitsArgs{
			MaxMemoryGib: pulumi.Int(0),
			MaxVcpu:      pulumi.Int(0),
		},
	},
	SpotPercentage:           pulumi.Int(0),
	SpreadNodesBy:            pulumi.String("string"),
	AssociatePublicIpAddress: pulumi.Bool(false),
	Tags: aws.OceanTagArray{
		&aws.OceanTagArgs{
			Key:   pulumi.String("string"),
			Value: pulumi.String("string"),
		},
	},
	UpdatePolicy: &aws.OceanUpdatePolicyArgs{
		ShouldRoll:      pulumi.Bool(false),
		AutoApplyTags:   pulumi.Bool(false),
		ConditionedRoll: pulumi.Bool(false),
		ConditionedRollParams: pulumi.StringArray{
			pulumi.String("string"),
		},
		RollConfig: &aws.OceanUpdatePolicyRollConfigArgs{
			BatchSizePercentage:       pulumi.Int(0),
			BatchMinHealthyPercentage: pulumi.Int(0),
			LaunchSpecIds: pulumi.StringArray{
				pulumi.String("string"),
			},
			RespectPdb: pulumi.Bool(false),
		},
	},
	UseAsTemplateOnly:  pulumi.Bool(false),
	UserData:           pulumi.String("string"),
	UtilizeCommitments: pulumi.Bool(false),
	MinSize:            pulumi.Int(0),
	Whitelists: pulumi.StringArray{
		pulumi.String("string"),
	},
})

var oceanResource = new Ocean("oceanResource", OceanArgs.builder()        
    .securityGroups("string")
    .subnetIds("string")
    .loadBalancers(OceanLoadBalancerArgs.builder()
        .arn("string")
        .name("string")
        .type("string")
        .build())
    .utilizeReservedInstances(false)
    .blockDeviceMappings(OceanBlockDeviceMappingArgs.builder()
        .deviceName("string")
        .ebs(OceanBlockDeviceMappingEbsArgs.builder()
            .deleteOnTermination(false)
            .dynamicIops(OceanBlockDeviceMappingEbsDynamicIopsArgs.builder()
                .baseSize(0)
                .resource("string")
                .sizePerResourceUnit(0)
                .build())
            .dynamicVolumeSize(OceanBlockDeviceMappingEbsDynamicVolumeSizeArgs.builder()
                .baseSize(0)
                .resource("string")
                .sizePerResourceUnit(0)
                .build())
            .encrypted(false)
            .iops(0)
            .kmsKeyId("string")
            .snapshotId("string")
            .throughput(0)
            .volumeSize(0)
            .volumeType("string")
            .build())
        .build())
    .maxSize(0)
    .controllerId("string")
    .desiredCapacity(0)
    .drainingTimeout(0)
    .ebsOptimized(false)
    .fallbackToOndemand(false)
    .filters(OceanFiltersArgs.builder()
        .architectures("string")
        .categories("string")
        .diskTypes("string")
        .excludeFamilies("string")
        .excludeMetal(false)
        .hypervisors("string")
        .includeFamilies("string")
        .isEnaSupported("string")
        .maxGpu(0)
        .maxMemoryGib(0)
        .maxNetworkPerformance(0)
        .maxVcpu(0)
        .minEnis(0)
        .minGpu(0)
        .minMemoryGib(0)
        .minNetworkPerformance(0)
        .minVcpu(0)
        .rootDeviceTypes("string")
        .virtualizationTypes("string")
        .build())
    .gracePeriod(0)
    .healthCheckUnhealthyDurationBeforeReplacement(0)
    .iamInstanceProfile("string")
    .imageId("string")
    .instanceMetadataOptions(OceanInstanceMetadataOptionsArgs.builder()
        .httpTokens("string")
        .httpPutResponseHopLimit(0)
        .build())
    .keyName("string")
    .associateIpv6Address(false)
    .logging(OceanLoggingArgs.builder()
        .export(OceanLoggingExportArgs.builder()
            .s3s(OceanLoggingExportS3Args.builder()
                .id("string")
                .build())
            .build())
        .build())
    .clusterOrientations(OceanClusterOrientationArgs.builder()
        .availabilityVsCost("string")
        .build())
    .blacklists("string")
    .name("string")
    .monitoring(false)
    .region("string")
    .resourceTagSpecifications(OceanResourceTagSpecificationArgs.builder()
        .shouldTagVolumes(false)
        .build())
    .rootVolumeSize(0)
    .scheduledTasks(OceanScheduledTaskArgs.builder()
        .shutdownHours(OceanScheduledTaskShutdownHoursArgs.builder()
            .timeWindows("string")
            .isEnabled(false)
            .build())
        .tasks(OceanScheduledTaskTaskArgs.builder()
            .cronExpression("string")
            .isEnabled(false)
            .taskType("string")
            .parameters(OceanScheduledTaskTaskParametersArgs.builder()
                .amiAutoUpdate(OceanScheduledTaskTaskParametersAmiAutoUpdateArgs.builder()
                    .amiAutoUpdateClusterRoll(OceanScheduledTaskTaskParametersAmiAutoUpdateAmiAutoUpdateClusterRollArgs.builder()
                        .batchMinHealthyPercentage(0)
                        .batchSizePercentage(0)
                        .comment("string")
                        .respectPdb(false)
                        .build())
                    .applyRoll(false)
                    .minorVersion(false)
                    .patch(false)
                    .build())
                .parametersClusterRoll(OceanScheduledTaskTaskParametersParametersClusterRollArgs.builder()
                    .batchMinHealthyPercentage(0)
                    .batchSizePercentage(0)
                    .comment("string")
                    .respectPdb(false)
                    .build())
                .build())
            .build())
        .build())
    .autoscaler(OceanAutoscalerArgs.builder()
        .autoHeadroomPercentage(0)
        .autoscaleCooldown(0)
        .autoscaleDown(OceanAutoscalerAutoscaleDownArgs.builder()
            .evaluationPeriods(0)
            .isAggressiveScaleDownEnabled(false)
            .maxScaleDownPercentage(0)
            .build())
        .autoscaleHeadroom(OceanAutoscalerAutoscaleHeadroomArgs.builder()
            .cpuPerUnit(0)
            .gpuPerUnit(0)
            .memoryPerUnit(0)
            .numOfUnits(0)
            .build())
        .autoscaleIsAutoConfig(false)
        .autoscaleIsEnabled(false)
        .enableAutomaticAndManualHeadroom(false)
        .extendedResourceDefinitions("string")
        .resourceLimits(OceanAutoscalerResourceLimitsArgs.builder()
            .maxMemoryGib(0)
            .maxVcpu(0)
            .build())
        .build())
    .spotPercentage(0)
    .spreadNodesBy("string")
    .associatePublicIpAddress(false)
    .tags(OceanTagArgs.builder()
        .key("string")
        .value("string")
        .build())
    .updatePolicy(OceanUpdatePolicyArgs.builder()
        .shouldRoll(false)
        .autoApplyTags(false)
        .conditionedRoll(false)
        .conditionedRollParams("string")
        .rollConfig(OceanUpdatePolicyRollConfigArgs.builder()
            .batchSizePercentage(0)
            .batchMinHealthyPercentage(0)
            .launchSpecIds("string")
            .respectPdb(false)
            .build())
        .build())
    .useAsTemplateOnly(false)
    .userData("string")
    .utilizeCommitments(false)
    .minSize(0)
    .whitelists("string")
    .build());

ocean_resource = spotinst.aws.Ocean("oceanResource",
    security_groups=["string"],
    subnet_ids=["string"],
    load_balancers=[spotinst.aws.OceanLoadBalancerArgs(
        arn="string",
        name="string",
        type="string",
    )],
    utilize_reserved_instances=False,
    block_device_mappings=[spotinst.aws.OceanBlockDeviceMappingArgs(
        device_name="string",
        ebs=spotinst.aws.OceanBlockDeviceMappingEbsArgs(
            delete_on_termination=False,
            dynamic_iops=spotinst.aws.OceanBlockDeviceMappingEbsDynamicIopsArgs(
                base_size=0,
                resource="string",
                size_per_resource_unit=0,
            ),
            dynamic_volume_size=spotinst.aws.OceanBlockDeviceMappingEbsDynamicVolumeSizeArgs(
                base_size=0,
                resource="string",
                size_per_resource_unit=0,
            ),
            encrypted=False,
            iops=0,
            kms_key_id="string",
            snapshot_id="string",
            throughput=0,
            volume_size=0,
            volume_type="string",
        ),
    )],
    max_size=0,
    controller_id="string",
    desired_capacity=0,
    draining_timeout=0,
    ebs_optimized=False,
    fallback_to_ondemand=False,
    filters=spotinst.aws.OceanFiltersArgs(
        architectures=["string"],
        categories=["string"],
        disk_types=["string"],
        exclude_families=["string"],
        exclude_metal=False,
        hypervisors=["string"],
        include_families=["string"],
        is_ena_supported="string",
        max_gpu=0,
        max_memory_gib=0,
        max_network_performance=0,
        max_vcpu=0,
        min_enis=0,
        min_gpu=0,
        min_memory_gib=0,
        min_network_performance=0,
        min_vcpu=0,
        root_device_types=["string"],
        virtualization_types=["string"],
    ),
    grace_period=0,
    health_check_unhealthy_duration_before_replacement=0,
    iam_instance_profile="string",
    image_id="string",
    instance_metadata_options=spotinst.aws.OceanInstanceMetadataOptionsArgs(
        http_tokens="string",
        http_put_response_hop_limit=0,
    ),
    key_name="string",
    associate_ipv6_address=False,
    logging=spotinst.aws.OceanLoggingArgs(
        export=spotinst.aws.OceanLoggingExportArgs(
            s3s=[spotinst.aws.OceanLoggingExportS3Args(
                id="string",
            )],
        ),
    ),
    cluster_orientations=[spotinst.aws.OceanClusterOrientationArgs(
        availability_vs_cost="string",
    )],
    blacklists=["string"],
    name="string",
    monitoring=False,
    region="string",
    resource_tag_specifications=[spotinst.aws.OceanResourceTagSpecificationArgs(
        should_tag_volumes=False,
    )],
    root_volume_size=0,
    scheduled_tasks=[spotinst.aws.OceanScheduledTaskArgs(
        shutdown_hours=spotinst.aws.OceanScheduledTaskShutdownHoursArgs(
            time_windows=["string"],
            is_enabled=False,
        ),
        tasks=[spotinst.aws.OceanScheduledTaskTaskArgs(
            cron_expression="string",
            is_enabled=False,
            task_type="string",
            parameters=spotinst.aws.OceanScheduledTaskTaskParametersArgs(
                ami_auto_update=spotinst.aws.OceanScheduledTaskTaskParametersAmiAutoUpdateArgs(
                    ami_auto_update_cluster_roll=spotinst.aws.OceanScheduledTaskTaskParametersAmiAutoUpdateAmiAutoUpdateClusterRollArgs(
                        batch_min_healthy_percentage=0,
                        batch_size_percentage=0,
                        comment="string",
                        respect_pdb=False,
                    ),
                    apply_roll=False,
                    minor_version=False,
                    patch=False,
                ),
                parameters_cluster_roll=spotinst.aws.OceanScheduledTaskTaskParametersParametersClusterRollArgs(
                    batch_min_healthy_percentage=0,
                    batch_size_percentage=0,
                    comment="string",
                    respect_pdb=False,
                ),
            ),
        )],
    )],
    autoscaler=spotinst.aws.OceanAutoscalerArgs(
        auto_headroom_percentage=0,
        autoscale_cooldown=0,
        autoscale_down=spotinst.aws.OceanAutoscalerAutoscaleDownArgs(
            evaluation_periods=0,
            is_aggressive_scale_down_enabled=False,
            max_scale_down_percentage=0,
        ),
        autoscale_headroom=spotinst.aws.OceanAutoscalerAutoscaleHeadroomArgs(
            cpu_per_unit=0,
            gpu_per_unit=0,
            memory_per_unit=0,
            num_of_units=0,
        ),
        autoscale_is_auto_config=False,
        autoscale_is_enabled=False,
        enable_automatic_and_manual_headroom=False,
        extended_resource_definitions=["string"],
        resource_limits=spotinst.aws.OceanAutoscalerResourceLimitsArgs(
            max_memory_gib=0,
            max_vcpu=0,
        ),
    ),
    spot_percentage=0,
    spread_nodes_by="string",
    associate_public_ip_address=False,
    tags=[spotinst.aws.OceanTagArgs(
        key="string",
        value="string",
    )],
    update_policy=spotinst.aws.OceanUpdatePolicyArgs(
        should_roll=False,
        auto_apply_tags=False,
        conditioned_roll=False,
        conditioned_roll_params=["string"],
        roll_config=spotinst.aws.OceanUpdatePolicyRollConfigArgs(
            batch_size_percentage=0,
            batch_min_healthy_percentage=0,
            launch_spec_ids=["string"],
            respect_pdb=False,
        ),
    ),
    use_as_template_only=False,
    user_data="string",
    utilize_commitments=False,
    min_size=0,
    whitelists=["string"])

const oceanResource = new spotinst.aws.Ocean("oceanResource", {
    securityGroups: ["string"],
    subnetIds: ["string"],
    loadBalancers: [{
        arn: "string",
        name: "string",
        type: "string",
    }],
    utilizeReservedInstances: false,
    blockDeviceMappings: [{
        deviceName: "string",
        ebs: {
            deleteOnTermination: false,
            dynamicIops: {
                baseSize: 0,
                resource: "string",
                sizePerResourceUnit: 0,
            },
            dynamicVolumeSize: {
                baseSize: 0,
                resource: "string",
                sizePerResourceUnit: 0,
            },
            encrypted: false,
            iops: 0,
            kmsKeyId: "string",
            snapshotId: "string",
            throughput: 0,
            volumeSize: 0,
            volumeType: "string",
        },
    }],
    maxSize: 0,
    controllerId: "string",
    desiredCapacity: 0,
    drainingTimeout: 0,
    ebsOptimized: false,
    fallbackToOndemand: false,
    filters: {
        architectures: ["string"],
        categories: ["string"],
        diskTypes: ["string"],
        excludeFamilies: ["string"],
        excludeMetal: false,
        hypervisors: ["string"],
        includeFamilies: ["string"],
        isEnaSupported: "string",
        maxGpu: 0,
        maxMemoryGib: 0,
        maxNetworkPerformance: 0,
        maxVcpu: 0,
        minEnis: 0,
        minGpu: 0,
        minMemoryGib: 0,
        minNetworkPerformance: 0,
        minVcpu: 0,
        rootDeviceTypes: ["string"],
        virtualizationTypes: ["string"],
    },
    gracePeriod: 0,
    healthCheckUnhealthyDurationBeforeReplacement: 0,
    iamInstanceProfile: "string",
    imageId: "string",
    instanceMetadataOptions: {
        httpTokens: "string",
        httpPutResponseHopLimit: 0,
    },
    keyName: "string",
    associateIpv6Address: false,
    logging: {
        "export": {
            s3s: [{
                id: "string",
            }],
        },
    },
    clusterOrientations: [{
        availabilityVsCost: "string",
    }],
    blacklists: ["string"],
    name: "string",
    monitoring: false,
    region: "string",
    resourceTagSpecifications: [{
        shouldTagVolumes: false,
    }],
    rootVolumeSize: 0,
    scheduledTasks: [{
        shutdownHours: {
            timeWindows: ["string"],
            isEnabled: false,
        },
        tasks: [{
            cronExpression: "string",
            isEnabled: false,
            taskType: "string",
            parameters: {
                amiAutoUpdate: {
                    amiAutoUpdateClusterRoll: {
                        batchMinHealthyPercentage: 0,
                        batchSizePercentage: 0,
                        comment: "string",
                        respectPdb: false,
                    },
                    applyRoll: false,
                    minorVersion: false,
                    patch: false,
                },
                parametersClusterRoll: {
                    batchMinHealthyPercentage: 0,
                    batchSizePercentage: 0,
                    comment: "string",
                    respectPdb: false,
                },
            },
        }],
    }],
    autoscaler: {
        autoHeadroomPercentage: 0,
        autoscaleCooldown: 0,
        autoscaleDown: {
            evaluationPeriods: 0,
            isAggressiveScaleDownEnabled: false,
            maxScaleDownPercentage: 0,
        },
        autoscaleHeadroom: {
            cpuPerUnit: 0,
            gpuPerUnit: 0,
            memoryPerUnit: 0,
            numOfUnits: 0,
        },
        autoscaleIsAutoConfig: false,
        autoscaleIsEnabled: false,
        enableAutomaticAndManualHeadroom: false,
        extendedResourceDefinitions: ["string"],
        resourceLimits: {
            maxMemoryGib: 0,
            maxVcpu: 0,
        },
    },
    spotPercentage: 0,
    spreadNodesBy: "string",
    associatePublicIpAddress: false,
    tags: [{
        key: "string",
        value: "string",
    }],
    updatePolicy: {
        shouldRoll: false,
        autoApplyTags: false,
        conditionedRoll: false,
        conditionedRollParams: ["string"],
        rollConfig: {
            batchSizePercentage: 0,
            batchMinHealthyPercentage: 0,
            launchSpecIds: ["string"],
            respectPdb: false,
        },
    },
    useAsTemplateOnly: false,
    userData: "string",
    utilizeCommitments: false,
    minSize: 0,
    whitelists: ["string"],
});

type: spotinst:aws:Ocean
properties:
    associateIpv6Address: false
    associatePublicIpAddress: false
    autoscaler:
        autoHeadroomPercentage: 0
        autoscaleCooldown: 0
        autoscaleDown:
            evaluationPeriods: 0
            isAggressiveScaleDownEnabled: false
            maxScaleDownPercentage: 0
        autoscaleHeadroom:
            cpuPerUnit: 0
            gpuPerUnit: 0
            memoryPerUnit: 0
            numOfUnits: 0
        autoscaleIsAutoConfig: false
        autoscaleIsEnabled: false
        enableAutomaticAndManualHeadroom: false
        extendedResourceDefinitions:
            - string
        resourceLimits:
            maxMemoryGib: 0
            maxVcpu: 0
    blacklists:
        - string
    blockDeviceMappings:
        - deviceName: string
          ebs:
            deleteOnTermination: false
            dynamicIops:
                baseSize: 0
                resource: string
                sizePerResourceUnit: 0
            dynamicVolumeSize:
                baseSize: 0
                resource: string
                sizePerResourceUnit: 0
            encrypted: false
            iops: 0
            kmsKeyId: string
            snapshotId: string
            throughput: 0
            volumeSize: 0
            volumeType: string
    clusterOrientations:
        - availabilityVsCost: string
    controllerId: string
    desiredCapacity: 0
    drainingTimeout: 0
    ebsOptimized: false
    fallbackToOndemand: false
    filters:
        architectures:
            - string
        categories:
            - string
        diskTypes:
            - string
        excludeFamilies:
            - string
        excludeMetal: false
        hypervisors:
            - string
        includeFamilies:
            - string
        isEnaSupported: string
        maxGpu: 0
        maxMemoryGib: 0
        maxNetworkPerformance: 0
        maxVcpu: 0
        minEnis: 0
        minGpu: 0
        minMemoryGib: 0
        minNetworkPerformance: 0
        minVcpu: 0
        rootDeviceTypes:
            - string
        virtualizationTypes:
            - string
    gracePeriod: 0
    healthCheckUnhealthyDurationBeforeReplacement: 0
    iamInstanceProfile: string
    imageId: string
    instanceMetadataOptions:
        httpPutResponseHopLimit: 0
        httpTokens: string
    keyName: string
    loadBalancers:
        - arn: string
          name: string
          type: string
    logging:
        export:
            s3s:
                - id: string
    maxSize: 0
    minSize: 0
    monitoring: false
    name: string
    region: string
    resourceTagSpecifications:
        - shouldTagVolumes: false
    rootVolumeSize: 0
    scheduledTasks:
        - shutdownHours:
            isEnabled: false
            timeWindows:
                - string
          tasks:
            - cronExpression: string
              isEnabled: false
              parameters:
                amiAutoUpdate:
                    amiAutoUpdateClusterRoll:
                        batchMinHealthyPercentage: 0
                        batchSizePercentage: 0
                        comment: string
                        respectPdb: false
                    applyRoll: false
                    minorVersion: false
                    patch: false
                parametersClusterRoll:
                    batchMinHealthyPercentage: 0
                    batchSizePercentage: 0
                    comment: string
                    respectPdb: false
              taskType: string
    securityGroups:
        - string
    spotPercentage: 0
    spreadNodesBy: string
    subnetIds:
        - string
    tags:
        - key: string
          value: string
    updatePolicy:
        autoApplyTags: false
        conditionedRoll: false
        conditionedRollParams:
            - string
        rollConfig:
            batchMinHealthyPercentage: 0
            batchSizePercentage: 0
            launchSpecIds:
                - string
            respectPdb: false
        shouldRoll: false
    useAsTemplateOnly: false
    userData: string
    utilizeCommitments: false
    utilizeReservedInstances: false
    whitelists:
        - string

Ocean Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

The Ocean resource accepts the following input properties:

SecurityGroups List<string>: One or more security group ids.
SubnetIds List<string>: A comma-separated list of subnet identifiers for the Ocean cluster. Subnet IDs should be configured with auto assign public IP.
AssociateIpv6Address bool: Configure IPv6 address allocation.
AssociatePublicIpAddress bool: Configure public IP address allocation.
Autoscaler Pulumi.SpotInst.Aws.Inputs.OceanAutoscaler
Blacklists List<string>: Instance types not allowed in the Ocean cluster. Cannot be configured if whitelist is configured.
BlockDeviceMappings List<Pulumi.SpotInst.Aws.Inputs.OceanBlockDeviceMapping>: Object. Array list of block devices that are exposed to the instance, specify either virtual devices and EBS volumes.
ClusterOrientations List<Pulumi.SpotInst.Aws.Inputs.OceanClusterOrientation>
ControllerId string: A unique identifier used for connecting the Ocean SaaS platform and the Kubernetes cluster. Typically, the cluster name is used as its identifier.
DesiredCapacity int: The number of instances to launch and maintain in the cluster.
DrainingTimeout int: The time in seconds, the instance is allowed to run while detached from the ELB. This is to allow the instance time to be drained from incoming TCP connections before terminating it, during a scale down operation.
EbsOptimized bool: Enable EBS optimized for cluster. Flag will enable optimized capacity for high bandwidth connectivity to the EB service for non EBS optimized instance types. For instances that are EBS optimized this flag will be ignored.
FallbackToOndemand bool: If not Spot instance markets are available, enable Ocean to launch On-Demand instances instead.
Filters Pulumi.SpotInst.Aws.Inputs.OceanFilters: List of filters. The Instance types that match with all filters compose the Ocean's whitelist parameter. Cannot be configured together with whitelist/blacklist.
GracePeriod int: The amount of time, in seconds, after the instance has launched to start checking its health.
HealthCheckUnhealthyDurationBeforeReplacement int: The amount of time, in seconds, an existing instance should remain active after becoming unhealthy. After the set time out the instance will be replaced. The minimum value allowed is 60, and it must be a multiple of 60.
IamInstanceProfile string: The instance profile iam role.
ImageId string: ID of the image used to launch the instances.
InstanceMetadataOptions Pulumi.SpotInst.Aws.Inputs.OceanInstanceMetadataOptions: Ocean instance metadata options object for IMDSv2.
KeyName string: The key pair to attach the instances.
LoadBalancers List<Pulumi.SpotInst.Aws.Inputs.OceanLoadBalancer>: Array of load balancer objects to add to ocean cluster
Logging Pulumi.SpotInst.Aws.Inputs.OceanLogging: Logging configuration.
MaxSize int: The upper limit of instances the cluster can scale up to.
MinSize int: The lower limit of instances the cluster can scale down to.
Monitoring bool: Enable detailed monitoring for cluster. Flag will enable Cloud Watch detailed monitoring (one minute increments). Note: there are additional hourly costs for this service based on the region used.
Name string: Required if type is set to CLASSIC
Region string: The region the cluster will run in.
ResourceTagSpecifications List<Pulumi.SpotInst.Aws.Inputs.OceanResourceTagSpecification>: Specify which resources should be tagged with Virtual Node Group tags or Ocean tags. If tags are set on the VNG, the resources will be tagged with the VNG tags; otherwise, they will be tagged with the Ocean tags.
RootVolumeSize int: The size (in Gb) to allocate for the root volume. Minimum 20.
ScheduledTasks List<Pulumi.SpotInst.Aws.Inputs.OceanScheduledTask>
SpotPercentage int: The desired percentage of Spot instances out of all running instances. Only available when the field is not set in any VNG directly (launchSpec.strategy.spotPercentage).
SpreadNodesBy string: Ocean will spread the nodes across markets by this value. Possible values: vcpu or count.
Tags List<Pulumi.SpotInst.Aws.Inputs.OceanTag>: Optionally adds tags to instances launched in an Ocean cluster.
UpdatePolicy Pulumi.SpotInst.Aws.Inputs.OceanUpdatePolicy
UseAsTemplateOnly bool: launch specification defined on the Ocean object will function only as a template for virtual node groups. When set to true, on Ocean resource creation please make sure your custom VNG has an initial_nodes parameter to create nodes for your VNG.
UserData string: Base64-encoded MIME user data to make available to the instances.
UtilizeCommitments bool: If savings plans exist, Ocean will utilize them before launching Spot instances.
UtilizeReservedInstances bool: If Reserved instances exist, Ocean will utilize them before launching Spot instances.
Whitelists List<string>: Instance types allowed in the Ocean cluster. Cannot be configured if blacklist is configured.

SecurityGroups []string: One or more security group ids.
SubnetIds []string: A comma-separated list of subnet identifiers for the Ocean cluster. Subnet IDs should be configured with auto assign public IP.
AssociateIpv6Address bool: Configure IPv6 address allocation.
AssociatePublicIpAddress bool: Configure public IP address allocation.
Autoscaler OceanAutoscalerArgs
Blacklists []string: Instance types not allowed in the Ocean cluster. Cannot be configured if whitelist is configured.
BlockDeviceMappings []OceanBlockDeviceMappingArgs: Object. Array list of block devices that are exposed to the instance, specify either virtual devices and EBS volumes.
ClusterOrientations []OceanClusterOrientationArgs
ControllerId string: A unique identifier used for connecting the Ocean SaaS platform and the Kubernetes cluster. Typically, the cluster name is used as its identifier.
DesiredCapacity int: The number of instances to launch and maintain in the cluster.
DrainingTimeout int: The time in seconds, the instance is allowed to run while detached from the ELB. This is to allow the instance time to be drained from incoming TCP connections before terminating it, during a scale down operation.
EbsOptimized bool: Enable EBS optimized for cluster. Flag will enable optimized capacity for high bandwidth connectivity to the EB service for non EBS optimized instance types. For instances that are EBS optimized this flag will be ignored.
FallbackToOndemand bool: If not Spot instance markets are available, enable Ocean to launch On-Demand instances instead.
Filters OceanFiltersArgs: List of filters. The Instance types that match with all filters compose the Ocean's whitelist parameter. Cannot be configured together with whitelist/blacklist.
GracePeriod int: The amount of time, in seconds, after the instance has launched to start checking its health.
HealthCheckUnhealthyDurationBeforeReplacement int: The amount of time, in seconds, an existing instance should remain active after becoming unhealthy. After the set time out the instance will be replaced. The minimum value allowed is 60, and it must be a multiple of 60.
IamInstanceProfile string: The instance profile iam role.
ImageId string: ID of the image used to launch the instances.
InstanceMetadataOptions OceanInstanceMetadataOptionsArgs: Ocean instance metadata options object for IMDSv2.
KeyName string: The key pair to attach the instances.
LoadBalancers []OceanLoadBalancerArgs: Array of load balancer objects to add to ocean cluster
Logging OceanLoggingArgs: Logging configuration.
MaxSize int: The upper limit of instances the cluster can scale up to.
MinSize int: The lower limit of instances the cluster can scale down to.
Monitoring bool: Enable detailed monitoring for cluster. Flag will enable Cloud Watch detailed monitoring (one minute increments). Note: there are additional hourly costs for this service based on the region used.
Name string: Required if type is set to CLASSIC
Region string: The region the cluster will run in.
ResourceTagSpecifications []OceanResourceTagSpecificationArgs: Specify which resources should be tagged with Virtual Node Group tags or Ocean tags. If tags are set on the VNG, the resources will be tagged with the VNG tags; otherwise, they will be tagged with the Ocean tags.
RootVolumeSize int: The size (in Gb) to allocate for the root volume. Minimum 20.
ScheduledTasks []OceanScheduledTaskArgs
SpotPercentage int: The desired percentage of Spot instances out of all running instances. Only available when the field is not set in any VNG directly (launchSpec.strategy.spotPercentage).
SpreadNodesBy string: Ocean will spread the nodes across markets by this value. Possible values: vcpu or count.
Tags []OceanTagArgs: Optionally adds tags to instances launched in an Ocean cluster.
UpdatePolicy OceanUpdatePolicyArgs
UseAsTemplateOnly bool: launch specification defined on the Ocean object will function only as a template for virtual node groups. When set to true, on Ocean resource creation please make sure your custom VNG has an initial_nodes parameter to create nodes for your VNG.
UserData string: Base64-encoded MIME user data to make available to the instances.
UtilizeCommitments bool: If savings plans exist, Ocean will utilize them before launching Spot instances.
UtilizeReservedInstances bool: If Reserved instances exist, Ocean will utilize them before launching Spot instances.
Whitelists []string: Instance types allowed in the Ocean cluster. Cannot be configured if blacklist is configured.

securityGroups List<String>: One or more security group ids.
subnetIds List<String>: A comma-separated list of subnet identifiers for the Ocean cluster. Subnet IDs should be configured with auto assign public IP.
associateIpv6Address Boolean: Configure IPv6 address allocation.
associatePublicIpAddress Boolean: Configure public IP address allocation.
autoscaler OceanAutoscaler
blacklists List<String>: Instance types not allowed in the Ocean cluster. Cannot be configured if whitelist is configured.
blockDeviceMappings List<OceanBlockDeviceMapping>: Object. Array list of block devices that are exposed to the instance, specify either virtual devices and EBS volumes.
clusterOrientations List<OceanClusterOrientation>
controllerId String: A unique identifier used for connecting the Ocean SaaS platform and the Kubernetes cluster. Typically, the cluster name is used as its identifier.
desiredCapacity Integer: The number of instances to launch and maintain in the cluster.
drainingTimeout Integer: The time in seconds, the instance is allowed to run while detached from the ELB. This is to allow the instance time to be drained from incoming TCP connections before terminating it, during a scale down operation.
ebsOptimized Boolean: Enable EBS optimized for cluster. Flag will enable optimized capacity for high bandwidth connectivity to the EB service for non EBS optimized instance types. For instances that are EBS optimized this flag will be ignored.
fallbackToOndemand Boolean: If not Spot instance markets are available, enable Ocean to launch On-Demand instances instead.
filters OceanFilters: List of filters. The Instance types that match with all filters compose the Ocean's whitelist parameter. Cannot be configured together with whitelist/blacklist.
gracePeriod Integer: The amount of time, in seconds, after the instance has launched to start checking its health.
healthCheckUnhealthyDurationBeforeReplacement Integer: The amount of time, in seconds, an existing instance should remain active after becoming unhealthy. After the set time out the instance will be replaced. The minimum value allowed is 60, and it must be a multiple of 60.
iamInstanceProfile String: The instance profile iam role.
imageId String: ID of the image used to launch the instances.
instanceMetadataOptions OceanInstanceMetadataOptions: Ocean instance metadata options object for IMDSv2.
keyName String: The key pair to attach the instances.
loadBalancers List<OceanLoadBalancer>: Array of load balancer objects to add to ocean cluster
logging OceanLogging: Logging configuration.
maxSize Integer: The upper limit of instances the cluster can scale up to.
minSize Integer: The lower limit of instances the cluster can scale down to.
monitoring Boolean: Enable detailed monitoring for cluster. Flag will enable Cloud Watch detailed monitoring (one minute increments). Note: there are additional hourly costs for this service based on the region used.
name String: Required if type is set to CLASSIC
region String: The region the cluster will run in.
resourceTagSpecifications List<OceanResourceTagSpecification>: Specify which resources should be tagged with Virtual Node Group tags or Ocean tags. If tags are set on the VNG, the resources will be tagged with the VNG tags; otherwise, they will be tagged with the Ocean tags.
rootVolumeSize Integer: The size (in Gb) to allocate for the root volume. Minimum 20.
scheduledTasks List<OceanScheduledTask>
spotPercentage Integer: The desired percentage of Spot instances out of all running instances. Only available when the field is not set in any VNG directly (launchSpec.strategy.spotPercentage).
spreadNodesBy String: Ocean will spread the nodes across markets by this value. Possible values: vcpu or count.
tags List<OceanTag>: Optionally adds tags to instances launched in an Ocean cluster.
updatePolicy OceanUpdatePolicy
useAsTemplateOnly Boolean: launch specification defined on the Ocean object will function only as a template for virtual node groups. When set to true, on Ocean resource creation please make sure your custom VNG has an initial_nodes parameter to create nodes for your VNG.
userData String: Base64-encoded MIME user data to make available to the instances.
utilizeCommitments Boolean: If savings plans exist, Ocean will utilize them before launching Spot instances.
utilizeReservedInstances Boolean: If Reserved instances exist, Ocean will utilize them before launching Spot instances.
whitelists List<String>: Instance types allowed in the Ocean cluster. Cannot be configured if blacklist is configured.

securityGroups string[]: One or more security group ids.
subnetIds string[]: A comma-separated list of subnet identifiers for the Ocean cluster. Subnet IDs should be configured with auto assign public IP.
associateIpv6Address boolean: Configure IPv6 address allocation.
associatePublicIpAddress boolean: Configure public IP address allocation.
autoscaler OceanAutoscaler
blacklists string[]: Instance types not allowed in the Ocean cluster. Cannot be configured if whitelist is configured.
blockDeviceMappings OceanBlockDeviceMapping[]: Object. Array list of block devices that are exposed to the instance, specify either virtual devices and EBS volumes.
clusterOrientations OceanClusterOrientation[]
controllerId string: A unique identifier used for connecting the Ocean SaaS platform and the Kubernetes cluster. Typically, the cluster name is used as its identifier.
desiredCapacity number: The number of instances to launch and maintain in the cluster.
drainingTimeout number: The time in seconds, the instance is allowed to run while detached from the ELB. This is to allow the instance time to be drained from incoming TCP connections before terminating it, during a scale down operation.
ebsOptimized boolean: Enable EBS optimized for cluster. Flag will enable optimized capacity for high bandwidth connectivity to the EB service for non EBS optimized instance types. For instances that are EBS optimized this flag will be ignored.
fallbackToOndemand boolean: If not Spot instance markets are available, enable Ocean to launch On-Demand instances instead.
filters OceanFilters: List of filters. The Instance types that match with all filters compose the Ocean's whitelist parameter. Cannot be configured together with whitelist/blacklist.
gracePeriod number: The amount of time, in seconds, after the instance has launched to start checking its health.
healthCheckUnhealthyDurationBeforeReplacement number: The amount of time, in seconds, an existing instance should remain active after becoming unhealthy. After the set time out the instance will be replaced. The minimum value allowed is 60, and it must be a multiple of 60.
iamInstanceProfile string: The instance profile iam role.
imageId string: ID of the image used to launch the instances.
instanceMetadataOptions OceanInstanceMetadataOptions: Ocean instance metadata options object for IMDSv2.
keyName string: The key pair to attach the instances.
loadBalancers OceanLoadBalancer[]: Array of load balancer objects to add to ocean cluster
logging OceanLogging: Logging configuration.
maxSize number: The upper limit of instances the cluster can scale up to.
minSize number: The lower limit of instances the cluster can scale down to.
monitoring boolean: Enable detailed monitoring for cluster. Flag will enable Cloud Watch detailed monitoring (one minute increments). Note: there are additional hourly costs for this service based on the region used.
name string: Required if type is set to CLASSIC
region string: The region the cluster will run in.
resourceTagSpecifications OceanResourceTagSpecification[]: Specify which resources should be tagged with Virtual Node Group tags or Ocean tags. If tags are set on the VNG, the resources will be tagged with the VNG tags; otherwise, they will be tagged with the Ocean tags.
rootVolumeSize number: The size (in Gb) to allocate for the root volume. Minimum 20.
scheduledTasks OceanScheduledTask[]
spotPercentage number: The desired percentage of Spot instances out of all running instances. Only available when the field is not set in any VNG directly (launchSpec.strategy.spotPercentage).
spreadNodesBy string: Ocean will spread the nodes across markets by this value. Possible values: vcpu or count.
tags OceanTag[]: Optionally adds tags to instances launched in an Ocean cluster.
updatePolicy OceanUpdatePolicy
useAsTemplateOnly boolean: launch specification defined on the Ocean object will function only as a template for virtual node groups. When set to true, on Ocean resource creation please make sure your custom VNG has an initial_nodes parameter to create nodes for your VNG.
userData string: Base64-encoded MIME user data to make available to the instances.
utilizeCommitments boolean: If savings plans exist, Ocean will utilize them before launching Spot instances.
utilizeReservedInstances boolean: If Reserved instances exist, Ocean will utilize them before launching Spot instances.
whitelists string[]: Instance types allowed in the Ocean cluster. Cannot be configured if blacklist is configured.

security_groups Sequence[str]: One or more security group ids.
subnet_ids Sequence[str]: A comma-separated list of subnet identifiers for the Ocean cluster. Subnet IDs should be configured with auto assign public IP.
associate_ipv6_address bool: Configure IPv6 address allocation.
associate_public_ip_address bool: Configure public IP address allocation.
autoscaler OceanAutoscalerArgs
blacklists Sequence[str]: Instance types not allowed in the Ocean cluster. Cannot be configured if whitelist is configured.
block_device_mappings Sequence[OceanBlockDeviceMappingArgs]: Object. Array list of block devices that are exposed to the instance, specify either virtual devices and EBS volumes.
cluster_orientations Sequence[OceanClusterOrientationArgs]
controller_id str: A unique identifier used for connecting the Ocean SaaS platform and the Kubernetes cluster. Typically, the cluster name is used as its identifier.
desired_capacity int: The number of instances to launch and maintain in the cluster.
draining_timeout int: The time in seconds, the instance is allowed to run while detached from the ELB. This is to allow the instance time to be drained from incoming TCP connections before terminating it, during a scale down operation.
ebs_optimized bool: Enable EBS optimized for cluster. Flag will enable optimized capacity for high bandwidth connectivity to the EB service for non EBS optimized instance types. For instances that are EBS optimized this flag will be ignored.
fallback_to_ondemand bool: If not Spot instance markets are available, enable Ocean to launch On-Demand instances instead.
filters OceanFiltersArgs: List of filters. The Instance types that match with all filters compose the Ocean's whitelist parameter. Cannot be configured together with whitelist/blacklist.
grace_period int: The amount of time, in seconds, after the instance has launched to start checking its health.
health_check_unhealthy_duration_before_replacement int: The amount of time, in seconds, an existing instance should remain active after becoming unhealthy. After the set time out the instance will be replaced. The minimum value allowed is 60, and it must be a multiple of 60.
iam_instance_profile str: The instance profile iam role.
image_id str: ID of the image used to launch the instances.
instance_metadata_options OceanInstanceMetadataOptionsArgs: Ocean instance metadata options object for IMDSv2.
key_name str: The key pair to attach the instances.
load_balancers Sequence[OceanLoadBalancerArgs]: Array of load balancer objects to add to ocean cluster
logging OceanLoggingArgs: Logging configuration.
max_size int: The upper limit of instances the cluster can scale up to.
min_size int: The lower limit of instances the cluster can scale down to.
monitoring bool: Enable detailed monitoring for cluster. Flag will enable Cloud Watch detailed monitoring (one minute increments). Note: there are additional hourly costs for this service based on the region used.
name str: Required if type is set to CLASSIC
region str: The region the cluster will run in.
resource_tag_specifications Sequence[OceanResourceTagSpecificationArgs]: Specify which resources should be tagged with Virtual Node Group tags or Ocean tags. If tags are set on the VNG, the resources will be tagged with the VNG tags; otherwise, they will be tagged with the Ocean tags.
root_volume_size int: The size (in Gb) to allocate for the root volume. Minimum 20.
scheduled_tasks Sequence[OceanScheduledTaskArgs]
spot_percentage int: The desired percentage of Spot instances out of all running instances. Only available when the field is not set in any VNG directly (launchSpec.strategy.spotPercentage).
spread_nodes_by str: Ocean will spread the nodes across markets by this value. Possible values: vcpu or count.
tags Sequence[OceanTagArgs]: Optionally adds tags to instances launched in an Ocean cluster.
update_policy OceanUpdatePolicyArgs
use_as_template_only bool: launch specification defined on the Ocean object will function only as a template for virtual node groups. When set to true, on Ocean resource creation please make sure your custom VNG has an initial_nodes parameter to create nodes for your VNG.
user_data str: Base64-encoded MIME user data to make available to the instances.
utilize_commitments bool: If savings plans exist, Ocean will utilize them before launching Spot instances.
utilize_reserved_instances bool: If Reserved instances exist, Ocean will utilize them before launching Spot instances.
whitelists Sequence[str]: Instance types allowed in the Ocean cluster. Cannot be configured if blacklist is configured.

securityGroups List<String>: One or more security group ids.
subnetIds List<String>: A comma-separated list of subnet identifiers for the Ocean cluster. Subnet IDs should be configured with auto assign public IP.
associateIpv6Address Boolean: Configure IPv6 address allocation.
associatePublicIpAddress Boolean: Configure public IP address allocation.
autoscaler Property Map
blacklists List<String>: Instance types not allowed in the Ocean cluster. Cannot be configured if whitelist is configured.
blockDeviceMappings List<Property Map>: Object. Array list of block devices that are exposed to the instance, specify either virtual devices and EBS volumes.
clusterOrientations List<Property Map>
controllerId String: A unique identifier used for connecting the Ocean SaaS platform and the Kubernetes cluster. Typically, the cluster name is used as its identifier.
desiredCapacity Number: The number of instances to launch and maintain in the cluster.
drainingTimeout Number: The time in seconds, the instance is allowed to run while detached from the ELB. This is to allow the instance time to be drained from incoming TCP connections before terminating it, during a scale down operation.
ebsOptimized Boolean: Enable EBS optimized for cluster. Flag will enable optimized capacity for high bandwidth connectivity to the EB service for non EBS optimized instance types. For instances that are EBS optimized this flag will be ignored.
fallbackToOndemand Boolean: If not Spot instance markets are available, enable Ocean to launch On-Demand instances instead.
filters Property Map: List of filters. The Instance types that match with all filters compose the Ocean's whitelist parameter. Cannot be configured together with whitelist/blacklist.
gracePeriod Number: The amount of time, in seconds, after the instance has launched to start checking its health.
healthCheckUnhealthyDurationBeforeReplacement Number: The amount of time, in seconds, an existing instance should remain active after becoming unhealthy. After the set time out the instance will be replaced. The minimum value allowed is 60, and it must be a multiple of 60.
iamInstanceProfile String: The instance profile iam role.
imageId String: ID of the image used to launch the instances.
instanceMetadataOptions Property Map: Ocean instance metadata options object for IMDSv2.
keyName String: The key pair to attach the instances.
loadBalancers List<Property Map>: Array of load balancer objects to add to ocean cluster
logging Property Map: Logging configuration.
maxSize Number: The upper limit of instances the cluster can scale up to.
minSize Number: The lower limit of instances the cluster can scale down to.
monitoring Boolean: Enable detailed monitoring for cluster. Flag will enable Cloud Watch detailed monitoring (one minute increments). Note: there are additional hourly costs for this service based on the region used.
name String: Required if type is set to CLASSIC
region String: The region the cluster will run in.
resourceTagSpecifications List<Property Map>: Specify which resources should be tagged with Virtual Node Group tags or Ocean tags. If tags are set on the VNG, the resources will be tagged with the VNG tags; otherwise, they will be tagged with the Ocean tags.
rootVolumeSize Number: The size (in Gb) to allocate for the root volume. Minimum 20.
scheduledTasks List<Property Map>
spotPercentage Number: The desired percentage of Spot instances out of all running instances. Only available when the field is not set in any VNG directly (launchSpec.strategy.spotPercentage).
spreadNodesBy String: Ocean will spread the nodes across markets by this value. Possible values: vcpu or count.
tags List<Property Map>: Optionally adds tags to instances launched in an Ocean cluster.
updatePolicy Property Map
useAsTemplateOnly Boolean: launch specification defined on the Ocean object will function only as a template for virtual node groups. When set to true, on Ocean resource creation please make sure your custom VNG has an initial_nodes parameter to create nodes for your VNG.
userData String: Base64-encoded MIME user data to make available to the instances.
utilizeCommitments Boolean: If savings plans exist, Ocean will utilize them before launching Spot instances.
utilizeReservedInstances Boolean: If Reserved instances exist, Ocean will utilize them before launching Spot instances.
whitelists List<String>: Instance types allowed in the Ocean cluster. Cannot be configured if blacklist is configured.

Outputs

All input properties are implicitly available as output properties. Additionally, the Ocean resource produces the following output properties:

Id string: The provider-assigned unique ID for this managed resource.

Id string: The provider-assigned unique ID for this managed resource.

id String: The provider-assigned unique ID for this managed resource.

id string: The provider-assigned unique ID for this managed resource.

id str: The provider-assigned unique ID for this managed resource.

id String: The provider-assigned unique ID for this managed resource.

Look up Existing Ocean Resource

Get an existing Ocean resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

public static get(name: string, id: Input<ID>, state?: OceanState, opts?: CustomResourceOptions): Ocean

@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        associate_ipv6_address: Optional[bool] = None,
        associate_public_ip_address: Optional[bool] = None,
        autoscaler: Optional[OceanAutoscalerArgs] = None,
        blacklists: Optional[Sequence[str]] = None,
        block_device_mappings: Optional[Sequence[OceanBlockDeviceMappingArgs]] = None,
        cluster_orientations: Optional[Sequence[OceanClusterOrientationArgs]] = None,
        controller_id: Optional[str] = None,
        desired_capacity: Optional[int] = None,
        draining_timeout: Optional[int] = None,
        ebs_optimized: Optional[bool] = None,
        fallback_to_ondemand: Optional[bool] = None,
        filters: Optional[OceanFiltersArgs] = None,
        grace_period: Optional[int] = None,
        health_check_unhealthy_duration_before_replacement: Optional[int] = None,
        iam_instance_profile: Optional[str] = None,
        image_id: Optional[str] = None,
        instance_metadata_options: Optional[OceanInstanceMetadataOptionsArgs] = None,
        key_name: Optional[str] = None,
        load_balancers: Optional[Sequence[OceanLoadBalancerArgs]] = None,
        logging: Optional[OceanLoggingArgs] = None,
        max_size: Optional[int] = None,
        min_size: Optional[int] = None,
        monitoring: Optional[bool] = None,
        name: Optional[str] = None,
        region: Optional[str] = None,
        resource_tag_specifications: Optional[Sequence[OceanResourceTagSpecificationArgs]] = None,
        root_volume_size: Optional[int] = None,
        scheduled_tasks: Optional[Sequence[OceanScheduledTaskArgs]] = None,
        security_groups: Optional[Sequence[str]] = None,
        spot_percentage: Optional[int] = None,
        spread_nodes_by: Optional[str] = None,
        subnet_ids: Optional[Sequence[str]] = None,
        tags: Optional[Sequence[OceanTagArgs]] = None,
        update_policy: Optional[OceanUpdatePolicyArgs] = None,
        use_as_template_only: Optional[bool] = None,
        user_data: Optional[str] = None,
        utilize_commitments: Optional[bool] = None,
        utilize_reserved_instances: Optional[bool] = None,
        whitelists: Optional[Sequence[str]] = None) -> Ocean

func GetOcean(ctx *Context, name string, id IDInput, state *OceanState, opts ...ResourceOption) (*Ocean, error)

public static Ocean Get(string name, Input<string> id, OceanState? state, CustomResourceOptions? opts = null)

public static Ocean get(String name, Output<String> id, OceanState state, CustomResourceOptions options)

Resource lookup is not supported in YAML

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

resource_name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

The following state arguments are supported:

AssociateIpv6Address bool: Configure IPv6 address allocation.
AssociatePublicIpAddress bool: Configure public IP address allocation.
Autoscaler Pulumi.SpotInst.Aws.Inputs.OceanAutoscaler
Blacklists List<string>: Instance types not allowed in the Ocean cluster. Cannot be configured if whitelist is configured.
BlockDeviceMappings List<Pulumi.SpotInst.Aws.Inputs.OceanBlockDeviceMapping>: Object. Array list of block devices that are exposed to the instance, specify either virtual devices and EBS volumes.
ClusterOrientations List<Pulumi.SpotInst.Aws.Inputs.OceanClusterOrientation>
ControllerId string: A unique identifier used for connecting the Ocean SaaS platform and the Kubernetes cluster. Typically, the cluster name is used as its identifier.
DesiredCapacity int: The number of instances to launch and maintain in the cluster.
DrainingTimeout int: The time in seconds, the instance is allowed to run while detached from the ELB. This is to allow the instance time to be drained from incoming TCP connections before terminating it, during a scale down operation.
EbsOptimized bool: Enable EBS optimized for cluster. Flag will enable optimized capacity for high bandwidth connectivity to the EB service for non EBS optimized instance types. For instances that are EBS optimized this flag will be ignored.
FallbackToOndemand bool: If not Spot instance markets are available, enable Ocean to launch On-Demand instances instead.
Filters Pulumi.SpotInst.Aws.Inputs.OceanFilters: List of filters. The Instance types that match with all filters compose the Ocean's whitelist parameter. Cannot be configured together with whitelist/blacklist.
GracePeriod int: The amount of time, in seconds, after the instance has launched to start checking its health.
HealthCheckUnhealthyDurationBeforeReplacement int: The amount of time, in seconds, an existing instance should remain active after becoming unhealthy. After the set time out the instance will be replaced. The minimum value allowed is 60, and it must be a multiple of 60.
IamInstanceProfile string: The instance profile iam role.
ImageId string: ID of the image used to launch the instances.
InstanceMetadataOptions Pulumi.SpotInst.Aws.Inputs.OceanInstanceMetadataOptions: Ocean instance metadata options object for IMDSv2.
KeyName string: The key pair to attach the instances.
LoadBalancers List<Pulumi.SpotInst.Aws.Inputs.OceanLoadBalancer>: Array of load balancer objects to add to ocean cluster
Logging Pulumi.SpotInst.Aws.Inputs.OceanLogging: Logging configuration.
MaxSize int: The upper limit of instances the cluster can scale up to.
MinSize int: The lower limit of instances the cluster can scale down to.
Monitoring bool: Enable detailed monitoring for cluster. Flag will enable Cloud Watch detailed monitoring (one minute increments). Note: there are additional hourly costs for this service based on the region used.
Name string: Required if type is set to CLASSIC
Region string: The region the cluster will run in.
ResourceTagSpecifications List<Pulumi.SpotInst.Aws.Inputs.OceanResourceTagSpecification>: Specify which resources should be tagged with Virtual Node Group tags or Ocean tags. If tags are set on the VNG, the resources will be tagged with the VNG tags; otherwise, they will be tagged with the Ocean tags.
RootVolumeSize int: The size (in Gb) to allocate for the root volume. Minimum 20.
ScheduledTasks List<Pulumi.SpotInst.Aws.Inputs.OceanScheduledTask>
SecurityGroups List<string>: One or more security group ids.
SpotPercentage int: The desired percentage of Spot instances out of all running instances. Only available when the field is not set in any VNG directly (launchSpec.strategy.spotPercentage).
SpreadNodesBy string: Ocean will spread the nodes across markets by this value. Possible values: vcpu or count.
SubnetIds List<string>: A comma-separated list of subnet identifiers for the Ocean cluster. Subnet IDs should be configured with auto assign public IP.
Tags List<Pulumi.SpotInst.Aws.Inputs.OceanTag>: Optionally adds tags to instances launched in an Ocean cluster.
UpdatePolicy Pulumi.SpotInst.Aws.Inputs.OceanUpdatePolicy
UseAsTemplateOnly bool: launch specification defined on the Ocean object will function only as a template for virtual node groups. When set to true, on Ocean resource creation please make sure your custom VNG has an initial_nodes parameter to create nodes for your VNG.
UserData string: Base64-encoded MIME user data to make available to the instances.
UtilizeCommitments bool: If savings plans exist, Ocean will utilize them before launching Spot instances.
UtilizeReservedInstances bool: If Reserved instances exist, Ocean will utilize them before launching Spot instances.
Whitelists List<string>: Instance types allowed in the Ocean cluster. Cannot be configured if blacklist is configured.

AssociateIpv6Address bool: Configure IPv6 address allocation.
AssociatePublicIpAddress bool: Configure public IP address allocation.
Autoscaler OceanAutoscalerArgs
Blacklists []string: Instance types not allowed in the Ocean cluster. Cannot be configured if whitelist is configured.
BlockDeviceMappings []OceanBlockDeviceMappingArgs: Object. Array list of block devices that are exposed to the instance, specify either virtual devices and EBS volumes.
ClusterOrientations []OceanClusterOrientationArgs
ControllerId string: A unique identifier used for connecting the Ocean SaaS platform and the Kubernetes cluster. Typically, the cluster name is used as its identifier.
DesiredCapacity int: The number of instances to launch and maintain in the cluster.
DrainingTimeout int: The time in seconds, the instance is allowed to run while detached from the ELB. This is to allow the instance time to be drained from incoming TCP connections before terminating it, during a scale down operation.
EbsOptimized bool: Enable EBS optimized for cluster. Flag will enable optimized capacity for high bandwidth connectivity to the EB service for non EBS optimized instance types. For instances that are EBS optimized this flag will be ignored.
FallbackToOndemand bool: If not Spot instance markets are available, enable Ocean to launch On-Demand instances instead.
Filters OceanFiltersArgs: List of filters. The Instance types that match with all filters compose the Ocean's whitelist parameter. Cannot be configured together with whitelist/blacklist.
GracePeriod int: The amount of time, in seconds, after the instance has launched to start checking its health.
HealthCheckUnhealthyDurationBeforeReplacement int: The amount of time, in seconds, an existing instance should remain active after becoming unhealthy. After the set time out the instance will be replaced. The minimum value allowed is 60, and it must be a multiple of 60.
IamInstanceProfile string: The instance profile iam role.
ImageId string: ID of the image used to launch the instances.
InstanceMetadataOptions OceanInstanceMetadataOptionsArgs: Ocean instance metadata options object for IMDSv2.
KeyName string: The key pair to attach the instances.
LoadBalancers []OceanLoadBalancerArgs: Array of load balancer objects to add to ocean cluster
Logging OceanLoggingArgs: Logging configuration.
MaxSize int: The upper limit of instances the cluster can scale up to.
MinSize int: The lower limit of instances the cluster can scale down to.
Monitoring bool: Enable detailed monitoring for cluster. Flag will enable Cloud Watch detailed monitoring (one minute increments). Note: there are additional hourly costs for this service based on the region used.
Name string: Required if type is set to CLASSIC
Region string: The region the cluster will run in.
ResourceTagSpecifications []OceanResourceTagSpecificationArgs: Specify which resources should be tagged with Virtual Node Group tags or Ocean tags. If tags are set on the VNG, the resources will be tagged with the VNG tags; otherwise, they will be tagged with the Ocean tags.
RootVolumeSize int: The size (in Gb) to allocate for the root volume. Minimum 20.
ScheduledTasks []OceanScheduledTaskArgs
SecurityGroups []string: One or more security group ids.
SpotPercentage int: The desired percentage of Spot instances out of all running instances. Only available when the field is not set in any VNG directly (launchSpec.strategy.spotPercentage).
SpreadNodesBy string: Ocean will spread the nodes across markets by this value. Possible values: vcpu or count.
SubnetIds []string: A comma-separated list of subnet identifiers for the Ocean cluster. Subnet IDs should be configured with auto assign public IP.
Tags []OceanTagArgs: Optionally adds tags to instances launched in an Ocean cluster.
UpdatePolicy OceanUpdatePolicyArgs
UseAsTemplateOnly bool: launch specification defined on the Ocean object will function only as a template for virtual node groups. When set to true, on Ocean resource creation please make sure your custom VNG has an initial_nodes parameter to create nodes for your VNG.
UserData string: Base64-encoded MIME user data to make available to the instances.
UtilizeCommitments bool: If savings plans exist, Ocean will utilize them before launching Spot instances.
UtilizeReservedInstances bool: If Reserved instances exist, Ocean will utilize them before launching Spot instances.
Whitelists []string: Instance types allowed in the Ocean cluster. Cannot be configured if blacklist is configured.

associateIpv6Address Boolean: Configure IPv6 address allocation.
associatePublicIpAddress Boolean: Configure public IP address allocation.
autoscaler OceanAutoscaler
blacklists List<String>: Instance types not allowed in the Ocean cluster. Cannot be configured if whitelist is configured.
blockDeviceMappings List<OceanBlockDeviceMapping>: Object. Array list of block devices that are exposed to the instance, specify either virtual devices and EBS volumes.
clusterOrientations List<OceanClusterOrientation>
controllerId String: A unique identifier used for connecting the Ocean SaaS platform and the Kubernetes cluster. Typically, the cluster name is used as its identifier.
desiredCapacity Integer: The number of instances to launch and maintain in the cluster.
drainingTimeout Integer: The time in seconds, the instance is allowed to run while detached from the ELB. This is to allow the instance time to be drained from incoming TCP connections before terminating it, during a scale down operation.
ebsOptimized Boolean: Enable EBS optimized for cluster. Flag will enable optimized capacity for high bandwidth connectivity to the EB service for non EBS optimized instance types. For instances that are EBS optimized this flag will be ignored.
fallbackToOndemand Boolean: If not Spot instance markets are available, enable Ocean to launch On-Demand instances instead.
filters OceanFilters: List of filters. The Instance types that match with all filters compose the Ocean's whitelist parameter. Cannot be configured together with whitelist/blacklist.
gracePeriod Integer: The amount of time, in seconds, after the instance has launched to start checking its health.
healthCheckUnhealthyDurationBeforeReplacement Integer: The amount of time, in seconds, an existing instance should remain active after becoming unhealthy. After the set time out the instance will be replaced. The minimum value allowed is 60, and it must be a multiple of 60.
iamInstanceProfile String: The instance profile iam role.
imageId String: ID of the image used to launch the instances.
instanceMetadataOptions OceanInstanceMetadataOptions: Ocean instance metadata options object for IMDSv2.
keyName String: The key pair to attach the instances.
loadBalancers List<OceanLoadBalancer>: Array of load balancer objects to add to ocean cluster
logging OceanLogging: Logging configuration.
maxSize Integer: The upper limit of instances the cluster can scale up to.
minSize Integer: The lower limit of instances the cluster can scale down to.
monitoring Boolean: Enable detailed monitoring for cluster. Flag will enable Cloud Watch detailed monitoring (one minute increments). Note: there are additional hourly costs for this service based on the region used.
name String: Required if type is set to CLASSIC
region String: The region the cluster will run in.
resourceTagSpecifications List<OceanResourceTagSpecification>: Specify which resources should be tagged with Virtual Node Group tags or Ocean tags. If tags are set on the VNG, the resources will be tagged with the VNG tags; otherwise, they will be tagged with the Ocean tags.
rootVolumeSize Integer: The size (in Gb) to allocate for the root volume. Minimum 20.
scheduledTasks List<OceanScheduledTask>
securityGroups List<String>: One or more security group ids.
spotPercentage Integer: The desired percentage of Spot instances out of all running instances. Only available when the field is not set in any VNG directly (launchSpec.strategy.spotPercentage).
spreadNodesBy String: Ocean will spread the nodes across markets by this value. Possible values: vcpu or count.
subnetIds List<String>: A comma-separated list of subnet identifiers for the Ocean cluster. Subnet IDs should be configured with auto assign public IP.
tags List<OceanTag>: Optionally adds tags to instances launched in an Ocean cluster.
updatePolicy OceanUpdatePolicy
useAsTemplateOnly Boolean: launch specification defined on the Ocean object will function only as a template for virtual node groups. When set to true, on Ocean resource creation please make sure your custom VNG has an initial_nodes parameter to create nodes for your VNG.
userData String: Base64-encoded MIME user data to make available to the instances.
utilizeCommitments Boolean: If savings plans exist, Ocean will utilize them before launching Spot instances.
utilizeReservedInstances Boolean: If Reserved instances exist, Ocean will utilize them before launching Spot instances.
whitelists List<String>: Instance types allowed in the Ocean cluster. Cannot be configured if blacklist is configured.

associateIpv6Address boolean: Configure IPv6 address allocation.
associatePublicIpAddress boolean: Configure public IP address allocation.
autoscaler OceanAutoscaler
blacklists string[]: Instance types not allowed in the Ocean cluster. Cannot be configured if whitelist is configured.
blockDeviceMappings OceanBlockDeviceMapping[]: Object. Array list of block devices that are exposed to the instance, specify either virtual devices and EBS volumes.
clusterOrientations OceanClusterOrientation[]
controllerId string: A unique identifier used for connecting the Ocean SaaS platform and the Kubernetes cluster. Typically, the cluster name is used as its identifier.
desiredCapacity number: The number of instances to launch and maintain in the cluster.
drainingTimeout number: The time in seconds, the instance is allowed to run while detached from the ELB. This is to allow the instance time to be drained from incoming TCP connections before terminating it, during a scale down operation.
ebsOptimized boolean: Enable EBS optimized for cluster. Flag will enable optimized capacity for high bandwidth connectivity to the EB service for non EBS optimized instance types. For instances that are EBS optimized this flag will be ignored.
fallbackToOndemand boolean: If not Spot instance markets are available, enable Ocean to launch On-Demand instances instead.
filters OceanFilters: List of filters. The Instance types that match with all filters compose the Ocean's whitelist parameter. Cannot be configured together with whitelist/blacklist.
gracePeriod number: The amount of time, in seconds, after the instance has launched to start checking its health.
healthCheckUnhealthyDurationBeforeReplacement number: The amount of time, in seconds, an existing instance should remain active after becoming unhealthy. After the set time out the instance will be replaced. The minimum value allowed is 60, and it must be a multiple of 60.
iamInstanceProfile string: The instance profile iam role.
imageId string: ID of the image used to launch the instances.
instanceMetadataOptions OceanInstanceMetadataOptions: Ocean instance metadata options object for IMDSv2.
keyName string: The key pair to attach the instances.
loadBalancers OceanLoadBalancer[]: Array of load balancer objects to add to ocean cluster
logging OceanLogging: Logging configuration.
maxSize number: The upper limit of instances the cluster can scale up to.
minSize number: The lower limit of instances the cluster can scale down to.
monitoring boolean: Enable detailed monitoring for cluster. Flag will enable Cloud Watch detailed monitoring (one minute increments). Note: there are additional hourly costs for this service based on the region used.
name string: Required if type is set to CLASSIC
region string: The region the cluster will run in.
resourceTagSpecifications OceanResourceTagSpecification[]: Specify which resources should be tagged with Virtual Node Group tags or Ocean tags. If tags are set on the VNG, the resources will be tagged with the VNG tags; otherwise, they will be tagged with the Ocean tags.
rootVolumeSize number: The size (in Gb) to allocate for the root volume. Minimum 20.
scheduledTasks OceanScheduledTask[]
securityGroups string[]: One or more security group ids.
spotPercentage number: The desired percentage of Spot instances out of all running instances. Only available when the field is not set in any VNG directly (launchSpec.strategy.spotPercentage).
spreadNodesBy string: Ocean will spread the nodes across markets by this value. Possible values: vcpu or count.
subnetIds string[]: A comma-separated list of subnet identifiers for the Ocean cluster. Subnet IDs should be configured with auto assign public IP.
tags OceanTag[]: Optionally adds tags to instances launched in an Ocean cluster.
updatePolicy OceanUpdatePolicy
useAsTemplateOnly boolean: launch specification defined on the Ocean object will function only as a template for virtual node groups. When set to true, on Ocean resource creation please make sure your custom VNG has an initial_nodes parameter to create nodes for your VNG.
userData string: Base64-encoded MIME user data to make available to the instances.
utilizeCommitments boolean: If savings plans exist, Ocean will utilize them before launching Spot instances.
utilizeReservedInstances boolean: If Reserved instances exist, Ocean will utilize them before launching Spot instances.
whitelists string[]: Instance types allowed in the Ocean cluster. Cannot be configured if blacklist is configured.

associate_ipv6_address bool: Configure IPv6 address allocation.
associate_public_ip_address bool: Configure public IP address allocation.
autoscaler OceanAutoscalerArgs
blacklists Sequence[str]: Instance types not allowed in the Ocean cluster. Cannot be configured if whitelist is configured.
block_device_mappings Sequence[OceanBlockDeviceMappingArgs]: Object. Array list of block devices that are exposed to the instance, specify either virtual devices and EBS volumes.
cluster_orientations Sequence[OceanClusterOrientationArgs]
controller_id str: A unique identifier used for connecting the Ocean SaaS platform and the Kubernetes cluster. Typically, the cluster name is used as its identifier.
desired_capacity int: The number of instances to launch and maintain in the cluster.
draining_timeout int: The time in seconds, the instance is allowed to run while detached from the ELB. This is to allow the instance time to be drained from incoming TCP connections before terminating it, during a scale down operation.
ebs_optimized bool: Enable EBS optimized for cluster. Flag will enable optimized capacity for high bandwidth connectivity to the EB service for non EBS optimized instance types. For instances that are EBS optimized this flag will be ignored.
fallback_to_ondemand bool: If not Spot instance markets are available, enable Ocean to launch On-Demand instances instead.
filters OceanFiltersArgs: List of filters. The Instance types that match with all filters compose the Ocean's whitelist parameter. Cannot be configured together with whitelist/blacklist.
grace_period int: The amount of time, in seconds, after the instance has launched to start checking its health.
health_check_unhealthy_duration_before_replacement int: The amount of time, in seconds, an existing instance should remain active after becoming unhealthy. After the set time out the instance will be replaced. The minimum value allowed is 60, and it must be a multiple of 60.
iam_instance_profile str: The instance profile iam role.
image_id str: ID of the image used to launch the instances.
instance_metadata_options OceanInstanceMetadataOptionsArgs: Ocean instance metadata options object for IMDSv2.
key_name str: The key pair to attach the instances.
load_balancers Sequence[OceanLoadBalancerArgs]: Array of load balancer objects to add to ocean cluster
logging OceanLoggingArgs: Logging configuration.
max_size int: The upper limit of instances the cluster can scale up to.
min_size int: The lower limit of instances the cluster can scale down to.
monitoring bool: Enable detailed monitoring for cluster. Flag will enable Cloud Watch detailed monitoring (one minute increments). Note: there are additional hourly costs for this service based on the region used.
name str: Required if type is set to CLASSIC
region str: The region the cluster will run in.
resource_tag_specifications Sequence[OceanResourceTagSpecificationArgs]: Specify which resources should be tagged with Virtual Node Group tags or Ocean tags. If tags are set on the VNG, the resources will be tagged with the VNG tags; otherwise, they will be tagged with the Ocean tags.
root_volume_size int: The size (in Gb) to allocate for the root volume. Minimum 20.
scheduled_tasks Sequence[OceanScheduledTaskArgs]
security_groups Sequence[str]: One or more security group ids.
spot_percentage int: The desired percentage of Spot instances out of all running instances. Only available when the field is not set in any VNG directly (launchSpec.strategy.spotPercentage).
spread_nodes_by str: Ocean will spread the nodes across markets by this value. Possible values: vcpu or count.
subnet_ids Sequence[str]: A comma-separated list of subnet identifiers for the Ocean cluster. Subnet IDs should be configured with auto assign public IP.
tags Sequence[OceanTagArgs]: Optionally adds tags to instances launched in an Ocean cluster.
update_policy OceanUpdatePolicyArgs
use_as_template_only bool: launch specification defined on the Ocean object will function only as a template for virtual node groups. When set to true, on Ocean resource creation please make sure your custom VNG has an initial_nodes parameter to create nodes for your VNG.
user_data str: Base64-encoded MIME user data to make available to the instances.
utilize_commitments bool: If savings plans exist, Ocean will utilize them before launching Spot instances.
utilize_reserved_instances bool: If Reserved instances exist, Ocean will utilize them before launching Spot instances.
whitelists Sequence[str]: Instance types allowed in the Ocean cluster. Cannot be configured if blacklist is configured.

associateIpv6Address Boolean: Configure IPv6 address allocation.
associatePublicIpAddress Boolean: Configure public IP address allocation.
autoscaler Property Map
blacklists List<String>: Instance types not allowed in the Ocean cluster. Cannot be configured if whitelist is configured.
blockDeviceMappings List<Property Map>: Object. Array list of block devices that are exposed to the instance, specify either virtual devices and EBS volumes.
clusterOrientations List<Property Map>
controllerId String: A unique identifier used for connecting the Ocean SaaS platform and the Kubernetes cluster. Typically, the cluster name is used as its identifier.
desiredCapacity Number: The number of instances to launch and maintain in the cluster.
drainingTimeout Number: The time in seconds, the instance is allowed to run while detached from the ELB. This is to allow the instance time to be drained from incoming TCP connections before terminating it, during a scale down operation.
ebsOptimized Boolean: Enable EBS optimized for cluster. Flag will enable optimized capacity for high bandwidth connectivity to the EB service for non EBS optimized instance types. For instances that are EBS optimized this flag will be ignored.
fallbackToOndemand Boolean: If not Spot instance markets are available, enable Ocean to launch On-Demand instances instead.
filters Property Map: List of filters. The Instance types that match with all filters compose the Ocean's whitelist parameter. Cannot be configured together with whitelist/blacklist.
gracePeriod Number: The amount of time, in seconds, after the instance has launched to start checking its health.
healthCheckUnhealthyDurationBeforeReplacement Number: The amount of time, in seconds, an existing instance should remain active after becoming unhealthy. After the set time out the instance will be replaced. The minimum value allowed is 60, and it must be a multiple of 60.
iamInstanceProfile String: The instance profile iam role.
imageId String: ID of the image used to launch the instances.
instanceMetadataOptions Property Map: Ocean instance metadata options object for IMDSv2.
keyName String: The key pair to attach the instances.
loadBalancers List<Property Map>: Array of load balancer objects to add to ocean cluster
logging Property Map: Logging configuration.
maxSize Number: The upper limit of instances the cluster can scale up to.
minSize Number: The lower limit of instances the cluster can scale down to.
monitoring Boolean: Enable detailed monitoring for cluster. Flag will enable Cloud Watch detailed monitoring (one minute increments). Note: there are additional hourly costs for this service based on the region used.
name String: Required if type is set to CLASSIC
region String: The region the cluster will run in.
resourceTagSpecifications List<Property Map>: Specify which resources should be tagged with Virtual Node Group tags or Ocean tags. If tags are set on the VNG, the resources will be tagged with the VNG tags; otherwise, they will be tagged with the Ocean tags.
rootVolumeSize Number: The size (in Gb) to allocate for the root volume. Minimum 20.
scheduledTasks List<Property Map>
securityGroups List<String>: One or more security group ids.
spotPercentage Number: The desired percentage of Spot instances out of all running instances. Only available when the field is not set in any VNG directly (launchSpec.strategy.spotPercentage).
spreadNodesBy String: Ocean will spread the nodes across markets by this value. Possible values: vcpu or count.
subnetIds List<String>: A comma-separated list of subnet identifiers for the Ocean cluster. Subnet IDs should be configured with auto assign public IP.
tags List<Property Map>: Optionally adds tags to instances launched in an Ocean cluster.
updatePolicy Property Map
useAsTemplateOnly Boolean: launch specification defined on the Ocean object will function only as a template for virtual node groups. When set to true, on Ocean resource creation please make sure your custom VNG has an initial_nodes parameter to create nodes for your VNG.
userData String: Base64-encoded MIME user data to make available to the instances.
utilizeCommitments Boolean: If savings plans exist, Ocean will utilize them before launching Spot instances.
utilizeReservedInstances Boolean: If Reserved instances exist, Ocean will utilize them before launching Spot instances.
whitelists List<String>: Instance types allowed in the Ocean cluster. Cannot be configured if blacklist is configured.

Supporting Types

OceanAutoscalerResourceLimits, OceanAutoscalerResourceLimitsArgs

MaxMemoryGib int: Maximum amount of Memory (GiB).
MaxVcpu int: Maximum number of vcpus available.

MaxMemoryGib int: Maximum amount of Memory (GiB).
MaxVcpu int: Maximum number of vcpus available.

maxMemoryGib Integer: Maximum amount of Memory (GiB).
maxVcpu Integer: Maximum number of vcpus available.

maxMemoryGib number: Maximum amount of Memory (GiB).
maxVcpu number: Maximum number of vcpus available.

max_memory_gib int: Maximum amount of Memory (GiB).
max_vcpu int: Maximum number of vcpus available.

maxMemoryGib Number: Maximum amount of Memory (GiB).
maxVcpu Number: Maximum number of vcpus available.

OceanBlockDeviceMapping, OceanBlockDeviceMappingArgs

DeviceName string: String. Set device name. (Example: /dev/xvda).
Ebs Pulumi.SpotInst.Aws.Inputs.OceanBlockDeviceMappingEbs: Object. Set Elastic Block Store properties .

DeviceName string: String. Set device name. (Example: /dev/xvda).
Ebs OceanBlockDeviceMappingEbs: Object. Set Elastic Block Store properties .

deviceName String: String. Set device name. (Example: /dev/xvda).
ebs OceanBlockDeviceMappingEbs: Object. Set Elastic Block Store properties .

deviceName string: String. Set device name. (Example: /dev/xvda).
ebs OceanBlockDeviceMappingEbs: Object. Set Elastic Block Store properties .

device_name str: String. Set device name. (Example: /dev/xvda).
ebs OceanBlockDeviceMappingEbs: Object. Set Elastic Block Store properties .

deviceName String: String. Set device name. (Example: /dev/xvda).
ebs Property Map: Object. Set Elastic Block Store properties .

OceanBlockDeviceMappingEbs, OceanBlockDeviceMappingEbsArgs

DeleteOnTermination bool: Boolean. Flag to delete the EBS on instance termination.
DynamicIops Pulumi.SpotInst.Aws.Inputs.OceanBlockDeviceMappingEbsDynamicIops: Set dynamic IOPS properties. When using this object, you cannot use the iops attribute. You must use one or the other.
DynamicVolumeSize Pulumi.SpotInst.Aws.Inputs.OceanBlockDeviceMappingEbsDynamicVolumeSize: Object. Set dynamic volume size properties. When using this object, you cannot use volumeSize. You must use one or the other.
Encrypted bool: Boolean. Enables EBS encryption on the volume.
Iops int: Must be greater than or equal to 0.
KmsKeyId string: String. Identifier (key ID, key alias, ID ARN, or alias ARN) for a customer managed CMK under which the EBS volume is encrypted.
SnapshotId string: (Optional) String. The Snapshot ID to mount by.
Throughput int: The amount of data transferred to or from a storage device per second, you can use this param just in a case that volume_type = gp3.
VolumeSize int: Int. The size, in GB of the volume.
VolumeType string: String. The type of the volume. (Example: gp2).

DeleteOnTermination bool: Boolean. Flag to delete the EBS on instance termination.
DynamicIops OceanBlockDeviceMappingEbsDynamicIops: Set dynamic IOPS properties. When using this object, you cannot use the iops attribute. You must use one or the other.
DynamicVolumeSize OceanBlockDeviceMappingEbsDynamicVolumeSize: Object. Set dynamic volume size properties. When using this object, you cannot use volumeSize. You must use one or the other.
Encrypted bool: Boolean. Enables EBS encryption on the volume.
Iops int: Must be greater than or equal to 0.
KmsKeyId string: String. Identifier (key ID, key alias, ID ARN, or alias ARN) for a customer managed CMK under which the EBS volume is encrypted.
SnapshotId string: (Optional) String. The Snapshot ID to mount by.
Throughput int: The amount of data transferred to or from a storage device per second, you can use this param just in a case that volume_type = gp3.
VolumeSize int: Int. The size, in GB of the volume.
VolumeType string: String. The type of the volume. (Example: gp2).

deleteOnTermination Boolean: Boolean. Flag to delete the EBS on instance termination.
dynamicIops OceanBlockDeviceMappingEbsDynamicIops: Set dynamic IOPS properties. When using this object, you cannot use the iops attribute. You must use one or the other.
dynamicVolumeSize OceanBlockDeviceMappingEbsDynamicVolumeSize: Object. Set dynamic volume size properties. When using this object, you cannot use volumeSize. You must use one or the other.
encrypted Boolean: Boolean. Enables EBS encryption on the volume.
iops Integer: Must be greater than or equal to 0.
kmsKeyId String: String. Identifier (key ID, key alias, ID ARN, or alias ARN) for a customer managed CMK under which the EBS volume is encrypted.
snapshotId String: (Optional) String. The Snapshot ID to mount by.
throughput Integer: The amount of data transferred to or from a storage device per second, you can use this param just in a case that volume_type = gp3.
volumeSize Integer: Int. The size, in GB of the volume.
volumeType String: String. The type of the volume. (Example: gp2).

deleteOnTermination boolean: Boolean. Flag to delete the EBS on instance termination.
dynamicIops OceanBlockDeviceMappingEbsDynamicIops: Set dynamic IOPS properties. When using this object, you cannot use the iops attribute. You must use one or the other.
dynamicVolumeSize OceanBlockDeviceMappingEbsDynamicVolumeSize: Object. Set dynamic volume size properties. When using this object, you cannot use volumeSize. You must use one or the other.
encrypted boolean: Boolean. Enables EBS encryption on the volume.
iops number: Must be greater than or equal to 0.
kmsKeyId string: String. Identifier (key ID, key alias, ID ARN, or alias ARN) for a customer managed CMK under which the EBS volume is encrypted.
snapshotId string: (Optional) String. The Snapshot ID to mount by.
throughput number: The amount of data transferred to or from a storage device per second, you can use this param just in a case that volume_type = gp3.
volumeSize number: Int. The size, in GB of the volume.
volumeType string: String. The type of the volume. (Example: gp2).

delete_on_termination bool: Boolean. Flag to delete the EBS on instance termination.
dynamic_iops OceanBlockDeviceMappingEbsDynamicIops: Set dynamic IOPS properties. When using this object, you cannot use the iops attribute. You must use one or the other.
dynamic_volume_size OceanBlockDeviceMappingEbsDynamicVolumeSize: Object. Set dynamic volume size properties. When using this object, you cannot use volumeSize. You must use one or the other.
encrypted bool: Boolean. Enables EBS encryption on the volume.
iops int: Must be greater than or equal to 0.
kms_key_id str: String. Identifier (key ID, key alias, ID ARN, or alias ARN) for a customer managed CMK under which the EBS volume is encrypted.
snapshot_id str: (Optional) String. The Snapshot ID to mount by.
throughput int: The amount of data transferred to or from a storage device per second, you can use this param just in a case that volume_type = gp3.
volume_size int: Int. The size, in GB of the volume.
volume_type str: String. The type of the volume. (Example: gp2).

deleteOnTermination Boolean: Boolean. Flag to delete the EBS on instance termination.
dynamicIops Property Map: Set dynamic IOPS properties. When using this object, you cannot use the iops attribute. You must use one or the other.
dynamicVolumeSize Property Map: Object. Set dynamic volume size properties. When using this object, you cannot use volumeSize. You must use one or the other.
encrypted Boolean: Boolean. Enables EBS encryption on the volume.
iops Number: Must be greater than or equal to 0.
kmsKeyId String: String. Identifier (key ID, key alias, ID ARN, or alias ARN) for a customer managed CMK under which the EBS volume is encrypted.
snapshotId String: (Optional) String. The Snapshot ID to mount by.
throughput Number: The amount of data transferred to or from a storage device per second, you can use this param just in a case that volume_type = gp3.
volumeSize Number: Int. The size, in GB of the volume.
volumeType String: String. The type of the volume. (Example: gp2).

OceanBlockDeviceMappingEbsDynamicIops, OceanBlockDeviceMappingEbsDynamicIopsArgs

BaseSize int: Initial size for IOPS.
Resource string
SizePerResourceUnit int: Additional size per resource unit (in IOPS). (Example: baseSize=50, sizePerResourceUnit=20, and an instance with 2 CPU is launched; its IOPS size will be: 90).

BaseSize int: Initial size for IOPS.
Resource string
SizePerResourceUnit int: Additional size per resource unit (in IOPS). (Example: baseSize=50, sizePerResourceUnit=20, and an instance with 2 CPU is launched; its IOPS size will be: 90).

baseSize Integer: Initial size for IOPS.
resource String
sizePerResourceUnit Integer: Additional size per resource unit (in IOPS). (Example: baseSize=50, sizePerResourceUnit=20, and an instance with 2 CPU is launched; its IOPS size will be: 90).

baseSize number: Initial size for IOPS.
resource string
sizePerResourceUnit number: Additional size per resource unit (in IOPS). (Example: baseSize=50, sizePerResourceUnit=20, and an instance with 2 CPU is launched; its IOPS size will be: 90).

base_size int: Initial size for IOPS.
resource str
size_per_resource_unit int: Additional size per resource unit (in IOPS). (Example: baseSize=50, sizePerResourceUnit=20, and an instance with 2 CPU is launched; its IOPS size will be: 90).

baseSize Number: Initial size for IOPS.
resource String
sizePerResourceUnit Number: Additional size per resource unit (in IOPS). (Example: baseSize=50, sizePerResourceUnit=20, and an instance with 2 CPU is launched; its IOPS size will be: 90).

OceanBlockDeviceMappingEbsDynamicVolumeSize, OceanBlockDeviceMappingEbsDynamicVolumeSizeArgs

BaseSize int: Initial size for IOPS.
Resource string
SizePerResourceUnit int: Additional size per resource unit (in IOPS). (Example: baseSize=50, sizePerResourceUnit=20, and an instance with 2 CPU is launched; its IOPS size will be: 90).

BaseSize int: Initial size for IOPS.
Resource string
SizePerResourceUnit int: Additional size per resource unit (in IOPS). (Example: baseSize=50, sizePerResourceUnit=20, and an instance with 2 CPU is launched; its IOPS size will be: 90).

baseSize Integer: Initial size for IOPS.
resource String
sizePerResourceUnit Integer: Additional size per resource unit (in IOPS). (Example: baseSize=50, sizePerResourceUnit=20, and an instance with 2 CPU is launched; its IOPS size will be: 90).

baseSize number: Initial size for IOPS.
resource string
sizePerResourceUnit number: Additional size per resource unit (in IOPS). (Example: baseSize=50, sizePerResourceUnit=20, and an instance with 2 CPU is launched; its IOPS size will be: 90).

base_size int: Initial size for IOPS.
resource str
size_per_resource_unit int: Additional size per resource unit (in IOPS). (Example: baseSize=50, sizePerResourceUnit=20, and an instance with 2 CPU is launched; its IOPS size will be: 90).

baseSize Number: Initial size for IOPS.
resource String
sizePerResourceUnit Number: Additional size per resource unit (in IOPS). (Example: baseSize=50, sizePerResourceUnit=20, and an instance with 2 CPU is launched; its IOPS size will be: 90).

OceanClusterOrientation, OceanClusterOrientationArgs

AvailabilityVsCost string: You can control the approach that Ocean takes while launching nodes by configuring this value. Possible values: costOriented,balanced,cheapest.

AvailabilityVsCost string: You can control the approach that Ocean takes while launching nodes by configuring this value. Possible values: costOriented,balanced,cheapest.

availabilityVsCost String: You can control the approach that Ocean takes while launching nodes by configuring this value. Possible values: costOriented,balanced,cheapest.

availabilityVsCost string: You can control the approach that Ocean takes while launching nodes by configuring this value. Possible values: costOriented,balanced,cheapest.

availability_vs_cost str: You can control the approach that Ocean takes while launching nodes by configuring this value. Possible values: costOriented,balanced,cheapest.

availabilityVsCost String: You can control the approach that Ocean takes while launching nodes by configuring this value. Possible values: costOriented,balanced,cheapest.

OceanFilters, OceanFiltersArgs

Architectures List<string>: The filtered instance types will support at least one of the architectures from this list.
Categories List<string>: The filtered instance types will belong to one of the categories types from this list.
DiskTypes List<string>: The filtered instance types will have one of the disk type from this list.
ExcludeFamilies List<string>: Types belonging to a family from the ExcludeFamilies will not be available for scaling (asterisk wildcard is also supported). For example, C* will exclude instance types from these families: c5, c4, c4a, etc.
ExcludeMetal bool: In case excludeMetal is set to true, metal types will not be available for scaling.
Hypervisors List<string>: The filtered instance types will have a hypervisor type from this list.
IncludeFamilies List<string>: Types belonging to a family from the IncludeFamilies will be available for scaling (asterisk wildcard is also supported). For example, C* will include instance types from these families: c5, c4, c4a, etc.
IsEnaSupported string: Ena is supported or not.
MaxGpu int: Maximum total number of GPUs.
MaxMemoryGib double: Maximum amount of Memory (GiB).
MaxNetworkPerformance int: Maximum Bandwidth in Gib/s of network performance.
MaxVcpu int: Maximum number of vcpus available.
MinEnis int: Minimum number of network interfaces (ENIs).
MinGpu int: Minimum total number of GPUs.
MinMemoryGib double: Minimum amount of Memory (GiB).
MinNetworkPerformance int: Minimum Bandwidth in Gib/s of network performance.
MinVcpu int: Minimum number of vcpus available.
RootDeviceTypes List<string>: The filtered instance types will have a root device types from this list.
VirtualizationTypes List<string>: The filtered instance types will support at least one of the virtualization types from this list.

Architectures []string: The filtered instance types will support at least one of the architectures from this list.
Categories []string: The filtered instance types will belong to one of the categories types from this list.
DiskTypes []string: The filtered instance types will have one of the disk type from this list.
ExcludeFamilies []string: Types belonging to a family from the ExcludeFamilies will not be available for scaling (asterisk wildcard is also supported). For example, C* will exclude instance types from these families: c5, c4, c4a, etc.
ExcludeMetal bool: In case excludeMetal is set to true, metal types will not be available for scaling.
Hypervisors []string: The filtered instance types will have a hypervisor type from this list.
IncludeFamilies []string: Types belonging to a family from the IncludeFamilies will be available for scaling (asterisk wildcard is also supported). For example, C* will include instance types from these families: c5, c4, c4a, etc.
IsEnaSupported string: Ena is supported or not.
MaxGpu int: Maximum total number of GPUs.
MaxMemoryGib float64: Maximum amount of Memory (GiB).
MaxNetworkPerformance int: Maximum Bandwidth in Gib/s of network performance.
MaxVcpu int: Maximum number of vcpus available.
MinEnis int: Minimum number of network interfaces (ENIs).
MinGpu int: Minimum total number of GPUs.
MinMemoryGib float64: Minimum amount of Memory (GiB).
MinNetworkPerformance int: Minimum Bandwidth in Gib/s of network performance.
MinVcpu int: Minimum number of vcpus available.
RootDeviceTypes []string: The filtered instance types will have a root device types from this list.
VirtualizationTypes []string: The filtered instance types will support at least one of the virtualization types from this list.

architectures List<String>: The filtered instance types will support at least one of the architectures from this list.
categories List<String>: The filtered instance types will belong to one of the categories types from this list.
diskTypes List<String>: The filtered instance types will have one of the disk type from this list.
excludeFamilies List<String>: Types belonging to a family from the ExcludeFamilies will not be available for scaling (asterisk wildcard is also supported). For example, C* will exclude instance types from these families: c5, c4, c4a, etc.
excludeMetal Boolean: In case excludeMetal is set to true, metal types will not be available for scaling.
hypervisors List<String>: The filtered instance types will have a hypervisor type from this list.
includeFamilies List<String>: Types belonging to a family from the IncludeFamilies will be available for scaling (asterisk wildcard is also supported). For example, C* will include instance types from these families: c5, c4, c4a, etc.
isEnaSupported String: Ena is supported or not.
maxGpu Integer: Maximum total number of GPUs.
maxMemoryGib Double: Maximum amount of Memory (GiB).
maxNetworkPerformance Integer: Maximum Bandwidth in Gib/s of network performance.
maxVcpu Integer: Maximum number of vcpus available.
minEnis Integer: Minimum number of network interfaces (ENIs).
minGpu Integer: Minimum total number of GPUs.
minMemoryGib Double: Minimum amount of Memory (GiB).
minNetworkPerformance Integer: Minimum Bandwidth in Gib/s of network performance.
minVcpu Integer: Minimum number of vcpus available.
rootDeviceTypes List<String>: The filtered instance types will have a root device types from this list.
virtualizationTypes List<String>: The filtered instance types will support at least one of the virtualization types from this list.

architectures string[]: The filtered instance types will support at least one of the architectures from this list.
categories string[]: The filtered instance types will belong to one of the categories types from this list.
diskTypes string[]: The filtered instance types will have one of the disk type from this list.
excludeFamilies string[]: Types belonging to a family from the ExcludeFamilies will not be available for scaling (asterisk wildcard is also supported). For example, C* will exclude instance types from these families: c5, c4, c4a, etc.
excludeMetal boolean: In case excludeMetal is set to true, metal types will not be available for scaling.
hypervisors string[]: The filtered instance types will have a hypervisor type from this list.
includeFamilies string[]: Types belonging to a family from the IncludeFamilies will be available for scaling (asterisk wildcard is also supported). For example, C* will include instance types from these families: c5, c4, c4a, etc.
isEnaSupported string: Ena is supported or not.
maxGpu number: Maximum total number of GPUs.
maxMemoryGib number: Maximum amount of Memory (GiB).
maxNetworkPerformance number: Maximum Bandwidth in Gib/s of network performance.
maxVcpu number: Maximum number of vcpus available.
minEnis number: Minimum number of network interfaces (ENIs).
minGpu number: Minimum total number of GPUs.
minMemoryGib number: Minimum amount of Memory (GiB).
minNetworkPerformance number: Minimum Bandwidth in Gib/s of network performance.
minVcpu number: Minimum number of vcpus available.
rootDeviceTypes string[]: The filtered instance types will have a root device types from this list.
virtualizationTypes string[]: The filtered instance types will support at least one of the virtualization types from this list.

architectures Sequence[str]: The filtered instance types will support at least one of the architectures from this list.
categories Sequence[str]: The filtered instance types will belong to one of the categories types from this list.
disk_types Sequence[str]: The filtered instance types will have one of the disk type from this list.
exclude_families Sequence[str]: Types belonging to a family from the ExcludeFamilies will not be available for scaling (asterisk wildcard is also supported). For example, C* will exclude instance types from these families: c5, c4, c4a, etc.
exclude_metal bool: In case excludeMetal is set to true, metal types will not be available for scaling.
hypervisors Sequence[str]: The filtered instance types will have a hypervisor type from this list.
include_families Sequence[str]: Types belonging to a family from the IncludeFamilies will be available for scaling (asterisk wildcard is also supported). For example, C* will include instance types from these families: c5, c4, c4a, etc.
is_ena_supported str: Ena is supported or not.
max_gpu int: Maximum total number of GPUs.
max_memory_gib float: Maximum amount of Memory (GiB).
max_network_performance int: Maximum Bandwidth in Gib/s of network performance.
max_vcpu int: Maximum number of vcpus available.
min_enis int: Minimum number of network interfaces (ENIs).
min_gpu int: Minimum total number of GPUs.
min_memory_gib float: Minimum amount of Memory (GiB).
min_network_performance int: Minimum Bandwidth in Gib/s of network performance.
min_vcpu int: Minimum number of vcpus available.
root_device_types Sequence[str]: The filtered instance types will have a root device types from this list.
virtualization_types Sequence[str]: The filtered instance types will support at least one of the virtualization types from this list.

architectures List<String>: The filtered instance types will support at least one of the architectures from this list.
categories List<String>: The filtered instance types will belong to one of the categories types from this list.
diskTypes List<String>: The filtered instance types will have one of the disk type from this list.
excludeFamilies List<String>: Types belonging to a family from the ExcludeFamilies will not be available for scaling (asterisk wildcard is also supported). For example, C* will exclude instance types from these families: c5, c4, c4a, etc.
excludeMetal Boolean: In case excludeMetal is set to true, metal types will not be available for scaling.
hypervisors List<String>: The filtered instance types will have a hypervisor type from this list.
includeFamilies List<String>: Types belonging to a family from the IncludeFamilies will be available for scaling (asterisk wildcard is also supported). For example, C* will include instance types from these families: c5, c4, c4a, etc.
isEnaSupported String: Ena is supported or not.
maxGpu Number: Maximum total number of GPUs.
maxMemoryGib Number: Maximum amount of Memory (GiB).
maxNetworkPerformance Number: Maximum Bandwidth in Gib/s of network performance.
maxVcpu Number: Maximum number of vcpus available.
minEnis Number: Minimum number of network interfaces (ENIs).
minGpu Number: Minimum total number of GPUs.
minMemoryGib Number: Minimum amount of Memory (GiB).
minNetworkPerformance Number: Minimum Bandwidth in Gib/s of network performance.
minVcpu Number: Minimum number of vcpus available.
rootDeviceTypes List<String>: The filtered instance types will have a root device types from this list.
virtualizationTypes List<String>: The filtered instance types will support at least one of the virtualization types from this list.

OceanInstanceMetadataOptions, OceanInstanceMetadataOptionsArgs

HttpTokens string: Determines if a signed token is required or not. Valid values: optional or required.
HttpPutResponseHopLimit int: An integer from 1 through 64. The desired HTTP PUT response hop limit for instance metadata requests. The larger the number, the further the instance metadata requests can travel.

HttpTokens string: Determines if a signed token is required or not. Valid values: optional or required.
HttpPutResponseHopLimit int: An integer from 1 through 64. The desired HTTP PUT response hop limit for instance metadata requests. The larger the number, the further the instance metadata requests can travel.

httpTokens String: Determines if a signed token is required or not. Valid values: optional or required.
httpPutResponseHopLimit Integer: An integer from 1 through 64. The desired HTTP PUT response hop limit for instance metadata requests. The larger the number, the further the instance metadata requests can travel.

httpTokens string: Determines if a signed token is required or not. Valid values: optional or required.
httpPutResponseHopLimit number: An integer from 1 through 64. The desired HTTP PUT response hop limit for instance metadata requests. The larger the number, the further the instance metadata requests can travel.

http_tokens str: Determines if a signed token is required or not. Valid values: optional or required.
http_put_response_hop_limit int: An integer from 1 through 64. The desired HTTP PUT response hop limit for instance metadata requests. The larger the number, the further the instance metadata requests can travel.

httpTokens String: Determines if a signed token is required or not. Valid values: optional or required.
httpPutResponseHopLimit Number: An integer from 1 through 64. The desired HTTP PUT response hop limit for instance metadata requests. The larger the number, the further the instance metadata requests can travel.

OceanLoadBalancer, OceanLoadBalancerArgs

Arn string: Required if type is set to TARGET_GROUP
Name string: Required if type is set to CLASSIC
Type string: Can be set to CLASSIC or TARGET_GROUP

Arn string: Required if type is set to TARGET_GROUP
Name string: Required if type is set to CLASSIC
Type string: Can be set to CLASSIC or TARGET_GROUP

arn String: Required if type is set to TARGET_GROUP
name String: Required if type is set to CLASSIC
type String: Can be set to CLASSIC or TARGET_GROUP

arn string: Required if type is set to TARGET_GROUP
name string: Required if type is set to CLASSIC
type string: Can be set to CLASSIC or TARGET_GROUP

arn str: Required if type is set to TARGET_GROUP
name str: Required if type is set to CLASSIC
type str: Can be set to CLASSIC or TARGET_GROUP

arn String: Required if type is set to TARGET_GROUP
name String: Required if type is set to CLASSIC
type String: Can be set to CLASSIC or TARGET_GROUP

OceanLogging, OceanLoggingArgs

Export Pulumi.SpotInst.Aws.Inputs.OceanLoggingExport: Logging Export configuration.

Export OceanLoggingExport: Logging Export configuration.

export OceanLoggingExport: Logging Export configuration.

export OceanLoggingExport: Logging Export configuration.

export OceanLoggingExport: Logging Export configuration.

export Property Map: Logging Export configuration.

OceanLoggingExport, OceanLoggingExportArgs

S3s List<Pulumi.SpotInst.Aws.Inputs.OceanLoggingExportS3>: Exports your cluster's logs to the S3 bucket and subdir configured on the S3 data integration given.

S3s []OceanLoggingExportS3: Exports your cluster's logs to the S3 bucket and subdir configured on the S3 data integration given.

s3s List<OceanLoggingExportS3>: Exports your cluster's logs to the S3 bucket and subdir configured on the S3 data integration given.

s3s OceanLoggingExportS3[]: Exports your cluster's logs to the S3 bucket and subdir configured on the S3 data integration given.

s3s Sequence[OceanLoggingExportS3]: Exports your cluster's logs to the S3 bucket and subdir configured on the S3 data integration given.

s3s List<Property Map>: Exports your cluster's logs to the S3 bucket and subdir configured on the S3 data integration given.

OceanLoggingExportS3, OceanLoggingExportS3Args

Id string: The identifier of The S3 data integration to export the logs to.

Id string: The identifier of The S3 data integration to export the logs to.

id String: The identifier of The S3 data integration to export the logs to.

id string: The identifier of The S3 data integration to export the logs to.

id str: The identifier of The S3 data integration to export the logs to.

id String: The identifier of The S3 data integration to export the logs to.

OceanResourceTagSpecification, OceanResourceTagSpecificationArgs

ShouldTagVolumes bool: Specify if Volume resources will be tagged with Virtual Node Group tags or Ocean tags.

ShouldTagVolumes bool: Specify if Volume resources will be tagged with Virtual Node Group tags or Ocean tags.

shouldTagVolumes Boolean: Specify if Volume resources will be tagged with Virtual Node Group tags or Ocean tags.

shouldTagVolumes boolean: Specify if Volume resources will be tagged with Virtual Node Group tags or Ocean tags.

should_tag_volumes bool: Specify if Volume resources will be tagged with Virtual Node Group tags or Ocean tags.

shouldTagVolumes Boolean: Specify if Volume resources will be tagged with Virtual Node Group tags or Ocean tags.

OceanScheduledTask, OceanScheduledTaskArgs

ShutdownHours Pulumi.SpotInst.Aws.Inputs.OceanScheduledTaskShutdownHours
Tasks List<Pulumi.SpotInst.Aws.Inputs.OceanScheduledTaskTask>

ShutdownHours OceanScheduledTaskShutdownHours
Tasks []OceanScheduledTaskTask

shutdownHours OceanScheduledTaskShutdownHours
tasks List<OceanScheduledTaskTask>

shutdownHours OceanScheduledTaskShutdownHours
tasks OceanScheduledTaskTask[]

shutdown_hours OceanScheduledTaskShutdownHours
tasks Sequence[OceanScheduledTaskTask]

shutdownHours Property Map
tasks List<Property Map>

OceanScheduledTaskShutdownHours, OceanScheduledTaskShutdownHoursArgs

TimeWindows List<string>
IsEnabled bool

TimeWindows []string
IsEnabled bool

timeWindows List<String>
isEnabled Boolean

timeWindows string[]
isEnabled boolean

time_windows Sequence[str]
is_enabled bool

timeWindows List<String>
isEnabled Boolean

OceanScheduledTaskTask, OceanScheduledTaskTaskArgs

CronExpression string
IsEnabled bool
TaskType string
Parameters Pulumi.SpotInst.Aws.Inputs.OceanScheduledTaskTaskParameters

CronExpression string
IsEnabled bool
TaskType string
Parameters OceanScheduledTaskTaskParameters

cronExpression String
isEnabled Boolean
taskType String
parameters OceanScheduledTaskTaskParameters

cronExpression string
isEnabled boolean
taskType string
parameters OceanScheduledTaskTaskParameters

cron_expression str
is_enabled bool
task_type str
parameters OceanScheduledTaskTaskParameters

cronExpression String
isEnabled Boolean
taskType String
parameters Property Map

OceanScheduledTaskTaskParameters, OceanScheduledTaskTaskParametersArgs

AmiAutoUpdate Pulumi.SpotInst.Aws.Inputs.OceanScheduledTaskTaskParametersAmiAutoUpdate
ParametersClusterRoll Pulumi.SpotInst.Aws.Inputs.OceanScheduledTaskTaskParametersParametersClusterRoll

AmiAutoUpdate OceanScheduledTaskTaskParametersAmiAutoUpdate
ParametersClusterRoll OceanScheduledTaskTaskParametersParametersClusterRoll

amiAutoUpdate OceanScheduledTaskTaskParametersAmiAutoUpdate
parametersClusterRoll OceanScheduledTaskTaskParametersParametersClusterRoll

amiAutoUpdate OceanScheduledTaskTaskParametersAmiAutoUpdate
parametersClusterRoll OceanScheduledTaskTaskParametersParametersClusterRoll

ami_auto_update OceanScheduledTaskTaskParametersAmiAutoUpdate
parameters_cluster_roll OceanScheduledTaskTaskParametersParametersClusterRoll

amiAutoUpdate Property Map
parametersClusterRoll Property Map

OceanScheduledTaskTaskParametersAmiAutoUpdate, OceanScheduledTaskTaskParametersAmiAutoUpdateArgs

AmiAutoUpdateClusterRoll Pulumi.SpotInst.Aws.Inputs.OceanScheduledTaskTaskParametersAmiAutoUpdateAmiAutoUpdateClusterRoll
ApplyRoll bool
MinorVersion bool
Patch bool

AmiAutoUpdateClusterRoll OceanScheduledTaskTaskParametersAmiAutoUpdateAmiAutoUpdateClusterRoll
ApplyRoll bool
MinorVersion bool
Patch bool

amiAutoUpdateClusterRoll OceanScheduledTaskTaskParametersAmiAutoUpdateAmiAutoUpdateClusterRoll
applyRoll Boolean
minorVersion Boolean
patch Boolean

amiAutoUpdateClusterRoll OceanScheduledTaskTaskParametersAmiAutoUpdateAmiAutoUpdateClusterRoll
applyRoll boolean
minorVersion boolean
patch boolean

ami_auto_update_cluster_roll OceanScheduledTaskTaskParametersAmiAutoUpdateAmiAutoUpdateClusterRoll
apply_roll bool
minor_version bool
patch bool

amiAutoUpdateClusterRoll Property Map
applyRoll Boolean
minorVersion Boolean
patch Boolean

OceanScheduledTaskTaskParametersAmiAutoUpdateAmiAutoUpdateClusterRoll, OceanScheduledTaskTaskParametersAmiAutoUpdateAmiAutoUpdateClusterRollArgs

BatchMinHealthyPercentage int
BatchSizePercentage int
Comment string
RespectPdb bool

BatchMinHealthyPercentage int
BatchSizePercentage int
Comment string
RespectPdb bool

batchMinHealthyPercentage Integer
batchSizePercentage Integer
comment String
respectPdb Boolean

batchMinHealthyPercentage number
batchSizePercentage number
comment string
respectPdb boolean

batch_min_healthy_percentage int
batch_size_percentage int
comment str
respect_pdb bool

batchMinHealthyPercentage Number
batchSizePercentage Number
comment String
respectPdb Boolean

OceanScheduledTaskTaskParametersParametersClusterRoll, OceanScheduledTaskTaskParametersParametersClusterRollArgs

BatchMinHealthyPercentage int
BatchSizePercentage int
Comment string
RespectPdb bool

BatchMinHealthyPercentage int
BatchSizePercentage int
Comment string
RespectPdb bool

batchMinHealthyPercentage Integer
batchSizePercentage Integer
comment String
respectPdb Boolean

batchMinHealthyPercentage number
batchSizePercentage number
comment string
respectPdb boolean

batch_min_healthy_percentage int
batch_size_percentage int
comment str
respect_pdb bool

batchMinHealthyPercentage Number
batchSizePercentage Number
comment String
respectPdb Boolean

OceanTag, OceanTagArgs

Key string: The tag key.
Value string: The tag value.

Key string: The tag key.
Value string: The tag value.

key String: The tag key.
value String: The tag value.

key string: The tag key.
value string: The tag value.

key str: The tag key.
value str: The tag value.

key String: The tag key.
value String: The tag value.

OceanUpdatePolicy, OceanUpdatePolicyArgs

ShouldRoll bool
AutoApplyTags bool
ConditionedRoll bool
ConditionedRollParams List<string>
RollConfig Pulumi.SpotInst.Aws.Inputs.OceanUpdatePolicyRollConfig

ShouldRoll bool
AutoApplyTags bool
ConditionedRoll bool
ConditionedRollParams []string
RollConfig OceanUpdatePolicyRollConfig

shouldRoll Boolean
autoApplyTags Boolean
conditionedRoll Boolean
conditionedRollParams List<String>
rollConfig OceanUpdatePolicyRollConfig

shouldRoll boolean
autoApplyTags boolean
conditionedRoll boolean
conditionedRollParams string[]
rollConfig OceanUpdatePolicyRollConfig

should_roll bool
auto_apply_tags bool
conditioned_roll bool
conditioned_roll_params Sequence[str]
roll_config OceanUpdatePolicyRollConfig

shouldRoll Boolean
autoApplyTags Boolean
conditionedRoll Boolean
conditionedRollParams List<String>
rollConfig Property Map

OceanUpdatePolicyRollConfig, OceanUpdatePolicyRollConfigArgs

BatchSizePercentage int
BatchMinHealthyPercentage int
LaunchSpecIds List<string>
RespectPdb bool

BatchSizePercentage int
BatchMinHealthyPercentage int
LaunchSpecIds []string
RespectPdb bool

batchSizePercentage Integer
batchMinHealthyPercentage Integer
launchSpecIds List<String>
respectPdb Boolean

batchSizePercentage number
batchMinHealthyPercentage number
launchSpecIds string[]
respectPdb boolean

batch_size_percentage int
batch_min_healthy_percentage int
launch_spec_ids Sequence[str]
respect_pdb bool

batchSizePercentage Number
batchMinHealthyPercentage Number
launchSpecIds List<String>
respectPdb Boolean

Import

Clusters can be imported using the Ocean id, e.g.,

hcl

$ pulumi import spotinst:aws/ocean:Ocean this o-12345678

To learn more about importing existing cloud resources, see Importing resources.

Package Details

Repository: Spotinst pulumi/pulumi-spotinst
License: Apache-2.0
Notes: This Pulumi package is based on the spotinst Terraform Provider.

Spotinst v3.74.1 published on Thursday, Apr 11, 2024 by Pulumi

pulumi/pulumi-spotinst

spotinst.aws.Ocean

On this page

On this page

Example Usage

Auto Scaler

Update Policy

Scheduled Task

Create Ocean Resource

Constructor syntax

Parameters

Example

Ocean Resource Properties

Inputs

Outputs

Look up Existing Ocean Resource

Supporting Types

OceanAutoscaler, OceanAutoscalerArgs

OceanAutoscalerAutoscaleDown, OceanAutoscalerAutoscaleDownArgs

OceanAutoscalerAutoscaleHeadroom, OceanAutoscalerAutoscaleHeadroomArgs

OceanAutoscalerResourceLimits, OceanAutoscalerResourceLimitsArgs

OceanBlockDeviceMapping, OceanBlockDeviceMappingArgs

OceanBlockDeviceMappingEbs, OceanBlockDeviceMappingEbsArgs

OceanBlockDeviceMappingEbsDynamicIops, OceanBlockDeviceMappingEbsDynamicIopsArgs

OceanBlockDeviceMappingEbsDynamicVolumeSize, OceanBlockDeviceMappingEbsDynamicVolumeSizeArgs

OceanClusterOrientation, OceanClusterOrientationArgs

OceanFilters, OceanFiltersArgs

OceanInstanceMetadataOptions, OceanInstanceMetadataOptionsArgs

OceanLoadBalancer, OceanLoadBalancerArgs

OceanLogging, OceanLoggingArgs

OceanLoggingExport, OceanLoggingExportArgs

OceanLoggingExportS3, OceanLoggingExportS3Args

OceanResourceTagSpecification, OceanResourceTagSpecificationArgs

OceanScheduledTask, OceanScheduledTaskArgs

OceanScheduledTaskShutdownHours, OceanScheduledTaskShutdownHoursArgs

OceanScheduledTaskTask, OceanScheduledTaskTaskArgs

OceanScheduledTaskTaskParameters, OceanScheduledTaskTaskParametersArgs

OceanScheduledTaskTaskParametersAmiAutoUpdate, OceanScheduledTaskTaskParametersAmiAutoUpdateArgs

OceanScheduledTaskTaskParametersAmiAutoUpdateAmiAutoUpdateClusterRoll, OceanScheduledTaskTaskParametersAmiAutoUpdateAmiAutoUpdateClusterRollArgs

OceanScheduledTaskTaskParametersParametersClusterRoll, OceanScheduledTaskTaskParametersParametersClusterRollArgs

OceanTag, OceanTagArgs

OceanUpdatePolicy, OceanUpdatePolicyArgs

OceanUpdatePolicyRollConfig, OceanUpdatePolicyRollConfigArgs

Import

Package Details

On this page

On this page