Interface ContinueUpdateRollbackRequest.Builder
-
- All Superinterfaces:
AwsRequest.Builder
,Buildable
,CloudFormationRequest.Builder
,CopyableBuilder<ContinueUpdateRollbackRequest.Builder,ContinueUpdateRollbackRequest>
,SdkBuilder<ContinueUpdateRollbackRequest.Builder,ContinueUpdateRollbackRequest>
,SdkPojo
,SdkRequest.Builder
- Enclosing class:
- ContinueUpdateRollbackRequest
public static interface ContinueUpdateRollbackRequest.Builder extends CloudFormationRequest.Builder, SdkPojo, CopyableBuilder<ContinueUpdateRollbackRequest.Builder,ContinueUpdateRollbackRequest>
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description ContinueUpdateRollbackRequest.Builder
clientRequestToken(String clientRequestToken)
A unique identifier for thisContinueUpdateRollback
request.ContinueUpdateRollbackRequest.Builder
overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
ContinueUpdateRollbackRequest.Builder
overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
ContinueUpdateRollbackRequest.Builder
resourcesToSkip(String... resourcesToSkip)
A list of the logical IDs of the resources that CloudFormation skips during the continue update rollback operation.ContinueUpdateRollbackRequest.Builder
resourcesToSkip(Collection<String> resourcesToSkip)
A list of the logical IDs of the resources that CloudFormation skips during the continue update rollback operation.ContinueUpdateRollbackRequest.Builder
roleARN(String roleARN)
The Amazon Resource Name (ARN) of an Identity and Access Management (IAM) role that CloudFormation assumes to roll back the stack.ContinueUpdateRollbackRequest.Builder
stackName(String stackName)
The name or the unique ID of the stack that you want to continue rolling back.-
Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder
overrideConfiguration
-
Methods inherited from interface software.amazon.awssdk.services.cloudformation.model.CloudFormationRequest.Builder
build
-
Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
-
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build
-
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFields
-
-
-
-
Method Detail
-
stackName
ContinueUpdateRollbackRequest.Builder stackName(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 theAWS::CloudFormation::Stack
resource).- Parameters:
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 theAWS::CloudFormation::Stack
resource).- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
roleARN
ContinueUpdateRollbackRequest.Builder roleARN(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.
- Parameters:
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.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
resourcesToSkip
ContinueUpdateRollbackRequest.Builder resourcesToSkip(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 theUPDATE_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 theResourcesToSkip
list, then its corresponding embedded stack must be in one of the following states:DELETE_IN_PROGRESS
,DELETE_COMPLETE
, orDELETE_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.
- Parameters:
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 theUPDATE_FAILED
state because a rollback failed. You can't specify resources that are in theUPDATE_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 theResourcesToSkip
list, then its corresponding embedded stack must be in one of the following states:DELETE_IN_PROGRESS
,DELETE_COMPLETE
, orDELETE_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.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
resourcesToSkip
ContinueUpdateRollbackRequest.Builder resourcesToSkip(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 theUPDATE_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 theResourcesToSkip
list, then its corresponding embedded stack must be in one of the following states:DELETE_IN_PROGRESS
,DELETE_COMPLETE
, orDELETE_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.
- Parameters:
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 theUPDATE_FAILED
state because a rollback failed. You can't specify resources that are in theUPDATE_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 theResourcesToSkip
list, then its corresponding embedded stack must be in one of the following states:DELETE_IN_PROGRESS
,DELETE_COMPLETE
, orDELETE_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.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
clientRequestToken
ContinueUpdateRollbackRequest.Builder clientRequestToken(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 retryContinueUpdateRollback
requests to ensure that CloudFormation successfully received them.- Parameters:
clientRequestToken
- A unique identifier for thisContinueUpdateRollback
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 retryContinueUpdateRollback
requests to ensure that CloudFormation successfully received them.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
overrideConfiguration
ContinueUpdateRollbackRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
- Specified by:
overrideConfiguration
in interfaceAwsRequest.Builder
-
overrideConfiguration
ContinueUpdateRollbackRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
- Specified by:
overrideConfiguration
in interfaceAwsRequest.Builder
-
-