EcsOptimizedAmiProps

class aws_cdk.aws_ecs.EcsOptimizedAmiProps(*, cached_in_context=None, generation=None, hardware_type=None, windows_version=None)

Bases: object

(deprecated) The properties that define which ECS-optimized AMI is used.

Parameters
  • cached_in_context (Optional[bool]) – (deprecated) Whether the AMI ID is cached to be stable between deployments. By default, the newest image is used on each deployment. This will cause instances to be replaced whenever a new version is released, and may cause downtime if there aren’t enough running instances in the AutoScalingGroup to reschedule the tasks on. If set to true, the AMI ID will be cached in cdk.context.json and the same value will be used on future runs. Your instances will not be replaced but your AMI version will grow old over time. To refresh the AMI lookup, you will have to evict the value from the cache using the cdk context command. See https://docs.aws.amazon.com/cdk/latest/guide/context.html for more information. Can not be set to true in environment-agnostic stacks. Default: false

  • generation (Optional[AmazonLinuxGeneration]) – (deprecated) The Amazon Linux generation to use. Default: AmazonLinuxGeneration.AmazonLinux2

  • hardware_type (Optional[AmiHardwareType]) – (deprecated) The ECS-optimized AMI variant to use. Default: AmiHardwareType.Standard

  • windows_version (Optional[WindowsOptimizedVersion]) – (deprecated) The Windows Server version to use. Default: none, uses Linux generation

Deprecated

see {@link EcsOptimizedImage}

Stability

deprecated

Example:

# vpc is of type Vpc

my_compute_env = batch.ComputeEnvironment(self, "ComputeEnv",
    compute_resources=batch.ComputeResources(
        image=ecs.EcsOptimizedAmi(
            generation=ec2.AmazonLinuxGeneration.AMAZON_LINUX_2
        ),
        vpc=vpc
    )
)

Attributes

cached_in_context

(deprecated) Whether the AMI ID is cached to be stable between deployments.

By default, the newest image is used on each deployment. This will cause instances to be replaced whenever a new version is released, and may cause downtime if there aren’t enough running instances in the AutoScalingGroup to reschedule the tasks on.

If set to true, the AMI ID will be cached in cdk.context.json and the same value will be used on future runs. Your instances will not be replaced but your AMI version will grow old over time. To refresh the AMI lookup, you will have to evict the value from the cache using the cdk context command. See https://docs.aws.amazon.com/cdk/latest/guide/context.html for more information.

Can not be set to true in environment-agnostic stacks.

Default

false

Stability

deprecated

Return type

Optional[bool]

generation

(deprecated) The Amazon Linux generation to use.

Default

AmazonLinuxGeneration.AmazonLinux2

Stability

deprecated

Return type

Optional[AmazonLinuxGeneration]

hardware_type

(deprecated) The ECS-optimized AMI variant to use.

Default

AmiHardwareType.Standard

Stability

deprecated

Return type

Optional[AmiHardwareType]

windows_version

(deprecated) The Windows Server version to use.

Default

none, uses Linux generation

Stability

deprecated

Return type

Optional[WindowsOptimizedVersion]