public static interface UpdateAutoScalingGroupRequest.Builder extends AutoScalingRequest.Builder, SdkPojo, CopyableBuilder<UpdateAutoScalingGroupRequest.Builder,UpdateAutoScalingGroupRequest>
Modifier and Type | Method and Description |
---|---|
UpdateAutoScalingGroupRequest.Builder |
autoScalingGroupName(String autoScalingGroupName)
The name of the Auto Scaling group.
|
UpdateAutoScalingGroupRequest.Builder |
availabilityZones(Collection<String> availabilityZones)
One or more Availability Zones for the group.
|
UpdateAutoScalingGroupRequest.Builder |
availabilityZones(String... availabilityZones)
One or more Availability Zones for the group.
|
UpdateAutoScalingGroupRequest.Builder |
capacityRebalance(Boolean capacityRebalance)
Enables or disables Capacity Rebalancing.
|
UpdateAutoScalingGroupRequest.Builder |
context(String context)
Reserved.
|
UpdateAutoScalingGroupRequest.Builder |
defaultCooldown(Integer defaultCooldown)
Only needed if you use simple scaling policies.
|
UpdateAutoScalingGroupRequest.Builder |
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 the
InService state. |
UpdateAutoScalingGroupRequest.Builder |
desiredCapacity(Integer desiredCapacity)
The desired capacity is the initial capacity of the Auto Scaling group after this operation completes and the
capacity it attempts to maintain.
|
UpdateAutoScalingGroupRequest.Builder |
desiredCapacityType(String desiredCapacityType)
The unit of measurement for the value specified for desired capacity.
|
UpdateAutoScalingGroupRequest.Builder |
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.
|
UpdateAutoScalingGroupRequest.Builder |
healthCheckType(String healthCheckType)
A comma-separated value string of one or more health check types.
|
UpdateAutoScalingGroupRequest.Builder |
launchConfigurationName(String launchConfigurationName)
The name of the launch configuration.
|
default UpdateAutoScalingGroupRequest.Builder |
launchTemplate(Consumer<LaunchTemplateSpecification.Builder> launchTemplate)
The launch template and version to use to specify the updates.
|
UpdateAutoScalingGroupRequest.Builder |
launchTemplate(LaunchTemplateSpecification launchTemplate)
The launch template and version to use to specify the updates.
|
UpdateAutoScalingGroupRequest.Builder |
maxInstanceLifetime(Integer maxInstanceLifetime)
The maximum amount of time, in seconds, that an instance can be in service.
|
UpdateAutoScalingGroupRequest.Builder |
maxSize(Integer maxSize)
The maximum size of the Auto Scaling group.
|
UpdateAutoScalingGroupRequest.Builder |
minSize(Integer minSize)
The minimum size of the Auto Scaling group.
|
default UpdateAutoScalingGroupRequest.Builder |
mixedInstancesPolicy(Consumer<MixedInstancesPolicy.Builder> mixedInstancesPolicy)
The mixed instances policy.
|
UpdateAutoScalingGroupRequest.Builder |
mixedInstancesPolicy(MixedInstancesPolicy mixedInstancesPolicy)
The mixed instances policy.
|
UpdateAutoScalingGroupRequest.Builder |
newInstancesProtectedFromScaleIn(Boolean newInstancesProtectedFromScaleIn)
Indicates whether newly launched instances are protected from termination by Amazon EC2 Auto Scaling when
scaling in.
|
UpdateAutoScalingGroupRequest.Builder |
overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) |
UpdateAutoScalingGroupRequest.Builder |
overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) |
UpdateAutoScalingGroupRequest.Builder |
placementGroup(String placementGroup)
The name of an existing placement group into which to launch your instances.
|
UpdateAutoScalingGroupRequest.Builder |
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 on your behalf.
|
UpdateAutoScalingGroupRequest.Builder |
terminationPolicies(Collection<String> terminationPolicies)
A policy or a list of policies that are used to select the instances to terminate.
|
UpdateAutoScalingGroupRequest.Builder |
terminationPolicies(String... terminationPolicies)
A policy or a list of policies that are used to select the instances to terminate.
|
UpdateAutoScalingGroupRequest.Builder |
vpcZoneIdentifier(String vpcZoneIdentifier)
A comma-separated list of subnet IDs for a virtual private cloud (VPC).
|
build
overrideConfiguration
equalsBySdkFields, sdkFields
copy
applyMutation, build
UpdateAutoScalingGroupRequest.Builder autoScalingGroupName(String autoScalingGroupName)
The name of the Auto Scaling group.
autoScalingGroupName
- The name of the Auto Scaling group.UpdateAutoScalingGroupRequest.Builder launchConfigurationName(String launchConfigurationName)
The name of the launch configuration. If you specify LaunchConfigurationName
in your update
request, you can't specify LaunchTemplate
or MixedInstancesPolicy
.
launchConfigurationName
- The name of the launch configuration. If you specify LaunchConfigurationName
in your
update request, you can't specify LaunchTemplate
or MixedInstancesPolicy
.UpdateAutoScalingGroupRequest.Builder launchTemplate(LaunchTemplateSpecification launchTemplate)
The launch template and version to use to specify the updates. If you specify LaunchTemplate
in
your update request, you can't specify LaunchConfigurationName
or
MixedInstancesPolicy
.
launchTemplate
- The launch template and version to use to specify the updates. If you specify
LaunchTemplate
in your update request, you can't specify
LaunchConfigurationName
or MixedInstancesPolicy
.default UpdateAutoScalingGroupRequest.Builder launchTemplate(Consumer<LaunchTemplateSpecification.Builder> launchTemplate)
The launch template and version to use to specify the updates. If you specify LaunchTemplate
in
your update request, you can't specify LaunchConfigurationName
or
MixedInstancesPolicy
.
LaunchTemplateSpecification.Builder
avoiding the need to create one manually via LaunchTemplateSpecification.builder()
.
When the Consumer
completes, SdkBuilder.build()
is called
immediately and its result is passed to launchTemplate(LaunchTemplateSpecification)
.
launchTemplate
- a consumer that will call methods on LaunchTemplateSpecification.Builder
launchTemplate(LaunchTemplateSpecification)
UpdateAutoScalingGroupRequest.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.
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.default UpdateAutoScalingGroupRequest.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 via MixedInstancesPolicy.builder()
.
When the Consumer
completes, SdkBuilder.build()
is called immediately and
its result is passed to mixedInstancesPolicy(MixedInstancesPolicy)
.
mixedInstancesPolicy
- a consumer that will call methods on MixedInstancesPolicy.Builder
mixedInstancesPolicy(MixedInstancesPolicy)
UpdateAutoScalingGroupRequest.Builder minSize(Integer minSize)
The minimum size of the Auto Scaling group.
minSize
- The minimum size of the Auto Scaling group.UpdateAutoScalingGroupRequest.Builder maxSize(Integer maxSize)
The maximum size of the Auto Scaling 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).
maxSize
- The maximum size of the Auto Scaling 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).
UpdateAutoScalingGroupRequest.Builder desiredCapacity(Integer desiredCapacity)
The desired capacity is the initial capacity of the Auto Scaling group after this operation completes and the capacity it attempts to maintain. 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.
desiredCapacity
- The desired capacity is the initial capacity of the Auto Scaling group after this operation completes
and the capacity it attempts to maintain. 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.UpdateAutoScalingGroupRequest.Builder defaultCooldown(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.
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.
UpdateAutoScalingGroupRequest.Builder availabilityZones(Collection<String> availabilityZones)
One or more Availability Zones for the group.
availabilityZones
- One or more Availability Zones for the group.UpdateAutoScalingGroupRequest.Builder availabilityZones(String... availabilityZones)
One or more Availability Zones for the group.
availabilityZones
- One or more Availability Zones for the group.UpdateAutoScalingGroupRequest.Builder healthCheckType(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.
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.
UpdateAutoScalingGroupRequest.Builder 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. 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.
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.UpdateAutoScalingGroupRequest.Builder placementGroup(String placementGroup)
The name of an existing 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.
placementGroup
- The name of an existing 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.
UpdateAutoScalingGroupRequest.Builder vpcZoneIdentifier(String vpcZoneIdentifier)
A comma-separated list of subnet IDs for a virtual private cloud (VPC). If you specify
VPCZoneIdentifier
with AvailabilityZones
, the subnets that you specify must reside
in those Availability Zones.
vpcZoneIdentifier
- A comma-separated list of subnet IDs for a virtual private cloud (VPC). If you specify
VPCZoneIdentifier
with AvailabilityZones
, the subnets that you specify must
reside in those Availability Zones.UpdateAutoScalingGroupRequest.Builder terminationPolicies(Collection<String> terminationPolicies)
A policy or a list of policies that are used to select the instances to terminate. The 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
terminationPolicies
- A policy or a list of policies that are used to select the instances to terminate. The 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
UpdateAutoScalingGroupRequest.Builder terminationPolicies(String... terminationPolicies)
A policy or a list of policies that are used to select the instances to terminate. The 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
terminationPolicies
- A policy or a list of policies that are used to select the instances to terminate. The 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
UpdateAutoScalingGroupRequest.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.
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.UpdateAutoScalingGroupRequest.Builder 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 on your behalf. For more information, see Service-linked roles in the Amazon EC2 Auto Scaling User Guide.
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. For more information, see Service-linked roles in the Amazon EC2 Auto Scaling User Guide.UpdateAutoScalingGroupRequest.Builder maxInstanceLifetime(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). To clear a previously set value, specify a new value of 0. For more information, see Replacing Auto Scaling instances based on maximum instance lifetime in the Amazon EC2 Auto Scaling User Guide.
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). To
clear a previously set value, specify a new value of 0. For more information, see Replacing
Auto Scaling instances based on maximum instance lifetime in the Amazon EC2 Auto Scaling User
Guide.UpdateAutoScalingGroupRequest.Builder capacityRebalance(Boolean capacityRebalance)
Enables or disables Capacity Rebalancing. For more information, see Use Capacity Rebalancing to handle Amazon EC2 Spot Interruptions in the Amazon EC2 Auto Scaling User Guide.
capacityRebalance
- Enables or disables Capacity Rebalancing. For more information, see Use
Capacity Rebalancing to handle Amazon EC2 Spot Interruptions in the Amazon EC2 Auto Scaling
User Guide.UpdateAutoScalingGroupRequest.Builder context(String context)
Reserved.
context
- Reserved.UpdateAutoScalingGroupRequest.Builder desiredCapacityType(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
- 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
UpdateAutoScalingGroupRequest.Builder 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 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.
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.
UpdateAutoScalingGroupRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
overrideConfiguration
in interface AwsRequest.Builder
UpdateAutoScalingGroupRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
overrideConfiguration
in interface AwsRequest.Builder
Copyright © 2023. All rights reserved.