com.amazonaws.services.cloudformation.model.ContinueUpdateRollbackRequest Maven / Gradle / Ivy
Show all versions of aws-java-sdk-cloudformation Show documentation
/*
* Copyright 2012-2017 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 ContinueUpdateRollback action.
*
*
* @see AWS API Documentation
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class ContinueUpdateRollbackRequest extends com.amazonaws.AmazonWebServiceRequest implements Serializable, Cloneable {
/**
*
* The name or the unique ID of the stack that you want to continue rolling back.
*
*
*
* Don't specify the name of a nested stack (a stack that was created by using the
* AWS::CloudFormation::Stack resource). Instead, use this operation on the parent stack (the stack
* that contains the AWS::CloudFormation::Stack resource).
*
*
*/
private String stackName;
/**
*
* The Amazon Resource Name (ARN) of an AWS Identity and Access Management (IAM) role that AWS CloudFormation
* assumes to roll back the stack. AWS CloudFormation uses the role's credentials to make calls on your behalf. AWS
* CloudFormation always uses this role for all future operations on the stack. As long as users have permission to
* operate on the stack, AWS CloudFormation uses this role even if the users don't have permission to pass it.
* Ensure that the role grants least privilege.
*
*
* If you don't specify a value, AWS CloudFormation uses the role that was previously associated with the stack. If
* no role is available, AWS CloudFormation uses a temporary session that is generated from your user credentials.
*
*/
private String roleARN;
/**
*
* A list of the logical IDs of the resources that AWS CloudFormation skips during the continue update rollback
* operation. You can specify only resources that are in the UPDATE_FAILED state because a rollback
* failed. You can't specify resources that are in the UPDATE_FAILED state for other reasons, for
* example, because an update was canceled. To check why a resource update failed, use the
* DescribeStackResources action, and view the resource status reason.
*
*
*
* Specify this property to skip rolling back resources that AWS CloudFormation can't successfully roll back. We
* recommend that you troubleshoot resources before skipping them. AWS CloudFormation sets the status of the specified resources
* to UPDATE_COMPLETE and continues to roll back the stack. After the rollback is complete, the state
* of the skipped resources will be inconsistent with the state of the resources in the stack template. Before
* performing another stack update, you must update the stack or resources to be consistent with each other. If you
* don't, subsequent stack updates might fail, and the stack will become unrecoverable.
*
*
*
* Specify the minimum number of resources required to successfully roll back your stack. For example, a failed
* resource update might cause dependent resources to fail. In this case, it might not be necessary to skip the
* dependent resources.
*
*
* To specify resources in a nested stack, use the following format: NestedStackName.ResourceLogicalID.
* You can specify a nested stack resource (the logical ID of an AWS::CloudFormation::Stack resource)
* only if it's in one of the following states: DELETE_IN_PROGRESS, DELETE_COMPLETE, or
* DELETE_FAILED.
*
*/
private com.amazonaws.internal.SdkInternalList resourcesToSkip;
/**
*
* The name or the unique ID of the stack that you want to continue rolling back.
*
*
*
* Don't specify the name of a nested stack (a stack that was created by using the
* AWS::CloudFormation::Stack resource). Instead, use this operation on the parent stack (the stack
* that contains the AWS::CloudFormation::Stack resource).
*
*
*
* @param stackName
* The name or the unique ID of the stack that you want to continue rolling back.
*
* Don't specify the name of a nested stack (a stack that was created by using the
* AWS::CloudFormation::Stack resource). Instead, use this operation on the parent stack (the
* stack that contains the AWS::CloudFormation::Stack resource).
*
*/
public void setStackName(String stackName) {
this.stackName = stackName;
}
/**
*
* The name or the unique ID of the stack that you want to continue rolling back.
*
*
*
* Don't specify the name of a nested stack (a stack that was created by using the
* AWS::CloudFormation::Stack resource). Instead, use this operation on the parent stack (the stack
* that contains the AWS::CloudFormation::Stack resource).
*
*
*
* @return The name or the unique ID of the stack that you want to continue rolling back.
*
* Don't specify the name of a nested stack (a stack that was created by using the
* AWS::CloudFormation::Stack resource). Instead, use this operation on the parent stack (the
* stack that contains the AWS::CloudFormation::Stack resource).
*
*/
public String getStackName() {
return this.stackName;
}
/**
*
* The name or the unique ID of the stack that you want to continue rolling back.
*
*
*
* Don't specify the name of a nested stack (a stack that was created by using the
* AWS::CloudFormation::Stack resource). Instead, use this operation on the parent stack (the stack
* that contains the AWS::CloudFormation::Stack resource).
*
*
*
* @param stackName
* The name or the unique ID of the stack that you want to continue rolling back.
*
* Don't specify the name of a nested stack (a stack that was created by using the
* AWS::CloudFormation::Stack resource). Instead, use this operation on the parent stack (the
* stack that contains the AWS::CloudFormation::Stack resource).
*
* @return Returns a reference to this object so that method calls can be chained together.
*/
public ContinueUpdateRollbackRequest withStackName(String stackName) {
setStackName(stackName);
return this;
}
/**
*
* The Amazon Resource Name (ARN) of an AWS Identity and Access Management (IAM) role that AWS CloudFormation
* assumes to roll back the stack. AWS CloudFormation uses the role's credentials to make calls on your behalf. AWS
* CloudFormation always uses this role for all future operations on the stack. As long as users have permission to
* operate on the stack, AWS CloudFormation uses this role even if the users don't have permission to pass it.
* Ensure that the role grants least privilege.
*
*
* If you don't specify a value, AWS CloudFormation uses the role that was previously associated with the stack. If
* no role is available, AWS CloudFormation uses a temporary session that is generated from your user credentials.
*
*
* @param roleARN
* The Amazon Resource Name (ARN) of an AWS Identity and Access Management (IAM) role that AWS CloudFormation
* assumes to roll back the stack. AWS CloudFormation uses the role's credentials to make calls on your
* behalf. AWS CloudFormation always uses this role for all future operations on the stack. As long as users
* have permission to operate on the stack, AWS CloudFormation uses this role even if the users don't have
* permission to pass it. Ensure that the role grants least privilege.
*
* If you don't specify a value, AWS CloudFormation uses the role that was previously associated with the
* stack. If no role is available, AWS CloudFormation uses a temporary session that is generated from your
* user credentials.
*/
public void setRoleARN(String roleARN) {
this.roleARN = roleARN;
}
/**
*
* The Amazon Resource Name (ARN) of an AWS Identity and Access Management (IAM) role that AWS CloudFormation
* assumes to roll back the stack. AWS CloudFormation uses the role's credentials to make calls on your behalf. AWS
* CloudFormation always uses this role for all future operations on the stack. As long as users have permission to
* operate on the stack, AWS CloudFormation uses this role even if the users don't have permission to pass it.
* Ensure that the role grants least privilege.
*
*
* If you don't specify a value, AWS CloudFormation uses the role that was previously associated with the stack. If
* no role is available, AWS CloudFormation uses a temporary session that is generated from your user credentials.
*
*
* @return The Amazon Resource Name (ARN) of an AWS Identity and Access Management (IAM) role that AWS
* CloudFormation assumes to roll back the stack. AWS CloudFormation uses the role's credentials to make
* calls on your behalf. AWS CloudFormation always uses this role for all future operations on the stack. As
* long as users have permission to operate on the stack, AWS CloudFormation uses this role even if the
* users don't have permission to pass it. Ensure that the role grants least privilege.
*
* If you don't specify a value, AWS CloudFormation uses the role that was previously associated with the
* stack. If no role is available, AWS CloudFormation uses a temporary session that is generated from your
* user credentials.
*/
public String getRoleARN() {
return this.roleARN;
}
/**
*
* The Amazon Resource Name (ARN) of an AWS Identity and Access Management (IAM) role that AWS CloudFormation
* assumes to roll back the stack. AWS CloudFormation uses the role's credentials to make calls on your behalf. AWS
* CloudFormation always uses this role for all future operations on the stack. As long as users have permission to
* operate on the stack, AWS CloudFormation uses this role even if the users don't have permission to pass it.
* Ensure that the role grants least privilege.
*
*
* If you don't specify a value, AWS CloudFormation uses the role that was previously associated with the stack. If
* no role is available, AWS CloudFormation uses a temporary session that is generated from your user credentials.
*
*
* @param roleARN
* The Amazon Resource Name (ARN) of an AWS Identity and Access Management (IAM) role that AWS CloudFormation
* assumes to roll back the stack. AWS CloudFormation uses the role's credentials to make calls on your
* behalf. AWS CloudFormation always uses this role for all future operations on the stack. As long as users
* have permission to operate on the stack, AWS CloudFormation uses this role even if the users don't have
* permission to pass it. Ensure that the role grants least privilege.
*
* If you don't specify a value, AWS CloudFormation uses the role that was previously associated with the
* stack. If no role is available, AWS CloudFormation uses a temporary session that is generated from your
* user credentials.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public ContinueUpdateRollbackRequest withRoleARN(String roleARN) {
setRoleARN(roleARN);
return this;
}
/**
*
* A list of the logical IDs of the resources that AWS CloudFormation skips during the continue update rollback
* operation. You can specify only resources that are in the UPDATE_FAILED state because a rollback
* failed. You can't specify resources that are in the UPDATE_FAILED state for other reasons, for
* example, because an update was canceled. To check why a resource update failed, use the
* DescribeStackResources action, and view the resource status reason.
*
*
*
* Specify this property to skip rolling back resources that AWS CloudFormation can't successfully roll back. We
* recommend that you troubleshoot resources before skipping them. AWS CloudFormation sets the status of the specified resources
* to UPDATE_COMPLETE and continues to roll back the stack. After the rollback is complete, the state
* of the skipped resources will be inconsistent with the state of the resources in the stack template. Before
* performing another stack update, you must update the stack or resources to be consistent with each other. If you
* don't, subsequent stack updates might fail, and the stack will become unrecoverable.
*
*
*
* Specify the minimum number of resources required to successfully roll back your stack. For example, a failed
* resource update might cause dependent resources to fail. In this case, it might not be necessary to skip the
* dependent resources.
*
*
* To specify resources in a nested stack, use the following format: NestedStackName.ResourceLogicalID.
* You can specify a nested stack resource (the logical ID of an AWS::CloudFormation::Stack resource)
* only if it's in one of the following states: DELETE_IN_PROGRESS, DELETE_COMPLETE, or
* DELETE_FAILED.
*
*
* @return A list of the logical IDs of the resources that AWS CloudFormation skips during the continue update
* rollback operation. You can specify only resources that are in the UPDATE_FAILED state
* because a rollback failed. You can't specify resources that are in the UPDATE_FAILED state
* for other reasons, for example, because an update was canceled. To check why a resource update failed,
* use the DescribeStackResources action, and view the resource status reason.
*
* Specify this property to skip rolling back resources that AWS CloudFormation can't successfully roll
* back. We recommend that you troubleshoot resources before skipping them. AWS CloudFormation sets the status of the specified
* resources to UPDATE_COMPLETE and continues to roll back the stack. After the rollback is
* complete, the state of the skipped resources will be inconsistent with the state of the resources in the
* stack template. Before performing another stack update, you must update the stack or resources to be
* consistent with each other. If you don't, subsequent stack updates might fail, and the stack will become
* unrecoverable.
*
*
*
* Specify the minimum number of resources required to successfully roll back your stack. For example, a
* failed resource update might cause dependent resources to fail. In this case, it might not be necessary
* to skip the dependent resources.
*
*
* To specify resources in a nested stack, use the following format:
* NestedStackName.ResourceLogicalID. You can specify a nested stack resource (the logical ID
* of an AWS::CloudFormation::Stack resource) only if it's in one of the following states:
* DELETE_IN_PROGRESS, DELETE_COMPLETE, or DELETE_FAILED.
*/
public java.util.List getResourcesToSkip() {
if (resourcesToSkip == null) {
resourcesToSkip = new com.amazonaws.internal.SdkInternalList();
}
return resourcesToSkip;
}
/**
*
* A list of the logical IDs of the resources that AWS CloudFormation skips during the continue update rollback
* operation. You can specify only resources that are in the UPDATE_FAILED state because a rollback
* failed. You can't specify resources that are in the UPDATE_FAILED state for other reasons, for
* example, because an update was canceled. To check why a resource update failed, use the
* DescribeStackResources action, and view the resource status reason.
*
*
*
* Specify this property to skip rolling back resources that AWS CloudFormation can't successfully roll back. We
* recommend that you troubleshoot resources before skipping them. AWS CloudFormation sets the status of the specified resources
* to UPDATE_COMPLETE and continues to roll back the stack. After the rollback is complete, the state
* of the skipped resources will be inconsistent with the state of the resources in the stack template. Before
* performing another stack update, you must update the stack or resources to be consistent with each other. If you
* don't, subsequent stack updates might fail, and the stack will become unrecoverable.
*
*
*
* Specify the minimum number of resources required to successfully roll back your stack. For example, a failed
* resource update might cause dependent resources to fail. In this case, it might not be necessary to skip the
* dependent resources.
*
*
* To specify resources in a nested stack, use the following format: NestedStackName.ResourceLogicalID.
* You can specify a nested stack resource (the logical ID of an AWS::CloudFormation::Stack resource)
* only if it's in one of the following states: DELETE_IN_PROGRESS, DELETE_COMPLETE, or
* DELETE_FAILED.
*
*
* @param resourcesToSkip
* A list of the logical IDs of the resources that AWS CloudFormation skips during the continue update
* rollback operation. You can specify only resources that are in the UPDATE_FAILED state
* because a rollback failed. You can't specify resources that are in the UPDATE_FAILED state
* for other reasons, for example, because an update was canceled. To check why a resource update failed, use
* the DescribeStackResources action, and view the resource status reason.
*
* Specify this property to skip rolling back resources that AWS CloudFormation can't successfully roll back.
* We recommend that you troubleshoot resources before skipping them. AWS CloudFormation sets the status of the specified
* resources to UPDATE_COMPLETE and continues to roll back the stack. After the rollback is
* complete, the state of the skipped resources will be inconsistent with the state of the resources in the
* stack template. Before performing another stack update, you must update the stack or resources to be
* consistent with each other. If you don't, subsequent stack updates might fail, and the stack will become
* unrecoverable.
*
*
*
* Specify the minimum number of resources required to successfully roll back your stack. For example, a
* failed resource update might cause dependent resources to fail. In this case, it might not be necessary to
* skip the dependent resources.
*
*
* To specify resources in a nested stack, use the following format:
* NestedStackName.ResourceLogicalID. You can specify a nested stack resource (the logical ID of
* an AWS::CloudFormation::Stack resource) only if it's in one of the following states:
* DELETE_IN_PROGRESS, DELETE_COMPLETE, or DELETE_FAILED.
*/
public void setResourcesToSkip(java.util.Collection resourcesToSkip) {
if (resourcesToSkip == null) {
this.resourcesToSkip = null;
return;
}
this.resourcesToSkip = new com.amazonaws.internal.SdkInternalList(resourcesToSkip);
}
/**
*
* A list of the logical IDs of the resources that AWS CloudFormation skips during the continue update rollback
* operation. You can specify only resources that are in the UPDATE_FAILED state because a rollback
* failed. You can't specify resources that are in the UPDATE_FAILED state for other reasons, for
* example, because an update was canceled. To check why a resource update failed, use the
* DescribeStackResources action, and view the resource status reason.
*
*
*
* Specify this property to skip rolling back resources that AWS CloudFormation can't successfully roll back. We
* recommend that you troubleshoot resources before skipping them. AWS CloudFormation sets the status of the specified resources
* to UPDATE_COMPLETE and continues to roll back the stack. After the rollback is complete, the state
* of the skipped resources will be inconsistent with the state of the resources in the stack template. Before
* performing another stack update, you must update the stack or resources to be consistent with each other. If you
* don't, subsequent stack updates might fail, and the stack will become unrecoverable.
*
*
*
* Specify the minimum number of resources required to successfully roll back your stack. For example, a failed
* resource update might cause dependent resources to fail. In this case, it might not be necessary to skip the
* dependent resources.
*
*
* To specify resources in a nested stack, use the following format: NestedStackName.ResourceLogicalID.
* You can specify a nested stack resource (the logical ID of an AWS::CloudFormation::Stack resource)
* only if it's in one of the following states: DELETE_IN_PROGRESS, DELETE_COMPLETE, or
* DELETE_FAILED.
*
*
* NOTE: This method appends the values to the existing list (if any). Use
* {@link #setResourcesToSkip(java.util.Collection)} or {@link #withResourcesToSkip(java.util.Collection)} if you
* want to override the existing values.
*
*
* @param resourcesToSkip
* A list of the logical IDs of the resources that AWS CloudFormation skips during the continue update
* rollback operation. You can specify only resources that are in the UPDATE_FAILED state
* because a rollback failed. You can't specify resources that are in the UPDATE_FAILED state
* for other reasons, for example, because an update was canceled. To check why a resource update failed, use
* the DescribeStackResources action, and view the resource status reason.
*
* Specify this property to skip rolling back resources that AWS CloudFormation can't successfully roll back.
* We recommend that you troubleshoot resources before skipping them. AWS CloudFormation sets the status of the specified
* resources to UPDATE_COMPLETE and continues to roll back the stack. After the rollback is
* complete, the state of the skipped resources will be inconsistent with the state of the resources in the
* stack template. Before performing another stack update, you must update the stack or resources to be
* consistent with each other. If you don't, subsequent stack updates might fail, and the stack will become
* unrecoverable.
*
*
*
* Specify the minimum number of resources required to successfully roll back your stack. For example, a
* failed resource update might cause dependent resources to fail. In this case, it might not be necessary to
* skip the dependent resources.
*
*
* To specify resources in a nested stack, use the following format:
* NestedStackName.ResourceLogicalID. You can specify a nested stack resource (the logical ID of
* an AWS::CloudFormation::Stack resource) only if it's in one of the following states:
* DELETE_IN_PROGRESS, DELETE_COMPLETE, or DELETE_FAILED.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public ContinueUpdateRollbackRequest withResourcesToSkip(String... resourcesToSkip) {
if (this.resourcesToSkip == null) {
setResourcesToSkip(new com.amazonaws.internal.SdkInternalList(resourcesToSkip.length));
}
for (String ele : resourcesToSkip) {
this.resourcesToSkip.add(ele);
}
return this;
}
/**
*
* A list of the logical IDs of the resources that AWS CloudFormation skips during the continue update rollback
* operation. You can specify only resources that are in the UPDATE_FAILED state because a rollback
* failed. You can't specify resources that are in the UPDATE_FAILED state for other reasons, for
* example, because an update was canceled. To check why a resource update failed, use the
* DescribeStackResources action, and view the resource status reason.
*
*
*
* Specify this property to skip rolling back resources that AWS CloudFormation can't successfully roll back. We
* recommend that you troubleshoot resources before skipping them. AWS CloudFormation sets the status of the specified resources
* to UPDATE_COMPLETE and continues to roll back the stack. After the rollback is complete, the state
* of the skipped resources will be inconsistent with the state of the resources in the stack template. Before
* performing another stack update, you must update the stack or resources to be consistent with each other. If you
* don't, subsequent stack updates might fail, and the stack will become unrecoverable.
*
*
*
* Specify the minimum number of resources required to successfully roll back your stack. For example, a failed
* resource update might cause dependent resources to fail. In this case, it might not be necessary to skip the
* dependent resources.
*
*
* To specify resources in a nested stack, use the following format: NestedStackName.ResourceLogicalID.
* You can specify a nested stack resource (the logical ID of an AWS::CloudFormation::Stack resource)
* only if it's in one of the following states: DELETE_IN_PROGRESS, DELETE_COMPLETE, or
* DELETE_FAILED.
*
*
* @param resourcesToSkip
* A list of the logical IDs of the resources that AWS CloudFormation skips during the continue update
* rollback operation. You can specify only resources that are in the UPDATE_FAILED state
* because a rollback failed. You can't specify resources that are in the UPDATE_FAILED state
* for other reasons, for example, because an update was canceled. To check why a resource update failed, use
* the DescribeStackResources action, and view the resource status reason.
*
* Specify this property to skip rolling back resources that AWS CloudFormation can't successfully roll back.
* We recommend that you troubleshoot resources before skipping them. AWS CloudFormation sets the status of the specified
* resources to UPDATE_COMPLETE and continues to roll back the stack. After the rollback is
* complete, the state of the skipped resources will be inconsistent with the state of the resources in the
* stack template. Before performing another stack update, you must update the stack or resources to be
* consistent with each other. If you don't, subsequent stack updates might fail, and the stack will become
* unrecoverable.
*
*
*
* Specify the minimum number of resources required to successfully roll back your stack. For example, a
* failed resource update might cause dependent resources to fail. In this case, it might not be necessary to
* skip the dependent resources.
*
*
* To specify resources in a nested stack, use the following format:
* NestedStackName.ResourceLogicalID. You can specify a nested stack resource (the logical ID of
* an AWS::CloudFormation::Stack resource) only if it's in one of the following states:
* DELETE_IN_PROGRESS, DELETE_COMPLETE, or DELETE_FAILED.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public ContinueUpdateRollbackRequest withResourcesToSkip(java.util.Collection resourcesToSkip) {
setResourcesToSkip(resourcesToSkip);
return this;
}
/**
* Returns a string representation of this object; useful for testing and debugging.
*
* @return A string representation of this object.
*
* @see java.lang.Object#toString()
*/
@Override
public String toString() {
StringBuilder sb = new StringBuilder();
sb.append("{");
if (getStackName() != null)
sb.append("StackName: ").append(getStackName()).append(",");
if (getRoleARN() != null)
sb.append("RoleARN: ").append(getRoleARN()).append(",");
if (getResourcesToSkip() != null)
sb.append("ResourcesToSkip: ").append(getResourcesToSkip());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof ContinueUpdateRollbackRequest == false)
return false;
ContinueUpdateRollbackRequest other = (ContinueUpdateRollbackRequest) obj;
if (other.getStackName() == null ^ this.getStackName() == null)
return false;
if (other.getStackName() != null && other.getStackName().equals(this.getStackName()) == false)
return false;
if (other.getRoleARN() == null ^ this.getRoleARN() == null)
return false;
if (other.getRoleARN() != null && other.getRoleARN().equals(this.getRoleARN()) == false)
return false;
if (other.getResourcesToSkip() == null ^ this.getResourcesToSkip() == null)
return false;
if (other.getResourcesToSkip() != null && other.getResourcesToSkip().equals(this.getResourcesToSkip()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getStackName() == null) ? 0 : getStackName().hashCode());
hashCode = prime * hashCode + ((getRoleARN() == null) ? 0 : getRoleARN().hashCode());
hashCode = prime * hashCode + ((getResourcesToSkip() == null) ? 0 : getResourcesToSkip().hashCode());
return hashCode;
}
@Override
public ContinueUpdateRollbackRequest clone() {
return (ContinueUpdateRollbackRequest) super.clone();
}
}