AutoScalingGroup (AWS Java SDK :: Services :: Auto Scaling 2.16.78 API)

java.lang.Object
- software.amazon.awssdk.services.autoscaling.model.AutoScalingGroup

All Implemented Interfaces:: Serializable, SdkPojo, ToCopyableBuilder<AutoScalingGroup.Builder,AutoScalingGroup>

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

Describes an Auto Scaling group.

See Also:: Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface AutoScalingGroup.Builder

Nested Classes
Modifier and Type	Class and Description
`static interface`	`AutoScalingGroup.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`String`	`autoScalingGroupARN()` The Amazon Resource Name (ARN) of the Auto Scaling group.
`String`	`autoScalingGroupName()` The name of the Auto Scaling group.
`List<String>`	`availabilityZones()` One or more Availability Zones for the group.
`static AutoScalingGroup.Builder`	`builder()`
`Boolean`	`capacityRebalance()` Indicates whether Capacity Rebalancing is enabled.
`Instant`	`createdTime()` The date and time the group was created.
`Integer`	`defaultCooldown()` The duration of the default cooldown period, in seconds.
`Integer`	`desiredCapacity()` The desired size of the group.
`List<EnabledMetric>`	`enabledMetrics()` The metrics enabled for the group.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`boolean`	`hasAvailabilityZones()` Returns true if the AvailabilityZones property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
`boolean`	`hasEnabledMetrics()` Returns true if the EnabledMetrics property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
`int`	`hashCode()`
`boolean`	`hasInstances()` Returns true if the Instances property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
`boolean`	`hasLoadBalancerNames()` Returns true if the LoadBalancerNames property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
`boolean`	`hasSuspendedProcesses()` Returns true if the SuspendedProcesses property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
`boolean`	`hasTags()` Returns true if the Tags property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
`boolean`	`hasTargetGroupARNs()` Returns true if the TargetGroupARNs property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
`boolean`	`hasTerminationPolicies()` Returns true if the TerminationPolicies property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
`Integer`	`healthCheckGracePeriod()` The amount of time, in seconds, that Amazon EC2 Auto Scaling waits before checking the health status of an EC2 instance that has come into service.
`String`	`healthCheckType()` The service to use for the health checks.
`List<Instance>`	`instances()` The EC2 instances associated with the group.
`String`	`launchConfigurationName()` The name of the associated launch configuration.
`LaunchTemplateSpecification`	`launchTemplate()` The launch template for the group.
`List<String>`	`loadBalancerNames()` One or more load balancers associated with the group.
`Integer`	`maxInstanceLifetime()` The maximum amount of time, in seconds, that an instance can be in service.
`Integer`	`maxSize()` The maximum size of the group.
`Integer`	`minSize()` The minimum size of the group.
`MixedInstancesPolicy`	`mixedInstancesPolicy()` The mixed instances policy for the group.
`Boolean`	`newInstancesProtectedFromScaleIn()` Indicates whether newly launched instances are protected from termination by Amazon EC2 Auto Scaling when scaling in.
`String`	`placementGroup()` The name of the placement group into which to launch your instances, if any.
`Integer`	`predictedCapacity()` The predicted capacity of the group when it has a predictive scaling policy.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends AutoScalingGroup.Builder>`	`serializableBuilderClass()`
`String`	`serviceLinkedRoleARN()` The Amazon Resource Name (ARN) of the service-linked role that the Auto Scaling group uses to call other Amazon Web Services on your behalf.
`String`	`status()` The current state of the group when the DeleteAutoScalingGroup operation is in progress.
`List<SuspendedProcess>`	`suspendedProcesses()` The suspended processes associated with the group.
`List<TagDescription>`	`tags()` The tags for the group.
`List<String>`	`targetGroupARNs()` The Amazon Resource Names (ARN) of the target groups for your load balancer.
`List<String>`	`terminationPolicies()` The termination policies for the group.
`AutoScalingGroup.Builder`	`toBuilder()`
`String`	`toString()` Returns a string representation of this object.
`String`	`vpcZoneIdentifier()` One or more subnet IDs, if applicable, separated by commas.
`WarmPoolConfiguration`	`warmPoolConfiguration()` The warm pool for the group.
`Integer`	`warmPoolSize()` The current size of the warm pool.

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
  - autoScalingGroupName
```
public final String autoScalingGroupName()
```
    The name of the Auto Scaling group.
    
    Returns:
    
    The name of the Auto Scaling group.
  - autoScalingGroupARN
