software.amazon.awscdk.cloudassembly.schema

Class AwsCloudFormationStackProperties.Builder

java.lang.Object

software.amazon.awscdk.cloudassembly.schema.AwsCloudFormationStackProperties.Builder

Enclosing interface:

AwsCloudFormationStackProperties

public static final class AwsCloudFormationStackProperties.Builder
extends java.lang.Object

A builder for AwsCloudFormationStackProperties

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
AwsCloudFormationStackProperties.Builder	assumeRoleArn(java.lang.String assumeRoleArn) Sets the value of AwsCloudFormationStackProperties.getAssumeRoleArn()
AwsCloudFormationStackProperties.Builder	assumeRoleExternalId(java.lang.String assumeRoleExternalId) Sets the value of AwsCloudFormationStackProperties.getAssumeRoleExternalId()
AwsCloudFormationStackProperties.Builder	bootstrapStackVersionSsmParameter(java.lang.String bootstrapStackVersionSsmParameter) Sets the value of AwsCloudFormationStackProperties.getBootstrapStackVersionSsmParameter()
AwsCloudFormationStackProperties	build() Builds the configured instance.
AwsCloudFormationStackProperties.Builder	cloudFormationExecutionRoleArn(java.lang.String cloudFormationExecutionRoleArn) Sets the value of AwsCloudFormationStackProperties.getCloudFormationExecutionRoleArn()
AwsCloudFormationStackProperties.Builder	lookupRole(BootstrapRole lookupRole) Sets the value of AwsCloudFormationStackProperties.getLookupRole()
AwsCloudFormationStackProperties.Builder	parameters(java.util.Map<java.lang.String,java.lang.String> parameters) Sets the value of AwsCloudFormationStackProperties.getParameters()
AwsCloudFormationStackProperties.Builder	requiresBootstrapStackVersion(java.lang.Number requiresBootstrapStackVersion) Sets the value of AwsCloudFormationStackProperties.getRequiresBootstrapStackVersion()
AwsCloudFormationStackProperties.Builder	stackName(java.lang.String stackName) Sets the value of AwsCloudFormationStackProperties.getStackName()
AwsCloudFormationStackProperties.Builder	stackTemplateAssetObjectUrl(java.lang.String stackTemplateAssetObjectUrl) Sets the value of AwsCloudFormationStackProperties.getStackTemplateAssetObjectUrl()
AwsCloudFormationStackProperties.Builder	tags(java.util.Map<java.lang.String,java.lang.String> tags) Sets the value of AwsCloudFormationStackProperties.getTags()
AwsCloudFormationStackProperties.Builder	templateFile(java.lang.String templateFile) Sets the value of AwsCloudFormationStackProperties.getTemplateFile()
AwsCloudFormationStackProperties.Builder	terminationProtection(java.lang.Boolean terminationProtection) Sets the value of AwsCloudFormationStackProperties.getTerminationProtection()
AwsCloudFormationStackProperties.Builder	validateOnSynth(java.lang.Boolean validateOnSynth) Sets the value of AwsCloudFormationStackProperties.getValidateOnSynth()

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

templateFile

public AwsCloudFormationStackProperties.Builder templateFile(java.lang.String templateFile)

Sets the value of AwsCloudFormationStackProperties.getTemplateFile()

Parameters:

templateFile - A file relative to the assembly root which contains the CloudFormation template for this stack. This parameter is required.

Returns:

this

assumeRoleArn

public AwsCloudFormationStackProperties.Builder assumeRoleArn(java.lang.String assumeRoleArn)

Sets the value of AwsCloudFormationStackProperties.getAssumeRoleArn()

Parameters:

assumeRoleArn - The role that needs to be assumed to deploy the stack.

Returns:

this

assumeRoleExternalId

public AwsCloudFormationStackProperties.Builder assumeRoleExternalId(java.lang.String assumeRoleExternalId)

Sets the value of AwsCloudFormationStackProperties.getAssumeRoleExternalId()

