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

Class ExecuteChangeSetRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.cloudformation.model.CloudFormationRequest

software.amazon.awssdk.services.cloudformation.model.ExecuteChangeSetRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<ExecuteChangeSetRequest.Builder,ExecuteChangeSetRequest>

@Generated("software.amazon.awssdk:codegen")
public final class ExecuteChangeSetRequest
extends CloudFormationRequest
implements ToCopyableBuilder<ExecuteChangeSetRequest.Builder,ExecuteChangeSetRequest>

The input for the ExecuteChangeSet action.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	ExecuteChangeSetRequest.Builder

Method Summary

Modifier and Type	Method	Description
static ExecuteChangeSetRequest.Builder	builder()
String	changeSetName()	The name or Amazon Resource Name (ARN) of the change set that you want use to update the specified stack.
String	clientRequestToken()	A unique identifier for this ExecuteChangeSet request.
Boolean	disableRollback()	Preserves the state of previously provisioned resources when an operation fails.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
Boolean	retainExceptOnCreate()	When set to true, newly created resources are deleted when the operation rolls back.
List<SdkField<?>>	sdkFields()
static Class<? extends ExecuteChangeSetRequest.Builder>	serializableBuilderClass()
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.
ExecuteChangeSetRequest.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

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

copy

Method Detail

changeSetName

public final String changeSetName()

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

Returns:

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

stackName

public final 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.

Returns:

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.

clientRequestToken

public final 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.

Returns:

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.

disableRollback

public final 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

Returns:

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

retainExceptOnCreate

public final 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

Returns:

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

toBuilder

public ExecuteChangeSetRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<ExecuteChangeSetRequest.Builder,ExecuteChangeSetRequest>

Specified by:

toBuilder in class CloudFormationRequest

builder

public static ExecuteChangeSetRequest.Builder builder()

serializableBuilderClass

public static Class<? extends ExecuteChangeSetRequest.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsRequest

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

Overrides:

getValueForField in class SdkRequest

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo