@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()
The amount of time, in seconds, after a scaling activity completes before another scaling activity can start.
|
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.
|
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).
|
int |
hashCode() |
boolean |
hasLifecycleHookSpecificationList()
Returns true if the LifecycleHookSpecificationList 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 |
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.
|
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()
Parameters used to specify the launch template and version to use to launch instances.
|
List<LifecycleHookSpecification> |
lifecycleHookSpecificationList()
One or more lifecycle hooks for the group, which specify actions to perform when Amazon EC2 Auto Scaling launches
or terminates instances.
|
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()
An embedded object that specifies a 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 an existing placement group into which to launch your instances, if any.
|
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 on your behalf.
|
List<Tag> |
tags()
One or more tags.
|
List<String> |
targetGroupARNs()
The Amazon Resource Names (ARN) of the 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.
|
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.
|
overrideConfigurationclone, finalize, getClass, notify, notifyAll, wait, wait, waitcopypublic final String autoScalingGroupName()
The name of the Auto Scaling group. This name must be unique per Region per account.
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()
Parameters 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()
An embedded object that specifies a mixed instances policy. The required properties must be specified. If optional properties are unspecified, their default values are used.
The policy includes properties that not only define the distribution of On-Demand Instances and Spot Instances, the maximum price to pay for Spot Instances, and how the Auto Scaling group allocates instance types to fulfill On-Demand and Spot capacities, but also the properties that specify the instance configuration information—the launch template and instance types. The policy can also include a weight for each instance type and different launch templates for individual instance types. For more information, see Auto Scaling groups with multiple instance types and purchase options in the Amazon EC2 Auto Scaling User Guide.
The policy includes properties that not only define the distribution of On-Demand Instances and Spot Instances, the maximum price to pay for Spot Instances, and how the Auto Scaling group allocates instance types to fulfill On-Demand and Spot capacities, but also the properties that specify the instance configuration information—the launch template and instance types. The policy can also include a weight for each instance type and different launch templates for individual instance types. 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()
The amount of time, in seconds, after a scaling activity completes before another scaling activity can start. The
default value is 300. This setting applies when using simple scaling policies, but not when using
other scaling policies or scheduled scaling. For more information, see Scaling cooldowns for Amazon EC2 Auto
Scaling in the Amazon EC2 Auto Scaling User Guide.
300. This setting applies when using simple scaling policies,
but not when using other scaling policies or scheduled scaling. For more information, see Scaling cooldowns for Amazon
EC2 Auto Scaling in the Amazon EC2 Auto Scaling User Guide.public final boolean hasAvailabilityZones()
public final List<String> availabilityZones()
A list of Availability Zones where instances in the Auto Scaling group can be created. This parameter is optional
if you specify one or more subnets for VPCZoneIdentifier.
Conditional: If your account supports EC2-Classic and VPC, this parameter is required to launch instances into EC2-Classic.
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.
VPCZoneIdentifier.
Conditional: If your account supports EC2-Classic and VPC, this parameter is required to launch instances into EC2-Classic.
public final boolean hasLoadBalancerNames()
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.
You can use hasLoadBalancerNames() to see if a value was sent in this field.
TargetGroupARNs property
instead.public final boolean hasTargetGroupARNs()
public final List<String> targetGroupARNs()
The Amazon Resource Names (ARN) of the target groups to associate with the Auto Scaling group. Instances are registered as targets in a target group, and traffic is routed to the target group. For more information, see Elastic Load Balancing and Amazon EC2 Auto Scaling in the Amazon EC2 Auto Scaling User Guide.
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.
public final String healthCheckType()
The service to use for the health checks. The valid values are EC2 (default) and ELB.
If you configure an Auto Scaling group to use load balancer (ELB) health checks, it considers the instance
unhealthy if it fails either the EC2 status checks or the load balancer health checks. For more information, see
Health checks for Auto Scaling
instances in the Amazon EC2 Auto Scaling User Guide.
EC2 (default) and
ELB. If you configure an Auto Scaling group to use load balancer (ELB) health checks, it
considers the instance unhealthy if it fails either the EC2 status checks or the load balancer health
checks. For more information, see Health checks for Auto
Scaling instances in the Amazon EC2 Auto Scaling User Guide.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. During this time, any health check failures for the instance are ignored.
The default value is 0. For more information, see Health
check grace period in the Amazon EC2 Auto Scaling User Guide.
Conditional: Required if you are adding an ELB health check.
0. For more information, see Health check grace period in the Amazon EC2 Auto Scaling User Guide.
Conditional: Required if you are adding an ELB health check.
public final String placementGroup()
The name of an existing placement group into which to launch your instances, if any. A placement group is a logical grouping of instances within a single Availability Zone. You cannot specify multiple Availability Zones and a placement group. For more information, see Placement Groups in the Amazon EC2 User Guide for Linux Instances.
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 for this parameter must reside in those Availability Zones.
Conditional: If your account supports EC2-Classic and VPC, this parameter is required to launch instances into a VPC.
VPCZoneIdentifier with
AvailabilityZones, the subnets that you specify for this parameter must reside in those
Availability Zones.
Conditional: If your account supports EC2-Classic and VPC, this parameter is required to launch instances into a VPC.
public final boolean hasTerminationPolicies()
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 Controlling which Auto Scaling instances terminate during scale in in the Amazon EC2 Auto Scaling User Guide.
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.
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 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 Amazon EC2 Auto Scaling Capacity Rebalancing in the Amazon EC2 Auto Scaling User Guide.
public final boolean hasLifecycleHookSpecificationList()
public final List<LifecycleHookSpecification> lifecycleHookSpecificationList()
One or more lifecycle hooks for the group, which specify actions to perform when Amazon EC2 Auto Scaling launches or terminates instances.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
You can use hasLifecycleHookSpecificationList() to see if a value was sent in this field.
public final boolean hasTags()
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 Tagging 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.
You can use hasTags() to see if a value was sent in this field.
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. 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 CreateAutoScalingGroupRequest.Builder toBuilder()
toBuilder in interface ToCopyableBuilder<CreateAutoScalingGroupRequest.Builder,CreateAutoScalingGroupRequest>toBuilder in class AutoScalingRequestpublic static CreateAutoScalingGroupRequest.Builder builder()
public static Class<? extends CreateAutoScalingGroupRequest.Builder> serializableBuilderClass()
public final int hashCode()
hashCode in class AwsRequestpublic final boolean equals(Object obj)
equals in class AwsRequestpublic final boolean equalsBySdkFields(Object obj)
equalsBySdkFields in interface SdkPojopublic final String toString()
public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
getValueForField in class SdkRequestCopyright © 2021. All rights reserved.