Parameters:

assumeRoleExternalId - External ID to use when assuming role for cloudformation deployments.

Returns:

this

bootstrapStackVersionSsmParameter

public AwsCloudFormationStackProperties.Builder bootstrapStackVersionSsmParameter(java.lang.String bootstrapStackVersionSsmParameter)

Sets the value of AwsCloudFormationStackProperties.getBootstrapStackVersionSsmParameter()

Parameters:

bootstrapStackVersionSsmParameter - SSM parameter where the bootstrap stack version number can be found. Only used if requiresBootstrapStackVersion is set.

• If this value is not set, the bootstrap stack name must be known at deployment time so the stack version can be looked up from the stack outputs.
• If this value is set, the bootstrap stack can have any name because we won't need to look it up.

Returns:

this

cloudFormationExecutionRoleArn

public AwsCloudFormationStackProperties.Builder cloudFormationExecutionRoleArn(java.lang.String cloudFormationExecutionRoleArn)

Sets the value of AwsCloudFormationStackProperties.getCloudFormationExecutionRoleArn()

Parameters:

cloudFormationExecutionRoleArn - The role that is passed to CloudFormation to execute the change set.

Returns:

this

lookupRole

public AwsCloudFormationStackProperties.Builder lookupRole(BootstrapRole lookupRole)

Sets the value of AwsCloudFormationStackProperties.getLookupRole()

Parameters:

lookupRole - The role to use to look up values from the target AWS account.

Returns:

this

parameters

public AwsCloudFormationStackProperties.Builder parameters(java.util.Map<java.lang.String,java.lang.String> parameters)

Sets the value of AwsCloudFormationStackProperties.getParameters()

Parameters:

parameters - Values for CloudFormation stack parameters that should be passed when the stack is deployed.

Returns:

this

requiresBootstrapStackVersion

public AwsCloudFormationStackProperties.Builder requiresBootstrapStackVersion(java.lang.Number requiresBootstrapStackVersion)

Sets the value of AwsCloudFormationStackProperties.getRequiresBootstrapStackVersion()

Parameters:

requiresBootstrapStackVersion - Version of bootstrap stack required to deploy this stack.

Returns:

this

stackName

public AwsCloudFormationStackProperties.Builder stackName(java.lang.String stackName)

Sets the value of AwsCloudFormationStackProperties.getStackName()

Parameters:

stackName - The name to use for the CloudFormation stack.

Returns:

this

stackTemplateAssetObjectUrl

public AwsCloudFormationStackProperties.Builder stackTemplateAssetObjectUrl(java.lang.String stackTemplateAssetObjectUrl)

Sets the value of AwsCloudFormationStackProperties.getStackTemplateAssetObjectUrl()

Parameters:

stackTemplateAssetObjectUrl - If the stack template has already been included in the asset manifest, its asset URL.

Returns:

this

tags

public AwsCloudFormationStackProperties.Builder tags(java.util.Map<java.lang.String,java.lang.String> tags)

Sets the value of AwsCloudFormationStackProperties.getTags()

Parameters:

tags - Values for CloudFormation stack tags that should be passed when the stack is deployed.

Returns:

this

terminationProtection

public AwsCloudFormationStackProperties.Builder terminationProtection(java.lang.Boolean terminationProtection)

Sets the value of AwsCloudFormationStackProperties.getTerminationProtection()

Parameters:

terminationProtection - Whether to enable termination protection for this stack.

Returns:

this

validateOnSynth

public AwsCloudFormationStackProperties.Builder validateOnSynth(java.lang.Boolean validateOnSynth)

Sets the value of AwsCloudFormationStackProperties.getValidateOnSynth()

Parameters:

validateOnSynth - Whether this stack should be validated by the CLI after synthesis.

Returns:

this

build

public AwsCloudFormationStackProperties build()

Builds the configured instance.

Returns:

a new instance of AwsCloudFormationStackProperties

Throws:

java.lang.NullPointerException - if any required attribute was not provided