spotinst.ecs.Ocean
Explore with Pulumi AI
Manages a Spotinst Ocean ECS resource.
Example Usage
Coming soon!
Coming soon!
Coming soon!
Coming soon!
Coming soon!
resources:
  example:
    type: spotinst:ecs:Ocean
    properties:
      region: us-west-2
      name: sample-ecs-cluster
      clusterName: sample-ecs-cluster
      minSize: '0'
      maxSize: '1'
      desiredCapacity: '0'
      subnetIds:
        - subnet-12345
      instanceTypes:
        - filters:
            - architectures:
                - x86_64
                - i386
              categories:
                - Accelerated_computing
                - Compute_optimized
              diskTypes:
                - EBS
                - SSD
              excludeFamilies:
                - m*
              excludeMetal: false
              hypervisor:
                - xen
              includeFamilies:
                - c*
                - t*
              isEnaSupported: false
              maxGpu: 4
              minGpu: 0
              maxMemoryGib: 16
              maxNetworkPerformance: 20
              maxVcpu: 16
              minEnis: 2
              minMemoryGib: 8
              minNetworkPerformance: 2
              minVcpu: 2
              rootDeviceTypes:
                - ebs
              virtualizationTypes:
                - hvm
      securityGroupIds:
        - sg-12345
      imageId: ami-12345
      iamInstanceProfile: iam-profile
      keyPair: KeyPair
      userData: echo hello world
      associatePublicIpAddress: false
      utilizeReservedInstances: false
      drainingTimeout: 120
      monitoring: true
      ebsOptimized: true
      useAsTemplateOnly: true
      spotPercentage: 100
      utilizeCommitments: false
      fallbackToOndemand: true
      clusterOrientations:
        - availabilityVsCost: balanced
      instanceMetadataOptions:
        httpTokens: required
        httpPutResponseHopLimit: 10
      blockDeviceMappings:
        - deviceName: /dev/xvda1
          ebs:
            deleteOnTermination: 'true'
            encrypted: 'false'
            volumeType: gp2
            volumeSize: 50
            throughput: 500
            dynamicVolumeSize:
              baseSize: 50
              resource: CPU
              sizePerResourceUnit: 20
      optimizeImages:
        performAt: timeWindow
        timeWindows:
          - Sun:02:00-Sun:12:00
          - Sun:05:00-Sun:16:00
        shouldOptimizeEcsAmi: true
      tags:
        - key: fakeKey
          value: fakeValue
      logging:
        export:
          s3s:
            - id: di-abcd123
output "ocean_id" {
  value = spotinst_ocean_ecs.example.id
}
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,
          image_id: Optional[str] = None,
          subnet_ids: Optional[Sequence[str]] = None,
          security_group_ids: Optional[Sequence[str]] = None,
          region: Optional[str] = None,
          cluster_name: Optional[str] = None,
          max_size: Optional[int] = None,
          monitoring: Optional[bool] = None,
          draining_timeout: Optional[int] = None,
          ebs_optimized: Optional[bool] = None,
          fallback_to_ondemand: Optional[bool] = None,
          filters: Optional[OceanFiltersArgs] = None,
          iam_instance_profile: Optional[str] = None,
          cluster_orientations: Optional[Sequence[OceanClusterOrientationArgs]] = None,
          instance_metadata_options: Optional[OceanInstanceMetadataOptionsArgs] = None,
          key_pair: Optional[str] = None,
          logging: Optional[OceanLoggingArgs] = None,
          associate_public_ip_address: Optional[bool] = None,
          min_size: Optional[int] = None,
          desired_capacity: Optional[int] = None,
          name: Optional[str] = None,
          optimize_images: Optional[OceanOptimizeImagesArgs] = None,
          block_device_mappings: Optional[Sequence[OceanBlockDeviceMappingArgs]] = None,
          scheduled_tasks: Optional[Sequence[OceanScheduledTaskArgs]] = None,
          blacklists: Optional[Sequence[str]] = None,
          spot_percentage: Optional[int] = None,
          autoscaler: Optional[OceanAutoscalerArgs] = 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)func NewOcean(ctx *Context, name string, args OceanArgs, opts ...ResourceOption) (*Ocean, error)public Ocean(string name, OceanArgs args, CustomResourceOptions? opts = null)type: spotinst:ecs: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.
Constructor example
The following reference example uses placeholder values for all input properties.
var spotinstOceanResource = new SpotInst.Ecs.Ocean("spotinstOceanResource", new()
{
    ImageId = "string",
    SubnetIds = new[]
    {
        "string",
    },
    SecurityGroupIds = new[]
    {
        "string",
    },
    Region = "string",
    ClusterName = "string",
    MaxSize = 0,
    Monitoring = false,
    DrainingTimeout = 0,
    EbsOptimized = false,
    FallbackToOndemand = false,
    Filters = new SpotInst.Ecs.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",
        },
    },
    IamInstanceProfile = "string",
    ClusterOrientations = new[]
    {
        new SpotInst.Ecs.Inputs.OceanClusterOrientationArgs
        {
            AvailabilityVsCost = "string",
        },
    },
    InstanceMetadataOptions = new SpotInst.Ecs.Inputs.OceanInstanceMetadataOptionsArgs
    {
        HttpTokens = "string",
        HttpPutResponseHopLimit = 0,
    },
    KeyPair = "string",
    Logging = new SpotInst.Ecs.Inputs.OceanLoggingArgs
    {
        Export = new SpotInst.Ecs.Inputs.OceanLoggingExportArgs
        {
            S3s = new[]
            {
                new SpotInst.Ecs.Inputs.OceanLoggingExportS3Args
                {
                    Id = "string",
                },
            },
        },
    },
    AssociatePublicIpAddress = false,
    MinSize = 0,
    DesiredCapacity = 0,
    Name = "string",
    OptimizeImages = new SpotInst.Ecs.Inputs.OceanOptimizeImagesArgs
    {
        PerformAt = "string",
        ShouldOptimizeEcsAmi = false,
        TimeWindows = new[]
        {
            "string",
        },
    },
    BlockDeviceMappings = new[]
    {
        new SpotInst.Ecs.Inputs.OceanBlockDeviceMappingArgs
        {
            DeviceName = "string",
            Ebs = new SpotInst.Ecs.Inputs.OceanBlockDeviceMappingEbsArgs
            {
                DeleteOnTermination = false,
                DynamicVolumeSize = new SpotInst.Ecs.Inputs.OceanBlockDeviceMappingEbsDynamicVolumeSizeArgs
                {
                    BaseSize = 0,
                    Resource = "string",
                    SizePerResourceUnit = 0,
                },
                Encrypted = false,
                Iops = 0,
                KmsKeyId = "string",
                SnapshotId = "string",
                Throughput = 0,
                VolumeSize = 0,
                VolumeType = "string",
            },
            NoDevice = "string",
            VirtualName = "string",
        },
    },
    ScheduledTasks = new[]
    {
        new SpotInst.Ecs.Inputs.OceanScheduledTaskArgs
        {
            ShutdownHours = new SpotInst.Ecs.Inputs.OceanScheduledTaskShutdownHoursArgs
            {
                TimeWindows = new[]
                {
                    "string",
                },
                IsEnabled = false,
            },
            Tasks = new[]
            {
                new SpotInst.Ecs.Inputs.OceanScheduledTaskTaskArgs
                {
                    CronExpression = "string",
                    IsEnabled = false,
                    TaskType = "string",
                },
            },
        },
    },
    Blacklists = new[]
    {
        "string",
    },
    SpotPercentage = 0,
    Autoscaler = new SpotInst.Ecs.Inputs.OceanAutoscalerArgs
    {
        AutoHeadroomPercentage = 0,
        Cooldown = 0,
        Down = new SpotInst.Ecs.Inputs.OceanAutoscalerDownArgs
        {
            MaxScaleDownPercentage = 0,
        },
        EnableAutomaticAndManualHeadroom = false,
        Headroom = new SpotInst.Ecs.Inputs.OceanAutoscalerHeadroomArgs
        {
            CpuPerUnit = 0,
            MemoryPerUnit = 0,
            NumOfUnits = 0,
        },
        IsAutoConfig = false,
        IsEnabled = false,
        ResourceLimits = new SpotInst.Ecs.Inputs.OceanAutoscalerResourceLimitsArgs
        {
            MaxMemoryGib = 0,
            MaxVcpu = 0,
        },
        ShouldScaleDownNonServiceTasks = false,
    },
    Tags = new[]
    {
        new SpotInst.Ecs.Inputs.OceanTagArgs
        {
            Key = "string",
            Value = "string",
        },
    },
    UpdatePolicy = new SpotInst.Ecs.Inputs.OceanUpdatePolicyArgs
    {
        ShouldRoll = false,
        AutoApplyTags = false,
        ConditionedRoll = false,
        RollConfig = new SpotInst.Ecs.Inputs.OceanUpdatePolicyRollConfigArgs
        {
            BatchSizePercentage = 0,
            BatchMinHealthyPercentage = 0,
        },
    },
    UseAsTemplateOnly = false,
    UserData = "string",
    UtilizeCommitments = false,
    UtilizeReservedInstances = false,
    Whitelists = new[]
    {
        "string",
    },
});
example, err := ecs.NewOcean(ctx, "spotinstOceanResource", &ecs.OceanArgs{
	ImageId: pulumi.String("string"),
	SubnetIds: pulumi.StringArray{
		pulumi.String("string"),
	},
	SecurityGroupIds: pulumi.StringArray{
		pulumi.String("string"),
	},
	Region:             pulumi.String("string"),
	ClusterName:        pulumi.String("string"),
	MaxSize:            pulumi.Int(0),
	Monitoring:         pulumi.Bool(false),
	DrainingTimeout:    pulumi.Int(0),
	EbsOptimized:       pulumi.Bool(false),
	FallbackToOndemand: pulumi.Bool(false),
	Filters: &ecs.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"),
		},
	},
	IamInstanceProfile: pulumi.String("string"),
	ClusterOrientations: ecs.OceanClusterOrientationArray{
		&ecs.OceanClusterOrientationArgs{
			AvailabilityVsCost: pulumi.String("string"),
		},
	},
	InstanceMetadataOptions: &ecs.OceanInstanceMetadataOptionsArgs{
		HttpTokens:              pulumi.String("string"),
		HttpPutResponseHopLimit: pulumi.Int(0),
	},
	KeyPair: pulumi.String("string"),
	Logging: &ecs.OceanLoggingArgs{
		Export: &ecs.OceanLoggingExportArgs{
			S3s: ecs.OceanLoggingExportS3Array{
				&ecs.OceanLoggingExportS3Args{
					Id: pulumi.String("string"),
				},
			},
		},
	},
	AssociatePublicIpAddress: pulumi.Bool(false),
	MinSize:                  pulumi.Int(0),
	DesiredCapacity:          pulumi.Int(0),
	Name:                     pulumi.String("string"),
	OptimizeImages: &ecs.OceanOptimizeImagesArgs{
		PerformAt:            pulumi.String("string"),
		ShouldOptimizeEcsAmi: pulumi.Bool(false),
		TimeWindows: pulumi.StringArray{
			pulumi.String("string"),
		},
	},
	BlockDeviceMappings: ecs.OceanBlockDeviceMappingArray{
		&ecs.OceanBlockDeviceMappingArgs{
			DeviceName: pulumi.String("string"),
			Ebs: &ecs.OceanBlockDeviceMappingEbsArgs{
				DeleteOnTermination: pulumi.Bool(false),
				DynamicVolumeSize: &ecs.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"),
			},
			NoDevice:    pulumi.String("string"),
			VirtualName: pulumi.String("string"),
		},
	},
	ScheduledTasks: ecs.OceanScheduledTaskArray{
		&ecs.OceanScheduledTaskArgs{
			ShutdownHours: &ecs.OceanScheduledTaskShutdownHoursArgs{
				TimeWindows: pulumi.StringArray{
					pulumi.String("string"),
				},
				IsEnabled: pulumi.Bool(false),
			},
			Tasks: ecs.OceanScheduledTaskTaskArray{
				&ecs.OceanScheduledTaskTaskArgs{
					CronExpression: pulumi.String("string"),
					IsEnabled:      pulumi.Bool(false),
					TaskType:       pulumi.String("string"),
				},
			},
		},
	},
	Blacklists: pulumi.StringArray{
		pulumi.String("string"),
	},
	SpotPercentage: pulumi.Int(0),
	Autoscaler: &ecs.OceanAutoscalerArgs{
		AutoHeadroomPercentage: pulumi.Int(0),
		Cooldown:               pulumi.Int(0),
		Down: &ecs.OceanAutoscalerDownArgs{
			MaxScaleDownPercentage: pulumi.Float64(0),
		},
		EnableAutomaticAndManualHeadroom: pulumi.Bool(false),
		Headroom: &ecs.OceanAutoscalerHeadroomArgs{
			CpuPerUnit:    pulumi.Int(0),
			MemoryPerUnit: pulumi.Int(0),
			NumOfUnits:    pulumi.Int(0),
		},
		IsAutoConfig: pulumi.Bool(false),
		IsEnabled:    pulumi.Bool(false),
		ResourceLimits: &ecs.OceanAutoscalerResourceLimitsArgs{
			MaxMemoryGib: pulumi.Int(0),
			MaxVcpu:      pulumi.Int(0),
		},
		ShouldScaleDownNonServiceTasks: pulumi.Bool(false),
	},
	Tags: ecs.OceanTagArray{
		&ecs.OceanTagArgs{
			Key:   pulumi.String("string"),
			Value: pulumi.String("string"),
		},
	},
	UpdatePolicy: &ecs.OceanUpdatePolicyArgs{
		ShouldRoll:      pulumi.Bool(false),
		AutoApplyTags:   pulumi.Bool(false),
		ConditionedRoll: pulumi.Bool(false),
		RollConfig: &ecs.OceanUpdatePolicyRollConfigArgs{
			BatchSizePercentage:       pulumi.Int(0),
			BatchMinHealthyPercentage: pulumi.Int(0),
		},
	},
	UseAsTemplateOnly:        pulumi.Bool(false),
	UserData:                 pulumi.String("string"),
	UtilizeCommitments:       pulumi.Bool(false),
	UtilizeReservedInstances: pulumi.Bool(false),
	Whitelists: pulumi.StringArray{
		pulumi.String("string"),
	},
})
var spotinstOceanResource = new com.pulumi.spotinst.ecs.Ocean("spotinstOceanResource", com.pulumi.spotinst.ecs.OceanArgs.builder()
    .imageId("string")
    .subnetIds("string")
    .securityGroupIds("string")
    .region("string")
    .clusterName("string")
    .maxSize(0)
    .monitoring(false)
    .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.0)
        .maxNetworkPerformance(0)
        .maxVcpu(0)
        .minEnis(0)
        .minGpu(0)
        .minMemoryGib(0.0)
        .minNetworkPerformance(0)
        .minVcpu(0)
        .rootDeviceTypes("string")
        .virtualizationTypes("string")
        .build())
    .iamInstanceProfile("string")
    .clusterOrientations(OceanClusterOrientationArgs.builder()
        .availabilityVsCost("string")
        .build())
    .instanceMetadataOptions(OceanInstanceMetadataOptionsArgs.builder()
        .httpTokens("string")
        .httpPutResponseHopLimit(0)
        .build())
    .keyPair("string")
    .logging(OceanLoggingArgs.builder()
        .export(OceanLoggingExportArgs.builder()
            .s3s(OceanLoggingExportS3Args.builder()
                .id("string")
                .build())
            .build())
        .build())
    .associatePublicIpAddress(false)
    .minSize(0)
    .desiredCapacity(0)
    .name("string")
    .optimizeImages(OceanOptimizeImagesArgs.builder()
        .performAt("string")
        .shouldOptimizeEcsAmi(false)
        .timeWindows("string")
        .build())
    .blockDeviceMappings(OceanBlockDeviceMappingArgs.builder()
        .deviceName("string")
        .ebs(OceanBlockDeviceMappingEbsArgs.builder()
            .deleteOnTermination(false)
            .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())
        .noDevice("string")
        .virtualName("string")
        .build())
    .scheduledTasks(OceanScheduledTaskArgs.builder()
        .shutdownHours(OceanScheduledTaskShutdownHoursArgs.builder()
            .timeWindows("string")
            .isEnabled(false)
            .build())
        .tasks(OceanScheduledTaskTaskArgs.builder()
            .cronExpression("string")
            .isEnabled(false)
            .taskType("string")
            .build())
        .build())
    .blacklists("string")
    .spotPercentage(0)
    .autoscaler(OceanAutoscalerArgs.builder()
        .autoHeadroomPercentage(0)
        .cooldown(0)
        .down(OceanAutoscalerDownArgs.builder()
            .maxScaleDownPercentage(0.0)
            .build())
        .enableAutomaticAndManualHeadroom(false)
        .headroom(OceanAutoscalerHeadroomArgs.builder()
            .cpuPerUnit(0)
            .memoryPerUnit(0)
            .numOfUnits(0)
            .build())
        .isAutoConfig(false)
        .isEnabled(false)
        .resourceLimits(OceanAutoscalerResourceLimitsArgs.builder()
            .maxMemoryGib(0)
            .maxVcpu(0)
            .build())
        .shouldScaleDownNonServiceTasks(false)
        .build())
    .tags(OceanTagArgs.builder()
        .key("string")
        .value("string")
        .build())
    .updatePolicy(OceanUpdatePolicyArgs.builder()
        .shouldRoll(false)
        .autoApplyTags(false)
        .conditionedRoll(false)
        .rollConfig(OceanUpdatePolicyRollConfigArgs.builder()
            .batchSizePercentage(0)
            .batchMinHealthyPercentage(0)
            .build())
        .build())
    .useAsTemplateOnly(false)
    .userData("string")
    .utilizeCommitments(false)
    .utilizeReservedInstances(false)
    .whitelists("string")
    .build());
spotinst_ocean_resource = spotinst.ecs.Ocean("spotinstOceanResource",
    image_id="string",
    subnet_ids=["string"],
    security_group_ids=["string"],
    region="string",
    cluster_name="string",
    max_size=0,
    monitoring=False,
    draining_timeout=0,
    ebs_optimized=False,
    fallback_to_ondemand=False,
    filters={
        "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"],
    },
    iam_instance_profile="string",
    cluster_orientations=[{
        "availability_vs_cost": "string",
    }],
    instance_metadata_options={
        "http_tokens": "string",
        "http_put_response_hop_limit": 0,
    },
    key_pair="string",
    logging={
        "export": {
            "s3s": [{
                "id": "string",
            }],
        },
    },
    associate_public_ip_address=False,
    min_size=0,
    desired_capacity=0,
    name="string",
    optimize_images={
        "perform_at": "string",
        "should_optimize_ecs_ami": False,
        "time_windows": ["string"],
    },
    block_device_mappings=[{
        "device_name": "string",
        "ebs": {
            "delete_on_termination": False,
            "dynamic_volume_size": {
                "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",
        },
        "no_device": "string",
        "virtual_name": "string",
    }],
    scheduled_tasks=[{
        "shutdown_hours": {
            "time_windows": ["string"],
            "is_enabled": False,
        },
        "tasks": [{
            "cron_expression": "string",
            "is_enabled": False,
            "task_type": "string",
        }],
    }],
    blacklists=["string"],
    spot_percentage=0,
    autoscaler={
        "auto_headroom_percentage": 0,
        "cooldown": 0,
        "down": {
            "max_scale_down_percentage": 0,
        },
        "enable_automatic_and_manual_headroom": False,
        "headroom": {
            "cpu_per_unit": 0,
            "memory_per_unit": 0,
            "num_of_units": 0,
        },
        "is_auto_config": False,
        "is_enabled": False,
        "resource_limits": {
            "max_memory_gib": 0,
            "max_vcpu": 0,
        },
        "should_scale_down_non_service_tasks": False,
    },
    tags=[{
        "key": "string",
        "value": "string",
    }],
    update_policy={
        "should_roll": False,
        "auto_apply_tags": False,
        "conditioned_roll": False,
        "roll_config": {
            "batch_size_percentage": 0,
            "batch_min_healthy_percentage": 0,
        },
    },
    use_as_template_only=False,
    user_data="string",
    utilize_commitments=False,
    utilize_reserved_instances=False,
    whitelists=["string"])
