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	defaultCooldown(Integer defaultCooldown) The amount of time, in seconds, after a scaling activity completes before another scaling activity can start.
UpdateAutoScalingGroupRequest.Builder	desiredCapacity(Integer desiredCapacity) The number of EC2 instances that should be running in the Auto Scaling group.
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.
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 the placement group into which to launch your instances, if any.
UpdateAutoScalingGroupRequest.Builder	serviceLinkedRoleARN(String serviceLinkedRoleARN) The Amazon Resource Name (ARN) of the service-linked role that the Auto Scaling group uses to call other AWS services on your behalf.
UpdateAutoScalingGroupRequest.Builder	terminationPolicies(Collection<String> terminationPolicies) A standalone termination policy or a list of termination policies used to select the instance to terminate.
UpdateAutoScalingGroupRequest.Builder	terminationPolicies(String... terminationPolicies) A standalone termination policy or a list of termination policies used to select the instance to terminate.
UpdateAutoScalingGroupRequest.Builder	vpcZoneIdentifier(String vpcZoneIdentifier) A comma-separated list of subnet IDs for 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.

For more information, see LaunchTemplateSpecification in the Amazon EC2 Auto Scaling API Reference.

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.

For more information, see LaunchTemplateSpecification in the Amazon EC2 Auto Scaling API Reference.

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.

For more information, see LaunchTemplateSpecification in the Amazon EC2 Auto Scaling API Reference.

This is a convenience 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.

In your call to UpdateAutoScalingGroup, you can make changes to the policy that is specified. All optional parameters are left unchanged if not specified.

For more information, see MixedInstancesPolicy in the Amazon EC2 Auto Scaling API Reference and 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.

In your call to UpdateAutoScalingGroup, you can make changes to the policy that is specified. All optional parameters are left unchanged if not specified.

For more information, see MixedInstancesPolicy in the Amazon EC2 Auto Scaling API Reference and 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.

In your call to UpdateAutoScalingGroup, you can make changes to the policy that is specified. All optional parameters are left unchanged if not specified.

For more information, see MixedInstancesPolicy in the Amazon EC2 Auto Scaling API Reference and Auto Scaling Groups with Multiple Instance Types and Purchase Options in the Amazon EC2 Auto Scaling User Guide.

This is a convenience 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.

Parameters:

maxSize - The maximum size of the Auto Scaling group.

Returns:

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

desiredCapacity

UpdateAutoScalingGroupRequest.Builder desiredCapacity(Integer desiredCapacity)

The number of EC2 instances that should be running in the Auto Scaling group. 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 number of EC2 instances that should be running in the Auto Scaling group. 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)

The amount of time, in seconds, after a scaling activity completes before another scaling activity can start. The default value is 300. This cooldown period is not used when a scaling-specific cooldown is specified.

Cooldown periods are not supported for target tracking scaling policies, step scaling policies, or scheduled scaling. For more information, see Scaling Cooldowns in the Amazon EC2 Auto Scaling User Guide.

Parameters:

defaultCooldown - The amount of time, in seconds, after a scaling activity completes before another scaling activity can start. The default value is 300. This cooldown period is not used when a scaling-specific cooldown is specified.

Cooldown periods are not supported for target tracking scaling policies, step scaling policies, or scheduled scaling. For more information, see Scaling Cooldowns 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. The default value is 0.

For more information, see Health Check Grace Period in the Amazon EC2 Auto Scaling User Guide.

Conditional: This parameter is required if you are adding an ELB health check.

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. The default value is 0.

For more information, see Health Check Grace Period in the Amazon EC2 Auto Scaling User Guide.

Conditional: This parameter is required if you are adding an ELB health check.

Returns:

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

placementGroup

UpdateAutoScalingGroupRequest.Builder placementGroup(String placementGroup)

The name of the 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.

Parameters:

placementGroup - The name of the 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.

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 virtual private cloud (VPC).

If you specify VPCZoneIdentifier with AvailabilityZones, the subnets that you specify for this parameter must reside in those Availability Zones.

Parameters:

vpcZoneIdentifier - A comma-separated list of subnet IDs for virtual private cloud (VPC).

If you specify VPCZoneIdentifier with AvailabilityZones, the subnets that you specify for this parameter 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 standalone termination policy or a list of termination policies used to select the instance to terminate. The policies are executed in the order that they are listed.

For more information, see Controlling Which Instances Auto Scaling Terminates During Scale In in the Amazon EC2 Auto Scaling User Guide.

Parameters:

terminationPolicies - A standalone termination policy or a list of termination policies used to select the instance to terminate. The policies are executed in the order that they are listed.

For more information, see Controlling Which Instances Auto Scaling Terminates During Scale In in the Amazon EC2 Auto Scaling User Guide.

Returns:

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

terminationPolicies

UpdateAutoScalingGroupRequest.Builder terminationPolicies(String... terminationPolicies)

A standalone termination policy or a list of termination policies used to select the instance to terminate. The policies are executed in the order that they are listed.

For more information, see Controlling Which Instances Auto Scaling Terminates During Scale In in the Amazon EC2 Auto Scaling User Guide.

Parameters:

terminationPolicies - A standalone termination policy or a list of termination policies used to select the instance to terminate. The policies are executed in the order that they are listed.

For more information, see Controlling Which Instances Auto Scaling Terminates During Scale In in the Amazon EC2 Auto Scaling User Guide.

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 Instance 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 Instance 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 AWS 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 AWS 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.

Valid Range: Minimum value of 604800.

Parameters:

maxInstanceLifetime - The maximum amount of time, in seconds, that an instance can be in service.

Valid Range: Minimum value of 604800.

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