com.amazonaws.services.cloudformation.model

Class ExecuteChangeSetRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.cloudformation.model.ExecuteChangeSetRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class ExecuteChangeSetRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

The input for the ExecuteChangeSet action.

See Also:

AWS API Documentation, Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
ExecuteChangeSetRequest()

Method Summary

Modifier and Type	Method and Description
ExecuteChangeSetRequest	clone() Creates a shallow clone of this object for all fields except the handler context.
boolean	equals(Object obj)
String	getChangeSetName() The name or Amazon Resource Name (ARN) of the change set that you want use to update the specified stack.
String	getClientRequestToken() A unique identifier for this ExecuteChangeSet request.
Boolean	getDisableRollback() Preserves the state of previously provisioned resources when an operation fails.
Boolean	getRetainExceptOnCreate() When set to true, newly created resources are deleted when the operation rolls back.
String	getStackName() 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.
int	hashCode()
Boolean	isDisableRollback() Preserves the state of previously provisioned resources when an operation fails.
Boolean	isRetainExceptOnCreate() When set to true, newly created resources are deleted when the operation rolls back.
void	setChangeSetName(String changeSetName) The name or Amazon Resource Name (ARN) of the change set that you want use to update the specified stack.
void	setClientRequestToken(String clientRequestToken) A unique identifier for this ExecuteChangeSet request.
void	setDisableRollback(Boolean disableRollback) Preserves the state of previously provisioned resources when an operation fails.
void	setRetainExceptOnCreate(Boolean retainExceptOnCreate) When set to true, newly created resources are deleted when the operation rolls back.
void	setStackName(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.
String	toString() Returns a string representation of this object.
ExecuteChangeSetRequest	withChangeSetName(String changeSetName) The name or Amazon Resource Name (ARN) of the change set that you want use to update the specified stack.
ExecuteChangeSetRequest	withClientRequestToken(String clientRequestToken) A unique identifier for this ExecuteChangeSet request.
ExecuteChangeSetRequest	withDisableRollback(Boolean disableRollback) Preserves the state of previously provisioned resources when an operation fails.
ExecuteChangeSetRequest	withRetainExceptOnCreate(Boolean retainExceptOnCreate) When set to true, newly created resources are deleted when the operation rolls back.
ExecuteChangeSetRequest	withStackName(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 class com.amazonaws.AmazonWebServiceRequest

addHandlerContext, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

ExecuteChangeSetRequest

public ExecuteChangeSetRequest()

Method Detail

setChangeSetName

public void setChangeSetName(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.

getChangeSetName

public String getChangeSetName()

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.

withChangeSetName

public ExecuteChangeSetRequest withChangeSetName(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.

setStackName

public void setStackName(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.

getStackName

public String getStackName()

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.

withStackName

public ExecuteChangeSetRequest withStackName(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.

setClientRequestToken

public void setClientRequestToken(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.

getClientRequestToken

public String getClientRequestToken()

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.

withClientRequestToken

public ExecuteChangeSetRequest withClientRequestToken(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.

setDisableRollback

public void setDisableRollback(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

getDisableRollback

public Boolean getDisableRollback()

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

withDisableRollback

public ExecuteChangeSetRequest withDisableRollback(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.

isDisableRollback

public Boolean isDisableRollback()

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

setRetainExceptOnCreate

public void setRetainExceptOnCreate(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

getRetainExceptOnCreate

public Boolean getRetainExceptOnCreate()

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

withRetainExceptOnCreate

public ExecuteChangeSetRequest withRetainExceptOnCreate(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.

isRetainExceptOnCreate

public Boolean isRetainExceptOnCreate()

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

toString

public 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

Returns:

A string representation of this object.

See Also:

Object.toString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public ExecuteChangeSetRequest clone()

Description copied from class: AmazonWebServiceRequest

Creates a shallow clone of this object for all fields except the handler context. Explicitly does not clone the deep structure of the other fields in the message.

Overrides:

clone in class AmazonWebServiceRequest

See Also:

Object.clone()