const spotinstOceanResource = new spotinst.ecs.Ocean("spotinstOceanResource", {
    imageId: "string",
    subnetIds: ["string"],
    securityGroupIds: ["string"],
    region: "string",
    clusterName: "string",
    maxSize: 0,
    monitoring: false,
    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"],
    },
    iamInstanceProfile: "string",
    clusterOrientations: [{
        availabilityVsCost: "string",
    }],
    instanceMetadataOptions: {
        httpTokens: "string",
        httpPutResponseHopLimit: 0,
    },
    keyPair: "string",
    logging: {
        "export": {
            s3s: [{
                id: "string",
            }],
        },
    },
    associatePublicIpAddress: false,
    minSize: 0,
    desiredCapacity: 0,
    name: "string",
    optimizeImages: {
        performAt: "string",
        shouldOptimizeEcsAmi: false,
        timeWindows: ["string"],
    },
    blockDeviceMappings: [{
        deviceName: "string",
        ebs: {
            deleteOnTermination: false,
            dynamicVolumeSize: {
                baseSize: 0,
                resource: "string",
                sizePerResourceUnit: 0,
            },
            encrypted: false,
            iops: 0,
            kmsKeyId: "string",
            snapshotId: "string",
            throughput: 0,
            volumeSize: 0,
            volumeType: "string",
        },
        noDevice: "string",
        virtualName: "string",
    }],
    scheduledTasks: [{
        shutdownHours: {
            timeWindows: ["string"],
            isEnabled: false,
        },
        tasks: [{
            cronExpression: "string",
            isEnabled: false,
            taskType: "string",
        }],
    }],
    blacklists: ["string"],
    spotPercentage: 0,
    autoscaler: {
        autoHeadroomPercentage: 0,
        cooldown: 0,
        down: {
            maxScaleDownPercentage: 0,
        },
        enableAutomaticAndManualHeadroom: false,
        headroom: {
            cpuPerUnit: 0,
            memoryPerUnit: 0,
            numOfUnits: 0,
        },
        isAutoConfig: false,
        isEnabled: false,
        resourceLimits: {
            maxMemoryGib: 0,
            maxVcpu: 0,
        },
        shouldScaleDownNonServiceTasks: false,
    },
    tags: [{
        key: "string",
        value: "string",
    }],
    updatePolicy: {
        shouldRoll: false,
        autoApplyTags: false,
        conditionedRoll: false,
        rollConfig: {
            batchSizePercentage: 0,
            batchMinHealthyPercentage: 0,
        },
    },
    useAsTemplateOnly: false,
    userData: "string",
    utilizeCommitments: false,
    utilizeReservedInstances: false,
    whitelists: ["string"],
});
type: spotinst:ecs:Ocean
properties:
    associatePublicIpAddress: false
    autoscaler:
        autoHeadroomPercentage: 0
        cooldown: 0
        down:
            maxScaleDownPercentage: 0
        enableAutomaticAndManualHeadroom: false
        headroom:
            cpuPerUnit: 0
            memoryPerUnit: 0
            numOfUnits: 0
        isAutoConfig: false
        isEnabled: false
        resourceLimits:
            maxMemoryGib: 0
            maxVcpu: 0
        shouldScaleDownNonServiceTasks: false
    blacklists:
        - string
    blockDeviceMappings:
        - deviceName: string
          ebs:
            deleteOnTermination: false
            dynamicVolumeSize:
                baseSize: 0
                resource: string
                sizePerResourceUnit: 0
            encrypted: false
            iops: 0
            kmsKeyId: string
            snapshotId: string
            throughput: 0
            volumeSize: 0
            volumeType: string
          noDevice: string
          virtualName: string
    clusterName: string
    clusterOrientations:
        - availabilityVsCost: 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
    iamInstanceProfile: string
    imageId: string
    instanceMetadataOptions:
        httpPutResponseHopLimit: 0
        httpTokens: string
    keyPair: string
    logging:
        export:
            s3s:
                - id: string
    maxSize: 0
    minSize: 0
    monitoring: false
    name: string
    optimizeImages:
        performAt: string
        shouldOptimizeEcsAmi: false
        timeWindows:
            - string
    region: string
    scheduledTasks:
        - shutdownHours:
            isEnabled: false
            timeWindows:
                - string
          tasks:
            - cronExpression: string
              isEnabled: false
              taskType: string
    securityGroupIds:
        - string
    spotPercentage: 0
    subnetIds:
        - string
    tags:
        - key: string
          value: string
    updatePolicy:
        autoApplyTags: false
        conditionedRoll: false
        rollConfig:
            batchMinHealthyPercentage: 0
            batchSizePercentage: 0
        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
In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.
The Ocean resource accepts the following input properties:
- ClusterName string
- The name of the ECS cluster.
- ImageId string
- ID of the image used to launch the instances.
- Region string
- The region the cluster will run in.
- SecurityGroup List<string>Ids 
- 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.
- AssociatePublic boolIp Address 
- Configure public IP address allocation.
- Autoscaler
Pulumi.Spot Inst. Ecs. Inputs. Ocean Autoscaler 
- Describes the Ocean ECS autoscaler.
- Blacklists List<string>
- BlockDevice List<Pulumi.Mappings Spot Inst. Ecs. Inputs. Ocean Block Device Mapping> 
- Object. List of block devices that are exposed to the instance, specify either virtual devices and EBS volumes.
- ClusterOrientations List<Pulumi.Spot Inst. Ecs. Inputs. Ocean Cluster Orientation> 
- 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.
- FallbackTo boolOndemand 
- If no Spot instance markets are available, enable Ocean to launch On-Demand instances instead.
- Filters
Pulumi.Spot Inst. Ecs. Inputs. Ocean Filters 
- IamInstance stringProfile 
- The instance profile iam role.
- InstanceMetadata Pulumi.Options Spot Inst. Ecs. Inputs. Ocean Instance Metadata Options 
- Ocean instance metadata options object for IMDSv2.
- KeyPair string
- The key pair to attach the instances.
- Logging
Pulumi.Spot Inst. Ecs. Inputs. Ocean Logging 
- 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
- The Ocean cluster name.
- OptimizeImages Pulumi.Spot Inst. Ecs. Inputs. Ocean Optimize Images 
- Object. Set auto image update settings.
- ScheduledTasks List<Pulumi.Spot Inst. Ecs. Inputs. Ocean Scheduled Task> 
- While used, you can control whether the group should perform a deployment after an update to the configuration.
- SpotPercentage int
- The percentage of Spot instances that would spin up from the desired_capacitynumber.
- 
List<Pulumi.Spot Inst. Ecs. Inputs. Ocean Tag> 
- Optionally adds tags to instances launched in an Ocean cluster.
- UpdatePolicy Pulumi.Spot Inst. Ecs. Inputs. Ocean Update Policy 
- While used, you can control whether the group should perform a deployment after an update to the configuration.
- UseAs boolTemplate Only 
- launch specification defined on the Ocean object will function only as a template for virtual node groups.
- 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.
- UtilizeReserved boolInstances 
- If Reserved instances exist, Ocean will utilize them before launching Spot instances.
- Whitelists List<string>
- ClusterName string
- The name of the ECS cluster.
- ImageId string
- ID of the image used to launch the instances.
- Region string
- The region the cluster will run in.
- SecurityGroup []stringIds 
- 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.
- AssociatePublic boolIp Address 
- Configure public IP address allocation.
- Autoscaler
OceanAutoscaler Args 
- Describes the Ocean ECS autoscaler.
- Blacklists []string
- BlockDevice []OceanMappings Block Device Mapping Args 
- Object. List of block devices that are exposed to the instance, specify either virtual devices and EBS volumes.
- ClusterOrientations []OceanCluster Orientation Args 
- 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.
- FallbackTo boolOndemand 
- If no Spot instance markets are available, enable Ocean to launch On-Demand instances instead.
- Filters
OceanFilters Args 
- IamInstance stringProfile 
- The instance profile iam role.
- InstanceMetadata OceanOptions Instance Metadata Options Args 
- Ocean instance metadata options object for IMDSv2.
- KeyPair string
- The key pair to attach the instances.
- Logging
OceanLogging Args 
- 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
- The Ocean cluster name.
- OptimizeImages OceanOptimize Images Args 
- Object. Set auto image update settings.
- ScheduledTasks []OceanScheduled Task Args 
- While used, you can control whether the group should perform a deployment after an update to the configuration.
- SpotPercentage int
- The percentage of Spot instances that would spin up from the desired_capacitynumber.
- 
[]OceanTag Args 
- Optionally adds tags to instances launched in an Ocean cluster.
- UpdatePolicy OceanUpdate Policy Args 
- While used, you can control whether the group should perform a deployment after an update to the configuration.
- UseAs boolTemplate Only 
- launch specification defined on the Ocean object will function only as a template for virtual node groups.
- 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.
- UtilizeReserved boolInstances 
- If Reserved instances exist, Ocean will utilize them before launching Spot instances.
- Whitelists []string
- clusterName String
- The name of the ECS cluster.
- imageId String
- ID of the image used to launch the instances.
- region String
- The region the cluster will run in.
- securityGroup List<String>Ids 
- 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.
- associatePublic BooleanIp Address 
- Configure public IP address allocation.
- autoscaler
OceanAutoscaler 
- Describes the Ocean ECS autoscaler.
- blacklists List<String>
- blockDevice List<OceanMappings Block Device Mapping> 
- Object. List of block devices that are exposed to the instance, specify either virtual devices and EBS volumes.
- clusterOrientations List<OceanCluster Orientation> 
- 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.
- fallbackTo BooleanOndemand 
- If no Spot instance markets are available, enable Ocean to launch On-Demand instances instead.
- filters
OceanFilters 
- iamInstance StringProfile 
- The instance profile iam role.
- instanceMetadata OceanOptions Instance Metadata Options 
- Ocean instance metadata options object for IMDSv2.
- keyPair String
- The key pair to attach the instances.
- 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
- The Ocean cluster name.
- optimizeImages OceanOptimize Images 
- Object. Set auto image update settings.
- scheduledTasks List<OceanScheduled Task> 
- While used, you can control whether the group should perform a deployment after an update to the configuration.
- spotPercentage Integer
- The percentage of Spot instances that would spin up from the desired_capacitynumber.
- 
List<OceanTag> 
- Optionally adds tags to instances launched in an Ocean cluster.
- updatePolicy OceanUpdate Policy 
- While used, you can control whether the group should perform a deployment after an update to the configuration.
- useAs BooleanTemplate Only 
- launch specification defined on the Ocean object will function only as a template for virtual node groups.
- 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.
- utilizeReserved BooleanInstances 
- If Reserved instances exist, Ocean will utilize them before launching Spot instances.
- whitelists List<String>
- clusterName string
- The name of the ECS cluster.
- imageId string
- ID of the image used to launch the instances.
- region string
- The region the cluster will run in.
- securityGroup string[]Ids 
- 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.
- associatePublic booleanIp Address 
- Configure public IP address allocation.
- autoscaler
OceanAutoscaler 
- Describes the Ocean ECS autoscaler.
- blacklists string[]
- blockDevice OceanMappings Block Device Mapping[] 
- Object. List of block devices that are exposed to the instance, specify either virtual devices and EBS volumes.
- clusterOrientations OceanCluster Orientation[] 
- 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.
- fallbackTo booleanOndemand 
- If no Spot instance markets are available, enable Ocean to launch On-Demand instances instead.
- filters
OceanFilters 
- iamInstance stringProfile 
- The instance profile iam role.
- instanceMetadata OceanOptions Instance Metadata Options 
- Ocean instance metadata options object for IMDSv2.
- keyPair string
- The key pair to attach the instances.
- 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
- The Ocean cluster name.
- optimizeImages OceanOptimize Images 
- Object. Set auto image update settings.
- scheduledTasks OceanScheduled Task[] 
- While used, you can control whether the group should perform a deployment after an update to the configuration.
- spotPercentage number
- The percentage of Spot instances that would spin up from the desired_capacitynumber.
- 
OceanTag[] 
- Optionally adds tags to instances launched in an Ocean cluster.
- updatePolicy OceanUpdate Policy 
- While used, you can control whether the group should perform a deployment after an update to the configuration.
- useAs booleanTemplate Only 
- launch specification defined on the Ocean object will function only as a template for virtual node groups.
- 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.
- utilizeReserved booleanInstances 
- If Reserved instances exist, Ocean will utilize them before launching Spot instances.
- whitelists string[]
- cluster_name str
- The name of the ECS cluster.
- image_id str
- ID of the image used to launch the instances.
- region str
- The region the cluster will run in.
- security_group_ Sequence[str]ids 
- 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_public_ boolip_ address 
- Configure public IP address allocation.
- autoscaler
OceanAutoscaler Args 
- Describes the Ocean ECS autoscaler.
- blacklists Sequence[str]
- block_device_ Sequence[Oceanmappings Block Device Mapping Args] 
- Object. List of block devices that are exposed to the instance, specify either virtual devices and EBS volumes.
- cluster_orientations Sequence[OceanCluster Orientation Args] 
- 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_ boolondemand 
- If no Spot instance markets are available, enable Ocean to launch On-Demand instances instead.
- filters
OceanFilters Args 
- iam_instance_ strprofile 
- The instance profile iam role.
- instance_metadata_ Oceanoptions Instance Metadata Options Args 
- Ocean instance metadata options object for IMDSv2.
- key_pair str
- The key pair to attach the instances.
- logging
OceanLogging Args 
- 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
- The Ocean cluster name.
- optimize_images OceanOptimize Images Args 
- Object. Set auto image update settings.
- scheduled_tasks Sequence[OceanScheduled Task Args] 
- While used, you can control whether the group should perform a deployment after an update to the configuration.
- spot_percentage int
- The percentage of Spot instances that would spin up from the desired_capacitynumber.
- 
Sequence[OceanTag Args] 
- Optionally adds tags to instances launched in an Ocean cluster.
- update_policy OceanUpdate Policy Args 
- While used, you can control whether the group should perform a deployment after an update to the configuration.
- use_as_ booltemplate_ only 
- launch specification defined on the Ocean object will function only as a template for virtual node groups.
- 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_ boolinstances 
- If Reserved instances exist, Ocean will utilize them before launching Spot instances.
- whitelists Sequence[str]
- clusterName String
- The name of the ECS cluster.
- imageId String
- ID of the image used to launch the instances.
- region String
- The region the cluster will run in.
- securityGroup List<String>Ids 
- 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.
- associatePublic BooleanIp Address 
- Configure public IP address allocation.
- autoscaler Property Map
- Describes the Ocean ECS autoscaler.
- blacklists List<String>
- blockDevice List<Property Map>Mappings 
- Object. List of block devices that are exposed to the instance, specify either virtual devices and EBS volumes.
- clusterOrientations List<Property Map>
- 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.
- fallbackTo BooleanOndemand 
- If no Spot instance markets are available, enable Ocean to launch On-Demand instances instead.
- filters Property Map
- iamInstance StringProfile 
- The instance profile iam role.
- instanceMetadata Property MapOptions 
- Ocean instance metadata options object for IMDSv2.
- keyPair String
- The key pair to attach the instances.
- 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
- The Ocean cluster name.
- optimizeImages Property Map
- Object. Set auto image update settings.
- scheduledTasks List<Property Map>
- While used, you can control whether the group should perform a deployment after an update to the configuration.
- spotPercentage Number
- The percentage of Spot instances that would spin up from the desired_capacitynumber.
- List<Property Map>
- Optionally adds tags to instances launched in an Ocean cluster.
- updatePolicy Property Map
- While used, you can control whether the group should perform a deployment after an update to the configuration.
- useAs BooleanTemplate Only 
- launch specification defined on the Ocean object will function only as a template for virtual node groups.
- 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.
- utilizeReserved BooleanInstances 
- If Reserved instances exist, Ocean will utilize them before launching Spot instances.
- whitelists List<String>
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_public_ip_address: Optional[bool] = None,
        autoscaler: Optional[OceanAutoscalerArgs] = None,
        blacklists: Optional[Sequence[str]] = None,
        block_device_mappings: Optional[Sequence[OceanBlockDeviceMappingArgs]] = None,
        cluster_name: Optional[str] = None,
        cluster_orientations: Optional[Sequence[OceanClusterOrientationArgs]] = 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,
        iam_instance_profile: Optional[str] = None,
        image_id: Optional[str] = None,
        instance_metadata_options: Optional[OceanInstanceMetadataOptionsArgs] = None,
        key_pair: Optional[str] = None,
        logging: Optional[OceanLoggingArgs] = None,
        max_size: Optional[int] = None,
        min_size: Optional[int] = None,
        monitoring: Optional[bool] = None,
        name: Optional[str] = None,
        optimize_images: Optional[OceanOptimizeImagesArgs] = None,
        region: Optional[str] = None,
        scheduled_tasks: Optional[Sequence[OceanScheduledTaskArgs]] = None,
        security_group_ids: Optional[Sequence[str]] = None,
        spot_percentage: Optional[int] = 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) -> Oceanfunc 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)resources:  _:    type: spotinst:ecs:Ocean    get:      id: ${id}- 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.
- AssociatePublic boolIp Address 
- Configure public IP address allocation.
- Autoscaler
Pulumi.Spot Inst. Ecs. Inputs. Ocean Autoscaler 
- Describes the Ocean ECS autoscaler.
- Blacklists List<string>
- BlockDevice List<Pulumi.Mappings Spot Inst. Ecs. Inputs. Ocean Block Device Mapping> 
- Object. List of block devices that are exposed to the instance, specify either virtual devices and EBS volumes.
- ClusterName string
- The name of the ECS cluster.
- ClusterOrientations List<Pulumi.Spot Inst. Ecs. Inputs. Ocean Cluster Orientation> 
- 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.
- FallbackTo boolOndemand 
- If no Spot instance markets are available, enable Ocean to launch On-Demand instances instead.
- Filters
Pulumi.Spot Inst. Ecs. Inputs. Ocean Filters 
- IamInstance stringProfile 
- The instance profile iam role.
- ImageId string
- ID of the image used to launch the instances.
- InstanceMetadata Pulumi.Options Spot Inst. Ecs. Inputs. Ocean Instance Metadata Options 
- Ocean instance metadata options object for IMDSv2.
- KeyPair string
- The key pair to attach the instances.
- Logging
Pulumi.Spot Inst. Ecs. Inputs. Ocean Logging 
- 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
- The Ocean cluster name.
- OptimizeImages Pulumi.Spot Inst. Ecs. Inputs. Ocean Optimize Images 
- Object. Set auto image update settings.
- Region string
- The region the cluster will run in.
- ScheduledTasks List<Pulumi.Spot Inst. Ecs. Inputs. Ocean Scheduled Task> 
- While used, you can control whether the group should perform a deployment after an update to the configuration.
- SecurityGroup List<string>Ids 
- One or more security group ids.
- SpotPercentage int
- The percentage of Spot instances that would spin up from the desired_capacitynumber.
- SubnetIds List<string>
- A comma-separated list of subnet identifiers for the Ocean cluster. Subnet IDs should be configured with auto assign public ip.
- 
List<Pulumi.Spot Inst. Ecs. Inputs. Ocean Tag> 
- Optionally adds tags to instances launched in an Ocean cluster.
- UpdatePolicy Pulumi.Spot Inst. Ecs. Inputs. Ocean Update Policy 
- While used, you can control whether the group should perform a deployment after an update to the configuration.
- UseAs boolTemplate Only 
- launch specification defined on the Ocean object will function only as a template for virtual node groups.
- 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.
- UtilizeReserved boolInstances 
- If Reserved instances exist, Ocean will utilize them before launching Spot instances.
- Whitelists List<string>
- AssociatePublic boolIp Address 
- Configure public IP address allocation.
- Autoscaler
OceanAutoscaler Args 
- Describes the Ocean ECS autoscaler.
- Blacklists []string
- BlockDevice []OceanMappings Block Device Mapping Args 
- Object. List of block devices that are exposed to the instance, specify either virtual devices and EBS volumes.
- ClusterName string
- The name of the ECS cluster.
- ClusterOrientations []OceanCluster Orientation Args 
- 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.
- FallbackTo boolOndemand 
- If no Spot instance markets are available, enable Ocean to launch On-Demand instances instead.
- Filters
OceanFilters Args 
- IamInstance stringProfile 
- The instance profile iam role.
- ImageId string
- ID of the image used to launch the instances.
- InstanceMetadata OceanOptions Instance Metadata Options Args 
- Ocean instance metadata options object for IMDSv2.
- KeyPair string
- The key pair to attach the instances.
- Logging
OceanLogging Args 
- 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
- The Ocean cluster name.
- OptimizeImages OceanOptimize Images Args 
- Object. Set auto image update settings.
- Region string
- The region the cluster will run in.
- ScheduledTasks []OceanScheduled Task Args 
- While used, you can control whether the group should perform a deployment after an update to the configuration.
- SecurityGroup []stringIds 
- One or more security group ids.
- SpotPercentage int
- The percentage of Spot instances that would spin up from the desired_capacitynumber.
- SubnetIds []string
- A comma-separated list of subnet identifiers for the Ocean cluster. Subnet IDs should be configured with auto assign public ip.
- 
[]OceanTag Args 
- Optionally adds tags to instances launched in an Ocean cluster.
- UpdatePolicy OceanUpdate Policy Args 
- While used, you can control whether the group should perform a deployment after an update to the configuration.
- UseAs boolTemplate Only 
- launch specification defined on the Ocean object will function only as a template for virtual node groups.
- 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.
- UtilizeReserved boolInstances 
- If Reserved instances exist, Ocean will utilize them before launching Spot instances.
- Whitelists []string
- associatePublic BooleanIp Address 
- Configure public IP address allocation.
- autoscaler
OceanAutoscaler 
- Describes the Ocean ECS autoscaler.
- blacklists List<String>
- blockDevice List<OceanMappings Block Device Mapping> 
- Object. List of block devices that are exposed to the instance, specify either virtual devices and EBS volumes.
- clusterName String
- The name of the ECS cluster.
- clusterOrientations List<OceanCluster Orientation> 
- 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.
- fallbackTo BooleanOndemand 
- If no Spot instance markets are available, enable Ocean to launch On-Demand instances instead.
- filters
OceanFilters 
- iamInstance StringProfile 
- The instance profile iam role.
- imageId String
- ID of the image used to launch the instances.
- instanceMetadata OceanOptions Instance Metadata Options 
- Ocean instance metadata options object for IMDSv2.
- keyPair String
- The key pair to attach the instances.
- 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
- The Ocean cluster name.
- optimizeImages OceanOptimize Images 
- Object. Set auto image update settings.
- region String
- The region the cluster will run in.
- scheduledTasks List<OceanScheduled Task> 
- While used, you can control whether the group should perform a deployment after an update to the configuration.
- securityGroup List<String>Ids 
- One or more security group ids.
- spotPercentage Integer
- The percentage of Spot instances that would spin up from the desired_capacitynumber.
- subnetIds List<String>
- A comma-separated list of subnet identifiers for the Ocean cluster. Subnet IDs should be configured with auto assign public ip.
- 
List<OceanTag> 
- Optionally adds tags to instances launched in an Ocean cluster.
- updatePolicy OceanUpdate Policy 
- While used, you can control whether the group should perform a deployment after an update to the configuration.
- useAs BooleanTemplate Only 
- launch specification defined on the Ocean object will function only as a template for virtual node groups.
- 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.
- utilizeReserved BooleanInstances 
- If Reserved instances exist, Ocean will utilize them before launching Spot instances.
- whitelists List<String>
- associatePublic booleanIp Address 
- Configure public IP address allocation.
- autoscaler
OceanAutoscaler 
- Describes the Ocean ECS autoscaler.
- blacklists string[]
- blockDevice OceanMappings Block Device Mapping[] 
- Object. List of block devices that are exposed to the instance, specify either virtual devices and EBS volumes.
- clusterName string
- The name of the ECS cluster.
- clusterOrientations OceanCluster Orientation[] 
- 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.
- fallbackTo booleanOndemand 
- If no Spot instance markets are available, enable Ocean to launch On-Demand instances instead.
- filters
OceanFilters 
- iamInstance stringProfile 
- The instance profile iam role.
- imageId string
- ID of the image used to launch the instances.
- instanceMetadata OceanOptions Instance Metadata Options 
- Ocean instance metadata options object for IMDSv2.
- keyPair string
- The key pair to attach the instances.
- 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
- The Ocean cluster name.
- optimizeImages OceanOptimize Images 
- Object. Set auto image update settings.
- region string
- The region the cluster will run in.
- scheduledTasks OceanScheduled Task[] 
- While used, you can control whether the group should perform a deployment after an update to the configuration.
- securityGroup string[]Ids 
- One or more security group ids.
- spotPercentage number
- The percentage of Spot instances that would spin up from the desired_capacitynumber.
- subnetIds string[]
- A comma-separated list of subnet identifiers for the Ocean cluster. Subnet IDs should be configured with auto assign public ip.
- 
OceanTag[] 
- Optionally adds tags to instances launched in an Ocean cluster.
- updatePolicy OceanUpdate Policy 
- While used, you can control whether the group should perform a deployment after an update to the configuration.
- useAs booleanTemplate Only 
- launch specification defined on the Ocean object will function only as a template for virtual node groups.
- 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.
- utilizeReserved booleanInstances 
- If Reserved instances exist, Ocean will utilize them before launching Spot instances.
- whitelists string[]
- associate_public_ boolip_ address 
- Configure public IP address allocation.
- autoscaler
OceanAutoscaler Args 
- Describes the Ocean ECS autoscaler.
- blacklists Sequence[str]
- block_device_ Sequence[Oceanmappings Block Device Mapping Args] 
- Object. List of block devices that are exposed to the instance, specify either virtual devices and EBS volumes.
- cluster_name str
- The name of the ECS cluster.
- cluster_orientations Sequence[OceanCluster Orientation Args] 
- 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_ boolondemand 
- If no Spot instance markets are available, enable Ocean to launch On-Demand instances instead.
- filters
OceanFilters Args 
- iam_instance_ strprofile 
- The instance profile iam role.
- image_id str
- ID of the image used to launch the instances.
- instance_metadata_ Oceanoptions Instance Metadata Options Args 
- Ocean instance metadata options object for IMDSv2.
- key_pair str
- The key pair to attach the instances.
- logging
OceanLogging Args 
- 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
- The Ocean cluster name.
- optimize_images OceanOptimize Images Args 
- Object. Set auto image update settings.
- region str
- The region the cluster will run in.
- scheduled_tasks Sequence[OceanScheduled Task Args] 
- While used, you can control whether the group should perform a deployment after an update to the configuration.
- security_group_ Sequence[str]ids 
- One or more security group ids.
- spot_percentage int
- The percentage of Spot instances that would spin up from the desired_capacitynumber.
- 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.
- 
Sequence[OceanTag Args] 
- Optionally adds tags to instances launched in an Ocean cluster.
- update_policy OceanUpdate Policy Args 
- While used, you can control whether the group should perform a deployment after an update to the configuration.
- use_as_ booltemplate_ only 
- launch specification defined on the Ocean object will function only as a template for virtual node groups.
- 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_ boolinstances 
- If Reserved instances exist, Ocean will utilize them before launching Spot instances.
- whitelists Sequence[str]
- associatePublic BooleanIp Address 
- Configure public IP address allocation.
- autoscaler Property Map
- Describes the Ocean ECS autoscaler.
- blacklists List<String>
- blockDevice List<Property Map>Mappings 
- Object. List of block devices that are exposed to the instance, specify either virtual devices and EBS volumes.
- clusterName String
- The name of the ECS cluster.
- clusterOrientations List<Property Map>
- 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.
- fallbackTo BooleanOndemand 
- If no Spot instance markets are available, enable Ocean to launch On-Demand instances instead.
- filters Property Map
- iamInstance StringProfile 
- The instance profile iam role.
- imageId String
- ID of the image used to launch the instances.
- instanceMetadata Property MapOptions 
- Ocean instance metadata options object for IMDSv2.
- keyPair String
- The key pair to attach the instances.
- 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
- The Ocean cluster name.
- optimizeImages Property Map
- Object. Set auto image update settings.
- region String
- The region the cluster will run in.
- scheduledTasks List<Property Map>
- While used, you can control whether the group should perform a deployment after an update to the configuration.
- securityGroup List<String>Ids 
- One or more security group ids.
- spotPercentage Number
- The percentage of Spot instances that would spin up from the desired_capacitynumber.
- subnetIds List<String>
- A comma-separated list of subnet identifiers for the Ocean cluster. Subnet IDs should be configured with auto assign public ip.
- List<Property Map>
- Optionally adds tags to instances launched in an Ocean cluster.
- updatePolicy Property Map
- While used, you can control whether the group should perform a deployment after an update to the configuration.
- useAs BooleanTemplate Only 
- launch specification defined on the Ocean object will function only as a template for virtual node groups.
- 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.
- utilizeReserved BooleanInstances 
- If Reserved instances exist, Ocean will utilize them before launching Spot instances.
- whitelists List<String>
Supporting Types
OceanAutoscaler, OceanAutoscalerArgs    
- AutoHeadroom intPercentage 
- The auto-headroom percentage. Set a number between 0-200 to control the headroom % of the cluster. Relevant when isAutoConfig= true.
- Cooldown int
- Cooldown period between scaling actions.
- Down
Pulumi.Spot Inst. Ecs. Inputs. Ocean Autoscaler Down 
- Auto Scaling scale down operations.
- EnableAutomatic boolAnd Manual Headroom 
- When set to true, both automatic and per custom launch specification manual headroom to be saved concurrently and independently in the cluster. prerequisite: isAutoConfig must be true
- Headroom
Pulumi.Spot Inst. Ecs. Inputs. Ocean Autoscaler Headroom 
- Spare resource capacity management enabling fast assignment of tasks without waiting for new resources to launch.
- IsAuto boolConfig 
- Automatically configure and optimize headroom resources.
- IsEnabled bool
- Enable the Ocean ECS autoscaler.
- ResourceLimits Pulumi.Spot Inst. Ecs. Inputs. Ocean Autoscaler Resource Limits 
- Optionally set upper and lower bounds on the resource usage of the cluster.
- ShouldScale boolDown Non Service Tasks 
- Option to scale down non-service tasks. If not set, Ocean does not scale down standalone tasks.
- AutoHeadroom intPercentage 
- The auto-headroom percentage. Set a number between 0-200 to control the headroom % of the cluster. Relevant when isAutoConfig= true.
- Cooldown int
- Cooldown period between scaling actions.
- Down
OceanAutoscaler Down 
- Auto Scaling scale down operations.
- EnableAutomatic boolAnd Manual Headroom 
- When set to true, both automatic and per custom launch specification manual headroom to be saved concurrently and independently in the cluster. prerequisite: isAutoConfig must be true
- Headroom
OceanAutoscaler Headroom 
- Spare resource capacity management enabling fast assignment of tasks without waiting for new resources to launch.
- IsAuto boolConfig 
- Automatically configure and optimize headroom resources.
- IsEnabled bool
- Enable the Ocean ECS autoscaler.
- ResourceLimits OceanAutoscaler Resource Limits 
- Optionally set upper and lower bounds on the resource usage of the cluster.
- ShouldScale boolDown Non Service Tasks 
- Option to scale down non-service tasks. If not set, Ocean does not scale down standalone tasks.
- autoHeadroom IntegerPercentage 
- The auto-headroom percentage. Set a number between 0-200 to control the headroom % of the cluster. Relevant when isAutoConfig= true.
- cooldown Integer
- Cooldown period between scaling actions.
- down
OceanAutoscaler Down 
- Auto Scaling scale down operations.
- enableAutomatic BooleanAnd Manual Headroom 
- When set to true, both automatic and per custom launch specification manual headroom to be saved concurrently and independently in the cluster. prerequisite: isAutoConfig must be true
- headroom
OceanAutoscaler Headroom 
- Spare resource capacity management enabling fast assignment of tasks without waiting for new resources to launch.
- isAuto BooleanConfig 
- Automatically configure and optimize headroom resources.
- isEnabled Boolean
- Enable the Ocean ECS autoscaler.
- resourceLimits OceanAutoscaler Resource Limits 
- Optionally set upper and lower bounds on the resource usage of the cluster.
- shouldScale BooleanDown Non Service Tasks 
- Option to scale down non-service tasks. If not set, Ocean does not scale down standalone tasks.
- autoHeadroom numberPercentage 
- The auto-headroom percentage. Set a number between 0-200 to control the headroom % of the cluster. Relevant when isAutoConfig= true.
- cooldown number
- Cooldown period between scaling actions.
- down
OceanAutoscaler Down 
- Auto Scaling scale down operations.
- enableAutomatic booleanAnd Manual Headroom 
- When set to true, both automatic and per custom launch specification manual headroom to be saved concurrently and independently in the cluster. prerequisite: isAutoConfig must be true
- headroom
OceanAutoscaler Headroom 
- Spare resource capacity management enabling fast assignment of tasks without waiting for new resources to launch.
- isAuto booleanConfig 
- Automatically configure and optimize headroom resources.
- isEnabled boolean
- Enable the Ocean ECS autoscaler.
- resourceLimits OceanAutoscaler Resource Limits 
- Optionally set upper and lower bounds on the resource usage of the cluster.
- shouldScale booleanDown Non Service Tasks 
- Option to scale down non-service tasks. If not set, Ocean does not scale down standalone tasks.
- auto_headroom_ intpercentage 
- The auto-headroom percentage. Set a number between 0-200 to control the headroom % of the cluster. Relevant when isAutoConfig= true.
- cooldown int
- Cooldown period between scaling actions.
- down
OceanAutoscaler Down 
- Auto Scaling scale down operations.
- enable_automatic_ booland_ manual_ headroom 
- When set to true, both automatic and per custom launch specification manual headroom to be saved concurrently and independently in the cluster. prerequisite: isAutoConfig must be true
- headroom
OceanAutoscaler Headroom 
- Spare resource capacity management enabling fast assignment of tasks without waiting for new resources to launch.
- is_auto_ boolconfig 
- Automatically configure and optimize headroom resources.
- is_enabled bool
- Enable the Ocean ECS autoscaler.
- resource_limits OceanAutoscaler Resource Limits 
- Optionally set upper and lower bounds on the resource usage of the cluster.
- should_scale_ booldown_ non_ service_ tasks 
- Option to scale down non-service tasks. If not set, Ocean does not scale down standalone tasks.
- autoHeadroom NumberPercentage 
- The auto-headroom percentage. Set a number between 0-200 to control the headroom % of the cluster. Relevant when isAutoConfig= true.
- cooldown Number
- Cooldown period between scaling actions.
- down Property Map
- Auto Scaling scale down operations.
- enableAutomatic BooleanAnd Manual Headroom 
- When set to true, both automatic and per custom launch specification manual headroom to be saved concurrently and independently in the cluster. prerequisite: isAutoConfig must be true
- headroom Property Map
- Spare resource capacity management enabling fast assignment of tasks without waiting for new resources to launch.
- isAuto BooleanConfig 
- Automatically configure and optimize headroom resources.
- isEnabled Boolean
- Enable the Ocean ECS autoscaler.
- resourceLimits Property Map
- Optionally set upper and lower bounds on the resource usage of the cluster.
- shouldScale BooleanDown Non Service Tasks 
- Option to scale down non-service tasks. If not set, Ocean does not scale down standalone tasks.
OceanAutoscalerDown, OceanAutoscalerDownArgs      
- MaxScale doubleDown Percentage 
- Would represent the maximum % to scale-down. Number between 1-100.
- MaxScale float64Down Percentage 
- Would represent the maximum % to scale-down. Number between 1-100.
- maxScale DoubleDown Percentage 
- Would represent the maximum % to scale-down. Number between 1-100.
- maxScale numberDown Percentage 
- Would represent the maximum % to scale-down. Number between 1-100.
- max_scale_ floatdown_ percentage 
- Would represent the maximum % to scale-down. Number between 1-100.
- maxScale NumberDown Percentage 
- Would represent the maximum % to scale-down. Number between 1-100.
OceanAutoscalerHeadroom, OceanAutoscalerHeadroomArgs      
- CpuPer intUnit 
- Optionally configure the number of CPUs to allocate the headroom. CPUs are denoted in millicores, where 1000 millicores = 1 vCPU.
- MemoryPer intUnit 
- Optionally configure the amount of memory (MB) to allocate the headroom.
- NumOf intUnits 
- The number of units to retain as headroom, where each unit has the defined headroom CPU and memory.
- CpuPer intUnit 
- Optionally configure the number of CPUs to allocate the headroom. CPUs are denoted in millicores, where 1000 millicores = 1 vCPU.
- MemoryPer intUnit 
- Optionally configure the amount of memory (MB) to allocate the headroom.
- NumOf intUnits 
- The number of units to retain as headroom, where each unit has the defined headroom CPU and memory.
- cpuPer IntegerUnit 
- Optionally configure the number of CPUs to allocate the headroom. CPUs are denoted in millicores, where 1000 millicores = 1 vCPU.
- memoryPer IntegerUnit 
- Optionally configure the amount of memory (MB) to allocate the headroom.
- numOf IntegerUnits 
- The number of units to retain as headroom, where each unit has the defined headroom CPU and memory.
- cpuPer numberUnit 
- Optionally configure the number of CPUs to allocate the headroom. CPUs are denoted in millicores, where 1000 millicores = 1 vCPU.
- memoryPer numberUnit 
- Optionally configure the amount of memory (MB) to allocate the headroom.
- numOf numberUnits 
- The number of units to retain as headroom, where each unit has the defined headroom CPU and memory.
- cpu_per_ intunit 
- Optionally configure the number of CPUs to allocate the headroom. CPUs are denoted in millicores, where 1000 millicores = 1 vCPU.
- memory_per_ intunit 
- Optionally configure the amount of memory (MB) to allocate the headroom.
- num_of_ intunits 
- The number of units to retain as headroom, where each unit has the defined headroom CPU and memory.
- cpuPer NumberUnit 
- Optionally configure the number of CPUs to allocate the headroom. CPUs are denoted in millicores, where 1000 millicores = 1 vCPU.
- memoryPer NumberUnit 
- Optionally configure the amount of memory (MB) to allocate the headroom.
- numOf NumberUnits 
- The number of units to retain as headroom, where each unit has the defined headroom CPU and memory.
OceanAutoscalerResourceLimits, OceanAutoscalerResourceLimitsArgs        
- MaxMemory intGib 
- The maximum memory in GiB units that can be allocated to the cluster.
- MaxVcpu int
- The maximum cpu in vCPU units that can be allocated to the cluster.
- MaxMemory intGib 
- The maximum memory in GiB units that can be allocated to the cluster.
- MaxVcpu int
- The maximum cpu in vCPU units that can be allocated to the cluster.
- maxMemory IntegerGib 
- The maximum memory in GiB units that can be allocated to the cluster.
- maxVcpu Integer
- The maximum cpu in vCPU units that can be allocated to the cluster.
- maxMemory numberGib 
- The maximum memory in GiB units that can be allocated to the cluster.
- maxVcpu number
- The maximum cpu in vCPU units that can be allocated to the cluster.
- max_memory_ intgib 
- The maximum memory in GiB units that can be allocated to the cluster.
- max_vcpu int
- The maximum cpu in vCPU units that can be allocated to the cluster.
- maxMemory NumberGib 
- The maximum memory in GiB units that can be allocated to the cluster.
- maxVcpu Number
- The maximum cpu in vCPU units that can be allocated to the cluster.
OceanBlockDeviceMapping, OceanBlockDeviceMappingArgs        
- DeviceName string
- String. Set device name. Example: /dev/xvda1.
- Ebs
Pulumi.Spot Inst. Ecs. Inputs. Ocean Block Device Mapping Ebs 
- Object. Set Elastic Block Store properties.
- NoDevice string
- String. Suppresses the specified device included in the block device mapping of the AMI.
- VirtualName string
- DeviceName string
- String. Set device name. Example: /dev/xvda1.
- Ebs
OceanBlock Device Mapping Ebs 
- Object. Set Elastic Block Store properties.
- NoDevice string
- String. Suppresses the specified device included in the block device mapping of the AMI.
- VirtualName string
- deviceName String
- String. Set device name. Example: /dev/xvda1.
- ebs
OceanBlock Device Mapping Ebs 
- Object. Set Elastic Block Store properties.
- noDevice String
- String. Suppresses the specified device included in the block device mapping of the AMI.
- virtualName String
- deviceName string
- String. Set device name. Example: /dev/xvda1.
- ebs
OceanBlock Device Mapping Ebs 
- Object. Set Elastic Block Store properties.
- noDevice string
- String. Suppresses the specified device included in the block device mapping of the AMI.
- virtualName string
- device_name str
- String. Set device name. Example: /dev/xvda1.
- ebs
OceanBlock Device Mapping Ebs 
- Object. Set Elastic Block Store properties.
- no_device str
- String. Suppresses the specified device included in the block device mapping of the AMI.
- virtual_name str
- deviceName String
- String. Set device name. Example: /dev/xvda1.
- ebs Property Map
- Object. Set Elastic Block Store properties.
- noDevice String
- String. Suppresses the specified device included in the block device mapping of the AMI.
- virtualName String
OceanBlockDeviceMappingEbs, OceanBlockDeviceMappingEbsArgs          
- DeleteOn boolTermination 
- Boolean. Toggles EBS deletion upon instance termination.
- DynamicVolume Pulumi.Size Spot Inst. Ecs. Inputs. Ocean Block Device Mapping Ebs Dynamic Volume Size 
- 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
- Int. The number of I/O operations per second (IOPS) that the volume supports.
- KmsKey stringId 
- 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.
- DeleteOn boolTermination 
- Boolean. Toggles EBS deletion upon instance termination.
- DynamicVolume OceanSize Block Device Mapping Ebs Dynamic Volume Size 
- 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
- Int. The number of I/O operations per second (IOPS) that the volume supports.
- KmsKey stringId 
- 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.
- deleteOn BooleanTermination 
- Boolean. Toggles EBS deletion upon instance termination.
- dynamicVolume OceanSize Block Device Mapping Ebs Dynamic Volume Size 
- 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
- Int. The number of I/O operations per second (IOPS) that the volume supports.
- kmsKey StringId 
- 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.
- deleteOn booleanTermination 
- Boolean. Toggles EBS deletion upon instance termination.
- dynamicVolume OceanSize Block Device Mapping Ebs Dynamic Volume Size 
- 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
- Int. The number of I/O operations per second (IOPS) that the volume supports.
- kmsKey stringId 
- 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_ booltermination 
- Boolean. Toggles EBS deletion upon instance termination.
- dynamic_volume_ Oceansize Block Device Mapping Ebs Dynamic Volume Size 
- 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
- Int. The number of I/O operations per second (IOPS) that the volume supports.
- kms_key_ strid 
- 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.
- deleteOn BooleanTermination 
- Boolean. Toggles EBS deletion upon instance termination.
- dynamicVolume Property MapSize 
- 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
- Int. The number of I/O operations per second (IOPS) that the volume supports.
- kmsKey StringId 
- 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.
OceanBlockDeviceMappingEbsDynamicVolumeSize, OceanBlockDeviceMappingEbsDynamicVolumeSizeArgs                
- BaseSize int
- Int. Initial size for volume. Example: 50.
- Resource string
- String. Resource type to increase volume size dynamically by. Valid values: CPU.
- SizePer intResource Unit 
- Int. Additional size (in GB) per resource unit. Example: When the baseSize=50,sizePerResourceUnit=20, and instance with two CPUs is launched, its total disk size will be: 90GB.
- BaseSize int
- Int. Initial size for volume. Example: 50.
- Resource string
- String. Resource type to increase volume size dynamically by. Valid values: CPU.
- SizePer intResource Unit 
- Int. Additional size (in GB) per resource unit. Example: When the baseSize=50,sizePerResourceUnit=20, and instance with two CPUs is launched, its total disk size will be: 90GB.
- baseSize Integer
- Int. Initial size for volume. Example: 50.
- resource String
- String. Resource type to increase volume size dynamically by. Valid values: CPU.
- sizePer IntegerResource Unit 
- Int. Additional size (in GB) per resource unit. Example: When the baseSize=50,sizePerResourceUnit=20, and instance with two CPUs is launched, its total disk size will be: 90GB.
- baseSize number
- Int. Initial size for volume. Example: 50.
- resource string
- String. Resource type to increase volume size dynamically by. Valid values: CPU.
- sizePer numberResource Unit 
- Int. Additional size (in GB) per resource unit. Example: When the baseSize=50,sizePerResourceUnit=20, and instance with two CPUs is launched, its total disk size will be: 90GB.
- base_size int
- Int. Initial size for volume. Example: 50.
- resource str
- String. Resource type to increase volume size dynamically by. Valid values: CPU.
- size_per_ intresource_ unit 
- Int. Additional size (in GB) per resource unit. Example: When the baseSize=50,sizePerResourceUnit=20, and instance with two CPUs is launched, its total disk size will be: 90GB.
- baseSize Number
- Int. Initial size for volume. Example: 50.
- resource String
- String. Resource type to increase volume size dynamically by. Valid values: CPU.
- sizePer NumberResource Unit 
- Int. Additional size (in GB) per resource unit. Example: When the baseSize=50,sizePerResourceUnit=20, and instance with two CPUs is launched, its total disk size will be: 90GB.
OceanClusterOrientation, OceanClusterOrientationArgs      
- AvailabilityVs stringCost 
- You can control the approach that Ocean takes while launching nodes by configuring this value. Possible values: costOriented,balanced,cheapest.
- AvailabilityVs stringCost 
- You can control the approach that Ocean takes while launching nodes by configuring this value. Possible values: costOriented,balanced,cheapest.
- availabilityVs StringCost 
- You can control the approach that Ocean takes while launching nodes by configuring this value. Possible values: costOriented,balanced,cheapest.
- availabilityVs stringCost 
- You can control the approach that Ocean takes while launching nodes by configuring this value. Possible values: costOriented,balanced,cheapest.
- availability_vs_ strcost 
- You can control the approach that Ocean takes while launching nodes by configuring this value. Possible values: costOriented,balanced,cheapest.
- availabilityVs StringCost 
- 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.
- IsEna stringSupported 
- Ena is supported or not.
- MaxGpu int
- Maximum total number of GPUs.
- MaxMemory doubleGib 
- MaxNetwork intPerformance 
- Maximum Bandwidth in Gib/s of network performance.
- MaxVcpu int
- MinEnis int
- Minimum number of network interfaces (ENIs).
- MinGpu int
- Minimum total number of GPUs.
- MinMemory doubleGib 
- Minimum amount of Memory (GiB).
- MinNetwork intPerformance 
- Minimum Bandwidth in Gib/s of network performance.
- MinVcpu int
- Minimum number of vcpus available.
- RootDevice List<string>Types 
- 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.
- IsEna stringSupported 
- Ena is supported or not.
- MaxGpu int
- Maximum total number of GPUs.
- MaxMemory float64Gib 
- MaxNetwork intPerformance 
- Maximum Bandwidth in Gib/s of network performance.
- MaxVcpu int
- MinEnis int
- Minimum number of network interfaces (ENIs).
- MinGpu int
- Minimum total number of GPUs.
- MinMemory float64Gib 
- Minimum amount of Memory (GiB).
- MinNetwork intPerformance 
- Minimum Bandwidth in Gib/s of network performance.
- MinVcpu int
- Minimum number of vcpus available.
- RootDevice []stringTypes 
- 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.
- isEna StringSupported 
- Ena is supported or not.
- maxGpu Integer
- Maximum total number of GPUs.
- maxMemory DoubleGib 
- maxNetwork IntegerPerformance 
- Maximum Bandwidth in Gib/s of network performance.
- maxVcpu Integer
- minEnis Integer
- Minimum number of network interfaces (ENIs).
- minGpu Integer
- Minimum total number of GPUs.
- minMemory DoubleGib 
- Minimum amount of Memory (GiB).
- minNetwork IntegerPerformance 
- Minimum Bandwidth in Gib/s of network performance.
- minVcpu Integer
- Minimum number of vcpus available.
- rootDevice List<String>Types 
- 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.
- isEna stringSupported 
- Ena is supported or not.
- maxGpu number
- Maximum total number of GPUs.
- maxMemory numberGib 
- maxNetwork numberPerformance 
- Maximum Bandwidth in Gib/s of network performance.
- maxVcpu number
- minEnis number
- Minimum number of network interfaces (ENIs).
- minGpu number
- Minimum total number of GPUs.
- minMemory numberGib 
- Minimum amount of Memory (GiB).
- minNetwork numberPerformance 
- Minimum Bandwidth in Gib/s of network performance.
- minVcpu number
- Minimum number of vcpus available.
- rootDevice string[]Types 
- 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_ strsupported 
- Ena is supported or not.
- max_gpu int
- Maximum total number of GPUs.
- max_memory_ floatgib 
- max_network_ intperformance 
- Maximum Bandwidth in Gib/s of network performance.
- max_vcpu int
- min_enis int
- Minimum number of network interfaces (ENIs).
- min_gpu int
- Minimum total number of GPUs.
- min_memory_ floatgib 
- Minimum amount of Memory (GiB).
- min_network_ intperformance 
- Minimum Bandwidth in Gib/s of network performance.
- min_vcpu int
- Minimum number of vcpus available.
- root_device_ Sequence[str]types 
- 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.
- isEna StringSupported 
- Ena is supported or not.
- maxGpu Number
- Maximum total number of GPUs.
- maxMemory NumberGib 
- maxNetwork NumberPerformance 
- Maximum Bandwidth in Gib/s of network performance.
- maxVcpu Number
- minEnis Number
- Minimum number of network interfaces (ENIs).
- minGpu Number
- Minimum total number of GPUs.
- minMemory NumberGib 
- Minimum amount of Memory (GiB).
- minNetwork NumberPerformance 
- Minimum Bandwidth in Gib/s of network performance.
- minVcpu Number
- Minimum number of vcpus available.
- rootDevice List<String>Types 
- 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: optionalorrequired.
- HttpPut intResponse Hop Limit 
- 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: optionalorrequired.
- HttpPut intResponse Hop Limit 
- 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: optionalorrequired.
- httpPut IntegerResponse Hop Limit 
- 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: optionalorrequired.
- httpPut numberResponse Hop Limit 
- 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: optionalorrequired.
- http_put_ intresponse_ hop_ limit 
- 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: optionalorrequired.
- httpPut NumberResponse Hop Limit 
- 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.
OceanLogging, OceanLoggingArgs    
- Export
Pulumi.Spot Inst. Ecs. Inputs. Ocean Logging Export 
- Logging Export configuration.
- Export
OceanLogging Export 
- Logging Export configuration.
- export
OceanLogging Export 
- Logging Export configuration.
- export
OceanLogging Export 
- Logging Export configuration.
- export
OceanLogging Export 
- Logging Export configuration.
- export Property Map
- Logging Export configuration.
OceanLoggingExport, OceanLoggingExportArgs      
- S3s
List<Pulumi.Spot Inst. Ecs. Inputs. Ocean Logging Export S3> 
- Exports your cluster's logs to the S3 bucket and subdir configured on the S3 data integration given.
- S3s
[]OceanLogging Export S3 
- Exports your cluster's logs to the S3 bucket and subdir configured on the S3 data integration given.
- s3s
List<OceanLogging Export S3> 
- Exports your cluster's logs to the S3 bucket and subdir configured on the S3 data integration given.
- s3s
OceanLogging Export S3[] 
- Exports your cluster's logs to the S3 bucket and subdir configured on the S3 data integration given.
- s3s
Sequence[OceanLogging Export S3] 
- 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.
OceanOptimizeImages, OceanOptimizeImagesArgs      
- PerformAt string
- String. Valid values: "always" "never" "timeWindow".
- ShouldOptimize boolEcs Ami 
- Boolean. Enable auto image (AMI) update for the ECS container instances. The auto update applies for ECS-Optimized AMIs.
- TimeWindows List<string>
- Array of strings. Set time windows for image update, at least one time window. Each string is in the format of ddd:hh:mm-ddd:hh:mm ddd. Time windows should not overlap.
- PerformAt string
- String. Valid values: "always" "never" "timeWindow".
- ShouldOptimize boolEcs Ami 
- Boolean. Enable auto image (AMI) update for the ECS container instances. The auto update applies for ECS-Optimized AMIs.
- TimeWindows []string
- Array of strings. Set time windows for image update, at least one time window. Each string is in the format of ddd:hh:mm-ddd:hh:mm ddd. Time windows should not overlap.
- performAt String
- String. Valid values: "always" "never" "timeWindow".
- shouldOptimize BooleanEcs Ami 
- Boolean. Enable auto image (AMI) update for the ECS container instances. The auto update applies for ECS-Optimized AMIs.
- timeWindows List<String>
- Array of strings. Set time windows for image update, at least one time window. Each string is in the format of ddd:hh:mm-ddd:hh:mm ddd. Time windows should not overlap.
- performAt string
- String. Valid values: "always" "never" "timeWindow".
- shouldOptimize booleanEcs Ami 
- Boolean. Enable auto image (AMI) update for the ECS container instances. The auto update applies for ECS-Optimized AMIs.
- timeWindows string[]
- Array of strings. Set time windows for image update, at least one time window. Each string is in the format of ddd:hh:mm-ddd:hh:mm ddd. Time windows should not overlap.
- perform_at str
- String. Valid values: "always" "never" "timeWindow".
- should_optimize_ boolecs_ ami 
- Boolean. Enable auto image (AMI) update for the ECS container instances. The auto update applies for ECS-Optimized AMIs.
- time_windows Sequence[str]
- Array of strings. Set time windows for image update, at least one time window. Each string is in the format of ddd:hh:mm-ddd:hh:mm ddd. Time windows should not overlap.
- performAt String
- String. Valid values: "always" "never" "timeWindow".
- shouldOptimize BooleanEcs Ami 
- Boolean. Enable auto image (AMI) update for the ECS container instances. The auto update applies for ECS-Optimized AMIs.
- timeWindows List<String>
- Array of strings. Set time windows for image update, at least one time window. Each string is in the format of ddd:hh:mm-ddd:hh:mm ddd. Time windows should not overlap.
OceanScheduledTask, OceanScheduledTaskArgs      
- ShutdownHours Pulumi.Spot Inst. Ecs. Inputs. Ocean Scheduled Task Shutdown Hours 
- Set shutdown hours for cluster object.
- Tasks
List<Pulumi.Spot Inst. Ecs. Inputs. Ocean Scheduled Task Task> 
- The scheduling tasks for the cluster.
- ShutdownHours OceanScheduled Task Shutdown Hours 
- Set shutdown hours for cluster object.
- Tasks
[]OceanScheduled Task Task 
- The scheduling tasks for the cluster.
- shutdownHours OceanScheduled Task Shutdown Hours 
- Set shutdown hours for cluster object.
- tasks
List<OceanScheduled Task Task> 
- The scheduling tasks for the cluster.
- shutdownHours OceanScheduled Task Shutdown Hours 
- Set shutdown hours for cluster object.
- tasks
OceanScheduled Task Task[] 
- The scheduling tasks for the cluster.
- shutdown_hours OceanScheduled Task Shutdown Hours 
- Set shutdown hours for cluster object.
- tasks
Sequence[OceanScheduled Task Task] 
- The scheduling tasks for the cluster.
- shutdownHours Property Map
- Set shutdown hours for cluster object.
- tasks List<Property Map>
- The scheduling tasks for the cluster.
OceanScheduledTaskShutdownHours, OceanScheduledTaskShutdownHoursArgs          
- TimeWindows List<string>
- Set time windows for shutdown hours. Specify a list of timeWindowswith at least one time window Each string is in the format ofddd:hh:mm-ddd:hh:mm(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 whencluster.scheduling.isEnabledis true. API Times are in UTC. Example:Fri:15:30-Wed:14:30.
- IsEnabled bool
- Flag to enable / disable the shutdown hours.
- TimeWindows []string
- Set time windows for shutdown hours. Specify a list of timeWindowswith at least one time window Each string is in the format ofddd:hh:mm-ddd:hh:mm(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 whencluster.scheduling.isEnabledis true. API Times are in UTC. Example:Fri:15:30-Wed:14:30.
- IsEnabled bool
- Flag to enable / disable the shutdown hours.
- timeWindows List<String>
- Set time windows for shutdown hours. Specify a list of timeWindowswith at least one time window Each string is in the format ofddd:hh:mm-ddd:hh:mm(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 whencluster.scheduling.isEnabledis true. API Times are in UTC. Example:Fri:15:30-Wed:14:30.
- isEnabled Boolean
- Flag to enable / disable the shutdown hours.
- timeWindows string[]
- Set time windows for shutdown hours. Specify a list of timeWindowswith at least one time window Each string is in the format ofddd:hh:mm-ddd:hh:mm(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 whencluster.scheduling.isEnabledis true. API Times are in UTC. Example:Fri:15:30-Wed:14:30.
- isEnabled boolean
- Flag to enable / disable the shutdown hours.
- time_windows Sequence[str]
- Set time windows for shutdown hours. Specify a list of timeWindowswith at least one time window Each string is in the format ofddd:hh:mm-ddd:hh:mm(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 whencluster.scheduling.isEnabledis true. API Times are in UTC. Example:Fri:15:30-Wed:14:30.
- is_enabled bool
- Flag to enable / disable the shutdown hours.
- timeWindows List<String>
- Set time windows for shutdown hours. Specify a list of timeWindowswith at least one time window Each string is in the format ofddd:hh:mm-ddd:hh:mm(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 whencluster.scheduling.isEnabledis true. API Times are in UTC. Example:Fri:15:30-Wed:14:30.
- isEnabled Boolean
- Flag to enable / disable the shutdown hours.
OceanScheduledTaskTask, OceanScheduledTaskTaskArgs        
- CronExpression string
- 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 frequencyorcronExpressionshould be used at a time. Required forcluster.scheduling.tasksobject. Example:0 1 * * *.
- IsEnabled bool
- Describes whether the task is enabled. When true the task should run when false it should not run. Required for cluster.scheduling.tasksobject.
- TaskType string
- Valid values: "clusterRoll". Required for cluster.scheduling.tasks object. Example:clusterRoll.
- CronExpression string
- 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 frequencyorcronExpressionshould be used at a time. Required forcluster.scheduling.tasksobject. Example:0 1 * * *.
- IsEnabled bool
- Describes whether the task is enabled. When true the task should run when false it should not run. Required for cluster.scheduling.tasksobject.
- TaskType string
- Valid values: "clusterRoll". Required for cluster.scheduling.tasks object. Example:clusterRoll.
- cronExpression String
- 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 frequencyorcronExpressionshould be used at a time. Required forcluster.scheduling.tasksobject. Example:0 1 * * *.
- isEnabled Boolean
- Describes whether the task is enabled. When true the task should run when false it should not run. Required for cluster.scheduling.tasksobject.
- taskType String
- Valid values: "clusterRoll". Required for cluster.scheduling.tasks object. Example:clusterRoll.
- cronExpression string
- 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 frequencyorcronExpressionshould be used at a time. Required forcluster.scheduling.tasksobject. Example:0 1 * * *.
- isEnabled boolean
- Describes whether the task is enabled. When true the task should run when false it should not run. Required for cluster.scheduling.tasksobject.
- taskType string
- Valid values: "clusterRoll". Required for cluster.scheduling.tasks object. Example:clusterRoll.
- cron_expression str
- 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 frequencyorcronExpressionshould be used at a time. Required forcluster.scheduling.tasksobject. Example:0 1 * * *.
- is_enabled bool
- Describes whether the task is enabled. When true the task should run when false it should not run. Required for cluster.scheduling.tasksobject.
- task_type str
- Valid values: "clusterRoll". Required for cluster.scheduling.tasks object. Example:clusterRoll.
- cronExpression String
- 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 frequencyorcronExpressionshould be used at a time. Required forcluster.scheduling.tasksobject. Example:0 1 * * *.
- isEnabled Boolean
- Describes whether the task is enabled. When true the task should run when false it should not run. Required for cluster.scheduling.tasksobject.
- taskType String
- Valid values: "clusterRoll". Required for cluster.scheduling.tasks object. Example:clusterRoll.
OceanTag, OceanTagArgs    
OceanUpdatePolicy, OceanUpdatePolicyArgs      
- ShouldRoll bool
- Enables the roll.
- bool
- will update instance tags on the fly without rolling the cluster.
- ConditionedRoll bool
- 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).
- RollConfig Pulumi.Spot Inst. Ecs. Inputs. Ocean Update Policy Roll Config 
- ShouldRoll bool
- Enables the roll.
- bool
- will update instance tags on the fly without rolling the cluster.
- ConditionedRoll bool
- 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).
- RollConfig OceanUpdate Policy Roll Config 
- shouldRoll Boolean
- Enables the roll.
- Boolean
- will update instance tags on the fly without rolling the cluster.
- conditionedRoll Boolean
- 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).
- rollConfig OceanUpdate Policy Roll Config 
- shouldRoll boolean
- Enables the roll.
- boolean
- will update instance tags on the fly without rolling the cluster.
- conditionedRoll boolean
- 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).
- rollConfig OceanUpdate Policy Roll Config 
- should_roll bool
- Enables the roll.
- bool
- will update instance tags on the fly without rolling the cluster.
- conditioned_roll bool
- 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).
- roll_config OceanUpdate Policy Roll Config 
- shouldRoll Boolean
- Enables the roll.
- Boolean
- will update instance tags on the fly without rolling the cluster.
- conditionedRoll Boolean
- 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).
- rollConfig Property Map
OceanUpdatePolicyRollConfig, OceanUpdatePolicyRollConfigArgs          
- BatchSize intPercentage 
- Sets the percentage of the instances to deploy in each batch.
- BatchMin intHealthy Percentage 
- 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.
- BatchSize intPercentage 
- Sets the percentage of the instances to deploy in each batch.
- BatchMin intHealthy Percentage 
- 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.
- batchSize IntegerPercentage 
- Sets the percentage of the instances to deploy in each batch.
- batchMin IntegerHealthy Percentage 
- 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.
- batchSize numberPercentage 
- Sets the percentage of the instances to deploy in each batch.
- batchMin numberHealthy Percentage 
- 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_ intpercentage 
- Sets the percentage of the instances to deploy in each batch.
- batch_min_ inthealthy_ percentage 
- 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.
- batchSize NumberPercentage 
- Sets the percentage of the instances to deploy in each batch.
- batchMin NumberHealthy Percentage 
- 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.
Import
Clusters can be imported using the Ocean id, e.g.,
hcl
$ pulumi import spotinst:ecs/ocean:Ocean nameOfTheResource 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 spotinstTerraform Provider.