| Copyright | (c) 2013-2023 Brendan Hay |
|---|---|
| License | Mozilla Public License, v. 2.0. |
| Maintainer | Brendan Hay |
| Stability | auto-generated |
| Portability | non-portable (GHC extensions) |
| Safe Haskell | Safe-Inferred |
| Language | Haskell2010 |
Amazonka.CloudFormation.ContinueUpdateRollback
Description
For a specified stack that's in the UPDATE_ROLLBACK_FAILED state,
continues rolling it back to the UPDATE_ROLLBACK_COMPLETE state.
Depending on the cause of the failure, you can manually
fix the error
and continue the rollback. By continuing the rollback, you can return
your stack to a working state (the UPDATE_ROLLBACK_COMPLETE state),
and then try to update the stack again.
A stack goes into the UPDATE_ROLLBACK_FAILED state when CloudFormation
can't roll back all changes after a failed stack update. For example,
you might have a stack that's rolling back to an old database instance
that was deleted outside of CloudFormation. Because CloudFormation
doesn't know the database was deleted, it assumes that the database
instance still exists and attempts to roll back to it, causing the
update rollback to fail.
Synopsis
- data ContinueUpdateRollback = ContinueUpdateRollback' {}
- newContinueUpdateRollback :: Text -> ContinueUpdateRollback
- continueUpdateRollback_clientRequestToken :: Lens' ContinueUpdateRollback (Maybe Text)
- continueUpdateRollback_resourcesToSkip :: Lens' ContinueUpdateRollback (Maybe [Text])
- continueUpdateRollback_roleARN :: Lens' ContinueUpdateRollback (Maybe Text)
- continueUpdateRollback_stackName :: Lens' ContinueUpdateRollback Text
- data ContinueUpdateRollbackResponse = ContinueUpdateRollbackResponse' {
- httpStatus :: Int
- newContinueUpdateRollbackResponse :: Int -> ContinueUpdateRollbackResponse
- continueUpdateRollbackResponse_httpStatus :: Lens' ContinueUpdateRollbackResponse Int
Creating a Request
data ContinueUpdateRollback Source #
The input for the ContinueUpdateRollback action.
See: newContinueUpdateRollback smart constructor.
Constructors
| ContinueUpdateRollback' | |
Fields
| |
Instances
newContinueUpdateRollback Source #
Arguments
| :: Text | |
| -> ContinueUpdateRollback |
Create a value of ContinueUpdateRollback with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
ContinueUpdateRollback, continueUpdateRollback_clientRequestToken - A unique identifier for this ContinueUpdateRollback request. Specify
this token if you plan to retry requests so that CloudFormationknows
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.
$sel:resourcesToSkip:ContinueUpdateRollback', continueUpdateRollback_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.
ContinueUpdateRollback, continueUpdateRollback_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.
ContinueUpdateRollback, continueUpdateRollback_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).
Request Lenses
continueUpdateRollback_clientRequestToken :: Lens' ContinueUpdateRollback (Maybe Text) Source #
A unique identifier for this ContinueUpdateRollback request. Specify
this token if you plan to retry requests so that CloudFormationknows
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_resourcesToSkip :: Lens' ContinueUpdateRollback (Maybe [Text]) Source #
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.
continueUpdateRollback_roleARN :: Lens' ContinueUpdateRollback (Maybe Text) Source #
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.
continueUpdateRollback_stackName :: Lens' ContinueUpdateRollback Text Source #
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).
Destructuring the Response
data ContinueUpdateRollbackResponse Source #
The output for a ContinueUpdateRollback operation.
See: newContinueUpdateRollbackResponse smart constructor.
Constructors
| ContinueUpdateRollbackResponse' | |
Fields
| |
Instances
newContinueUpdateRollbackResponse Source #
Create a value of ContinueUpdateRollbackResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:ContinueUpdateRollbackResponse', continueUpdateRollbackResponse_httpStatus - The response's http status code.
Response Lenses
continueUpdateRollbackResponse_httpStatus :: Lens' ContinueUpdateRollbackResponse Int Source #
The response's http status code.