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:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interface
AutoScalingGroupProvider.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description String
autoScalingGroupArn()
The Amazon Resource Name (ARN) that identifies the Auto Scaling group, or the Auto Scaling group name.static AutoScalingGroupProvider.Builder
builder()
boolean
equals(Object obj)
boolean
equalsBySdkFields(Object obj)
<T> Optional<T>
getValueForField(String fieldName, Class<T> clazz)
int
hashCode()
ManagedDraining
managedDraining()
The managed draining option for the Auto Scaling group capacity provider.String
managedDrainingAsString()
The managed draining option for the Auto Scaling group capacity provider.ManagedScaling
managedScaling()
The managed scaling settings for the Auto Scaling group capacity provider.ManagedTerminationProtection
managedTerminationProtection()
The managed termination protection setting to use for the Auto Scaling group capacity provider.String
managedTerminationProtectionAsString()
The managed termination protection setting to use for the Auto Scaling group capacity provider.List<SdkField<?>>
sdkFields()
static Class<? extends AutoScalingGroupProvider.Builder>
serializableBuilderClass()
AutoScalingGroupProvider.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
-
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 returnManagedTerminationProtection.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available frommanagedTerminationProtectionAsString()
.- 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:
ManagedTerminationProtection
-
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 returnManagedTerminationProtection.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available frommanagedTerminationProtectionAsString()
.- 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:
ManagedTerminationProtection
-
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 returnManagedDraining.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available frommanagedDrainingAsString()
.- 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:
ManagedDraining
-
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 returnManagedDraining.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available frommanagedDrainingAsString()
.- 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:
ManagedDraining
-
toBuilder
public AutoScalingGroupProvider.Builder toBuilder()
- Specified by:
toBuilder
in interfaceToCopyableBuilder<AutoScalingGroupProvider.Builder,AutoScalingGroupProvider>
-
builder
public static AutoScalingGroupProvider.Builder builder()
-
serializableBuilderClass
public static Class<? extends AutoScalingGroupProvider.Builder> serializableBuilderClass()
-
equalsBySdkFields
public final boolean equalsBySdkFields(Object obj)
- Specified by:
equalsBySdkFields
in interfaceSdkPojo
-
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.
-
-