Struct aws_sdk_cloudformation::operation::continue_update_rollback::builders::ContinueUpdateRollbackFluentBuilder
source · pub struct ContinueUpdateRollbackFluentBuilder { /* private fields */ }
Expand description
Fluent builder constructing a request to ContinueUpdateRollback
.
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.
Implementations§
source§impl ContinueUpdateRollbackFluentBuilder
impl ContinueUpdateRollbackFluentBuilder
sourcepub fn as_input(&self) -> &ContinueUpdateRollbackInputBuilder
pub fn as_input(&self) -> &ContinueUpdateRollbackInputBuilder
Access the ContinueUpdateRollback as a reference.
sourcepub async fn send(
self
) -> Result<ContinueUpdateRollbackOutput, SdkError<ContinueUpdateRollbackError, HttpResponse>>
pub async fn send( self ) -> Result<ContinueUpdateRollbackOutput, SdkError<ContinueUpdateRollbackError, HttpResponse>>
Sends the request and returns the response.
If an error occurs, an SdkError
will be returned with additional details that
can be matched against.
By default, any retryable failures will be retried twice. Retry behavior is configurable with the RetryConfig, which can be set when configuring the client.
sourcepub fn customize(
self
) -> CustomizableOperation<ContinueUpdateRollbackOutput, ContinueUpdateRollbackError, Self>
pub fn customize( self ) -> CustomizableOperation<ContinueUpdateRollbackOutput, ContinueUpdateRollbackError, Self>
Consumes this builder, creating a customizable operation that can be modified before being sent.
sourcepub fn stack_name(self, input: impl Into<String>) -> Self
pub fn stack_name(self, input: impl Into<String>) -> Self
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).
sourcepub fn set_stack_name(self, input: Option<String>) -> Self
pub fn set_stack_name(self, input: Option<String>) -> Self
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).
sourcepub fn get_stack_name(&self) -> &Option<String>
pub fn get_stack_name(&self) -> &Option<String>
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).
sourcepub fn role_arn(self, input: impl Into<String>) -> Self
pub fn role_arn(self, input: impl Into<String>) -> Self
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.
sourcepub fn set_role_arn(self, input: Option<String>) -> Self
pub fn set_role_arn(self, input: Option<String>) -> Self
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.
sourcepub fn get_role_arn(&self) -> &Option<String>
pub fn get_role_arn(&self) -> &Option<String>
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.
sourcepub fn resources_to_skip(self, input: impl Into<String>) -> Self
pub fn resources_to_skip(self, input: impl Into<String>) -> Self
Appends an item to ResourcesToSkip
.
To override the contents of this collection use set_resources_to_skip
.
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.
sourcepub fn set_resources_to_skip(self, input: Option<Vec<String>>) -> Self
pub fn set_resources_to_skip(self, input: Option<Vec<String>>) -> Self
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.
sourcepub fn get_resources_to_skip(&self) -> &Option<Vec<String>>
pub fn get_resources_to_skip(&self) -> &Option<Vec<String>>
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.
sourcepub fn client_request_token(self, input: impl Into<String>) -> Self
pub fn client_request_token(self, input: impl Into<String>) -> Self
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.
sourcepub fn set_client_request_token(self, input: Option<String>) -> Self
pub fn set_client_request_token(self, input: Option<String>) -> Self
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.
sourcepub fn get_client_request_token(&self) -> &Option<String>
pub fn get_client_request_token(&self) -> &Option<String>
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.
Trait Implementations§
source§impl Clone for ContinueUpdateRollbackFluentBuilder
impl Clone for ContinueUpdateRollbackFluentBuilder
source§fn clone(&self) -> ContinueUpdateRollbackFluentBuilder
fn clone(&self) -> ContinueUpdateRollbackFluentBuilder
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moreAuto Trait Implementations§
impl Freeze for ContinueUpdateRollbackFluentBuilder
impl !RefUnwindSafe for ContinueUpdateRollbackFluentBuilder
impl Send for ContinueUpdateRollbackFluentBuilder
impl Sync for ContinueUpdateRollbackFluentBuilder
impl Unpin for ContinueUpdateRollbackFluentBuilder
impl !UnwindSafe for ContinueUpdateRollbackFluentBuilder
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
source§impl<T> Instrument for T
impl<T> Instrument for T
source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
source§impl<T> IntoEither for T
impl<T> IntoEither for T
source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left
is true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read moresource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left(&self)
returns true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read more