Package software.amazon.awscdk.cloud_assembly_schema

Class AwsCloudFormationStackProperties.Builder

java.lang.Object

software.amazon.awscdk.cloud_assembly_schema.AwsCloudFormationStackProperties.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<AwsCloudFormationStackProperties>

Enclosing interface:

AwsCloudFormationStackProperties

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

A builder for AwsCloudFormationStackProperties

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
AwsCloudFormationStackProperties.Builder	assumeRoleAdditionalOptions(Map<String,? extends Object> assumeRoleAdditionalOptions)	Sets the value of AwsCloudFormationStackProperties.getAssumeRoleAdditionalOptions()
AwsCloudFormationStackProperties.Builder	assumeRoleArn(String assumeRoleArn)	Sets the value of AwsCloudFormationStackProperties.getAssumeRoleArn()
AwsCloudFormationStackProperties.Builder	assumeRoleExternalId(String assumeRoleExternalId)	Sets the value of AwsCloudFormationStackProperties.getAssumeRoleExternalId()
AwsCloudFormationStackProperties.Builder	bootstrapStackVersionSsmParameter(String bootstrapStackVersionSsmParameter)	Sets the value of AwsCloudFormationStackProperties.getBootstrapStackVersionSsmParameter()
AwsCloudFormationStackProperties	build()	Builds the configured instance.
AwsCloudFormationStackProperties.Builder	cloudFormationExecutionRoleArn(String cloudFormationExecutionRoleArn)	Sets the value of AwsCloudFormationStackProperties.getCloudFormationExecutionRoleArn()
AwsCloudFormationStackProperties.Builder	lookupRole(BootstrapRole lookupRole)	Sets the value of AwsCloudFormationStackProperties.getLookupRole()
AwsCloudFormationStackProperties.Builder	notificationArns(List<String> notificationArns)	Sets the value of AwsCloudFormationStackProperties.getNotificationArns()
AwsCloudFormationStackProperties.Builder	parameters(Map<String,String> parameters)	Sets the value of AwsCloudFormationStackProperties.getParameters()
AwsCloudFormationStackProperties.Builder	requiresBootstrapStackVersion(Number requiresBootstrapStackVersion)	Sets the value of AwsCloudFormationStackProperties.getRequiresBootstrapStackVersion()
AwsCloudFormationStackProperties.Builder	stackName(String stackName)	Sets the value of AwsCloudFormationStackProperties.getStackName()
AwsCloudFormationStackProperties.Builder	stackTemplateAssetObjectUrl(String stackTemplateAssetObjectUrl)	Sets the value of AwsCloudFormationStackProperties.getStackTemplateAssetObjectUrl()
AwsCloudFormationStackProperties.Builder	tags(Map<String,String> tags)	Sets the value of AwsCloudFormationStackProperties.getTags()
AwsCloudFormationStackProperties.Builder	templateFile(String templateFile)	Sets the value of AwsCloudFormationStackProperties.getTemplateFile()
AwsCloudFormationStackProperties.Builder	terminationProtection(Boolean terminationProtection)	Sets the value of AwsCloudFormationStackProperties.getTerminationProtection()
AwsCloudFormationStackProperties.Builder	validateOnSynth(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 Details

Builder

public Builder()

Method Details

templateFile

@Stability(Stable)
public AwsCloudFormationStackProperties.Builder templateFile(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

assumeRoleAdditionalOptions

@Stability(Stable)
public AwsCloudFormationStackProperties.Builder assumeRoleAdditionalOptions(Map<String,? extends Object> assumeRoleAdditionalOptions)

Sets the value of AwsCloudFormationStackProperties.getAssumeRoleAdditionalOptions()

Parameters:

assumeRoleAdditionalOptions - Additional options to pass to STS when assuming the role.

• RoleArn should not be used. Use the dedicated assumeRoleArn property instead.
• ExternalId should not be used. Use the dedicated assumeRoleExternalId instead.

Returns:

this

assumeRoleArn

@Stability(Stable)
public AwsCloudFormationStackProperties.Builder assumeRoleArn(String assumeRoleArn)

Sets the value of AwsCloudFormationStackProperties.getAssumeRoleArn()

Parameters:

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

Returns:

this

assumeRoleExternalId

@Stability(Stable)
public AwsCloudFormationStackProperties.Builder assumeRoleExternalId(String assumeRoleExternalId)

Sets the value of AwsCloudFormationStackProperties.getAssumeRoleExternalId()

Parameters:

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

Returns:

this

bootstrapStackVersionSsmParameter

@Stability(Stable)
public AwsCloudFormationStackProperties.Builder bootstrapStackVersionSsmParameter(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

@Stability(Stable)
public AwsCloudFormationStackProperties.Builder cloudFormationExecutionRoleArn(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

@Stability(Stable)
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

notificationArns

@Stability(Stable)
public AwsCloudFormationStackProperties.Builder notificationArns(List<String> notificationArns)

Sets the value of AwsCloudFormationStackProperties.getNotificationArns()

Parameters:

notificationArns - SNS Notification ARNs that should receive CloudFormation Stack Events.

Returns:

this

parameters

@Stability(Stable)
public AwsCloudFormationStackProperties.Builder parameters(Map<String,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

@Stability(Stable)
public AwsCloudFormationStackProperties.Builder requiresBootstrapStackVersion(Number requiresBootstrapStackVersion)

Sets the value of AwsCloudFormationStackProperties.getRequiresBootstrapStackVersion()

Parameters:

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

Returns:

this

stackName

@Stability(Stable)
public AwsCloudFormationStackProperties.Builder stackName(String stackName)

Sets the value of AwsCloudFormationStackProperties.getStackName()

Parameters:

stackName - The name to use for the CloudFormation stack.

Returns:

this

stackTemplateAssetObjectUrl

@Stability(Stable)
public AwsCloudFormationStackProperties.Builder stackTemplateAssetObjectUrl(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

@Stability(Stable)
public AwsCloudFormationStackProperties.Builder tags(Map<String,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

@Stability(Stable)
public AwsCloudFormationStackProperties.Builder terminationProtection(Boolean terminationProtection)

Sets the value of AwsCloudFormationStackProperties.getTerminationProtection()

Parameters:

terminationProtection - Whether to enable termination protection for this stack.

Returns:

this

validateOnSynth

@Stability(Stable)
public AwsCloudFormationStackProperties.Builder validateOnSynth(Boolean validateOnSynth)

Sets the value of AwsCloudFormationStackProperties.getValidateOnSynth()

Parameters:

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

Returns:

this

build

@Stability(Stable)
public AwsCloudFormationStackProperties build()

Builds the configured instance.

Specified by:

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

Returns:

a new instance of AwsCloudFormationStackProperties

Throws:

NullPointerException - if any required attribute was not provided