@Generated(value="software.amazon.awssdk:codegen") public final class CreateAutoScalingGroupRequest extends AutoScalingRequest implements ToCopyableBuilder<CreateAutoScalingGroupRequest.Builder,CreateAutoScalingGroupRequest>
Modifier and Type | Class and Description |
---|---|
static interface |
CreateAutoScalingGroupRequest.Builder |
Modifier and Type | Method and Description |
---|---|
String |
autoScalingGroupName()
The name of the Auto Scaling group.
|
List<String> |
availabilityZones()
A list of Availability Zones where instances in the Auto Scaling group can be created.
|
static CreateAutoScalingGroupRequest.Builder |
builder() |
Boolean |
capacityRebalance()
Indicates whether Capacity Rebalancing is enabled.
|
String |
context()
Reserved.
|
Integer |
defaultCooldown()
Only needed if you use simple scaling policies.
|
Integer |
defaultInstanceWarmup()
The amount of time, in seconds, until a new instance is considered to have finished initializing and resource
consumption to become stable after it enters the
InService state. |
Integer |
desiredCapacity()
The desired capacity is the initial capacity of the Auto Scaling group at the time of its creation and the
capacity it attempts to maintain.
|
String |
desiredCapacityType()
The unit of measurement for the value specified for desired capacity.
|
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.
|
int |
hashCode() |
boolean |
hasLifecycleHookSpecificationList()
For responses, this returns true if the service returned a value for the LifecycleHookSpecificationList property.
|
boolean |
hasLoadBalancerNames()
For responses, this returns true if the service returned a value for the LoadBalancerNames 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 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 and marking it unhealthy due to a failed health check.
|
String |
healthCheckType()
A comma-separated value string of one or more health check types.
|
String |
instanceId()
The ID of the instance used to base the launch configuration on.
|
String |
launchConfigurationName()
The name of the launch configuration to use to launch instances.
|
LaunchTemplateSpecification |
launchTemplate()
Information used to specify the launch template and version to use to launch instances.
|
List<LifecycleHookSpecification> |
lifecycleHookSpecificationList()
One or more lifecycle hooks to add to the Auto Scaling group before instances are launched.
|
List<String> |
loadBalancerNames()
A list of Classic Load Balancers associated with this Auto Scaling 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.
|
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.
|
List<SdkField<?>> |
sdkFields() |
static Class<? extends CreateAutoScalingGroupRequest.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 service on your behalf.
|
List<Tag> |
tags()
One or more tags.
|
List<String> |
targetGroupARNs()
The Amazon Resource Names (ARN) of the Elastic Load Balancing target groups to associate with the Auto Scaling
group.
|
List<String> |
terminationPolicies()
A policy or a list of policies that are used to select the instance to terminate.
|
CreateAutoScalingGroupRequest.Builder |
toBuilder() |
String |
toString()
Returns a string representation of this object.
|
List<TrafficSourceIdentifier> |
trafficSources()
The list of traffic sources to attach to this Auto Scaling group.
|
String |
vpcZoneIdentifier()
A comma-separated list of subnet IDs for a virtual private cloud (VPC) where instances in the Auto Scaling group
can be created.
|
overrideConfiguration
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
copy
public final String autoScalingGroupName()
The name of the Auto Scaling group. This name must be unique per Region per account.
The name can contain any ASCII character 33 to 126 including most punctuation characters, digits, and upper and lowercased letters.
You cannot use a colon (:) in the name.
The name can contain any ASCII character 33 to 126 including most punctuation characters, digits, and upper and lowercased letters.
You cannot use a colon (:) in the name.
public final String launchConfigurationName()
The name of the launch configuration to use to launch instances.
Conditional: You must specify either a launch template (LaunchTemplate
or
MixedInstancesPolicy
) or a launch configuration (LaunchConfigurationName
or
InstanceId
).
Conditional: You must specify either a launch template (LaunchTemplate
or
MixedInstancesPolicy
) or a launch configuration (LaunchConfigurationName
or
InstanceId
).
public final LaunchTemplateSpecification launchTemplate()
Information used to specify the launch template and version to use to launch instances.
Conditional: You must specify either a launch template (LaunchTemplate
or
MixedInstancesPolicy
) or a launch configuration (LaunchConfigurationName
or
InstanceId
).
The launch template that is specified must be configured for use with an Auto Scaling group. For more information, see Creating a launch template for an Auto Scaling group in the Amazon EC2 Auto Scaling User Guide.
Conditional: You must specify either a launch template (LaunchTemplate
or
MixedInstancesPolicy
) or a launch configuration (LaunchConfigurationName
or
InstanceId
).
The launch template that is specified must be configured for use with an Auto Scaling group. For more information, see Creating a launch template for an Auto Scaling group in the Amazon EC2 Auto Scaling User Guide.
public final MixedInstancesPolicy mixedInstancesPolicy()
The mixed instances policy. For more information, see Auto Scaling groups with multiple instance types and purchase options in the Amazon EC2 Auto Scaling User Guide.
public final String instanceId()
The ID of the instance used to base the launch configuration on. If specified, Amazon EC2 Auto Scaling uses the configuration values from the specified instance to create a new launch configuration. To get the instance ID, use the Amazon EC2 DescribeInstances API operation. For more information, see Creating an Auto Scaling group using an EC2 instance in the Amazon EC2 Auto Scaling User Guide.
public final Integer minSize()
The minimum size of the group.
public final Integer maxSize()
The maximum size of the group.
With a mixed instances policy that uses instance weighting, Amazon EC2 Auto Scaling may need to go above
MaxSize
to meet your capacity requirements. In this event, Amazon EC2 Auto Scaling will never go
above MaxSize
by more than your largest instance weight (weights that define how many units each
instance contributes to the desired capacity of the group).
With a mixed instances policy that uses instance weighting, Amazon EC2 Auto Scaling may need to go above
MaxSize
to meet your capacity requirements. In this event, Amazon EC2 Auto Scaling will
never go above MaxSize
by more than your largest instance weight (weights that define how
many units each instance contributes to the desired capacity of the group).
public final Integer desiredCapacity()
The desired capacity is the initial capacity of the Auto Scaling group at the time of its creation and the capacity it attempts to maintain. It can scale beyond this capacity if you configure auto scaling. 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.
public final Integer defaultCooldown()
Only needed if you use simple scaling policies.
The amount of time, in seconds, between one scaling activity ending and another one starting due to simple scaling policies. For more information, see Scaling cooldowns for Amazon EC2 Auto Scaling in the Amazon EC2 Auto Scaling User Guide.
Default: 300
seconds
The amount of time, in seconds, between one scaling activity ending and another one starting due to simple scaling policies. For more information, see Scaling cooldowns for Amazon EC2 Auto Scaling in the Amazon EC2 Auto Scaling User Guide.
Default: 300
seconds
public final boolean hasAvailabilityZones()
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.public final List<String> availabilityZones()
A list of Availability Zones where instances in the Auto Scaling group can be created. Used for launching into
the default VPC subnet in each Availability Zone when not using the VPCZoneIdentifier
property, or
for attaching a network interface when an existing network interface ID is specified in a launch template.
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.
VPCZoneIdentifier
property, or for attaching a network interface when an existing network interface ID is specified in a
launch template.public final boolean hasLoadBalancerNames()
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.public final List<String> loadBalancerNames()
A list of Classic Load Balancers associated with this Auto Scaling group. For Application Load Balancers, Network
Load Balancers, and Gateway Load Balancers, specify the TargetGroupARNs
property instead.
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.
TargetGroupARNs
property
instead.public final boolean hasTargetGroupARNs()
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.public final List<String> targetGroupARNs()
The Amazon Resource Names (ARN) of the Elastic Load Balancing target groups to associate with the Auto Scaling group. Instances are registered as targets with the target groups. The target groups receive incoming traffic and route requests to one or more registered targets. For more information, see Use Elastic Load Balancing to distribute traffic across the instances in your Auto Scaling group in the Amazon EC2 Auto Scaling User Guide.
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.
public final String healthCheckType()
A comma-separated value string of one or more health check types.
The valid values are EC2
, ELB
, and VPC_LATTICE
. EC2
is the
default health check and cannot be disabled. For more information, see Health checks for Auto Scaling
instances in the Amazon EC2 Auto Scaling User Guide.
Only specify EC2
if you must clear a value that was previously set.
The valid values are EC2
, ELB
, and VPC_LATTICE
. EC2
is the default health check and cannot be disabled. For more information, see Health checks for Auto
Scaling instances in the Amazon EC2 Auto Scaling User Guide.
Only specify EC2
if you must clear a value that was previously set.
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 and marking it unhealthy due to a failed health check. This is useful if your
instances do not immediately pass their health checks after they enter the InService
state. For more
information, see Set the health check
grace period for an Auto Scaling group in the Amazon EC2 Auto Scaling User Guide.
Default: 0
seconds
InService
state. For more information, see Set the
health check grace period for an Auto Scaling group in the Amazon EC2 Auto Scaling User
Guide.
Default: 0
seconds
public final String placementGroup()
The name of the placement group into which to launch your instances. For more information, see Placement groups in the Amazon EC2 User Guide for Linux Instances.
A cluster placement group is a logical grouping of instances within a single Availability Zone. You cannot specify multiple Availability Zones and a cluster placement group.
A cluster placement group is a logical grouping of instances within a single Availability Zone. You cannot specify multiple Availability Zones and a cluster placement group.
public final String vpcZoneIdentifier()
A comma-separated list of subnet IDs for a virtual private cloud (VPC) where instances in the Auto Scaling group
can be created. If you specify VPCZoneIdentifier
with AvailabilityZones
, the subnets
that you specify must reside in those Availability Zones.
VPCZoneIdentifier
with
AvailabilityZones
, the subnets that you specify must reside in those Availability Zones.public final boolean hasTerminationPolicies()
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.public final List<String> terminationPolicies()
A policy or a list of policies that are used to select the instance to terminate. These policies are executed in the order that you list them. For more information, see Work with Amazon EC2 Auto Scaling termination policies in the Amazon EC2 Auto Scaling User Guide.
Valid values: Default
| AllocationStrategy
| ClosestToNextInstanceHour
|
NewestInstance
| OldestInstance
| OldestLaunchConfiguration
|
OldestLaunchTemplate
| arn:aws:lambda:region:account-id:function:my-function:my-alias
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.
Valid values: Default
| AllocationStrategy
|
ClosestToNextInstanceHour
| NewestInstance
| OldestInstance
|
OldestLaunchConfiguration
| OldestLaunchTemplate
|
arn:aws:lambda:region:account-id:function:my-function:my-alias
public final Boolean newInstancesProtectedFromScaleIn()
Indicates whether newly launched instances are protected from termination by Amazon EC2 Auto Scaling when scaling in. For more information about preventing instances from terminating on scale in, see Using instance scale-in protection in the Amazon EC2 Auto Scaling User Guide.
public final Boolean capacityRebalance()
Indicates whether Capacity Rebalancing is enabled. Otherwise, Capacity Rebalancing is disabled. When you turn on Capacity Rebalancing, Amazon EC2 Auto Scaling attempts to launch a Spot Instance whenever Amazon EC2 notifies that a Spot Instance is at an elevated risk of interruption. After launching a new instance, it then terminates an old instance. For more information, see Use Capacity Rebalancing to handle Amazon EC2 Spot Interruptions in the in the Amazon EC2 Auto Scaling User Guide.
public final boolean hasLifecycleHookSpecificationList()
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.public final List<LifecycleHookSpecification> lifecycleHookSpecificationList()
One or more lifecycle hooks to add to the Auto Scaling group before instances are launched.
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 hasLifecycleHookSpecificationList()
method.
public final boolean hasTags()
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.public final List<Tag> tags()
One or more tags. You can tag your Auto Scaling group and propagate the tags to the Amazon EC2 instances it launches. Tags are not propagated to Amazon EBS volumes. To add tags to Amazon EBS volumes, specify the tags in a launch template but use caution. If the launch template specifies an instance tag with a key that is also specified for the Auto Scaling group, Amazon EC2 Auto Scaling overrides the value of that instance tag with the value specified by the Auto Scaling group. For more information, see Tag Auto Scaling groups and instances in the Amazon EC2 Auto Scaling User Guide.
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.
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 service on your behalf. By default, Amazon EC2 Auto Scaling uses a service-linked role named
AWSServiceRoleForAutoScaling
, which it creates if it does not exist. For more information, see Service-linked
roles in the Amazon EC2 Auto Scaling User Guide.
AWSServiceRoleForAutoScaling
, which it creates if it does not exist. For more
information, see Service-linked roles in the Amazon EC2 Auto Scaling User Guide.public final Integer maxInstanceLifetime()
The maximum amount of time, in seconds, that an instance can be in service. The default is null. If specified, the value must be either 0 or a number equal to or greater than 86,400 seconds (1 day). For more information, see Replacing Auto Scaling instances based on maximum instance lifetime in the Amazon EC2 Auto Scaling User Guide.
public final String context()
Reserved.
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. For more information, see Creating
an Auto Scaling group using attribute-based instance type selection in the Amazon EC2 Auto Scaling User
Guide.
By default, Amazon EC2 Auto Scaling specifies units
, which translates into number of instances.
Valid values: units
| vcpu
| memory-mib
DesiredCapacityType
for attribute-based instance type selection only. For more information,
see Creating an Auto Scaling group using attribute-based instance type selection in the Amazon EC2
Auto Scaling User Guide.
By default, Amazon EC2 Auto Scaling specifies units
, which translates into number of
instances.
Valid values: units
| vcpu
| memory-mib
public final Integer defaultInstanceWarmup()
The amount of time, in seconds, until a new instance is considered to have finished initializing and resource
consumption to become stable after it enters the InService
state.
During an instance refresh, Amazon EC2 Auto Scaling waits for the warm-up period after it replaces an instance before it moves on to replacing the next instance. Amazon EC2 Auto Scaling also waits for the warm-up period before aggregating the metrics for new instances with existing instances in the Amazon CloudWatch metrics that are used for scaling, resulting in more reliable usage data. For more information, see Set the default instance warmup for an Auto Scaling group in the Amazon EC2 Auto Scaling User Guide.
To manage various warm-up settings at the group level, we recommend that you set the default instance warmup,
even if it is set to 0 seconds. To remove a value that you previously set, include the property but
specify -1
for the value. However, we strongly recommend keeping the default instance warmup enabled
by specifying a value of 0
or other nominal value.
Default: None
InService
state.
During an instance refresh, Amazon EC2 Auto Scaling waits for the warm-up period after it replaces an instance before it moves on to replacing the next instance. Amazon EC2 Auto Scaling also waits for the warm-up period before aggregating the metrics for new instances with existing instances in the Amazon CloudWatch metrics that are used for scaling, resulting in more reliable usage data. For more information, see Set the default instance warmup for an Auto Scaling group in the Amazon EC2 Auto Scaling User Guide.
To manage various warm-up settings at the group level, we recommend that you set the default instance
warmup, even if it is set to 0 seconds. To remove a value that you previously set, include the
property but specify -1
for the value. However, we strongly recommend keeping the default
instance warmup enabled by specifying a value of 0
or other nominal value.
Default: None
public final boolean hasTrafficSources()
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.public final List<TrafficSourceIdentifier> trafficSources()
The list of traffic sources to attach to this Auto Scaling group. You can use any of the following as traffic sources for an Auto Scaling group: Classic Load Balancer, Application Load Balancer, Gateway Load Balancer, Network Load Balancer, and VPC Lattice.
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.
public CreateAutoScalingGroupRequest.Builder toBuilder()
toBuilder
in interface ToCopyableBuilder<CreateAutoScalingGroupRequest.Builder,CreateAutoScalingGroupRequest>
toBuilder
in class AutoScalingRequest
public static CreateAutoScalingGroupRequest.Builder builder()
public static Class<? extends CreateAutoScalingGroupRequest.Builder> serializableBuilderClass()
public final int hashCode()
hashCode
in class AwsRequest
public final boolean equals(Object obj)
equals
in class AwsRequest
public final boolean equalsBySdkFields(Object obj)
equalsBySdkFields
in interface SdkPojo
public final String toString()
public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
getValueForField
in class SdkRequest
Copyright © 2023. All rights reserved.