BottleRocketImageProps

class aws_cdk.aws_ecs.BottleRocketImageProps(*, architecture=None, cached_in_context=None, variant=None)

Bases: object

Properties for BottleRocketImage.

Parameters

  • architecture (Optional[InstanceArchitecture]) – The CPU architecture. Default: - x86_64

  • cached_in_context (Optional[bool]) – 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

  • variant (Optional[BottlerocketEcsVariant]) – The Amazon ECS variant to use. Only aws-ecs-1 is currently available Default: - BottlerocketEcsVariant.AWS_ECS_1

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
import aws_cdk.aws_ec2 as ec2
import aws_cdk.aws_ecs as ecs

bottle_rocket_image_props = ecs.BottleRocketImageProps(
    architecture=ec2.InstanceArchitecture.ARM_64,
    cached_in_context=False,
    variant=ecs.BottlerocketEcsVariant.AWS_ECS_1
)

Attributes

architecture

The CPU architecture.

Default

  • x86_64

Return type

Optional[InstanceArchitecture]

cached_in_context

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

Return type

Optional[bool]

variant

The Amazon ECS variant to use.

Only aws-ecs-1 is currently available

Default

  • BottlerocketEcsVariant.AWS_ECS_1

Return type

Optional[BottlerocketEcsVariant]