software.amazon.awssdk.services.cloudformation.model

Interface RollbackConfiguration.Builder

All Superinterfaces:

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

Enclosing class:

RollbackConfiguration

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

Method Summary

Modifier and Type	Method and 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

Method Detail

rollbackTriggers

RollbackConfiguration.Builder rollbackTriggers(Collection<RollbackTrigger> rollbackTriggers)

The triggers to monitor during stack creation or update actions.

By default, AWS 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:

• If you don't specify this parameter, AWS CloudFormation uses the rollback triggers previously specified for this stack, if any.

• If you specify any rollback triggers using this parameter, you must specify all the triggers that you want used for this stack, even triggers you've specifed 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.

• If you specify an empty list, AWS CloudFormation removes all currently specified triggers.

If a specified Cloudwatch alarm 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, AWS 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:

• If you don't specify this parameter, AWS CloudFormation uses the rollback triggers previously specified for this stack, if any.

• If you specify any rollback triggers using this parameter, you must specify all the triggers that you want used for this stack, even triggers you've specifed 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.

• If you specify an empty list, AWS CloudFormation removes all currently specified triggers.

If a specified Cloudwatch alarm 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, AWS 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:

• If you don't specify this parameter, AWS CloudFormation uses the rollback triggers previously specified for this stack, if any.

• If you specify any rollback triggers using this parameter, you must specify all the triggers that you want used for this stack, even triggers you've specifed 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.

• If you specify an empty list, AWS CloudFormation removes all currently specified triggers.

If a specified Cloudwatch alarm 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, AWS 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:

• If you don't specify this parameter, AWS CloudFormation uses the rollback triggers previously specified for this stack, if any.

• If you specify any rollback triggers using this parameter, you must specify all the triggers that you want used for this stack, even triggers you've specifed 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.

• If you specify an empty list, AWS CloudFormation removes all currently specified triggers.

If a specified Cloudwatch alarm 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, AWS 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:

• If you don't specify this parameter, AWS CloudFormation uses the rollback triggers previously specified for this stack, if any.

• If you specify any rollback triggers using this parameter, you must specify all the triggers that you want used for this stack, even triggers you've specifed 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.

• If you specify an empty list, AWS CloudFormation removes all currently specified triggers.

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

This is a convenience that creates an instance of the List.Builder avoiding the need to create one manually via List#builder(). When the Consumer completes, List.Builder#build() is called immediately and its result is passed to #rollbackTriggers(List).

Parameters:

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

Returns:

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

See Also:

#rollbackTriggers(List)

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. If any of the alarms goes to ALERT state during the stack operation or this monitoring period, CloudFormation rolls back the entire stack operation. Then, for update operations, if the monitoring period expires without any alarms going to ALERT state CloudFormation proceeds to dispose of old resources as usual.

If you specify a monitoring period but do not specify any rollback triggers, CloudFormation still waits the specified period of time before cleaning up old resources for 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. If any of the alarms goes to ALERT state during the stack operation or this monitoring period, CloudFormation rolls back the entire stack operation. Then, for update operations, if the monitoring period expires without any alarms going to ALERT state CloudFormation proceeds to dispose of old resources as usual.

If you specify a monitoring period but do not specify any rollback triggers, CloudFormation still waits the specified period of time before cleaning up old resources for 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.