AutoScalingGroup (AWS SDK for Java

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()`
`Instant`	`createdTime()` The date and time the group was created.
`Integer`	`defaultCooldown()` The amount of time, in seconds, after a scaling activity completes before another scaling activity can start.
`Integer`	`desiredCapacity()` The desired size of the group.
`List<EnabledMetric>`	`enabledMetrics()` The metrics enabled for the group.
`boolean`	`equals(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`int`	`hashCode()`
`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`	`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 Auto Scaling when scaling in.
`String`	`placementGroup()` The name of the placement group into which to launch your instances, if any.
`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 AWS services on your behalf.
`String`	`status()` The current state of the group when DeleteAutoScalingGroup 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()` Take this object and create a builder that contains all of the current property values of this object.
`String`	`toString()`
`String`	`vpcZoneIdentifier()` One or more subnet IDs, if applicable, separated by commas.

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

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

- Method Detail
  - autoScalingGroupName
```
public String autoScalingGroupName()
```
    The name of the Auto Scaling group.
    
    Returns:
    
    The name of the Auto Scaling group.
  - autoScalingGroupARN
```
public 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 String launchConfigurationName()
```
    The name of the associated launch configuration.
    
    Returns:
    
    The name of the associated launch configuration.
  - launchTemplate
```
public LaunchTemplateSpecification launchTemplate()
```
    The launch template for the group.
    
    Returns:
    
    The launch template for the group.
  - mixedInstancesPolicy
```
public MixedInstancesPolicy mixedInstancesPolicy()
```
    The mixed instances policy for the group.
    
    Returns:
    
    The mixed instances policy for the group.
  - minSize
```
public Integer minSize()
```
    The minimum size of the group.
    
    Returns:
    
    The minimum size of the group.
  - maxSize
```
public Integer maxSize()
```
    The maximum size of the group.
    
    Returns:
    
    The maximum size of the group.
  - desiredCapacity
```
public Integer desiredCapacity()
```
    The desired size of the group.
    
    Returns:
    
    The desired size of the group.
  - defaultCooldown
```
public Integer defaultCooldown()
```
    The amount of time, in seconds, after a scaling activity completes before another scaling activity can start.
    
    Returns:
    
    The amount of time, in seconds, after a scaling activity completes before another scaling activity can start.
  - availabilityZones
```
public 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.
    
    Returns:
    
    One or more Availability Zones for the group.
  - loadBalancerNames
```
public 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.
    
    Returns:
    
    One or more load balancers associated with the group.
  - targetGroupARNs
```
public 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.
    
    Returns:
    
    The Amazon Resource Names (ARN) of the target groups for your load balancer.
  - healthCheckType
```
public String healthCheckType()
```
    The service to use for the health checks. The valid values are EC2 and ELB.
    
    Returns:
    
    The service to use for the health checks. The valid values are EC2 and ELB.
  - healthCheckGracePeriod
```
public 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.
  - instances
```
public List<Instance> instances()
```
    The EC2 instances associated with the group.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    Returns:
    
    The EC2 instances associated with the group.
  - createdTime
```
public Instant createdTime()
```
    The date and time the group was created.
    
    Returns:
    
    The date and time the group was created.
  - suspendedProcesses
```
public List<SuspendedProcess> suspendedProcesses()
```
    The suspended processes associated with the group.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    Returns:
    
    The suspended processes associated with the group.
  - placementGroup
```
public String placementGroup()
```
    The name of the placement group into which to launch your instances, if any. For more information, see Placement Groups in the Amazon Elastic Compute Cloud User Guide.
    
    Returns:
    
    The name of the placement group into which to launch your instances, if any. For more information, see Placement Groups in the Amazon Elastic Compute Cloud User Guide.
  - vpcZoneIdentifier
```
public String vpcZoneIdentifier()
```
    One or more subnet IDs, if applicable, separated by commas.
    
    If you specify VPCZoneIdentifier and AvailabilityZones, ensure that the Availability Zones of the subnets match the values for AvailabilityZones.
    
    Returns:
    
    One or more subnet IDs, if applicable, separated by commas.
    
    If you specify VPCZoneIdentifier and AvailabilityZones, ensure that the Availability Zones of the subnets match the values for AvailabilityZones.
  - enabledMetrics
```
public List<EnabledMetric> enabledMetrics()
```
    The metrics enabled for the group.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    Returns:
    
    The metrics enabled for the group.
  - status
```
public String status()
```
    The current state of the group when DeleteAutoScalingGroup is in progress.
    
    Returns:
    
    The current state of the group when DeleteAutoScalingGroup is in progress.
  - tags
```
public List<TagDescription> tags()
```
    The tags for the group.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    Returns:
    
    The tags for the group.
  - terminationPolicies
```
public List<String> terminationPolicies()
```
    The termination policies for the group.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    Returns:
    
    The termination policies for the group.
  - newInstancesProtectedFromScaleIn
```
public Boolean newInstancesProtectedFromScaleIn()
```
    Indicates whether newly launched instances are protected from termination by Auto Scaling when scaling in.
    
    Returns:
    
    Indicates whether newly launched instances are protected from termination by Auto Scaling when scaling in.
  - serviceLinkedRoleARN
```
public String serviceLinkedRoleARN()
```
    The Amazon Resource Name (ARN) of the service-linked role that the Auto Scaling group uses to call other AWS services on your behalf.
    
    Returns:
    
    The Amazon Resource Name (ARN) of the service-linked role that the Auto Scaling group uses to call other AWS services on your behalf.
  - toBuilder
```
public AutoScalingGroup.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<AutoScalingGroup.Builder,AutoScalingGroup>
    
    Returns:
    
    a builder for type T
  - builder
```
public static AutoScalingGroup.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends AutoScalingGroup.Builder> serializableBuilderClass()
```
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - getValueForField
```
public <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)
```
  - sdkFields
```
public 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.

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

defaultCooldown

availabilityZones

loadBalancerNames

targetGroupARNs

healthCheckType

healthCheckGracePeriod

instances

createdTime

suspendedProcesses

placementGroup

vpcZoneIdentifier

enabledMetrics

status

tags

terminationPolicies

newInstancesProtectedFromScaleIn

serviceLinkedRoleARN

toBuilder

builder

serializableBuilderClass

hashCode

equals

toString

getValueForField

sdkFields