AWS SDK for C++  1.9.108
AWS SDK for C++
Public Member Functions | Protected Member Functions | List of all members
Aws::CloudFormation::Model::ContinueUpdateRollbackRequest Class Reference

#include <ContinueUpdateRollbackRequest.h>

+ Inheritance diagram for Aws::CloudFormation::Model::ContinueUpdateRollbackRequest:

Public Member Functions

 ContinueUpdateRollbackRequest ()
 
virtual const char * GetServiceRequestName () const override
 
Aws::String SerializePayload () const override
 
const Aws::StringGetStackName () const
 
bool StackNameHasBeenSet () const
 
void SetStackName (const Aws::String &value)
 
void SetStackName (Aws::String &&value)
 
void SetStackName (const char *value)
 
ContinueUpdateRollbackRequestWithStackName (const Aws::String &value)
 
ContinueUpdateRollbackRequestWithStackName (Aws::String &&value)
 
ContinueUpdateRollbackRequestWithStackName (const char *value)
 
const Aws::StringGetRoleARN () const
 
bool RoleARNHasBeenSet () const
 
void SetRoleARN (const Aws::String &value)
 
void SetRoleARN (Aws::String &&value)
 
void SetRoleARN (const char *value)
 
ContinueUpdateRollbackRequestWithRoleARN (const Aws::String &value)
 
ContinueUpdateRollbackRequestWithRoleARN (Aws::String &&value)
 
ContinueUpdateRollbackRequestWithRoleARN (const char *value)
 
const Aws::Vector< Aws::String > & GetResourcesToSkip () const
 
bool ResourcesToSkipHasBeenSet () const
 
void SetResourcesToSkip (const Aws::Vector< Aws::String > &value)
 
void SetResourcesToSkip (Aws::Vector< Aws::String > &&value)
 
ContinueUpdateRollbackRequestWithResourcesToSkip (const Aws::Vector< Aws::String > &value)
 
ContinueUpdateRollbackRequestWithResourcesToSkip (Aws::Vector< Aws::String > &&value)
 
ContinueUpdateRollbackRequestAddResourcesToSkip (const Aws::String &value)
 
ContinueUpdateRollbackRequestAddResourcesToSkip (Aws::String &&value)
 
ContinueUpdateRollbackRequestAddResourcesToSkip (const char *value)
 
const Aws::StringGetClientRequestToken () const
 
bool ClientRequestTokenHasBeenSet () const
 
void SetClientRequestToken (const Aws::String &value)
 
void SetClientRequestToken (Aws::String &&value)
 
void SetClientRequestToken (const char *value)
 
ContinueUpdateRollbackRequestWithClientRequestToken (const Aws::String &value)
 
ContinueUpdateRollbackRequestWithClientRequestToken (Aws::String &&value)
 
ContinueUpdateRollbackRequestWithClientRequestToken (const char *value)
 
- Public Member Functions inherited from Aws::CloudFormation::CloudFormationRequest
virtual ~CloudFormationRequest ()
 
void AddParametersToRequest (Aws::Http::HttpRequest &httpRequest) const
 
Aws::Http::HeaderValueCollection GetHeaders () const override
 
- Public Member Functions inherited from Aws::AmazonSerializableWebServiceRequest
 AmazonSerializableWebServiceRequest ()
 
virtual ~AmazonSerializableWebServiceRequest ()
 
std::shared_ptr< Aws::IOStreamGetBody () const override
 
- Public Member Functions inherited from Aws::AmazonWebServiceRequest
 AmazonWebServiceRequest ()
 
virtual ~AmazonWebServiceRequest ()=default
 
virtual void AddQueryStringParameters (Aws::Http::URI &uri) const
 
virtual void PutToPresignedUrl (Aws::Http::URI &uri) const
 
virtual bool IsStreaming () const
 
virtual bool IsEventStreamRequest () const
 
virtual bool SignBody () const
 
virtual bool IsChunked () const
 
virtual void SetRequestSignedHandler (const RequestSignedHandler &handler)
 
virtual const RequestSignedHandlerGetRequestSignedHandler () const
 
const Aws::IOStreamFactoryGetResponseStreamFactory () const
 
void SetResponseStreamFactory (const Aws::IOStreamFactory &factory)
 
