Class AmazonLinuxImageSsmParameterBaseProps.Builder
java.lang.Object
software.amazon.awscdk.services.ec2.AmazonLinuxImageSsmParameterBaseProps.Builder
- All Implemented Interfaces:
software.amazon.jsii.Builder<AmazonLinuxImageSsmParameterBaseProps>
- Enclosing interface:
AmazonLinuxImageSsmParameterBaseProps
@Stability(Stable)
public static final class AmazonLinuxImageSsmParameterBaseProps.Builder
extends Object
implements software.amazon.jsii.Builder<AmazonLinuxImageSsmParameterBaseProps>
A builder for
AmazonLinuxImageSsmParameterBaseProps
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionbuild()
Builds the configured instance.cachedInContext
(Boolean cachedInContext) Sets the value ofAmazonLinuxImageSsmParameterBaseOptions.getCachedInContext()
parameterName
(String parameterName) Sets the value ofAmazonLinuxImageSsmParameterBaseProps.getParameterName()
Sets the value ofAmazonLinuxImageSsmParameterBaseOptions.getUserData()
-
Constructor Details
-
Builder
public Builder()
-
-
Method Details
-
parameterName
@Stability(Stable) public AmazonLinuxImageSsmParameterBaseProps.Builder parameterName(String parameterName) Sets the value ofAmazonLinuxImageSsmParameterBaseProps.getParameterName()
- Parameters:
parameterName
- The name of the SSM parameter that contains the AMI value. This parameter is required.- Returns:
this
-
cachedInContext
@Stability(Stable) public AmazonLinuxImageSsmParameterBaseProps.Builder cachedInContext(Boolean cachedInContext) Sets the value ofAmazonLinuxImageSsmParameterBaseOptions.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 thecdk 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
-
userData
Sets the value ofAmazonLinuxImageSsmParameterBaseOptions.getUserData()
- Parameters:
userData
- Initial user data.- Returns:
this
-
build
Builds the configured instance.- Specified by:
build
in interfacesoftware.amazon.jsii.Builder<AmazonLinuxImageSsmParameterBaseProps>
- Returns:
- a new instance of
AmazonLinuxImageSsmParameterBaseProps
- Throws:
NullPointerException
- if any required attribute was not provided
-