Package software.amazon.awscdk.cfnpropertymixins.services.cloudformation

Class CfnChangeSetPropsMixin.Builder

java.lang.Object

software.amazon.awscdk.cfnpropertymixins.services.cloudformation.CfnChangeSetPropsMixin.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnChangeSetPropsMixin>

Enclosing class:

CfnChangeSetPropsMixin

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

A fluent builder for CfnChangeSetPropsMixin.

Method Summary

Modifier and Type	Method	Description
CfnChangeSetPropsMixin	build()
CfnChangeSetPropsMixin.Builder	capabilities(List<String> capabilities)	The capabilities that are allowed in the stack.
CfnChangeSetPropsMixin.Builder	changeSetName(String changeSetName)	The name of the change set.
CfnChangeSetPropsMixin.Builder	changeSetType(String changeSetType)	The type of change set operation.
static CfnChangeSetPropsMixin.Builder	create()
static CfnChangeSetPropsMixin.Builder	create(CfnPropertyMixinOptions options)
CfnChangeSetPropsMixin.Builder	deploymentMode(String deploymentMode)	Determines how CloudFormation handles configuration drift during deployment.
CfnChangeSetPropsMixin.Builder	description(String description)	A description to help you identify this change set.
CfnChangeSetPropsMixin.Builder	importExistingResources(Boolean importExistingResources)	Indicates if the change set imports resources that already exist.
CfnChangeSetPropsMixin.Builder	importExistingResources(IResolvable importExistingResources)	Indicates if the change set imports resources that already exist.
CfnChangeSetPropsMixin.Builder	includeNestedStacks(Boolean includeNestedStacks)	Creates a change set for all nested stacks specified in the template.
CfnChangeSetPropsMixin.Builder	includeNestedStacks(IResolvable includeNestedStacks)	Creates a change set for all nested stacks specified in the template.
CfnChangeSetPropsMixin.Builder	notificationArns(List<String> notificationArns)	The ARNs of Amazon SNS topics that CloudFormation associates with the stack.
CfnChangeSetPropsMixin.Builder	onStackFailure(String onStackFailure)	Determines what action will be taken if stack creation fails.
CfnChangeSetPropsMixin.Builder	roleArn(String roleArn)	The ARN of an IAM role that CloudFormation assumes when executing the change set.
CfnChangeSetPropsMixin.Builder	stackName(String stackName)	The name or unique ID of the stack for which you are creating a change set.
CfnChangeSetPropsMixin.Builder	tags(List<? extends CfnChangeSetPropsMixin.TagsItemsProperty> tags)	Key-value pairs to associate with the change set.
CfnChangeSetPropsMixin.Builder	templateBody(String templateBody)	A structure that contains the body of the revised template.
CfnChangeSetPropsMixin.Builder	templateUrl(String templateUrl)	The URL of the file that contains the revised template.
CfnChangeSetPropsMixin.Builder	usePreviousTemplate(Boolean usePreviousTemplate)	Whether to reuse the template associated with the stack to create the change set.
CfnChangeSetPropsMixin.Builder	usePreviousTemplate(IResolvable usePreviousTemplate)	Whether to reuse the template associated with the stack to create the change set.

Methods inherited from class java.lang.Object

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

Method Details

create

@Stability(Stable)
public static CfnChangeSetPropsMixin.Builder create(CfnPropertyMixinOptions options)

Parameters:

options - Mixin options.

Returns:

a new instance of CfnChangeSetPropsMixin.Builder.

create

@Stability(Stable)
public static CfnChangeSetPropsMixin.Builder create()

Returns:

a new instance of CfnChangeSetPropsMixin.Builder.

capabilities

@Stability(Stable)
public CfnChangeSetPropsMixin.Builder capabilities(List<String> capabilities)

The capabilities that are allowed in the stack.

Parameters:

capabilities - The capabilities that are allowed in the stack. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-changeset.html#cfn-cloudformation-changeset-capabilities

changeSetName

@Stability(Stable)
public CfnChangeSetPropsMixin.Builder changeSetName(String changeSetName)

The name of the change set.

Must be unique among all change sets associated with the specified stack.

Parameters:

changeSetName - The name of the change set. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-changeset.html#cfn-cloudformation-changeset-changesetname

changeSetType

@Stability(Stable)
public CfnChangeSetPropsMixin.Builder changeSetType(String changeSetType)

The type of change set operation.

Parameters:

changeSetType - The type of change set operation. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-changeset.html#cfn-cloudformation-changeset-changesettype

deploymentMode

@Stability(Stable)
public CfnChangeSetPropsMixin.Builder deploymentMode(String deploymentMode)

Determines how CloudFormation handles configuration drift during deployment.

Parameters:

