Package software.amazon.awscdk.services.ec2

Class SsmParameterImageOptions.Builder

java.lang.Object

software.amazon.awscdk.services.ec2.SsmParameterImageOptions.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<SsmParameterImageOptions>

Enclosing interface:

SsmParameterImageOptions

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

A builder for SsmParameterImageOptions

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
SsmParameterImageOptions	build()	Builds the configured instance.
SsmParameterImageOptions.Builder	cachedInContext(Boolean cachedInContext)	Sets the value of SsmParameterImageOptions.getCachedInContext()
SsmParameterImageOptions.Builder	os(OperatingSystemType os)	Sets the value of SsmParameterImageOptions.getOs()
SsmParameterImageOptions.Builder	parameterVersion(String parameterVersion)	Sets the value of SsmParameterImageOptions.getParameterVersion()
SsmParameterImageOptions.Builder	userData(UserData userData)	Sets the value of SsmParameterImageOptions.getUserData()

Methods inherited from class java.lang.Object

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

Constructor Details

Builder

public Builder()

Method Details

cachedInContext

@Stability(Stable)
public SsmParameterImageOptions.Builder cachedInContext(Boolean cachedInContext)

Sets the value of SsmParameterImageOptions.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

os

@Stability(Stable)
public SsmParameterImageOptions.Builder os(OperatingSystemType os)

Sets the value of SsmParameterImageOptions.getOs()

Parameters:

os - Operating system.

Returns:

this

parameterVersion

@Stability(Stable)
public SsmParameterImageOptions.Builder parameterVersion(String parameterVersion)

Sets the value of SsmParameterImageOptions.getParameterVersion()

Parameters:

parameterVersion - The version of the SSM parameter.

Returns:

this

userData

@Stability(Stable)
public SsmParameterImageOptions.Builder userData(UserData userData)

Sets the value of SsmParameterImageOptions.getUserData()

Parameters:

userData - Custom UserData.

Returns:

this

build

@Stability(Stable)
public SsmParameterImageOptions build()

Builds the configured instance.

Specified by:

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

Returns:

a new instance of SsmParameterImageOptions

Throws:

NullPointerException - if any required attribute was not provided