```
public final String autoScalingGroupARN()
```
    The Amazon Resource Name (ARN) of the Auto Scaling group.
    
    Returns:
    
    The Amazon Resource Name (ARN) of the Auto Scaling group.
  - launchConfigurationName
```
public final String launchConfigurationName()
```
    The name of the associated launch configuration.
    
    Returns:
    
    The name of the associated launch configuration.
  - launchTemplate
```
public final LaunchTemplateSpecification launchTemplate()
```
    The launch template for the group.
    
    Returns:
    
    The launch template for the group.
  - mixedInstancesPolicy
```
public final MixedInstancesPolicy mixedInstancesPolicy()
```
    The mixed instances policy for the group.
    
    Returns:
    
    The mixed instances policy for the group.
  - minSize
```
public final Integer minSize()
```
    The minimum size of the group.
    
    Returns:
    
    The minimum size of the group.
  - maxSize
```
public final Integer maxSize()
```
    The maximum size of the group.
    
    Returns:
    
    The maximum size of the group.
  - desiredCapacity
```
public final Integer desiredCapacity()
```
    The desired size of the group.
    
    Returns:
    
    The desired size of the group.
  - predictedCapacity
```
public final Integer predictedCapacity()
```
    The predicted capacity of the group when it has a predictive scaling policy.
    
    Returns:
    
    The predicted capacity of the group when it has a predictive scaling policy.
  - defaultCooldown
```
public final Integer defaultCooldown()
```
    The duration of the default cooldown period, in seconds.
    
    Returns:
    
    The duration of the default cooldown period, in seconds.
  - hasAvailabilityZones
```
public final boolean hasAvailabilityZones()
```
    Returns true if the AvailabilityZones property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.
  - availabilityZones
```
public final List<String> availabilityZones()
```
    One or more Availability Zones for the group.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    You can use hasAvailabilityZones() to see if a value was sent in this field.
    
    Returns:
    
    One or more Availability Zones for the group.
  - hasLoadBalancerNames
```
public final boolean hasLoadBalancerNames()
```
    Returns true if the LoadBalancerNames property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.
  - loadBalancerNames
```
public final List<String> loadBalancerNames()
```
    One or more load balancers associated with the group.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    You can use hasLoadBalancerNames() to see if a value was sent in this field.
    
    Returns:
    
    One or more load balancers associated with the group.
  - hasTargetGroupARNs
```
public final boolean hasTargetGroupARNs()
```
    Returns true if the TargetGroupARNs property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.
  - targetGroupARNs
```
public final List<String> targetGroupARNs()
```
    The Amazon Resource Names (ARN) of the target groups for your load balancer.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    You can use hasTargetGroupARNs() to see if a value was sent in this field.
    
    Returns:
    
    The Amazon Resource Names (ARN) of the target groups for your load balancer.
  - healthCheckType
```
public final String healthCheckType()
```
    The service to use for the health checks. The valid values are EC2 and ELB. If you configure an Auto Scaling group to use ELB health checks, it considers the instance unhealthy if it fails either the EC2 status checks or the load balancer health checks.
    
    Returns:
    
    The service to use for the health checks. The valid values are EC2 and ELB. If you configure an Auto Scaling group to use ELB health checks, it considers the instance unhealthy if it fails either the EC2 status checks or the load balancer health checks.
  - healthCheckGracePeriod
```
public final Integer healthCheckGracePeriod()
```
    The amount of time, in seconds, that Amazon EC2 Auto Scaling waits before checking the health status of an EC2 instance that has come into service.
    
    Returns:
    
    The amount of time, in seconds, that Amazon EC2 Auto Scaling waits before checking the health status of an EC2 instance that has come into service.
  - hasInstances
```
public final boolean hasInstances()
```
    Returns true if the Instances property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.
  - instances
```
public final List<Instance> instances()
```
    The EC2 instances associated with the group.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    You can use hasInstances() to see if a value was sent in this field.
    
    Returns:
    
    The EC2 instances associated with the group.
  - createdTime
```
public final Instant createdTime()
```
    The date and time the group was created.
    
    Returns:
    
    The date and time the group was created.
  - hasSuspendedProcesses
```
public final boolean hasSuspendedProcesses()
```
    Returns true if the SuspendedProcesses property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.
  - suspendedProcesses
```
public final List<SuspendedProcess> suspendedProcesses()
```
    The suspended processes associated with the group.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    You can use hasSuspendedProcesses() to see if a value was sent in this field.
    
    Returns:
    
    The suspended processes associated with the group.
  - placementGroup
```
public final String placementGroup()
```
    The name of the placement group into which to launch your instances, if any.
    
    Returns:
    
    The name of the placement group into which to launch your instances, if any.
  - vpcZoneIdentifier
```
public final String vpcZoneIdentifier()
```
    One or more subnet IDs, if applicable, separated by commas.
    
    Returns:
    
    One or more subnet IDs, if applicable, separated by commas.
  - hasEnabledMetrics
```
public final boolean hasEnabledMetrics()
```
    Returns true if the EnabledMetrics property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.
  - enabledMetrics
```
public final List<EnabledMetric> enabledMetrics()
```
    The metrics enabled for the group.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    You can use hasEnabledMetrics() to see if a value was sent in this field.
    
    Returns:
    
    The metrics enabled for the group.
  - status
```
public final String status()
```
    The current state of the group when the DeleteAutoScalingGroup operation is in progress.
    
    Returns:
    
    The current state of the group when the DeleteAutoScalingGroup operation is in progress.
  - hasTags
```
public final boolean hasTags()
```
    Returns true if the Tags property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.
  - tags
```
public final List<TagDescription> tags()
```
    The tags for the group.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    You can use hasTags() to see if a value was sent in this field.
    
    Returns:
    
    The tags for the group.
  - hasTerminationPolicies
```
public final boolean hasTerminationPolicies()
```
    Returns true if the TerminationPolicies property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.
  - terminationPolicies
```
public final List<String> terminationPolicies()
```
    The termination policies for the group.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    You can use hasTerminationPolicies() to see if a value was sent in this field.
    
    Returns:
    
    The termination policies for the group.
  - newInstancesProtectedFromScaleIn
```
public final Boolean newInstancesProtectedFromScaleIn()
```
    Indicates whether newly launched instances are protected from termination by Amazon EC2 Auto Scaling when scaling in.
    
    Returns:
    
    Indicates whether newly launched instances are protected from termination by Amazon EC2 Auto Scaling when scaling in.
  - serviceLinkedRoleARN
```
public final String serviceLinkedRoleARN()
```
    The Amazon Resource Name (ARN) of the service-linked role that the Auto Scaling group uses to call other Amazon Web Services on your behalf.
    
    Returns:
    
    The Amazon Resource Name (ARN) of the service-linked role that the Auto Scaling group uses to call other Amazon Web Services on your behalf.
  - maxInstanceLifetime
```
public final Integer maxInstanceLifetime()
```
    The maximum amount of time, in seconds, that an instance can be in service.
    
    Valid Range: Minimum value of 0.
    
    Returns:
    
    The maximum amount of time, in seconds, that an instance can be in service.
    
    Valid Range: Minimum value of 0.
  - capacityRebalance
```
public final Boolean capacityRebalance()
```
    Indicates whether Capacity Rebalancing is enabled.
    
    Returns:
    
    Indicates whether Capacity Rebalancing is enabled.
  - warmPoolConfiguration
```
public final WarmPoolConfiguration warmPoolConfiguration()
```
    The warm pool for the group.
    
    Returns:
    
    The warm pool for the group.
  - warmPoolSize
```
public final Integer warmPoolSize()
```
    The current size of the warm pool.
    
    Returns:
    
    The current size of the warm pool.
  - toBuilder
```
public AutoScalingGroup.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<AutoScalingGroup.Builder,AutoScalingGroup>
  - builder
```
public static AutoScalingGroup.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends AutoScalingGroup.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 AutoScalingGroup

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

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

Method Detail

autoScalingGroupName

autoScalingGroupARN

launchConfigurationName

launchTemplate

mixedInstancesPolicy

minSize

maxSize

desiredCapacity

predictedCapacity

defaultCooldown

hasAvailabilityZones

availabilityZones

hasLoadBalancerNames

loadBalancerNames

hasTargetGroupARNs

targetGroupARNs

healthCheckType

healthCheckGracePeriod

hasInstances

instances

createdTime

hasSuspendedProcesses

suspendedProcesses

placementGroup

vpcZoneIdentifier

hasEnabledMetrics

enabledMetrics

status

hasTags

tags

hasTerminationPolicies

terminationPolicies

newInstancesProtectedFromScaleIn

serviceLinkedRoleARN

maxInstanceLifetime

capacityRebalance

warmPoolConfiguration

warmPoolSize

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields