Package software.amazon.awssdk.services.cloudformation.model

Interface RollbackConfiguration.Builder

All Superinterfaces:

Buildable, CopyableBuilder<RollbackConfiguration.Builder,RollbackConfiguration>, SdkBuilder<RollbackConfiguration.Builder,RollbackConfiguration>, SdkPojo

Enclosing class:

RollbackConfiguration

public static interface RollbackConfiguration.Builder
extends SdkPojo, CopyableBuilder<RollbackConfiguration.Builder,RollbackConfiguration>

Method Summary

Modifier and Type	Method	Description
RollbackConfiguration.Builder	monitoringTimeInMinutes(Integer monitoringTimeInMinutes)	The amount of time, in minutes, during which CloudFormation should monitor all the rollback triggers after the stack creation or update operation deploys all necessary resources.
RollbackConfiguration.Builder	rollbackTriggers(Collection<RollbackTrigger> rollbackTriggers)	The triggers to monitor during stack creation or update actions.
RollbackConfiguration.Builder	rollbackTriggers(Consumer<RollbackTrigger.Builder>... rollbackTriggers)	The triggers to monitor during stack creation or update actions.
RollbackConfiguration.Builder	rollbackTriggers(RollbackTrigger... rollbackTriggers)	The triggers to monitor during stack creation or update actions.

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 Details

rollbackTriggers

RollbackConfiguration.Builder rollbackTriggers(Collection<RollbackTrigger> rollbackTriggers)

The triggers to monitor during stack creation or update actions.

By default, CloudFormation saves the rollback triggers specified for a stack and applies them to any subsequent update operations for the stack, unless you specify otherwise. If you do specify rollback triggers for this parameter, those triggers replace any list of triggers previously specified for the stack. This means:

• To use the rollback triggers previously specified for this stack, if any, don't specify this parameter.

• To specify new or updated rollback triggers, you must specify all the triggers that you want used for this stack, even triggers you've specified before (for example, when creating the stack or during a previous stack update). Any triggers that you don't include in the updated list of triggers are no longer applied to the stack.

• To remove all currently specified triggers, specify an empty list for this parameter.

If a specified trigger is missing, the entire stack operation fails and is rolled back.

Parameters:

rollbackTriggers - The triggers to monitor during stack creation or update actions.

By default, CloudFormation saves the rollback triggers specified for a stack and applies them to any subsequent update operations for the stack, unless you specify otherwise. If you do specify rollback triggers for this parameter, those triggers replace any list of triggers previously specified for the stack. This means:

• To use the rollback triggers previously specified for this stack, if any, don't specify this parameter.

• To specify new or updated rollback triggers, you must specify all the triggers that you want used for this stack, even triggers you've specified before (for example, when creating the stack or during a previous stack update). Any triggers that you don't include in the updated list of triggers are no longer applied to the stack.

• To remove all currently specified triggers, specify an empty list for this parameter.

If a specified trigger is missing, the entire stack operation fails and is rolled back.

Returns:

Returns a reference to this object so that method calls can be chained together.

rollbackTriggers

RollbackConfiguration.Builder rollbackTriggers(RollbackTrigger... rollbackTriggers)

The triggers to monitor during stack creation or update actions.

By default, CloudFormation saves the rollback triggers specified for a stack and applies them to any subsequent update operations for the stack, unless you specify otherwise. If you do specify rollback triggers for this parameter, those triggers replace any list of triggers previously specified for the stack. This means:

• To use the rollback triggers previously specified for this stack, if any, don't specify this parameter.

• To specify new or updated rollback triggers, you must specify all the triggers that you want used for this stack, even triggers you've specified before (for example, when creating the stack or during a previous stack update). Any triggers that you don't include in the updated list of triggers are no longer applied to the stack.

• To remove all currently specified triggers, specify an empty list for this parameter.

If a specified trigger is missing, the entire stack operation fails and is rolled back.

Parameters:

rollbackTriggers - The triggers to monitor during stack creation or update actions.

By default, CloudFormation saves the rollback triggers specified for a stack and applies them to any subsequent update operations for the stack, unless you specify otherwise. If you do specify rollback triggers for this parameter, those triggers replace any list of triggers previously specified for the stack. This means:

• To use the rollback triggers previously specified for this stack, if any, don't specify this parameter.

• To specify new or updated rollback triggers, you must specify all the triggers that you want used for this stack, even triggers you've specified before (for example, when creating the stack or during a previous stack update). Any triggers that you don't include in the updated list of triggers are no longer applied to the stack.

• To remove all currently specified triggers, specify an empty list for this parameter.

If a specified trigger is missing, the entire stack operation fails and is rolled back.

Returns:

Returns a reference to this object so that method calls can be chained together.

rollbackTriggers

RollbackConfiguration.Builder rollbackTriggers(Consumer<RollbackTrigger.Builder>... rollbackTriggers)

The triggers to monitor during stack creation or update actions.

By default, CloudFormation saves the rollback triggers specified for a stack and applies them to any subsequent update operations for the stack, unless you specify otherwise. If you do specify rollback triggers for this parameter, those triggers replace any list of triggers previously specified for the stack. This means:

• To use the rollback triggers previously specified for this stack, if any, don't specify this parameter.

• To specify new or updated rollback triggers, you must specify all the triggers that you want used for this stack, even triggers you've specified before (for example, when creating the stack or during a previous stack update). Any triggers that you don't include in the updated list of triggers are no longer applied to the stack.

• To remove all currently specified triggers, specify an empty list for this parameter.

If a specified trigger is missing, the entire stack operation fails and is rolled back.

This is a convenience method that creates an instance of the RollbackTrigger.Builder avoiding the need to create one manually via RollbackTrigger.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to rollbackTriggers(List<RollbackTrigger>).

Parameters:

rollbackTriggers - a consumer that will call methods on RollbackTrigger.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

• rollbackTriggers(java.util.Collection<RollbackTrigger>)

monitoringTimeInMinutes

RollbackConfiguration.Builder monitoringTimeInMinutes(Integer monitoringTimeInMinutes)

The amount of time, in minutes, during which CloudFormation should monitor all the rollback triggers after the stack creation or update operation deploys all necessary resources.

The default is 0 minutes.

If you specify a monitoring period but don't specify any rollback triggers, CloudFormation still waits the specified period of time before cleaning up old resources after update operations. You can use this monitoring period to perform any manual stack validation desired, and manually cancel the stack creation or update (using CancelUpdateStack, for example) as necessary.

If you specify 0 for this parameter, CloudFormation still monitors the specified rollback triggers during stack creation and update operations. Then, for update operations, it begins disposing of old resources immediately once the operation completes.

Parameters:

monitoringTimeInMinutes - The amount of time, in minutes, during which CloudFormation should monitor all the rollback triggers after the stack creation or update operation deploys all necessary resources.

The default is 0 minutes.

If you specify a monitoring period but don't specify any rollback triggers, CloudFormation still waits the specified period of time before cleaning up old resources after update operations. You can use this monitoring period to perform any manual stack validation desired, and manually cancel the stack creation or update (using CancelUpdateStack, for example) as necessary.

If you specify 0 for this parameter, CloudFormation still monitors the specified rollback triggers during stack creation and update operations. Then, for update operations, it begins disposing of old resources immediately once the operation completes.

Returns:

Returns a reference to this object so that method calls can be chained together.