com.amazonaws.services.cloudformation.model.ExecuteChangeSetRequest Maven / Gradle / Ivy
Show all versions of aws-java-sdk-cloudformation Show documentation
/*
* Copyright 2019-2024 Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with
* the License. A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
* CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions
* and limitations under the License.
*/
package com.amazonaws.services.cloudformation.model;
import java.io.Serializable;
import javax.annotation.Generated;
import com.amazonaws.AmazonWebServiceRequest;
/**
*
* The input for the ExecuteChangeSet action.
*
*
* @see AWS
* API Documentation
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class ExecuteChangeSetRequest extends com.amazonaws.AmazonWebServiceRequest implements Serializable, Cloneable {
/**
*
* The name or Amazon Resource Name (ARN) of the change set that you want use to update the specified stack.
*
*/
private String changeSetName;
/**
*
* 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.
*
*/
private String stackName;
/**
*
* 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.
*
*/
private String clientRequestToken;
/**
*
* 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
*
*/
private Boolean disableRollback;
/**
*
* 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
*
*/
private Boolean retainExceptOnCreate;
/**
*
* The name or Amazon Resource Name (ARN) of the change set that you want use to update the specified stack.
*
*
* @param changeSetName
* The name or Amazon Resource Name (ARN) of the change set that you want use to update the specified stack.
*/
public void setChangeSetName(String changeSetName) {
this.changeSetName = changeSetName;
}
/**
*
* The name or Amazon Resource Name (ARN) of the change set that you want use to update the specified stack.
*
*
* @return The name or Amazon Resource Name (ARN) of the change set that you want use to update the specified stack.
*/
public String getChangeSetName() {
return this.changeSetName;
}
/**
*
* The name or Amazon Resource Name (ARN) of the change set that you want use to update the specified stack.
*
*
* @param changeSetName
* The name or Amazon Resource Name (ARN) of the change set that you want use to update the specified stack.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public ExecuteChangeSetRequest withChangeSetName(String changeSetName) {
setChangeSetName(changeSetName);
return this;
}
/**
*
* 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.
*
*
* @param 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.
*/
public void setStackName(String stackName) {
this.stackName = 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.
*
*
* @return 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.
*/
public String getStackName() {
return this.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.
*
*
* @param 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.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public ExecuteChangeSetRequest withStackName(String stackName) {
setStackName(stackName);
return this;
}
/**
*
* 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.
*
*
* @param 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.
*/
public void setClientRequestToken(String clientRequestToken) {
this.clientRequestToken = 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.
*
*
* @return 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.
*/
public String getClientRequestToken() {
return this.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.
*
*
* @param 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.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public ExecuteChangeSetRequest withClientRequestToken(String clientRequestToken) {
setClientRequestToken(clientRequestToken);
return this;
}
/**
*
* 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
*
*
* @param 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
*/
public void setDisableRollback(Boolean disableRollback) {
this.disableRollback = 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
*
*
* @return 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
*/
public Boolean getDisableRollback() {
return this.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
*
*
* @param 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
* @return Returns a reference to this object so that method calls can be chained together.
*/
public ExecuteChangeSetRequest withDisableRollback(Boolean disableRollback) {
setDisableRollback(disableRollback);
return this;
}
/**
*
* 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
*
*
* @return 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
*/
public Boolean isDisableRollback() {
return this.disableRollback;
}
/**
*
* 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
*
*
* @param 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
*/
public void setRetainExceptOnCreate(Boolean retainExceptOnCreate) {
this.retainExceptOnCreate = 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
*
*
* @return 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
*/
public Boolean getRetainExceptOnCreate() {
return this.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
*
*
* @param 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
* @return Returns a reference to this object so that method calls can be chained together.
*/
public ExecuteChangeSetRequest withRetainExceptOnCreate(Boolean retainExceptOnCreate) {
setRetainExceptOnCreate(retainExceptOnCreate);
return this;
}
/**
*
* 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
*
*
* @return 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
*/
public Boolean isRetainExceptOnCreate() {
return this.retainExceptOnCreate;
}
/**
* 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.
*
* @return A string representation of this object.
*
* @see java.lang.Object#toString()
*/
@Override
public String toString() {
StringBuilder sb = new StringBuilder();
sb.append("{");
if (getChangeSetName() != null)
sb.append("ChangeSetName: ").append(getChangeSetName()).append(",");
if (getStackName() != null)
sb.append("StackName: ").append(getStackName()).append(",");
if (getClientRequestToken() != null)
sb.append("ClientRequestToken: ").append(getClientRequestToken()).append(",");
if (getDisableRollback() != null)
sb.append("DisableRollback: ").append(getDisableRollback()).append(",");
if (getRetainExceptOnCreate() != null)
sb.append("RetainExceptOnCreate: ").append(getRetainExceptOnCreate());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof ExecuteChangeSetRequest == false)
return false;
ExecuteChangeSetRequest other = (ExecuteChangeSetRequest) obj;
if (other.getChangeSetName() == null ^ this.getChangeSetName() == null)
return false;
if (other.getChangeSetName() != null && other.getChangeSetName().equals(this.getChangeSetName()) == false)
return false;
if (other.getStackName() == null ^ this.getStackName() == null)
return false;
if (other.getStackName() != null && other.getStackName().equals(this.getStackName()) == false)
return false;
if (other.getClientRequestToken() == null ^ this.getClientRequestToken() == null)
return false;
if (other.getClientRequestToken() != null && other.getClientRequestToken().equals(this.getClientRequestToken()) == false)
return false;
if (other.getDisableRollback() == null ^ this.getDisableRollback() == null)
return false;
if (other.getDisableRollback() != null && other.getDisableRollback().equals(this.getDisableRollback()) == false)
return false;
if (other.getRetainExceptOnCreate() == null ^ this.getRetainExceptOnCreate() == null)
return false;
if (other.getRetainExceptOnCreate() != null && other.getRetainExceptOnCreate().equals(this.getRetainExceptOnCreate()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getChangeSetName() == null) ? 0 : getChangeSetName().hashCode());
hashCode = prime * hashCode + ((getStackName() == null) ? 0 : getStackName().hashCode());
hashCode = prime * hashCode + ((getClientRequestToken() == null) ? 0 : getClientRequestToken().hashCode());
hashCode = prime * hashCode + ((getDisableRollback() == null) ? 0 : getDisableRollback().hashCode());
hashCode = prime * hashCode + ((getRetainExceptOnCreate() == null) ? 0 : getRetainExceptOnCreate().hashCode());
return hashCode;
}
@Override
public ExecuteChangeSetRequest clone() {
return (ExecuteChangeSetRequest) super.clone();
}
}