RollbackConfiguration (AWS Java SDK :: Services :: AWS CloudFormation 2.17.114 API)

java.lang.Object
- software.amazon.awssdk.services.cloudformation.model.RollbackConfiguration

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<RollbackConfiguration.Builder,RollbackConfiguration>
```
@Generated(value="software.amazon.awssdk:codegen")
public final class RollbackConfiguration
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<RollbackConfiguration.Builder,RollbackConfiguration>
```
Structure containing the rollback triggers for CloudFormation to monitor during stack creation and updating operations, and for the specified monitoring period afterwards.

Rollback triggers enable you to have CloudFormation monitor the state of your application during stack creation and updating, and to roll back that operation if the application breaches the threshold of any of the alarms you've specified. For more information, see Monitor and Roll Back Stack Operations.

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface RollbackConfiguration.Builder

Nested Classes
Modifier and Type	Class and Description
`static interface`	`RollbackConfiguration.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static RollbackConfiguration.Builder`	`builder()`
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`int`	`hashCode()`
`boolean`	`hasRollbackTriggers()` For responses, this returns true if the service returned a value for the RollbackTriggers property.
`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.
`List<RollbackTrigger>`	`rollbackTriggers()` The triggers to monitor during stack creation or update actions.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends RollbackConfiguration.Builder>`	`serializableBuilderClass()`
`RollbackConfiguration.Builder`	`toBuilder()`
`String`	`toString()` Returns a string representation of this object.

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy

- Method Detail
  - hasRollbackTriggers
```
public final boolean hasRollbackTriggers()
```
    For responses, this returns true if the service returned a value for the RollbackTriggers property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
  - rollbackTriggers
```
public final List<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 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.
    - 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.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasRollbackTriggers() method.
    Returns:
    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 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.
    
    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.
  - monitoringTimeInMinutes
```
public final 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 do not 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:
    
    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 do not 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.
  - toBuilder
```
public RollbackConfiguration.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<RollbackConfiguration.Builder,RollbackConfiguration>
  - builder
```
public static RollbackConfiguration.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends RollbackConfiguration.Builder> serializableBuilderClass()
```
  - hashCode
```
public final int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public final boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - equalsBySdkFields
```
public final boolean equalsBySdkFields(Object obj)
```
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
  - toString
```
public final String toString()
```
    Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
    
    Overrides:
    
    toString in class Object
  - getValueForField
```
public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)
```
  - sdkFields
```
public final List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo

Class RollbackConfiguration

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

Method Detail

hasRollbackTriggers

rollbackTriggers

monitoringTimeInMinutes

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields