Package software.amazon.awscdk.services.ecs

Interface BottleRocketImageProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

BottleRocketImageProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.119.0 (build 1634eac)",
           date="2025-11-17T14:40:50.290Z")
@Stability(Stable)
public interface BottleRocketImageProps
extends software.amazon.jsii.JsiiSerializable

Properties for BottleRocketImage.

Example:

 Cluster cluster;
 cluster.addCapacity("bottlerocket-asg", AddCapacityOptions.builder()
         .instanceType(new InstanceType("p3.2xlarge"))
         .machineImage(BottleRocketImage.Builder.create()
                 .variant(BottlerocketEcsVariant.AWS_ECS_2_NVIDIA)
                 .build())
         .build());
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	BottleRocketImageProps.Builder	A builder for BottleRocketImageProps
static final class	BottleRocketImageProps.Jsii$Proxy	An implementation for BottleRocketImageProps

Method Summary

Modifier and Type	Method	Description
static BottleRocketImageProps.Builder	builder()
default String	getAdditionalCacheKey()	Adds an additional discriminator to the cdk.context.json cache key.
default InstanceArchitecture	getArchitecture()	The CPU architecture.
default Boolean	getCachedInContext()	Whether the AMI ID is cached to be stable between deployments.
default BottlerocketEcsVariant	getVariant()	The Amazon ECS variant to use.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getAdditionalCacheKey

@Stability(Stable)
@Nullable
default String getAdditionalCacheKey()

Adds an additional discriminator to the cdk.context.json cache key.

Default: - no additional cache key

getArchitecture

@Stability(Stable)
@Nullable
default InstanceArchitecture getArchitecture()

The CPU architecture.

Default: - x86_64

getCachedInContext

@Stability(Stable)
@Nullable
default Boolean getCachedInContext()

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

getVariant

@Stability(Stable)
@Nullable
default BottlerocketEcsVariant getVariant()

The Amazon ECS variant to use.

Default: - BottlerocketEcsVariant.AWS_ECS_1

builder

@Stability(Stable)
static BottleRocketImageProps.Builder builder()

Returns:

a BottleRocketImageProps.Builder of BottleRocketImageProps