java.lang.Object
- software.amazon.awssdk.services.ecs.model.DeploymentAlarms

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<DeploymentAlarms.Builder,DeploymentAlarms>
```
@Generated("software.amazon.awssdk:codegen")
public final class DeploymentAlarms
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<DeploymentAlarms.Builder,DeploymentAlarms>
```
One of the methods which provide a way for you to quickly identify when a deployment has failed, and then to optionally roll back the failure to the last working deployment.

When the alarms are generated, Amazon ECS sets the service deployment to failed. Set the rollback parameter to have Amazon ECS to roll back your service to the last completed deployment after a failure.

You can only use the DeploymentAlarms method to detect failures when the DeploymentController is set to ECS (rolling update).

For more information, see Rolling update in the Amazon Elastic Container Service Developer Guide .

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static interface DeploymentAlarms.Builder

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`List<String>`	`alarmNames()`	One or more CloudWatch alarm names.
`static DeploymentAlarms.Builder`	`builder()`
`Boolean`	`enable()`	Determines whether to use the CloudWatch alarm option in the service deployment process.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`boolean`	`hasAlarmNames()`	For responses, this returns true if the service returned a value for the AlarmNames property.
`int`	`hashCode()`
`Boolean`	`rollback()`	Determines whether to configure Amazon ECS to roll back the service if a service deployment fails.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends DeploymentAlarms.Builder>`	`serializableBuilderClass()`
`DeploymentAlarms.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
  - hasAlarmNames
```
public final boolean hasAlarmNames()
```
    For responses, this returns true if the service returned a value for the AlarmNames 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.
  - alarmNames
```
public final List<String> alarmNames()
```
    One or more CloudWatch alarm names. Use a "," to separate the alarms.
    
    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 hasAlarmNames() method.
    
    Returns:
    
    One or more CloudWatch alarm names. Use a "," to separate the alarms.
  - enable
```
public final Boolean enable()
```
    Determines whether to use the CloudWatch alarm option in the service deployment process.
    
    Returns:
    
    Determines whether to use the CloudWatch alarm option in the service deployment process.
  - rollback
```
public final Boolean rollback()
```
    Determines whether to configure Amazon ECS to roll back the service if a service deployment fails. If rollback is used, when a service deployment fails, the service is rolled back to the last deployment that completed successfully.
    
    Returns:
    
    Determines whether to configure Amazon ECS to roll back the service if a service deployment fails. If rollback is used, when a service deployment fails, the service is rolled back to the last deployment that completed successfully.
  - toBuilder
```
public DeploymentAlarms.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<DeploymentAlarms.Builder,DeploymentAlarms>
  - builder
```
public static DeploymentAlarms.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends DeploymentAlarms.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 DeploymentAlarms

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

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

Method Detail

hasAlarmNames

alarmNames

enable

rollback

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields