DeploymentAlarms (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.ecs.model.DeploymentAlarms

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class DeploymentAlarms
extends Object
implements Serializable, Cloneable, StructuredPojo
```
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:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

DeploymentAlarms()

Constructors
Constructor and Description
`DeploymentAlarms()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`DeploymentAlarms`	`clone()`
`boolean`	`equals(Object obj)`
`List<String>`	`getAlarmNames()` One or more CloudWatch alarm names.
`Boolean`	`getEnable()` Determines whether to use the CloudWatch alarm option in the service deployment process.
`Boolean`	`getRollback()` Determines whether to configure Amazon ECS to roll back the service if a service deployment fails.
`int`	`hashCode()`
`Boolean`	`isEnable()` Determines whether to use the CloudWatch alarm option in the service deployment process.
`Boolean`	`isRollback()` Determines whether to configure Amazon ECS to roll back the service if a service deployment fails.
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setAlarmNames(Collection<String> alarmNames)` One or more CloudWatch alarm names.
`void`	`setEnable(Boolean enable)` Determines whether to use the CloudWatch alarm option in the service deployment process.
`void`	`setRollback(Boolean rollback)` Determines whether to configure Amazon ECS to roll back the service if a service deployment fails.
`String`	`toString()` Returns a string representation of this object.
`DeploymentAlarms`	`withAlarmNames(Collection<String> alarmNames)` One or more CloudWatch alarm names.
`DeploymentAlarms`	`withAlarmNames(String... alarmNames)` One or more CloudWatch alarm names.
`DeploymentAlarms`	`withEnable(Boolean enable)` Determines whether to use the CloudWatch alarm option in the service deployment process.
`DeploymentAlarms`	`withRollback(Boolean rollback)` Determines whether to configure Amazon ECS to roll back the service if a service deployment fails.

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

- Constructor Detail
  - DeploymentAlarms
```
public DeploymentAlarms()
```
- Method Detail
  - getAlarmNames
```
public List<String> getAlarmNames()
```
    One or more CloudWatch alarm names. Use a "," to separate the alarms.
    
    Returns:
    
    One or more CloudWatch alarm names. Use a "," to separate the alarms.
  - setAlarmNames
```
public void setAlarmNames(Collection<String> alarmNames)
```
    One or more CloudWatch alarm names. Use a "," to separate the alarms.
    
    Parameters:
    
    alarmNames - One or more CloudWatch alarm names. Use a "," to separate the alarms.
  - withAlarmNames
```
public DeploymentAlarms withAlarmNames(String... alarmNames)
```
    One or more CloudWatch alarm names. Use a "," to separate the alarms.
    
    NOTE: This method appends the values to the existing list (if any). Use setAlarmNames(java.util.Collection) or withAlarmNames(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    alarmNames - One or more CloudWatch alarm names. Use a "," to separate the alarms.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withAlarmNames
```
public DeploymentAlarms withAlarmNames(Collection<String> alarmNames)
```
    One or more CloudWatch alarm names. Use a "," to separate the alarms.
    
    Parameters:
    
    alarmNames - One or more CloudWatch alarm names. Use a "," to separate the alarms.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setEnable
```
public void setEnable(Boolean enable)
```
    Determines whether to use the CloudWatch alarm option in the service deployment process.
    
    Parameters:
    
    enable - Determines whether to use the CloudWatch alarm option in the service deployment process.
  - getEnable
```
public Boolean getEnable()
```
    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.
  - withEnable
```
public DeploymentAlarms withEnable(Boolean enable)
```
    Determines whether to use the CloudWatch alarm option in the service deployment process.
    
    Parameters:
    
    enable - Determines whether to use the CloudWatch alarm option in the service deployment process.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - isEnable
```
public Boolean isEnable()
```
    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.
  - setRollback
```
public void setRollback(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.
    
    Parameters:
    
    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.
  - getRollback
```
public Boolean getRollback()
```
    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.
  - withRollback
```
public DeploymentAlarms withRollback(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.
    
    Parameters:
    
    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:
    
    Returns a reference to this object so that method calls can be chained together.
  - isRollback
```
public Boolean isRollback()
```
    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.
  - toString
```
public 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
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public DeploymentAlarms clone()
```
    Overrides:
    
    clone in class Object
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Description copied from interface: StructuredPojo
    
    Marshalls this structured data using the given ProtocolMarshaller.
    
    Specified by:
    
    marshall in interface StructuredPojo
    
    Parameters:
    
    protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.

AWS SDK for Java 1.x API Reference - 1.12.772

Class DeploymentAlarms

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

DeploymentAlarms

Method Detail

getAlarmNames

setAlarmNames

withAlarmNames

withAlarmNames

setEnable

getEnable

withEnable

isEnable

setRollback

getRollback

withRollback

isRollback

toString

equals

hashCode

clone

marshall