virtual void SetDataReceivedEventHandler (const Aws::Http::DataReceivedEventHandler &dataReceivedEventHandler)
 
virtual void SetDataSentEventHandler (const Aws::Http::DataSentEventHandler &dataSentEventHandler)
 
virtual void SetContinueRequestHandler (const Aws::Http::ContinueRequestHandler &continueRequestHandler)
 
virtual void SetDataReceivedEventHandler (Aws::Http::DataReceivedEventHandler &&dataReceivedEventHandler)
 
virtual void SetDataSentEventHandler (Aws::Http::DataSentEventHandler &&dataSentEventHandler)
 
virtual void SetContinueRequestHandler (Aws::Http::ContinueRequestHandler &&continueRequestHandler)
 
virtual void SetRequestRetryHandler (const RequestRetryHandler &handler)
 
virtual void SetRequestRetryHandler (RequestRetryHandler &&handler)
 
virtual const Aws::Http::DataReceivedEventHandlerGetDataReceivedEventHandler () const
 
virtual const Aws::Http::DataSentEventHandlerGetDataSentEventHandler () const
 
virtual const Aws::Http::ContinueRequestHandlerGetContinueRequestHandler () const
 
virtual const RequestRetryHandlerGetRequestRetryHandler () const
 
virtual bool ShouldComputeContentMd5 () const
 

Protected Member Functions

void DumpBodyToUrl (Aws::Http::URI &uri) const override
 
- Protected Member Functions inherited from Aws::CloudFormation::CloudFormationRequest
virtual Aws::Http::HeaderValueCollection GetRequestSpecificHeaders () const
 

Detailed Description

The input for the ContinueUpdateRollback action.

See Also:

AWS API Reference

Definition at line 26 of file ContinueUpdateRollbackRequest.h.

Constructor & Destructor Documentation

◆ ContinueUpdateRollbackRequest()

Aws::CloudFormation::Model::ContinueUpdateRollbackRequest::ContinueUpdateRollbackRequest ( )

Member Function Documentation

◆ AddResourcesToSkip() [1/3]

ContinueUpdateRollbackRequest& Aws::CloudFormation::Model::ContinueUpdateRollbackRequest::AddResourcesToSkip ( Aws::String &&  value)
inline

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 cancelled. 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.

Definition at line 500 of file ContinueUpdateRollbackRequest.h.

◆ AddResourcesToSkip() [2/3]

ContinueUpdateRollbackRequest& Aws::CloudFormation::Model::ContinueUpdateRollbackRequest::AddResourcesToSkip ( const Aws::String value)
inline

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 cancelled. 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.

Definition at line 465 of file ContinueUpdateRollbackRequest.h.

◆ AddResourcesToSkip() [3/3]

ContinueUpdateRollbackRequest& Aws::CloudFormation::Model::ContinueUpdateRollbackRequest::AddResourcesToSkip ( const char *  value)
inline

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 cancelled. 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.

Definition at line 535 of file ContinueUpdateRollbackRequest.h.

◆ ClientRequestTokenHasBeenSet()

bool Aws::CloudFormation::Model::ContinueUpdateRollbackRequest::ClientRequestTokenHasBeenSet ( ) const
inline

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.

Definition at line 554 of file ContinueUpdateRollbackRequest.h.

◆ DumpBodyToUrl()

void Aws::CloudFormation::Model::ContinueUpdateRollbackRequest::DumpBodyToUrl ( Aws::Http::URI uri) const
overrideprotectedvirtual

Default does nothing. Override this to convert what would otherwise be the payload of the request to a query string format.

Reimplemented from Aws::AmazonWebServiceRequest.

◆ GetClientRequestToken()

const Aws::String& Aws::CloudFormation::Model::ContinueUpdateRollbackRequest::GetClientRequestToken ( ) const
inline

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.

Definition at line 545 of file ContinueUpdateRollbackRequest.h.

◆ GetResourcesToSkip()

const Aws::Vector<Aws::String>& Aws::CloudFormation::Model::ContinueUpdateRollbackRequest::GetResourcesToSkip ( ) const
inline

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 cancelled. 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.

Definition at line 255 of file ContinueUpdateRollbackRequest.h.

◆ GetRoleARN()

const Aws::String& Aws::CloudFormation::Model::ContinueUpdateRollbackRequest::GetRoleARN ( ) const
inline

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. As long as 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 privilege.

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 is generated from your user credentials.

Definition at line 128 of file ContinueUpdateRollbackRequest.h.

◆ GetServiceRequestName()

virtual const char* Aws::CloudFormation::Model::ContinueUpdateRollbackRequest::GetServiceRequestName ( ) const
inlineoverridevirtual

Implements Aws::AmazonWebServiceRequest.

Definition at line 35 of file ContinueUpdateRollbackRequest.h.

◆ GetStackName()

const Aws::String& Aws::CloudFormation::Model::ContinueUpdateRollbackRequest::GetStackName ( ) const
inline

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).

Definition at line 51 of file ContinueUpdateRollbackRequest.h.

◆ ResourcesToSkipHasBeenSet()

bool Aws::CloudFormation::Model::ContinueUpdateRollbackRequest::ResourcesToSkipHasBeenSet ( ) const
inline

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 cancelled. 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.

Definition at line 290 of file ContinueUpdateRollbackRequest.h.

◆ RoleARNHasBeenSet()

bool Aws::CloudFormation::Model::ContinueUpdateRollbackRequest::RoleARNHasBeenSet ( ) const
inline

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. As long as 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 privilege.

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 is generated from your user credentials.

Definition at line 141 of file ContinueUpdateRollbackRequest.h.

◆ SerializePayload()

Aws::String Aws::CloudFormation::Model::ContinueUpdateRollbackRequest::SerializePayload ( ) const
overridevirtual

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

◆ SetClientRequestToken() [1/3]

void Aws::CloudFormation::Model::ContinueUpdateRollbackRequest::SetClientRequestToken ( Aws::String &&  value)
inline

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.

Definition at line 572 of file ContinueUpdateRollbackRequest.h.

◆ SetClientRequestToken() [2/3]

void Aws::CloudFormation::Model::ContinueUpdateRollbackRequest::SetClientRequestToken ( const Aws::String value)
inline

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.

Definition at line 563 of file ContinueUpdateRollbackRequest.h.

◆ SetClientRequestToken() [3/3]

void Aws::CloudFormation::Model::ContinueUpdateRollbackRequest::SetClientRequestToken ( const char *  value)
inline

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.

Definition at line 581 of file ContinueUpdateRollbackRequest.h.

◆ SetResourcesToSkip() [1/2]

void Aws::CloudFormation::Model::ContinueUpdateRollbackRequest::SetResourcesToSkip ( Aws::Vector< Aws::String > &&  value)
inline

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 cancelled. 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.

Definition at line 360 of file ContinueUpdateRollbackRequest.h.

◆ SetResourcesToSkip() [2/2]

void Aws::CloudFormation::Model::ContinueUpdateRollbackRequest::SetResourcesToSkip ( const Aws::Vector< Aws::String > &  value)
inline

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 cancelled. 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.

Definition at line 325 of file ContinueUpdateRollbackRequest.h.

◆ SetRoleARN() [1/3]

void Aws::CloudFormation::Model::ContinueUpdateRollbackRequest::SetRoleARN ( Aws::String &&  value)
inline

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. As long as 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 privilege.

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 is generated from your user credentials.

Definition at line 167 of file ContinueUpdateRollbackRequest.h.

◆ SetRoleARN() [2/3]

void Aws::CloudFormation::Model::ContinueUpdateRollbackRequest::SetRoleARN ( const Aws::String value)
inline

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. As long as 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 privilege.

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 is generated from your user credentials.

Definition at line 154 of file ContinueUpdateRollbackRequest.h.

◆ SetRoleARN() [3/3]

void Aws::CloudFormation::Model::ContinueUpdateRollbackRequest::SetRoleARN ( const char *  value)
inline

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. As long as 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 privilege.

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 is generated from your user credentials.

Definition at line 180 of file ContinueUpdateRollbackRequest.h.

◆ SetStackName() [1/3]

void Aws::CloudFormation::Model::ContinueUpdateRollbackRequest::SetStackName ( Aws::String &&  value)
inline

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).

Definition at line 78 of file ContinueUpdateRollbackRequest.h.

◆ SetStackName() [2/3]