deploymentMode - Determines how CloudFormation handles configuration drift during deployment. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-changeset.html#cfn-cloudformation-changeset-deploymentmode

description

@Stability(Stable)
public CfnChangeSetPropsMixin.Builder description(String description)

A description to help you identify this change set.

Parameters:

description - A description to help you identify this change set. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-changeset.html#cfn-cloudformation-changeset-description

importExistingResources

@Stability(Stable)
public CfnChangeSetPropsMixin.Builder importExistingResources(Boolean importExistingResources)

Indicates if the change set imports resources that already exist.

Parameters:

importExistingResources - Indicates if the change set imports resources that already exist. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-changeset.html#cfn-cloudformation-changeset-importexistingresources

importExistingResources

@Stability(Stable)
public CfnChangeSetPropsMixin.Builder importExistingResources(IResolvable importExistingResources)

Indicates if the change set imports resources that already exist.

Parameters:

importExistingResources - Indicates if the change set imports resources that already exist. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-changeset.html#cfn-cloudformation-changeset-importexistingresources

includeNestedStacks

@Stability(Stable)
public CfnChangeSetPropsMixin.Builder includeNestedStacks(Boolean includeNestedStacks)

Creates a change set for all nested stacks specified in the template.

Parameters:

includeNestedStacks - Creates a change set for all nested stacks specified in the template. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-changeset.html#cfn-cloudformation-changeset-includenestedstacks

includeNestedStacks

@Stability(Stable)
public CfnChangeSetPropsMixin.Builder includeNestedStacks(IResolvable includeNestedStacks)

Creates a change set for all nested stacks specified in the template.

Parameters:

includeNestedStacks - Creates a change set for all nested stacks specified in the template. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-changeset.html#cfn-cloudformation-changeset-includenestedstacks

notificationArns

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

The ARNs of Amazon SNS topics that CloudFormation associates with the stack.

Parameters:

notificationArns - The ARNs of Amazon SNS topics that CloudFormation associates with the stack. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-changeset.html#cfn-cloudformation-changeset-notificationarns

onStackFailure

@Stability(Stable)
public CfnChangeSetPropsMixin.Builder onStackFailure(String onStackFailure)

Determines what action will be taken if stack creation fails.

Parameters:

onStackFailure - Determines what action will be taken if stack creation fails. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-changeset.html#cfn-cloudformation-changeset-onstackfailure

roleArn

@Stability(Stable)
public CfnChangeSetPropsMixin.Builder roleArn(String roleArn)

The ARN of an IAM role that CloudFormation assumes when executing the change set.

Parameters:

roleArn - The ARN of an IAM role that CloudFormation assumes when executing the change set. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-changeset.html#cfn-cloudformation-changeset-rolearn

stackName

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

The name or unique ID of the stack for which you are creating a change set.

Parameters:

stackName - The name or unique ID of the stack for which you are creating a change set. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-changeset.html#cfn-cloudformation-changeset-stackname

tags

@Stability(Stable)
public CfnChangeSetPropsMixin.Builder tags(List<? extends CfnChangeSetPropsMixin.TagsItemsProperty> tags)

Key-value pairs to associate with the change set.

Parameters:

tags - Key-value pairs to associate with the change set. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-changeset.html#cfn-cloudformation-changeset-tags

templateBody

@Stability(Stable)
public CfnChangeSetPropsMixin.Builder templateBody(String templateBody)

A structure that contains the body of the revised template.

Parameters:

templateBody - A structure that contains the body of the revised template. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-changeset.html#cfn-cloudformation-changeset-templatebody

templateUrl

@Stability(Stable)
public CfnChangeSetPropsMixin.Builder templateUrl(String templateUrl)

The URL of the file that contains the revised template.

Parameters:

templateUrl - The URL of the file that contains the revised template. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-changeset.html#cfn-cloudformation-changeset-templateurl

usePreviousTemplate

@Stability(Stable)
public CfnChangeSetPropsMixin.Builder usePreviousTemplate(Boolean usePreviousTemplate)

Whether to reuse the template associated with the stack to create the change set.

Parameters:

usePreviousTemplate - Whether to reuse the template associated with the stack to create the change set. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-changeset.html#cfn-cloudformation-changeset-useprevioustemplate

usePreviousTemplate

@Stability(Stable)
public CfnChangeSetPropsMixin.Builder usePreviousTemplate(IResolvable usePreviousTemplate)

Whether to reuse the template associated with the stack to create the change set.

Parameters:

usePreviousTemplate - Whether to reuse the template associated with the stack to create the change set. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-changeset.html#cfn-cloudformation-changeset-useprevioustemplate

build

@Stability(Stable)
public CfnChangeSetPropsMixin build()

Specified by:

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

Returns:

a newly built instance of CfnChangeSetPropsMixin.