@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class ContinueUpdateRollbackRequest extends AmazonWebServiceRequest implements Serializable, Cloneable
The input for the ContinueUpdateRollback action.
NOOP
Constructor and Description |
---|
ContinueUpdateRollbackRequest() |
Modifier and Type | Method and Description |
---|---|
ContinueUpdateRollbackRequest |
clone()
Creates a shallow clone of this object for all fields except the handler context.
|
boolean |
equals(Object obj) |
String |
getClientRequestToken()
A unique identifier for this
ContinueUpdateRollback request. |
List<String> |
getResourcesToSkip()
A list of the logical IDs of the resources that CloudFormation skips during the continue update rollback
operation.
|
String |
getRoleARN()
The Amazon Resource Name (ARN) of an Identity and Access Management (IAM) role that CloudFormation assumes to
roll back the stack.
|
String |
getStackName()
The name or the unique ID of the stack that you want to continue rolling back.
|
int |
hashCode() |
void |
setClientRequestToken(String clientRequestToken)
A unique identifier for this
ContinueUpdateRollback request. |
void |
setResourcesToSkip(Collection<String> resourcesToSkip)
A list of the logical IDs of the resources that CloudFormation skips during the continue update rollback
operation.
|
void |
setRoleARN(String roleARN)
The Amazon Resource Name (ARN) of an Identity and Access Management (IAM) role that CloudFormation assumes to
roll back the stack.
|
void |
setStackName(String stackName)
The name or the unique ID of the stack that you want to continue rolling back.
|
String |
toString()
Returns a string representation of this object.
|
ContinueUpdateRollbackRequest |
withClientRequestToken(String clientRequestToken)
A unique identifier for this
ContinueUpdateRollback request. |
ContinueUpdateRollbackRequest |
withResourcesToSkip(Collection<String> resourcesToSkip)
A list of the logical IDs of the resources that CloudFormation skips during the continue update rollback
operation.
|
ContinueUpdateRollbackRequest |
withResourcesToSkip(String... resourcesToSkip)
A list of the logical IDs of the resources that CloudFormation skips during the continue update rollback
operation.
|
ContinueUpdateRollbackRequest |
withRoleARN(String roleARN)
The Amazon Resource Name (ARN) of an Identity and Access Management (IAM) role that CloudFormation assumes to
roll back the stack.
|
ContinueUpdateRollbackRequest |
withStackName(String stackName)
The name or the unique ID of the stack that you want to continue rolling back.
|
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
public void setStackName(String 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).
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 String getStackName()
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).
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 ContinueUpdateRollbackRequest withStackName(String 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).
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 setRoleARN(String roleARN)
The Amazon Resource Name (ARN) of an Identity and Access Management (IAM) role that CloudFormation assumes to roll back the stack. CloudFormation uses the role's credentials to make calls on your behalf. CloudFormation always uses this role for all future operations on the stack. Provided that users have permission to operate on the stack, CloudFormation uses this role even if the users don't have permission to pass it. Ensure that the role grants least permission.
If you don't specify a value, CloudFormation uses the role that was previously associated with the stack. If no role is available, CloudFormation uses a temporary session that's generated from your user credentials.
roleARN
- The Amazon Resource Name (ARN) of an Identity and Access Management (IAM) role that CloudFormation assumes
to roll back the stack. CloudFormation uses the role's credentials to make calls on your behalf.
CloudFormation always uses this role for all future operations on the stack. Provided that users have
permission to operate on the stack, CloudFormation uses this role even if the users don't have permission
to pass it. Ensure that the role grants least permission.
If you don't specify a value, CloudFormation uses the role that was previously associated with the stack. If no role is available, CloudFormation uses a temporary session that's generated from your user credentials.
public String getRoleARN()
The Amazon Resource Name (ARN) of an Identity and Access Management (IAM) role that CloudFormation assumes to roll back the stack. CloudFormation uses the role's credentials to make calls on your behalf. CloudFormation always uses this role for all future operations on the stack. Provided that users have permission to operate on the stack, CloudFormation uses this role even if the users don't have permission to pass it. Ensure that the role grants least permission.
If you don't specify a value, CloudFormation uses the role that was previously associated with the stack. If no role is available, CloudFormation uses a temporary session that's generated from your user credentials.
If you don't specify a value, CloudFormation uses the role that was previously associated with the stack. If no role is available, CloudFormation uses a temporary session that's generated from your user credentials.
public ContinueUpdateRollbackRequest withRoleARN(String roleARN)
The Amazon Resource Name (ARN) of an Identity and Access Management (IAM) role that CloudFormation assumes to roll back the stack. CloudFormation uses the role's credentials to make calls on your behalf. CloudFormation always uses this role for all future operations on the stack. Provided that users have permission to operate on the stack, CloudFormation uses this role even if the users don't have permission to pass it. Ensure that the role grants least permission.
If you don't specify a value, CloudFormation uses the role that was previously associated with the stack. If no role is available, CloudFormation uses a temporary session that's generated from your user credentials.
roleARN
- The Amazon Resource Name (ARN) of an Identity and Access Management (IAM) role that CloudFormation assumes
to roll back the stack. CloudFormation uses the role's credentials to make calls on your behalf.
CloudFormation always uses this role for all future operations on the stack. Provided that users have
permission to operate on the stack, CloudFormation uses this role even if the users don't have permission
to pass it. Ensure that the role grants least permission.
If you don't specify a value, CloudFormation uses the role that was previously associated with the stack. If no role is available, CloudFormation uses a temporary session that's generated from your user credentials.
public List<String> getResourcesToSkip()
A list of the logical IDs of the resources that 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 CloudFormation can't successfully roll back. We
recommend that you troubleshoot resources before skipping them. 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 skip resources that are part of nested stacks, use the following format:
NestedStackName.ResourceLogicalID
. If you want to specify the logical ID of a stack resource (
Type: AWS::CloudFormation::Stack
) in the ResourcesToSkip
list, then its corresponding
embedded stack must be in one of the following states: DELETE_IN_PROGRESS
,
DELETE_COMPLETE
, or DELETE_FAILED
.
Don't confuse a child stack's name with its corresponding logical ID defined in the parent stack. For an example of a continue update rollback operation with nested stacks, see Using ResourcesToSkip to recover a nested stacks hierarchy.
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 CloudFormation can't successfully roll back. We
recommend that you troubleshoot resources before skipping them. 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 skip resources that are part of nested stacks, use the following format:
NestedStackName.ResourceLogicalID
. If you want to specify the logical ID of a stack resource
(Type: AWS::CloudFormation::Stack
) in the ResourcesToSkip
list, then its
corresponding embedded stack must be in one of the following states: DELETE_IN_PROGRESS
,
DELETE_COMPLETE
, or DELETE_FAILED
.
Don't confuse a child stack's name with its corresponding logical ID defined in the parent stack. For an example of a continue update rollback operation with nested stacks, see Using ResourcesToSkip to recover a nested stacks hierarchy.
public void setResourcesToSkip(Collection<String> resourcesToSkip)
A list of the logical IDs of the resources that 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 CloudFormation can't successfully roll back. We
recommend that you troubleshoot resources before skipping them. 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 skip resources that are part of nested stacks, use the following format:
NestedStackName.ResourceLogicalID
. If you want to specify the logical ID of a stack resource (
Type: AWS::CloudFormation::Stack
) in the ResourcesToSkip
list, then its corresponding
embedded stack must be in one of the following states: DELETE_IN_PROGRESS
,
DELETE_COMPLETE
, or DELETE_FAILED
.
Don't confuse a child stack's name with its corresponding logical ID defined in the parent stack. For an example of a continue update rollback operation with nested stacks, see Using ResourcesToSkip to recover a nested stacks hierarchy.
resourcesToSkip
- A list of the logical IDs of the resources that 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 CloudFormation can't successfully roll back. We
recommend that you troubleshoot resources before skipping them. 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 skip resources that are part of nested stacks, use the following format:
NestedStackName.ResourceLogicalID
. If you want to specify the logical ID of a stack resource
(Type: AWS::CloudFormation::Stack
) in the ResourcesToSkip
list, then its
corresponding embedded stack must be in one of the following states: DELETE_IN_PROGRESS
,
DELETE_COMPLETE
, or DELETE_FAILED
.
Don't confuse a child stack's name with its corresponding logical ID defined in the parent stack. For an example of a continue update rollback operation with nested stacks, see Using ResourcesToSkip to recover a nested stacks hierarchy.
public ContinueUpdateRollbackRequest withResourcesToSkip(String... resourcesToSkip)
A list of the logical IDs of the resources that 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 CloudFormation can't successfully roll back. We
recommend that you troubleshoot resources before skipping them. 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 skip resources that are part of nested stacks, use the following format:
NestedStackName.ResourceLogicalID
. If you want to specify the logical ID of a stack resource (
Type: AWS::CloudFormation::Stack
) in the ResourcesToSkip
list, then its corresponding
embedded stack must be in one of the following states: DELETE_IN_PROGRESS
,
DELETE_COMPLETE
, or DELETE_FAILED
.
Don't confuse a child stack's name with its corresponding logical ID defined in the parent stack. For an example of a continue update rollback operation with nested stacks, see Using ResourcesToSkip to recover a nested stacks hierarchy.
NOTE: This method appends the values to the existing list (if any). Use
setResourcesToSkip(java.util.Collection)
or withResourcesToSkip(java.util.Collection)
if you
want to override the existing values.
resourcesToSkip
- A list of the logical IDs of the resources that 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 CloudFormation can't successfully roll back. We
recommend that you troubleshoot resources before skipping them. 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 skip resources that are part of nested stacks, use the following format:
NestedStackName.ResourceLogicalID
. If you want to specify the logical ID of a stack resource
(Type: AWS::CloudFormation::Stack
) in the ResourcesToSkip
list, then its
corresponding embedded stack must be in one of the following states: DELETE_IN_PROGRESS
,
DELETE_COMPLETE
, or DELETE_FAILED
.
Don't confuse a child stack's name with its corresponding logical ID defined in the parent stack. For an example of a continue update rollback operation with nested stacks, see Using ResourcesToSkip to recover a nested stacks hierarchy.
public ContinueUpdateRollbackRequest withResourcesToSkip(Collection<String> resourcesToSkip)
A list of the logical IDs of the resources that 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 CloudFormation can't successfully roll back. We
recommend that you troubleshoot resources before skipping them. 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 skip resources that are part of nested stacks, use the following format:
NestedStackName.ResourceLogicalID
. If you want to specify the logical ID of a stack resource (
Type: AWS::CloudFormation::Stack
) in the ResourcesToSkip
list, then its corresponding
embedded stack must be in one of the following states: DELETE_IN_PROGRESS
,
DELETE_COMPLETE
, or DELETE_FAILED
.
Don't confuse a child stack's name with its corresponding logical ID defined in the parent stack. For an example of a continue update rollback operation with nested stacks, see Using ResourcesToSkip to recover a nested stacks hierarchy.
resourcesToSkip
- A list of the logical IDs of the resources that 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 CloudFormation can't successfully roll back. We
recommend that you troubleshoot resources before skipping them. 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 skip resources that are part of nested stacks, use the following format:
NestedStackName.ResourceLogicalID
. If you want to specify the logical ID of a stack resource
(Type: AWS::CloudFormation::Stack
) in the ResourcesToSkip
list, then its
corresponding embedded stack must be in one of the following states: DELETE_IN_PROGRESS
,
DELETE_COMPLETE
, or DELETE_FAILED
.
Don't confuse a child stack's name with its corresponding logical ID defined in the parent stack. For an example of a continue update rollback operation with nested stacks, see Using ResourcesToSkip to recover a nested stacks hierarchy.
public void setClientRequestToken(String clientRequestToken)
A unique identifier for this ContinueUpdateRollback
request. Specify this token if you plan to retry
requests so that CloudFormation knows that you're not attempting to continue the rollback to a stack with the
same name. You might retry ContinueUpdateRollback
requests to ensure that CloudFormation
successfully received them.
clientRequestToken
- A unique identifier for this ContinueUpdateRollback
request. Specify this token if you plan
to retry requests so that CloudFormation knows that you're not attempting to continue the rollback to a
stack with the same name. You might retry ContinueUpdateRollback
requests to ensure that
CloudFormation successfully received them.public String getClientRequestToken()
A unique identifier for this ContinueUpdateRollback
request. Specify this token if you plan to retry
requests so that CloudFormation knows that you're not attempting to continue the rollback to a stack with the
same name. You might retry ContinueUpdateRollback
requests to ensure that CloudFormation
successfully received them.
ContinueUpdateRollback
request. Specify this token if you plan
to retry requests so that CloudFormation knows that you're not attempting to continue the rollback to a
stack with the same name. You might retry ContinueUpdateRollback
requests to ensure that
CloudFormation successfully received them.public ContinueUpdateRollbackRequest withClientRequestToken(String clientRequestToken)
A unique identifier for this ContinueUpdateRollback
request. Specify this token if you plan to retry
requests so that CloudFormation knows that you're not attempting to continue the rollback to a stack with the
same name. You might retry ContinueUpdateRollback
requests to ensure that CloudFormation
successfully received them.
clientRequestToken
- A unique identifier for this ContinueUpdateRollback
request. Specify this token if you plan
to retry requests so that CloudFormation knows that you're not attempting to continue the rollback to a
stack with the same name. You might retry ContinueUpdateRollback
requests to ensure that
CloudFormation successfully received them.public String toString()
toString
in class Object
Object.toString()
public ContinueUpdateRollbackRequest clone()
AmazonWebServiceRequest
clone
in class AmazonWebServiceRequest
Object.clone()