software.amazon.awscdk.services.ecs

Class BottleRocketImage.Builder

java.lang.Object

software.amazon.awscdk.services.ecs.BottleRocketImage.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<BottleRocketImage>

Enclosing class:

BottleRocketImage

@Stability(value=Stable)
public static final class BottleRocketImage.Builder
extends Object
implements software.amazon.jsii.Builder<BottleRocketImage>

A fluent builder for BottleRocketImage.

Method Summary

Modifier and Type	Method and Description
BottleRocketImage.Builder	architecture(InstanceArchitecture architecture) The CPU architecture.
BottleRocketImage	build()
BottleRocketImage.Builder	cachedInContext(Boolean cachedInContext) Whether the AMI ID is cached to be stable between deployments.
static BottleRocketImage.Builder	create()
BottleRocketImage.Builder	variant(BottlerocketEcsVariant variant) The Amazon ECS variant to use.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

create

@Stability(value=Stable)
public static BottleRocketImage.Builder create()

Returns:

a new instance of BottleRocketImage.Builder.

architecture

@Stability(value=Stable)
public BottleRocketImage.Builder architecture(InstanceArchitecture architecture)

The CPU architecture.

Default: - x86_64

Parameters:

architecture - The CPU architecture. This parameter is required.

Returns:

this

cachedInContext

@Stability(value=Stable)
public BottleRocketImage.Builder cachedInContext(Boolean cachedInContext)

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

Parameters:

cachedInContext - Whether the AMI ID is cached to be stable between deployments. This parameter is required.

Returns:

this

variant

@Stability(value=Stable)
public BottleRocketImage.Builder variant(BottlerocketEcsVariant variant)

The Amazon ECS variant to use.

Only aws-ecs-1 is currently available

Default: - BottlerocketEcsVariant.AWS_ECS_1

Parameters:

variant - The Amazon ECS variant to use. This parameter is required.

Returns:

this

build

@Stability(value=Stable)
public BottleRocketImage build()

Specified by:

build in interface software.amazon.jsii.Builder<BottleRocketImage>