void Aws::CloudFormation::Model::ContinueUpdateRollbackRequest::SetStackName ( const Aws::String value)
inline

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).

Definition at line 69 of file ContinueUpdateRollbackRequest.h.

◆ SetStackName() [3/3]

void Aws::CloudFormation::Model::ContinueUpdateRollbackRequest::SetStackName ( const char *  value)
inline

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).

Definition at line 87 of file ContinueUpdateRollbackRequest.h.

◆ StackNameHasBeenSet()

bool Aws::CloudFormation::Model::ContinueUpdateRollbackRequest::StackNameHasBeenSet ( ) const
inline

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).

Definition at line 60 of file ContinueUpdateRollbackRequest.h.

◆ WithClientRequestToken() [1/3]

ContinueUpdateRollbackRequest& Aws::CloudFormation::Model::ContinueUpdateRollbackRequest::WithClientRequestToken ( Aws::String &&  value)
inline

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.

Definition at line 599 of file ContinueUpdateRollbackRequest.h.

◆ WithClientRequestToken() [2/3]

ContinueUpdateRollbackRequest& Aws::CloudFormation::Model::ContinueUpdateRollbackRequest::WithClientRequestToken ( const Aws::String value)
inline

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.

Definition at line 590 of file ContinueUpdateRollbackRequest.h.

◆ WithClientRequestToken() [3/3]

ContinueUpdateRollbackRequest& Aws::CloudFormation::Model::ContinueUpdateRollbackRequest::WithClientRequestToken ( const char *  value)
inline

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.

Definition at line 608 of file ContinueUpdateRollbackRequest.h.

◆ WithResourcesToSkip() [1/2]

ContinueUpdateRollbackRequest& Aws::CloudFormation::Model::ContinueUpdateRollbackRequest::WithResourcesToSkip ( Aws::Vector< Aws::String > &&  value)
inline

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 cancelled. 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.

Definition at line 430 of file ContinueUpdateRollbackRequest.h.

◆ WithResourcesToSkip() [2/2]

ContinueUpdateRollbackRequest& Aws::CloudFormation::Model::ContinueUpdateRollbackRequest::WithResourcesToSkip ( const Aws::Vector< Aws::String > &  value)
inline

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 cancelled. 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.

Definition at line 395 of file ContinueUpdateRollbackRequest.h.

◆ WithRoleARN() [1/3]

ContinueUpdateRollbackRequest& Aws::CloudFormation::Model::ContinueUpdateRollbackRequest::WithRoleARN ( Aws::String &&  value)
inline

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. As long as 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 privilege.

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 is generated from your user credentials.

Definition at line 206 of file ContinueUpdateRollbackRequest.h.

◆ WithRoleARN() [2/3]

ContinueUpdateRollbackRequest& Aws::CloudFormation::Model::ContinueUpdateRollbackRequest::WithRoleARN ( const Aws::String value)
inline

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. As long as 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 privilege.

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 is generated from your user credentials.

Definition at line 193 of file ContinueUpdateRollbackRequest.h.

◆ WithRoleARN() [3/3]

ContinueUpdateRollbackRequest& Aws::CloudFormation::Model::ContinueUpdateRollbackRequest::WithRoleARN ( const char *  value)
inline

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. As long as 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 privilege.

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 is generated from your user credentials.

Definition at line 219 of file ContinueUpdateRollbackRequest.h.

◆ WithStackName() [1/3]

ContinueUpdateRollbackRequest& Aws::CloudFormation::Model::ContinueUpdateRollbackRequest::WithStackName ( Aws::String &&  value)
inline

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).

Definition at line 105 of file ContinueUpdateRollbackRequest.h.

◆ WithStackName() [2/3]

ContinueUpdateRollbackRequest& Aws::CloudFormation::Model::ContinueUpdateRollbackRequest::WithStackName ( const Aws::String value)
inline

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).

Definition at line 96 of file ContinueUpdateRollbackRequest.h.

◆ WithStackName() [3/3]

ContinueUpdateRollbackRequest& Aws::CloudFormation::Model::ContinueUpdateRollbackRequest::WithStackName ( const char *  value)
inline

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).

Definition at line 114 of file ContinueUpdateRollbackRequest.h.


The documentation for this class was generated from the following file: