Class AutoScalingGroupProvider

java.lang.Object
software.amazon.awssdk.services.ecs.model.AutoScalingGroupProvider
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<AutoScalingGroupProvider.Builder,AutoScalingGroupProvider>

@Generated("software.amazon.awssdk:codegen") public final class AutoScalingGroupProvider extends Object implements SdkPojo, Serializable, ToCopyableBuilder<AutoScalingGroupProvider.Builder,AutoScalingGroupProvider>

The details of the Auto Scaling group for the capacity provider.

See Also:
  • Method Details

    • autoScalingGroupArn

      public final String autoScalingGroupArn()

      The Amazon Resource Name (ARN) that identifies the Auto Scaling group, or the Auto Scaling group name.

      Returns:
      The Amazon Resource Name (ARN) that identifies the Auto Scaling group, or the Auto Scaling group name.
    • managedScaling

      public final ManagedScaling managedScaling()

      The managed scaling settings for the Auto Scaling group capacity provider.

      Returns:
      The managed scaling settings for the Auto Scaling group capacity provider.
    • managedTerminationProtection

      public final ManagedTerminationProtection managedTerminationProtection()

      The managed termination protection setting to use for the Auto Scaling group capacity provider. This determines whether the Auto Scaling group has managed termination protection. The default is off.

      When using managed termination protection, managed scaling must also be used otherwise managed termination protection doesn't work.

      When managed termination protection is on, Amazon ECS prevents the Amazon EC2 instances in an Auto Scaling group that contain tasks from being terminated during a scale-in action. The Auto Scaling group and each instance in the Auto Scaling group must have instance protection from scale-in actions on as well. For more information, see Instance Protection in the Auto Scaling User Guide.

      When managed termination protection is off, your Amazon EC2 instances aren't protected from termination when the Auto Scaling group scales in.

      If the service returns an enum value that is not available in the current SDK version, managedTerminationProtection will return ManagedTerminationProtection.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from managedTerminationProtectionAsString().

      Returns:
      The managed termination protection setting to use for the Auto Scaling group capacity provider. This determines whether the Auto Scaling group has managed termination protection. The default is off.

      When using managed termination protection, managed scaling must also be used otherwise managed termination protection doesn't work.

      When managed termination protection is on, Amazon ECS prevents the Amazon EC2 instances in an Auto Scaling group that contain tasks from being terminated during a scale-in action. The Auto Scaling group and each instance in the Auto Scaling group must have instance protection from scale-in actions on as well. For more information, see Instance Protection in the Auto Scaling User Guide.

      When managed termination protection is off, your Amazon EC2 instances aren't protected from termination when the Auto Scaling group scales in.

      See Also:
    • managedTerminationProtectionAsString

      public final String managedTerminationProtectionAsString()

      The managed termination protection setting to use for the Auto Scaling group capacity provider. This determines whether the Auto Scaling group has managed termination protection. The default is off.

      When using managed termination protection, managed scaling must also be used otherwise managed termination protection doesn't work.

      When managed termination protection is on, Amazon ECS prevents the Amazon EC2 instances in an Auto Scaling group that contain tasks from being terminated during a scale-in action. The Auto Scaling group and each instance in the Auto Scaling group must have instance protection from scale-in actions on as well. For more information, see Instance Protection in the Auto Scaling User Guide.

      When managed termination protection is off, your Amazon EC2 instances aren't protected from termination when the Auto Scaling group scales in.

      If the service returns an enum value that is not available in the current SDK version, managedTerminationProtection will return ManagedTerminationProtection.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from managedTerminationProtectionAsString().

      Returns:
      The managed termination protection setting to use for the Auto Scaling group capacity provider. This determines whether the Auto Scaling group has managed termination protection. The default is off.

      When using managed termination protection, managed scaling must also be used otherwise managed termination protection doesn't work.

      When managed termination protection is on, Amazon ECS prevents the Amazon EC2 instances in an Auto Scaling group that contain tasks from being terminated during a scale-in action. The Auto Scaling group and each instance in the Auto Scaling group must have instance protection from scale-in actions on as well. For more information, see Instance Protection in the Auto Scaling User Guide.

      When managed termination protection is off, your Amazon EC2 instances aren't protected from termination when the Auto Scaling group scales in.

      See Also:
    • managedDraining

      public final ManagedDraining managedDraining()

      The managed draining option for the Auto Scaling group capacity provider. When you enable this, Amazon ECS manages and gracefully drains the EC2 container instances that are in the Auto Scaling group capacity provider.

      If the service returns an enum value that is not available in the current SDK version, managedDraining will return ManagedDraining.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from managedDrainingAsString().

      Returns:
      The managed draining option for the Auto Scaling group capacity provider. When you enable this, Amazon ECS manages and gracefully drains the EC2 container instances that are in the Auto Scaling group capacity provider.
      See Also:
    • managedDrainingAsString

      public final String managedDrainingAsString()

      The managed draining option for the Auto Scaling group capacity provider. When you enable this, Amazon ECS manages and gracefully drains the EC2 container instances that are in the Auto Scaling group capacity provider.

      If the service returns an enum value that is not available in the current SDK version, managedDraining will return ManagedDraining.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from managedDrainingAsString().

      Returns:
      The managed draining option for the Auto Scaling group capacity provider. When you enable this, Amazon ECS manages and gracefully drains the EC2 container instances that are in the Auto Scaling group capacity provider.
      See Also:
    • 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<AutoScalingGroupProvider.Builder,AutoScalingGroupProvider>
      Returns:
      a builder for type T
    • builder

      public static AutoScalingGroupProvider.Builder builder()
    • serializableBuilderClass

      public static Class<? extends AutoScalingGroupProvider.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.