Class DeploymentAlarms

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.

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

See Also:

  • Method Details

    • 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.

    • 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.

    • 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.

    • toBuilder

      public DeploymentAlarms.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<DeploymentAlarms.Builder,DeploymentAlarms>
      Returns:
      a builder for type T

    • 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)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.