software.amazon.awscdk.services.ecs

Class EcsOptimizedImageOptions.Builder

java.lang.Object

software.amazon.awscdk.services.ecs.EcsOptimizedImageOptions.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<EcsOptimizedImageOptions>

Enclosing interface:

EcsOptimizedImageOptions

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

A builder for EcsOptimizedImageOptions

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
EcsOptimizedImageOptions	build() Builds the configured instance.
EcsOptimizedImageOptions.Builder	cachedInContext(Boolean cachedInContext) Sets the value of EcsOptimizedImageOptions.getCachedInContext()

Methods inherited from class java.lang.Object

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

Constructor Detail

Builder

public Builder()

Method Detail

cachedInContext

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

Sets the value of EcsOptimizedImageOptions.getCachedInContext()

Parameters:

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.

Returns:

this

build

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

Builds the configured instance.

Specified by:

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

Returns:

a new instance of EcsOptimizedImageOptions

Throws:

NullPointerException - if any required attribute was not provided