Package software.amazon.awssdk.services.cloudformation.model

Interface ExecuteChangeSetRequest.Builder

All Superinterfaces:

AwsRequest.Builder, Buildable, CloudFormationRequest.Builder, CopyableBuilder<ExecuteChangeSetRequest.Builder,ExecuteChangeSetRequest>, SdkBuilder<ExecuteChangeSetRequest.Builder,ExecuteChangeSetRequest>, SdkPojo, SdkRequest.Builder

Enclosing class:

ExecuteChangeSetRequest

@Mutable
@NotThreadSafe
public static interface ExecuteChangeSetRequest.Builder
extends CloudFormationRequest.Builder, SdkPojo, CopyableBuilder<ExecuteChangeSetRequest.Builder,ExecuteChangeSetRequest>

Method Summary

Modifier and Type	Method	Description
ExecuteChangeSetRequest.Builder	changeSetName(String changeSetName)	The name or Amazon Resource Name (ARN) of the change set that you want use to update the specified stack.
ExecuteChangeSetRequest.Builder	clientRequestToken(String clientRequestToken)	A unique identifier for this ExecuteChangeSet request.
ExecuteChangeSetRequest.Builder	disableRollback(Boolean disableRollback)	Preserves the state of previously provisioned resources when an operation fails.
ExecuteChangeSetRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
ExecuteChangeSetRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
ExecuteChangeSetRequest.Builder	retainExceptOnCreate(Boolean retainExceptOnCreate)	When set to true, newly created resources are deleted when the operation rolls back.
ExecuteChangeSetRequest.Builder	stackName(String stackName)	If you specified the name of a change set, specify the stack name or Amazon Resource Name (ARN) that's associated with the change set you want to execute.

Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder

overrideConfiguration

Methods inherited from interface software.amazon.awssdk.services.cloudformation.model.CloudFormationRequest.Builder

build

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

copy

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

applyMutation, build

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFieldNameToField, sdkFields

Method Detail

changeSetName

ExecuteChangeSetRequest.Builder changeSetName(String changeSetName)

The name or Amazon Resource Name (ARN) of the change set that you want use to update the specified stack.

Parameters:

changeSetName - The name or Amazon Resource Name (ARN) of the change set that you want use to update the specified stack.

Returns:

Returns a reference to this object so that method calls can be chained together.

stackName

ExecuteChangeSetRequest.Builder stackName(String stackName)

If you specified the name of a change set, specify the stack name or Amazon Resource Name (ARN) that's associated with the change set you want to execute.

Parameters:

stackName - If you specified the name of a change set, specify the stack name or Amazon Resource Name (ARN) that's associated with the change set you want to execute.

Returns:

Returns a reference to this object so that method calls can be chained together.

clientRequestToken

ExecuteChangeSetRequest.Builder clientRequestToken(String clientRequestToken)

A unique identifier for this ExecuteChangeSet request. Specify this token if you plan to retry requests so that CloudFormation knows that you're not attempting to execute a change set to update a stack with the same name. You might retry ExecuteChangeSet requests to ensure that CloudFormation successfully received them.

Parameters:

clientRequestToken - A unique identifier for this ExecuteChangeSet request. Specify this token if you plan to retry requests so that CloudFormation knows that you're not attempting to execute a change set to update a stack with the same name. You might retry ExecuteChangeSet requests to ensure that CloudFormation successfully received them.

Returns:

Returns a reference to this object so that method calls can be chained together.

disableRollback

ExecuteChangeSetRequest.Builder disableRollback(Boolean disableRollback)

Preserves the state of previously provisioned resources when an operation fails. This parameter can't be specified when the OnStackFailure parameter to the CreateChangeSet API operation was specified.

• True - if the stack creation fails, do nothing. This is equivalent to specifying DO_NOTHING for the OnStackFailure parameter to the CreateChangeSet API operation.

• False - if the stack creation fails, roll back the stack. This is equivalent to specifying ROLLBACK for the OnStackFailure parameter to the CreateChangeSet API operation.

Default: True

Parameters:

disableRollback - Preserves the state of previously provisioned resources when an operation fails. This parameter can't be specified when the OnStackFailure parameter to the CreateChangeSet API operation was specified.

• True - if the stack creation fails, do nothing. This is equivalent to specifying DO_NOTHING for the OnStackFailure parameter to the CreateChangeSet API operation.

• False - if the stack creation fails, roll back the stack. This is equivalent to specifying ROLLBACK for the OnStackFailure parameter to the CreateChangeSet API operation.

Default: True

Returns:

Returns a reference to this object so that method calls can be chained together.

retainExceptOnCreate

ExecuteChangeSetRequest.Builder retainExceptOnCreate(Boolean retainExceptOnCreate)

When set to true, newly created resources are deleted when the operation rolls back. This includes newly created resources marked with a deletion policy of Retain.

Default: false

Parameters:

retainExceptOnCreate - When set to true, newly created resources are deleted when the operation rolls back. This includes newly created resources marked with a deletion policy of Retain.

Default: false

Returns:

Returns a reference to this object so that method calls can be chained together.

overrideConfiguration

ExecuteChangeSetRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)

Specified by:

overrideConfiguration in interface AwsRequest.Builder

overrideConfiguration

ExecuteChangeSetRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)

Specified by:

overrideConfiguration in interface AwsRequest.Builder