AutoScalingGroup (AWS Java SDK :: Services :: Auto Scaling 2.20.158 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.
`String`	`context()` Reserved.
`Instant`	`createdTime()` The date and time the group was created.
`Integer`	`defaultCooldown()` The duration of the default cooldown period, in seconds.
`Integer`	`defaultInstanceWarmup()` The duration of the default instance warmup, in seconds.
`Integer`	`desiredCapacity()` The desired size of the group.
`String`	`desiredCapacityType()` The unit of measurement for the value specified for desired capacity.
`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()` For responses, this returns true if the service returned a value for the AvailabilityZones property.
`boolean`	`hasEnabledMetrics()` For responses, this returns true if the service returned a value for the EnabledMetrics property.
`int`	`hashCode()`
`boolean`	`hasInstances()` For responses, this returns true if the service returned a value for the Instances property.
`boolean`	`hasLoadBalancerNames()` For responses, this returns true if the service returned a value for the LoadBalancerNames property.
`boolean`	`hasSuspendedProcesses()` For responses, this returns true if the service returned a value for the SuspendedProcesses property.
`boolean`	`hasTags()` For responses, this returns true if the service returned a value for the Tags property.
`boolean`	`hasTargetGroupARNs()` For responses, this returns true if the service returned a value for the TargetGroupARNs property.
`boolean`	`hasTerminationPolicies()` For responses, this returns true if the service returned a value for the TerminationPolicies property.
`boolean`	`hasTrafficSources()` For responses, this returns true if the service returned a value for the TrafficSources property.
`Integer`	`healthCheckGracePeriod()` The duration of the health check grace period, in seconds.
`String`	`healthCheckType()` A comma-separated value string of one or more health check types.
`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.
`List<TrafficSourceIdentifier>`	`trafficSources()` The traffic sources associated with this Auto Scaling group.
`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()
```
    For responses, this returns true if the service returned a value for the AvailabilityZones 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.
  - 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.
    
    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 hasAvailabilityZones() method.
    
    Returns:
    
    One or more Availability Zones for the group.
  - hasLoadBalancerNames
```
public final boolean hasLoadBalancerNames()
```
    For responses, this returns true if the service returned a value for the LoadBalancerNames 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.
  - 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.
    
    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 hasLoadBalancerNames() method.
    
    Returns:
    
    One or more load balancers associated with the group.
  - hasTargetGroupARNs
```
public final boolean hasTargetGroupARNs()
```
    For responses, this returns true if the service returned a value for the TargetGroupARNs 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.
  - 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.
    
    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 hasTargetGroupARNs() method.
    
    Returns:
    
    The Amazon Resource Names (ARN) of the target groups for your load balancer.
  - healthCheckType
```
public final String healthCheckType()
```
    A comma-separated value string of one or more health check types.
    
    Returns:
    
    A comma-separated value string of one or more health check types.
  - healthCheckGracePeriod
```
public final Integer healthCheckGracePeriod()
```
    The duration of the health check grace period, in seconds.
    
    Returns:
    
    The duration of the health check grace period, in seconds.
  - hasInstances
```
public final boolean hasInstances()
```
    For responses, this returns true if the service returned a value for the Instances 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.
  - 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.
    
    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 hasInstances() method.
    
    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()
```
    For responses, this returns true if the service returned a value for the SuspendedProcesses 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.
  - 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.
    
    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 hasSuspendedProcesses() method.
    
    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()
```
    For responses, this returns true if the service returned a value for the EnabledMetrics 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.
  - 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.
    
    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 hasEnabledMetrics() method.
    
    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()
```
    For responses, this returns true if the service returned a value for the Tags 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.
  - 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.
    
    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 hasTags() method.
    
    Returns:
    
    The tags for the group.
  - hasTerminationPolicies
```
public final boolean hasTerminationPolicies()
```
    For responses, this returns true if the service returned a value for the TerminationPolicies 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.
  - 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.
    
    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 hasTerminationPolicies() method.
    
    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.
  - context
```
public final String context()
```
    Reserved.
    
    Returns:
    
    Reserved.
  - desiredCapacityType
```
public final String desiredCapacityType()
```
    The unit of measurement for the value specified for desired capacity. Amazon EC2 Auto Scaling supports DesiredCapacityType for attribute-based instance type selection only.
    
    Returns:
    
    The unit of measurement for the value specified for desired capacity. Amazon EC2 Auto Scaling supports DesiredCapacityType for attribute-based instance type selection only.
  - defaultInstanceWarmup
```
public final Integer defaultInstanceWarmup()
```
    The duration of the default instance warmup, in seconds.
    
    Returns:
    
    The duration of the default instance warmup, in seconds.
  - hasTrafficSources
```
public final boolean hasTrafficSources()
```
    For responses, this returns true if the service returned a value for the TrafficSources 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.
  - trafficSources
```
public final List<TrafficSourceIdentifier> trafficSources()
```
    The traffic sources associated with this Auto Scaling group.
    
    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 hasTrafficSources() method.
    
    Returns:
    
    The traffic sources associated with this Auto Scaling group.
  - 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

context

desiredCapacityType

defaultInstanceWarmup

hasTrafficSources

trafficSources

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields