software.amazon.awssdk.services.autoscaling.model

Interface UpdateAutoScalingGroupRequest.Builder

All Superinterfaces:

AutoScalingRequest.Builder, AwsRequest.Builder, Buildable, CopyableBuilder<UpdateAutoScalingGroupRequest.Builder,UpdateAutoScalingGroupRequest>, SdkBuilder<UpdateAutoScalingGroupRequest.Builder,UpdateAutoScalingGroupRequest>, SdkPojo, SdkRequest.Builder

Enclosing class:

UpdateAutoScalingGroupRequest

public static interface UpdateAutoScalingGroupRequest.Builder
extends AutoScalingRequest.Builder, SdkPojo, CopyableBuilder<UpdateAutoScalingGroupRequest.Builder,UpdateAutoScalingGroupRequest>

Method Summary

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 newly launched instance can contribute to the Amazon CloudWatch metrics.
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 Elastic Load Balancing or custom health check.
UpdateAutoScalingGroupRequest.Builder	healthCheckType(String healthCheckType) The service to use for the health checks.
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) An embedded object that specifies a mixed instances policy.
UpdateAutoScalingGroupRequest.Builder	mixedInstancesPolicy(MixedInstancesPolicy mixedInstancesPolicy) An embedded object that specifies a 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).

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.core.SdkPojo

equalsBySdkFields, sdkFields

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

copy

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

applyMutation, build

Method Detail

autoScalingGroupName

UpdateAutoScalingGroupRequest.Builder autoScalingGroupName(String autoScalingGroupName)

The name of the Auto Scaling group.

Parameters:

autoScalingGroupName - The name of the Auto Scaling group.

Returns:

Returns a reference to this object so that method calls can be chained together.

launchConfigurationName

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.

Parameters:

launchConfigurationName - The name of the launch configuration. If you specify LaunchConfigurationName in your update request, you can't specify LaunchTemplate or MixedInstancesPolicy.

Returns:

Returns a reference to this object so that method calls can be chained together.

launchTemplate

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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

launchTemplate

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.

This is a convenience method that creates an instance of the 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).

Parameters:

launchTemplate - a consumer that will call methods on LaunchTemplateSpecification.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

launchTemplate(LaunchTemplateSpecification)

mixedInstancesPolicy

UpdateAutoScalingGroupRequest.Builder mixedInstancesPolicy(MixedInstancesPolicy mixedInstancesPolicy)

An embedded object that specifies a 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 - An embedded object that specifies a 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 UpdateAutoScalingGroupRequest.Builder mixedInstancesPolicy(Consumer<MixedInstancesPolicy.Builder> mixedInstancesPolicy)

An embedded object that specifies a 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 the MixedInstancesPolicy.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).

Parameters:

mixedInstancesPolicy - a consumer that will call methods on MixedInstancesPolicy.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

mixedInstancesPolicy(MixedInstancesPolicy)

minSize

UpdateAutoScalingGroupRequest.Builder minSize(Integer minSize)

The minimum size of the Auto Scaling group.

Parameters:

minSize - The minimum size of the Auto Scaling group.

Returns:

Returns a reference to this object so that method calls can be chained together.

maxSize

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).

Parameters:

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).

Returns:

Returns a reference to this object so that method calls can be chained together.

desiredCapacity

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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

defaultCooldown

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.

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

availabilityZones

UpdateAutoScalingGroupRequest.Builder availabilityZones(Collection<String> availabilityZones)

One or more Availability Zones for the group.

Parameters:

availabilityZones - One or more Availability Zones for the group.

Returns:

Returns a reference to this object so that method calls can be chained together.

availabilityZones

UpdateAutoScalingGroupRequest.Builder availabilityZones(String... availabilityZones)

One or more Availability Zones for the group.

Parameters:

availabilityZones - One or more Availability Zones for the group.

Returns:

Returns a reference to this object so that method calls can be chained together.

healthCheckType

UpdateAutoScalingGroupRequest.Builder healthCheckType(String healthCheckType)

The service to use for the health checks. The valid values are EC2 and ELB. If you configure an Auto Scaling group to use ELB health checks, it considers the instance unhealthy if it fails either the EC2 status checks or the load balancer health checks.

Parameters:

healthCheckType - The service to use for the health checks. The valid values are EC2 and ELB. If you configure an Auto Scaling group to use ELB health checks, it considers the instance unhealthy if it fails either the EC2 status checks or the load balancer health checks.

Returns:

Returns a reference to this object so that method calls can be chained together.

healthCheckGracePeriod

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 Elastic Load Balancing or custom health check. This is useful if your instances do not immediately pass these health checks after they enter the InService state. For more information, see Health check grace period in the Amazon EC2 Auto Scaling User Guide.

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 Elastic Load Balancing or custom health check. This is useful if your instances do not immediately pass these health checks after they enter the InService state. For more information, see Health check grace period in the Amazon EC2 Auto Scaling User Guide.

Returns:

Returns a reference to this object so that method calls can be chained together.

placementGroup

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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

vpcZoneIdentifier

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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

terminationPolicies

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

terminationPolicies

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

newInstancesProtectedFromScaleIn

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.

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.

serviceLinkedRoleARN

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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

maxInstanceLifetime

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.

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). 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.

Returns:

Returns a reference to this object so that method calls can be chained together.

capacityRebalance

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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

context

UpdateAutoScalingGroupRequest.Builder context(String context)

Reserved.

Parameters:

context - Reserved.

Returns:

Returns a reference to this object so that method calls can be chained together.

desiredCapacityType

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

defaultInstanceWarmup

UpdateAutoScalingGroupRequest.Builder defaultInstanceWarmup(Integer defaultInstanceWarmup)

The amount of time, in seconds, until a newly launched instance can contribute to the Amazon CloudWatch metrics. This delay lets an instance finish initializing before Amazon EC2 Auto Scaling aggregates instance metrics, resulting in more reliable usage data. Set this value equal to the amount of time that it takes for resource consumption to become stable after an instance reaches the InService state. For more information, see Set the default instance warmup for an Auto Scaling group in the Amazon EC2 Auto Scaling User Guide.

To manage your warm-up settings at the group level, we recommend that you set the default instance warmup, even if its value is set to 0 seconds. This also optimizes the performance of scaling policies that scale continuously, such as target tracking and step scaling policies.

If you need 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 minimum value of 0.

Parameters:

defaultInstanceWarmup - The amount of time, in seconds, until a newly launched instance can contribute to the Amazon CloudWatch metrics. This delay lets an instance finish initializing before Amazon EC2 Auto Scaling aggregates instance metrics, resulting in more reliable usage data. Set this value equal to the amount of time that it takes for resource consumption to become stable after an instance reaches the InService state. For more information, see Set the default instance warmup for an Auto Scaling group in the Amazon EC2 Auto Scaling User Guide.

To manage your warm-up settings at the group level, we recommend that you set the default instance warmup, even if its value is set to 0 seconds. This also optimizes the performance of scaling policies that scale continuously, such as target tracking and step scaling policies.

If you need 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 minimum value of 0.

Returns:

Returns a reference to this object so that method calls can be chained together.

overrideConfiguration

UpdateAutoScalingGroupRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)

Specified by:

overrideConfiguration in interface AwsRequest.Builder

overrideConfiguration

UpdateAutoScalingGroupRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)

Specified by:

overrideConfiguration in interface AwsRequest.Builder