CreateAutoScalingGroupRequest (AWS SDK for Java

java.lang.Object
- software.amazon.awssdk.core.SdkRequest
- - software.amazon.awssdk.awscore.AwsRequest
  - - software.amazon.awssdk.services.autoscaling.model.AutoScalingRequest
    - - software.amazon.awssdk.services.autoscaling.model.CreateAutoScalingGroupRequest

All Implemented Interfaces:: ToCopyableBuilder<CreateAutoScalingGroupRequest.Builder,CreateAutoScalingGroupRequest>

@Generated(value="software.amazon.awssdk:codegen")
public class CreateAutoScalingGroupRequest
extends AutoScalingRequest
implements ToCopyableBuilder<CreateAutoScalingGroupRequest.Builder,CreateAutoScalingGroupRequest>

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface CreateAutoScalingGroupRequest.Builder

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

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`String`	`autoScalingGroupName()` The name of the group.
`List<String>`	`availabilityZones()` One or more Availability Zones for the group.
`static CreateAutoScalingGroupRequest.Builder`	`builder()`
`Integer`	`defaultCooldown()` The amount of time, in seconds, after a scaling activity completes before another scaling activity can start.
`Integer`	`desiredCapacity()` The number of EC2 instances that should be running in the group.
`boolean`	`equals(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)` Used to retrieve the value of a field from any class that extends `SdkRequest`.
`int`	`hashCode()`
`Integer`	`healthCheckGracePeriod()` The amount of time, in seconds, that 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.
`String`	`instanceId()` The ID of the instance used to create a launch configuration for the group.
`String`	`launchConfigurationName()` The name of the launch configuration.
`List<LifecycleHookSpecification>`	`lifecycleHookSpecificationList()` One or more lifecycle hooks.
`List<String>`	`loadBalancerNames()` One or more Classic Load Balancers.
`Integer`	`maxSize()` The maximum size of the group.
`Integer`	`minSize()` The minimum size of 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 you'll launch your instances, if any.
`static Class<? extends CreateAutoScalingGroupRequest.Builder>`	`serializableBuilderClass()`
`List<Tag>`	`tags()` One or more tags.
`List<String>`	`targetGroupARNs()` The Amazon Resource Names (ARN) of the target groups.
`List<String>`	`terminationPolicies()` One or more termination policies used to select the instance to terminate.
`CreateAutoScalingGroupRequest.Builder`	`toBuilder()` Take this object and create a builder that contains all of the current property values of this object.
`String`	`toString()`
`String`	`vpcZoneIdentifier()` A comma-separated list of subnet identifiers for your virtual private cloud (VPC).

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
requestOverrideConfig

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 group. This name must be unique within the scope of your AWS account.
    
    Returns:
    
    The name of the group. This name must be unique within the scope of your AWS account.
  - launchConfigurationName
```
public String launchConfigurationName()
```
    The name of the launch configuration. Alternatively, specify an EC2 instance instead of a launch configuration.
    
    Returns:
    
    The name of the launch configuration. Alternatively, specify an EC2 instance instead of a launch configuration.
  - instanceId
```
public String instanceId()
```
    The ID of the instance used to create a launch configuration for the group. Alternatively, specify a launch configuration instead of an EC2 instance.
    
    When you specify an ID of an instance, Auto Scaling creates a new launch configuration and associates it with the group. This launch configuration derives its attributes from the specified instance, with the exception of the block device mapping.
    
    For more information, see Create an Auto Scaling Group Using an EC2 Instance in the Auto Scaling User Guide.
    
    Returns:
    
    The ID of the instance used to create a launch configuration for the group. Alternatively, specify a launch configuration instead of an EC2 instance.
    
    When you specify an ID of an instance, Auto Scaling creates a new launch configuration and associates it with the group. This launch configuration derives its attributes from the specified instance, with the exception of the block device mapping.
    
    For more information, see Create an Auto Scaling Group Using an EC2 Instance in the Auto Scaling User Guide.
  - 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 number of EC2 instances that should be running in the group. This number must be greater than or equal to the minimum size of the group and less than or equal to the maximum size of the group. If you do not specify a desired capacity, the default is the minimum size of the group.
    
    Returns:
    
    The number of EC2 instances that should be running in the group. This number must be greater than or equal to the minimum size of the group and less than or equal to the maximum size of the group. If you do not specify a desired capacity, the default is the minimum 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. The default is 300.
    
    For more information, see Auto Scaling Cooldowns in the Auto Scaling User Guide.
    
    Returns:
    
    The amount of time, in seconds, after a scaling activity completes before another scaling activity can start. The default is 300.
    
    For more information, see Auto Scaling Cooldowns in the Auto Scaling User Guide.
  - availabilityZones
```
public List<String> availabilityZones()
```
    One or more Availability Zones for the group. This parameter is optional if you specify one or more subnets.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    Returns:
    
    One or more Availability Zones for the group. This parameter is optional if you specify one or more subnets.
  - loadBalancerNames
```
public List<String> loadBalancerNames()
```
    One or more Classic Load Balancers. To specify an Application Load Balancer, use TargetGroupARNs instead.
    
    For more information, see Using a Load Balancer With an Auto Scaling Group in the Auto Scaling User Guide.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    Returns:
    
    One or more Classic Load Balancers. To specify an Application Load Balancer, use TargetGroupARNs instead.
    
    For more information, see Using a Load Balancer With an Auto Scaling Group in the Auto Scaling User Guide.
  - targetGroupARNs
```
public List<String> targetGroupARNs()
```
    The Amazon Resource Names (ARN) of the target groups.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    Returns:
    
    The Amazon Resource Names (ARN) of the target groups.
  - healthCheckType
```
public String healthCheckType()
```
    The service to use for the health checks. The valid values are EC2 and ELB.
    
    By default, health checks use Amazon EC2 instance status checks to determine the health of an instance. For more information, see Health Checks in the Auto Scaling User Guide.
    
    Returns:
    
    The service to use for the health checks. The valid values are EC2 and ELB.
    
    By default, health checks use Amazon EC2 instance status checks to determine the health of an instance. For more information, see Health Checks in the Auto Scaling User Guide.
  - healthCheckGracePeriod
```
public Integer healthCheckGracePeriod()
```
    The amount of time, in seconds, that Auto Scaling waits before checking the health status of an EC2 instance that has come into service. During this time, any health check failures for the instance are ignored. The default is 0.
    
    This parameter is required if you are adding an ELB health check.
    
    For more information, see Health Checks in the Auto Scaling User Guide.
    
    Returns:
    
    The amount of time, in seconds, that Auto Scaling waits before checking the health status of an EC2 instance that has come into service. During this time, any health check failures for the instance are ignored. The default is 0.
    
    This parameter is required if you are adding an ELB health check.
    
    For more information, see Health Checks in the Auto Scaling User Guide.
  - placementGroup
```
public String placementGroup()
```
    The name of the placement group into which you'll 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 you'll launch your instances, if any. For more information, see Placement Groups in the Amazon Elastic Compute Cloud User Guide.
  - vpcZoneIdentifier
```
public String vpcZoneIdentifier()
```
    A comma-separated list of subnet identifiers for your virtual private cloud (VPC).
    
    If you specify subnets and Availability Zones with this call, ensure that the subnets' Availability Zones match the Availability Zones specified.
    
    For more information, see Launching Auto Scaling Instances in a VPC in the Auto Scaling User Guide.
    
    Returns:
    
    A comma-separated list of subnet identifiers for your virtual private cloud (VPC).
    
    If you specify subnets and Availability Zones with this call, ensure that the subnets' Availability Zones match the Availability Zones specified.
    
    For more information, see Launching Auto Scaling Instances in a VPC in the Auto Scaling User Guide.
  - terminationPolicies
```
public List<String> terminationPolicies()
```
    One or more termination policies used to select the instance to terminate. These policies are executed in the order that they are listed.
    
    For more information, see Controlling Which Instances Auto Scaling Terminates During Scale In in the Auto Scaling User Guide.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    Returns:
    
    One or more termination policies used to select the instance to terminate. These policies are executed in the order that they are listed.
    
    For more information, see Controlling Which Instances Auto Scaling Terminates During Scale In in the Auto Scaling User Guide.
  - 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.
  - lifecycleHookSpecificationList
```
public List<LifecycleHookSpecification> lifecycleHookSpecificationList()
```
    One or more lifecycle hooks.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    Returns:
    
    One or more lifecycle hooks.
  - tags
```
public List<Tag> tags()
```
    One or more tags.
    
    For more information, see Tagging Auto Scaling Groups and Instances in the Auto Scaling User Guide.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    Returns:
    
    One or more tags.
    
    For more information, see Tagging Auto Scaling Groups and Instances in the Auto Scaling User Guide.
  - toBuilder
```
public CreateAutoScalingGroupRequest.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<CreateAutoScalingGroupRequest.Builder,CreateAutoScalingGroupRequest>
    
    Specified by:
    
    toBuilder in class AutoScalingRequest
    
    Returns:
    
    a builder for type T
  - builder
```
public static CreateAutoScalingGroupRequest.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends CreateAutoScalingGroupRequest.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)
```
    Description copied from class: SdkRequest
    
    Used to retrieve the value of a field from any class that extends SdkRequest. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class) method will again be available.
    
    Overrides:
    
    getValueForField in class SdkRequest
    
    Parameters:
    
    fieldName - The name of the member to be retrieved.
    
    clazz - The class to cast the returned object to.
    
    Returns:
    
    Optional containing the casted return value

Class CreateAutoScalingGroupRequest

Nested Class Summary

Method Summary

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

Methods inherited from class java.lang.Object

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

Method Detail

autoScalingGroupName

launchConfigurationName

instanceId

minSize

maxSize

desiredCapacity

defaultCooldown

availabilityZones

loadBalancerNames

targetGroupARNs

healthCheckType

healthCheckGracePeriod

placementGroup

vpcZoneIdentifier

terminationPolicies

newInstancesProtectedFromScaleIn

lifecycleHookSpecificationList

tags

toBuilder

builder

serializableBuilderClass

hashCode

equals

toString

getValueForField