Interface ExecuteChangeSetRequest.Builder
- All Superinterfaces:
AwsRequest.Builder,Buildable,CloudFormationRequest.Builder,CopyableBuilder<ExecuteChangeSetRequest.Builder,,ExecuteChangeSetRequest> SdkBuilder<ExecuteChangeSetRequest.Builder,,ExecuteChangeSetRequest> SdkPojo,SdkRequest.Builder
- Enclosing class:
ExecuteChangeSetRequest
-
Method Summary
Modifier and TypeMethodDescriptionchangeSetName(String changeSetName) The name or Amazon Resource Name (ARN) of the change set that you want use to update the specified stack.clientRequestToken(String clientRequestToken) A unique identifier for thisExecuteChangeSetrequest.disableRollback(Boolean disableRollback) Preserves the state of previously provisioned resources when an operation fails.overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Add an optional request override configuration.overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) Add an optional request override configuration.retainExceptOnCreate(Boolean retainExceptOnCreate) When set totrue, newly created resources are deleted when the operation rolls back.If you specified the name of a change set, specify the stack name or Amazon Resource Name (ARN) that's associated with the change set you want to execute.Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder
overrideConfigurationMethods inherited from interface software.amazon.awssdk.services.cloudformation.model.CloudFormationRequest.Builder
buildMethods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copyMethods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, buildMethods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFieldNameToField, sdkFields
-
Method Details
-
changeSetName
The name or Amazon Resource Name (ARN) of the change set that you want use to update the specified stack.
- Parameters:
changeSetName- The name or Amazon Resource Name (ARN) of the change set that you want use to update the specified stack.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
stackName
If you specified the name of a change set, specify the stack name or Amazon Resource Name (ARN) that's associated with the change set you want to execute.
- Parameters:
stackName- If you specified the name of a change set, specify the stack name or Amazon Resource Name (ARN) that's associated with the change set you want to execute.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
clientRequestToken
A unique identifier for this
ExecuteChangeSetrequest. Specify this token if you plan to retry requests so that CloudFormation knows that you're not attempting to execute a change set to update a stack with the same name. You might retryExecuteChangeSetrequests to ensure that CloudFormation successfully received them.- Parameters:
clientRequestToken- A unique identifier for thisExecuteChangeSetrequest. Specify this token if you plan to retry requests so that CloudFormation knows that you're not attempting to execute a change set to update a stack with the same name. You might retryExecuteChangeSetrequests to ensure that CloudFormation successfully received them.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
disableRollback
Preserves the state of previously provisioned resources when an operation fails. This parameter can't be specified when the
OnStackFailureparameter to the CreateChangeSet API operation was specified.-
True- if the stack creation fails, do nothing. This is equivalent to specifyingDO_NOTHINGfor theOnStackFailureparameter to the CreateChangeSet API operation. -
False- if the stack creation fails, roll back the stack. This is equivalent to specifyingROLLBACKfor theOnStackFailureparameter to the CreateChangeSet API operation.
Default:
True- Parameters:
disableRollback- Preserves the state of previously provisioned resources when an operation fails. This parameter can't be specified when theOnStackFailureparameter to the CreateChangeSet API operation was specified.-
True- if the stack creation fails, do nothing. This is equivalent to specifyingDO_NOTHINGfor theOnStackFailureparameter to the CreateChangeSet API operation. -
False- if the stack creation fails, roll back the stack. This is equivalent to specifyingROLLBACKfor theOnStackFailureparameter to the CreateChangeSet API operation.
Default:
True-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
-
retainExceptOnCreate
When set to
true, newly created resources are deleted when the operation rolls back. This includes newly created resources marked with a deletion policy ofRetain.Default:
false- Parameters:
retainExceptOnCreate- When set totrue, newly created resources are deleted when the operation rolls back. This includes newly created resources marked with a deletion policy ofRetain.Default:
false- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
overrideConfiguration
ExecuteChangeSetRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) Description copied from interface:AwsRequest.BuilderAdd an optional request override configuration.- Specified by:
overrideConfigurationin interfaceAwsRequest.Builder- Parameters:
overrideConfiguration- The override configuration.- Returns:
- This object for method chaining.
-
overrideConfiguration
ExecuteChangeSetRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Description copied from interface:AwsRequest.BuilderAdd an optional request override configuration.- Specified by:
overrideConfigurationin interfaceAwsRequest.Builder- Parameters:
builderConsumer- AConsumerto which an emptyAwsRequestOverrideConfiguration.Builderwill be given.- Returns:
- This object for method chaining.
-