Interface CreateAutoScalingGroupRequest.Builder
- All Superinterfaces:
AutoScalingRequest.Builder
,AwsRequest.Builder
,Buildable
,CopyableBuilder<CreateAutoScalingGroupRequest.Builder,
,CreateAutoScalingGroupRequest> SdkBuilder<CreateAutoScalingGroupRequest.Builder,
,CreateAutoScalingGroupRequest> SdkPojo
,SdkRequest.Builder
- Enclosing class:
CreateAutoScalingGroupRequest
-
Method Summary
Modifier and TypeMethodDescriptionautoScalingGroupName
(String autoScalingGroupName) The name of the Auto Scaling group.availabilityZones
(String... availabilityZones) A list of Availability Zones where instances in the Auto Scaling group can be created.availabilityZones
(Collection<String> availabilityZones) A list of Availability Zones where instances in the Auto Scaling group can be created.capacityRebalance
(Boolean capacityRebalance) Indicates whether Capacity Rebalancing is enabled.Reserved.defaultCooldown
(Integer defaultCooldown) Only needed if you use simple scaling policies.defaultInstanceWarmup
(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 theInService
state.desiredCapacity
(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.desiredCapacityType
(String desiredCapacityType) The unit of measurement for the value specified for desired capacity.healthCheckGracePeriod
(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.healthCheckType
(String healthCheckType) A comma-separated value string of one or more health check types.instanceId
(String instanceId) The ID of the instance used to base the launch configuration on.instanceMaintenancePolicy
(Consumer<InstanceMaintenancePolicy.Builder> instanceMaintenancePolicy) An instance maintenance policy.instanceMaintenancePolicy
(InstanceMaintenancePolicy instanceMaintenancePolicy) An instance maintenance policy.launchConfigurationName
(String launchConfigurationName) The name of the launch configuration to use to launch instances.launchTemplate
(Consumer<LaunchTemplateSpecification.Builder> launchTemplate) Information used to specify the launch template and version to use to launch instances.launchTemplate
(LaunchTemplateSpecification launchTemplate) Information used to specify the launch template and version to use to launch instances.lifecycleHookSpecificationList
(Collection<LifecycleHookSpecification> lifecycleHookSpecificationList) One or more lifecycle hooks to add to the Auto Scaling group before instances are launched.lifecycleHookSpecificationList
(Consumer<LifecycleHookSpecification.Builder>... lifecycleHookSpecificationList) One or more lifecycle hooks to add to the Auto Scaling group before instances are launched.lifecycleHookSpecificationList
(LifecycleHookSpecification... lifecycleHookSpecificationList) One or more lifecycle hooks to add to the Auto Scaling group before instances are launched.loadBalancerNames
(String... loadBalancerNames) A list of Classic Load Balancers associated with this Auto Scaling group.loadBalancerNames
(Collection<String> loadBalancerNames) A list of Classic Load Balancers associated with this Auto Scaling group.maxInstanceLifetime
(Integer maxInstanceLifetime) The maximum amount of time, in seconds, that an instance can be in service.The maximum size of the group.The minimum size of the group.mixedInstancesPolicy
(Consumer<MixedInstancesPolicy.Builder> mixedInstancesPolicy) The mixed instances policy.mixedInstancesPolicy
(MixedInstancesPolicy mixedInstancesPolicy) The mixed instances policy.newInstancesProtectedFromScaleIn
(Boolean newInstancesProtectedFromScaleIn) Indicates whether newly launched instances are protected from termination by Amazon EC2 Auto Scaling when scaling in.overrideConfiguration
(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Add an optional request override configuration.overrideConfiguration
(AwsRequestOverrideConfiguration overrideConfiguration) Add an optional request override configuration.placementGroup
(String placementGroup) The name of the placement group into which to launch your instances.serviceLinkedRoleARN
(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.tags
(Collection<Tag> tags) One or more tags.tags
(Consumer<Tag.Builder>... tags) One or more tags.One or more tags.targetGroupARNs
(String... targetGroupARNs) The Amazon Resource Names (ARN) of the Elastic Load Balancing target groups to associate with the Auto Scaling group.targetGroupARNs
(Collection<String> targetGroupARNs) The Amazon Resource Names (ARN) of the Elastic Load Balancing target groups to associate with the Auto Scaling group.terminationPolicies
(String... terminationPolicies) A policy or a list of policies that are used to select the instance to terminate.terminationPolicies
(Collection<String> terminationPolicies) A policy or a list of policies that are used to select the instance to terminate.trafficSources
(Collection<TrafficSourceIdentifier> trafficSources) The list of traffic sources to attach to this Auto Scaling group.trafficSources
(Consumer<TrafficSourceIdentifier.Builder>... trafficSources) The list of traffic sources to attach to this Auto Scaling group.trafficSources
(TrafficSourceIdentifier... trafficSources) The list of traffic sources to attach to this Auto Scaling group.vpcZoneIdentifier
(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.Methods inherited from interface software.amazon.awssdk.services.autoscaling.model.AutoScalingRequest.Builder
build
Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder
overrideConfiguration
Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFields
-
Method Details
-
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.
- Parameters:
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.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
launchConfigurationName
The name of the launch configuration to use to launch instances.
Conditional: You must specify either a launch template (
LaunchTemplate
orMixedInstancesPolicy
) or a launch configuration (LaunchConfigurationName
orInstanceId
).- Parameters:
launchConfigurationName
- The name of the launch configuration to use to launch instances.Conditional: You must specify either a launch template (
LaunchTemplate
orMixedInstancesPolicy
) or a launch configuration (LaunchConfigurationName
orInstanceId
).- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
launchTemplate
Information used to specify the launch template and version to use to launch instances.
Conditional: You must specify either a launch template (
LaunchTemplate
orMixedInstancesPolicy
) or a launch configuration (LaunchConfigurationName
orInstanceId
).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.
- Parameters:
launchTemplate
- Information used to specify the launch template and version to use to launch instances.Conditional: You must specify either a launch template (
LaunchTemplate
orMixedInstancesPolicy
) or a launch configuration (LaunchConfigurationName
orInstanceId
).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.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
launchTemplate
default CreateAutoScalingGroupRequest.Builder launchTemplate(Consumer<LaunchTemplateSpecification.Builder> launchTemplate) Information used to specify the launch template and version to use to launch instances.
Conditional: You must specify either a launch template (
LaunchTemplate
orMixedInstancesPolicy
) or a launch configuration (LaunchConfigurationName
orInstanceId
).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.
LaunchTemplateSpecification.Builder
avoiding the need to create one manually viaLaunchTemplateSpecification.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tolaunchTemplate(LaunchTemplateSpecification)
.- Parameters:
launchTemplate
- a consumer that will call methods onLaunchTemplateSpecification.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
mixedInstancesPolicy
CreateAutoScalingGroupRequest.Builder mixedInstancesPolicy(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.
- Parameters:
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.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
mixedInstancesPolicy
default CreateAutoScalingGroupRequest.Builder mixedInstancesPolicy(Consumer<MixedInstancesPolicy.Builder> 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.
This is a convenience method that creates an instance of theMixedInstancesPolicy.Builder
avoiding the need to create one manually viaMixedInstancesPolicy.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tomixedInstancesPolicy(MixedInstancesPolicy)
.- Parameters:
mixedInstancesPolicy
- a consumer that will call methods onMixedInstancesPolicy.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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.
- Parameters:
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.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
minSize
The minimum size of the group.
- Parameters:
minSize
- The minimum size of the group.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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 aboveMaxSize
by more than your largest instance weight (weights that define how many units each instance contributes to the desired capacity of the group).- Parameters:
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 aboveMaxSize
by more than your largest instance weight (weights that define how many units each instance contributes to the desired capacity of the group).- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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.
- Parameters:
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.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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- Parameters:
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- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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.- Parameters:
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 theVPCZoneIdentifier
property, or for attaching a network interface when an existing network interface ID is specified in a launch template.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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.- Parameters:
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 theVPCZoneIdentifier
property, or for attaching a network interface when an existing network interface ID is specified in a launch template.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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.- Parameters:
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 theTargetGroupARNs
property instead.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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.- Parameters:
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 theTargetGroupARNs
property instead.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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.
- Parameters:
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.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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.
- Parameters:
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.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
healthCheckType
A comma-separated value string of one or more health check types.
The valid values are
EC2
,ELB
, andVPC_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.- Parameters:
healthCheckType
- A comma-separated value string of one or more health check types.The valid values are
EC2
,ELB
, andVPC_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.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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- Parameters:
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 theInService
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- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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.
- Parameters:
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.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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
withAvailabilityZones
, the subnets that you specify must reside in those Availability Zones.- Parameters:
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 specifyVPCZoneIdentifier
withAvailabilityZones
, the subnets that you specify must reside in those Availability Zones.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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
- Parameters:
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
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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
- Parameters:
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
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
newInstancesProtectedFromScaleIn
CreateAutoScalingGroupRequest.Builder newInstancesProtectedFromScaleIn(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.
- Parameters:
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.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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.
- Parameters:
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.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
lifecycleHookSpecificationList
CreateAutoScalingGroupRequest.Builder lifecycleHookSpecificationList(Collection<LifecycleHookSpecification> lifecycleHookSpecificationList) One or more lifecycle hooks to add to the Auto Scaling group before instances are launched.
- Parameters:
lifecycleHookSpecificationList
- One or more lifecycle hooks to add to the Auto Scaling group before instances are launched.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
lifecycleHookSpecificationList
CreateAutoScalingGroupRequest.Builder lifecycleHookSpecificationList(LifecycleHookSpecification... lifecycleHookSpecificationList) One or more lifecycle hooks to add to the Auto Scaling group before instances are launched.
- Parameters:
lifecycleHookSpecificationList
- One or more lifecycle hooks to add to the Auto Scaling group before instances are launched.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
lifecycleHookSpecificationList
CreateAutoScalingGroupRequest.Builder lifecycleHookSpecificationList(Consumer<LifecycleHookSpecification.Builder>... lifecycleHookSpecificationList) One or more lifecycle hooks to add to the Auto Scaling group before instances are launched.
This is a convenience method that creates an instance of theLifecycleHookSpecification.Builder
avoiding the need to create one manually viaLifecycleHookSpecification.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tolifecycleHookSpecificationList(List<LifecycleHookSpecification>)
.- Parameters:
lifecycleHookSpecificationList
- a consumer that will call methods onLifecycleHookSpecification.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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.
- Parameters:
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.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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.
- Parameters:
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.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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.
This is a convenience method that creates an instance of theTag.Builder
avoiding the need to create one manually viaTag.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed totags(List<Tag>)
.- Parameters:
tags
- a consumer that will call methods onTag.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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.- Parameters:
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 namedAWSServiceRoleForAutoScaling
, which it creates if it does not exist. For more information, see Service-linked roles in the Amazon EC2 Auto Scaling User Guide.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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.
- Parameters:
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.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
context
Reserved.
- Parameters:
context
- Reserved.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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
- Parameters:
desiredCapacityType
- The unit of measurement for the value specified for desired capacity. Amazon EC2 Auto Scaling supportsDesiredCapacityType
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
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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 of0
or other nominal value.Default: None
- Parameters:
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 theInService
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 of0
or other nominal value.Default: None
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
trafficSources
CreateAutoScalingGroupRequest.Builder trafficSources(Collection<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.
- Parameters:
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.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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.
- Parameters:
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.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
trafficSources
CreateAutoScalingGroupRequest.Builder trafficSources(Consumer<TrafficSourceIdentifier.Builder>... 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.
This is a convenience method that creates an instance of theTrafficSourceIdentifier.Builder
avoiding the need to create one manually viaTrafficSourceIdentifier.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed totrafficSources(List<TrafficSourceIdentifier>)
.- Parameters:
trafficSources
- a consumer that will call methods onTrafficSourceIdentifier.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
instanceMaintenancePolicy
CreateAutoScalingGroupRequest.Builder instanceMaintenancePolicy(InstanceMaintenancePolicy instanceMaintenancePolicy) An instance maintenance policy. For more information, see Set instance maintenance policy in the Amazon EC2 Auto Scaling User Guide.
- Parameters:
instanceMaintenancePolicy
- An instance maintenance policy. For more information, see Set instance maintenance policy in the Amazon EC2 Auto Scaling User Guide.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
instanceMaintenancePolicy
default CreateAutoScalingGroupRequest.Builder instanceMaintenancePolicy(Consumer<InstanceMaintenancePolicy.Builder> instanceMaintenancePolicy) An instance maintenance policy. For more information, see Set instance maintenance policy in the Amazon EC2 Auto Scaling User Guide.
This is a convenience method that creates an instance of theInstanceMaintenancePolicy.Builder
avoiding the need to create one manually viaInstanceMaintenancePolicy.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed toinstanceMaintenancePolicy(InstanceMaintenancePolicy)
.- Parameters:
instanceMaintenancePolicy
- a consumer that will call methods onInstanceMaintenancePolicy.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
overrideConfiguration
CreateAutoScalingGroupRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) Description copied from interface:AwsRequest.Builder
Add an optional request override configuration.- Specified by:
overrideConfiguration
in interfaceAwsRequest.Builder
- Parameters:
overrideConfiguration
- The override configuration.- Returns:
- This object for method chaining.
-
overrideConfiguration
CreateAutoScalingGroupRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Description copied from interface:AwsRequest.Builder
Add an optional request override configuration.- Specified by:
overrideConfiguration
in interfaceAwsRequest.Builder
- Parameters:
builderConsumer
- AConsumer
to which an emptyAwsRequestOverrideConfiguration.Builder
will be given.- Returns:
- This object for method chaining.
-