software.amazon.awssdk.services.autoscaling.model

Interface CreateAutoScalingGroupRequest.Builder

All Superinterfaces:

AutoScalingRequest.Builder, AwsRequest.Builder, CopyableBuilder<CreateAutoScalingGroupRequest.Builder,CreateAutoScalingGroupRequest>, SdkBuilder<CreateAutoScalingGroupRequest.Builder,CreateAutoScalingGroupRequest>, SdkRequest.Builder

Enclosing class:

CreateAutoScalingGroupRequest

public static interface CreateAutoScalingGroupRequest.Builder
extends AutoScalingRequest.Builder, CopyableBuilder<CreateAutoScalingGroupRequest.Builder,CreateAutoScalingGroupRequest>

Method Summary

Modifier and Type	Method and Description
CreateAutoScalingGroupRequest.Builder	autoScalingGroupName(String autoScalingGroupName) The name of the group.
CreateAutoScalingGroupRequest.Builder	availabilityZones(Collection<String> availabilityZones) One or more Availability Zones for the group.
CreateAutoScalingGroupRequest.Builder	availabilityZones(String... availabilityZones) One or more Availability Zones for the group.
CreateAutoScalingGroupRequest.Builder	defaultCooldown(Integer defaultCooldown) The amount of time, in seconds, after a scaling activity completes before another scaling activity can start.
CreateAutoScalingGroupRequest.Builder	desiredCapacity(Integer desiredCapacity) The number of EC2 instances that should be running in the group.
CreateAutoScalingGroupRequest.Builder	healthCheckGracePeriod(Integer healthCheckGracePeriod) The amount of time, in seconds, that Auto Scaling waits before checking the health status of an EC2 instance that has come into service.
CreateAutoScalingGroupRequest.Builder	healthCheckType(String healthCheckType) The service to use for the health checks.
CreateAutoScalingGroupRequest.Builder	instanceId(String instanceId) The ID of the instance used to create a launch configuration for the group.
CreateAutoScalingGroupRequest.Builder	launchConfigurationName(String launchConfigurationName) The name of the launch configuration.
CreateAutoScalingGroupRequest.Builder	lifecycleHookSpecificationList(Collection<LifecycleHookSpecification> lifecycleHookSpecificationList) One or more lifecycle hooks.
CreateAutoScalingGroupRequest.Builder	lifecycleHookSpecificationList(Consumer<LifecycleHookSpecification.Builder>... lifecycleHookSpecificationList) One or more lifecycle hooks.
CreateAutoScalingGroupRequest.Builder	lifecycleHookSpecificationList(LifecycleHookSpecification... lifecycleHookSpecificationList) One or more lifecycle hooks.
CreateAutoScalingGroupRequest.Builder	loadBalancerNames(Collection<String> loadBalancerNames) One or more Classic Load Balancers.
CreateAutoScalingGroupRequest.Builder	loadBalancerNames(String... loadBalancerNames) One or more Classic Load Balancers.
CreateAutoScalingGroupRequest.Builder	maxSize(Integer maxSize) The maximum size of the group.
CreateAutoScalingGroupRequest.Builder	minSize(Integer minSize) The minimum size of the group.
CreateAutoScalingGroupRequest.Builder	newInstancesProtectedFromScaleIn(Boolean newInstancesProtectedFromScaleIn) Indicates whether newly launched instances are protected from termination by Auto Scaling when scaling in.
CreateAutoScalingGroupRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) Add an optional request override configuration.
CreateAutoScalingGroupRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Add an optional request override configuration.
CreateAutoScalingGroupRequest.Builder	placementGroup(String placementGroup) The name of the placement group into which you'll launch your instances, if any.
CreateAutoScalingGroupRequest.Builder	tags(Collection<Tag> tags) One or more tags.
CreateAutoScalingGroupRequest.Builder	tags(Consumer<Tag.Builder>... tags) One or more tags.
CreateAutoScalingGroupRequest.Builder	tags(Tag... tags) One or more tags.
CreateAutoScalingGroupRequest.Builder	targetGroupARNs(Collection<String> targetGroupARNs) The Amazon Resource Names (ARN) of the target groups.
CreateAutoScalingGroupRequest.Builder	targetGroupARNs(String... targetGroupARNs) The Amazon Resource Names (ARN) of the target groups.
CreateAutoScalingGroupRequest.Builder	terminationPolicies(Collection<String> terminationPolicies) One or more termination policies used to select the instance to terminate.
CreateAutoScalingGroupRequest.Builder	terminationPolicies(String... terminationPolicies) One or more termination policies used to select the instance to terminate.
CreateAutoScalingGroupRequest.Builder	vpcZoneIdentifier(String vpcZoneIdentifier) A comma-separated list of subnet identifiers for your 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.utils.builder.CopyableBuilder

copy

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

applyMutation, build

Method Detail

autoScalingGroupName

CreateAutoScalingGroupRequest.Builder autoScalingGroupName(String autoScalingGroupName)

The name of the group. This name must be unique within the scope of your AWS account.

Parameters:

autoScalingGroupName - The name of the group. This name must be unique within the scope of your AWS account.

Returns:

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

launchConfigurationName

CreateAutoScalingGroupRequest.Builder launchConfigurationName(String launchConfigurationName)

The name of the launch configuration. Alternatively, specify an EC2 instance instead of a launch configuration.

Parameters:

launchConfigurationName - The name of the launch configuration. Alternatively, specify an EC2 instance instead of a launch configuration.

Returns:

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

instanceId

CreateAutoScalingGroupRequest.Builder instanceId(String instanceId)

The ID of the instance used to create a launch configuration for the group. Alternatively, specify a launch configuration instead of an EC2 instance.

When you specify an ID of an instance, Auto Scaling creates a new launch configuration and associates it with the group. This launch configuration derives its attributes from the specified instance, with the exception of the block device mapping.

For more information, see Create an Auto Scaling Group Using an EC2 Instance in the Auto Scaling User Guide.

Parameters:

instanceId - The ID of the instance used to create a launch configuration for the group. Alternatively, specify a launch configuration instead of an EC2 instance.

When you specify an ID of an instance, Auto Scaling creates a new launch configuration and associates it with the group. This launch configuration derives its attributes from the specified instance, with the exception of the block device mapping.

For more information, see Create an Auto Scaling Group Using an EC2 Instance in the Auto Scaling User Guide.

Returns:

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

minSize

CreateAutoScalingGroupRequest.Builder minSize(Integer 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

CreateAutoScalingGroupRequest.Builder maxSize(Integer maxSize)

The maximum size of the group.

Parameters:

maxSize - The maximum size of the group.

Returns:

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

desiredCapacity

CreateAutoScalingGroupRequest.Builder desiredCapacity(Integer desiredCapacity)

The number of EC2 instances that should be running in the 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. If you do not specify a desired capacity, the default is the minimum size of the group.

Parameters:

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

CreateAutoScalingGroupRequest.Builder defaultCooldown(Integer defaultCooldown)

The amount of time, in seconds, after a scaling activity completes before another scaling activity can start. The default is 300.

For more information, see Auto Scaling Cooldowns in the 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 is 300.

For more information, see Auto Scaling Cooldowns in the Auto Scaling User Guide.

Returns:

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

availabilityZones

CreateAutoScalingGroupRequest.Builder availabilityZones(Collection<String> availabilityZones)

One or more Availability Zones for the group. This parameter is optional if you specify one or more subnets.

Parameters:

availabilityZones - One or more Availability Zones for the group. This parameter is optional if you specify one or more subnets.

Returns:

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

availabilityZones

CreateAutoScalingGroupRequest.Builder availabilityZones(String... availabilityZones)

One or more Availability Zones for the group. This parameter is optional if you specify one or more subnets.

Parameters:

availabilityZones - One or more Availability Zones for the group. This parameter is optional if you specify one or more subnets.

Returns:

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

loadBalancerNames

CreateAutoScalingGroupRequest.Builder loadBalancerNames(Collection<String> loadBalancerNames)

One or more Classic Load Balancers. To specify an Application Load Balancer, use TargetGroupARNs instead.

For more information, see Using a Load Balancer With an Auto Scaling Group in the Auto Scaling User Guide.

Parameters:

loadBalancerNames - One or more Classic Load Balancers. To specify an Application Load Balancer, use TargetGroupARNs instead.

For more information, see Using a Load Balancer With an Auto Scaling Group in the Auto Scaling User Guide.

Returns:

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

loadBalancerNames

CreateAutoScalingGroupRequest.Builder loadBalancerNames(String... loadBalancerNames)

One or more Classic Load Balancers. To specify an Application Load Balancer, use TargetGroupARNs instead.

For more information, see Using a Load Balancer With an Auto Scaling Group in the Auto Scaling User Guide.

Parameters:

loadBalancerNames - One or more Classic Load Balancers. To specify an Application Load Balancer, use TargetGroupARNs instead.

For more information, see Using a Load Balancer With an Auto Scaling Group in the Auto Scaling User Guide.

Returns:

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

targetGroupARNs

CreateAutoScalingGroupRequest.Builder targetGroupARNs(Collection<String> targetGroupARNs)

The Amazon Resource Names (ARN) of the target groups.

Parameters:

targetGroupARNs - The Amazon Resource Names (ARN) of the target groups.

Returns:

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

targetGroupARNs

CreateAutoScalingGroupRequest.Builder targetGroupARNs(String... targetGroupARNs)

The Amazon Resource Names (ARN) of the target groups.

Parameters:

targetGroupARNs - The Amazon Resource Names (ARN) of the target groups.

Returns:

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

healthCheckType

CreateAutoScalingGroupRequest.Builder healthCheckType(String healthCheckType)

The service to use for the health checks. The valid values are EC2 and ELB.

By default, health checks use Amazon EC2 instance status checks to determine the health of an instance. For more information, see Health Checks in the Auto Scaling User Guide.

Parameters:

healthCheckType - The service to use for the health checks. The valid values are EC2 and ELB .

By default, health checks use Amazon EC2 instance status checks to determine the health of an instance. For more information, see Health Checks in the Auto Scaling User Guide.

Returns:

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

healthCheckGracePeriod

CreateAutoScalingGroupRequest.Builder healthCheckGracePeriod(Integer healthCheckGracePeriod)

The amount of time, in seconds, that Auto Scaling waits before checking the health status of an EC2 instance that has come into service. During this time, any health check failures for the instance are ignored. The default is 0.

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

For more information, see Health Checks in the Auto Scaling User Guide.

Parameters:

healthCheckGracePeriod - The amount of time, in seconds, that Auto Scaling waits before checking the health status of an EC2 instance that has come into service. During this time, any health check failures for the instance are ignored. The default is 0.

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

For more information, see Health Checks in the Auto Scaling User Guide.

Returns:

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

placementGroup

CreateAutoScalingGroupRequest.Builder placementGroup(String placementGroup)

The name of the placement group into which you'll launch your instances, if any. For more information, see Placement Groups in the Amazon Elastic Compute Cloud User Guide.

Parameters:

placementGroup - The name of the placement group into which you'll launch your instances, if any. For more information, see Placement Groups in the Amazon Elastic Compute Cloud User Guide.

Returns:

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

vpcZoneIdentifier

CreateAutoScalingGroupRequest.Builder vpcZoneIdentifier(String vpcZoneIdentifier)

A comma-separated list of subnet identifiers for your virtual private cloud (VPC).

If you specify subnets and Availability Zones with this call, ensure that the subnets' Availability Zones match the Availability Zones specified.

For more information, see Launching Auto Scaling Instances in a VPC in the Auto Scaling User Guide.

Parameters:

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

If you specify subnets and Availability Zones with this call, ensure that the subnets' Availability Zones match the Availability Zones specified.

For more information, see Launching Auto Scaling Instances in a VPC in the Auto Scaling User Guide.

Returns:

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

terminationPolicies

CreateAutoScalingGroupRequest.Builder terminationPolicies(Collection<String> terminationPolicies)

One or more termination policies used to select the instance to terminate. These 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 Auto Scaling User Guide.

Parameters:

terminationPolicies - One or more termination policies used to select the instance to terminate. These 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 Auto Scaling User Guide.

Returns:

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

terminationPolicies

CreateAutoScalingGroupRequest.Builder terminationPolicies(String... terminationPolicies)

One or more termination policies used to select the instance to terminate. These 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 Auto Scaling User Guide.

Parameters:

terminationPolicies - One or more termination policies used to select the instance to terminate. These 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 Auto Scaling User Guide.

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 Auto Scaling when scaling in.

Parameters:

newInstancesProtectedFromScaleIn - Indicates whether newly launched instances are protected from termination by Auto Scaling when scaling in.

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.

Parameters:

lifecycleHookSpecificationList - One or more lifecycle hooks.

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.

Parameters:

lifecycleHookSpecificationList - One or more lifecycle hooks.

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.

This is a convenience that creates an instance of the List.Builder avoiding the need to create one manually via List#builder(). When the Consumer completes, List.Builder#build() is called immediately and its result is passed to #lifecycleHookSpecificationList(List).

Parameters:

lifecycleHookSpecificationList - a consumer that will call methods on List.Builder

Returns:

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

See Also:

#lifecycleHookSpecificationList(List)

tags

CreateAutoScalingGroupRequest.Builder tags(Collection<Tag> tags)

One or more tags.

For more information, see Tagging Auto Scaling Groups and Instances in the Auto Scaling User Guide.

Parameters:

tags - One or more tags.

For more information, see Tagging Auto Scaling Groups and Instances in the Auto Scaling User Guide.

Returns:

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

tags

CreateAutoScalingGroupRequest.Builder tags(Tag... tags)

One or more tags.

For more information, see Tagging Auto Scaling Groups and Instances in the Auto Scaling User Guide.

Parameters:

tags - One or more tags.

For more information, see Tagging Auto Scaling Groups and Instances in the Auto Scaling User Guide.

Returns:

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

tags

CreateAutoScalingGroupRequest.Builder tags(Consumer<Tag.Builder>... tags)

One or more tags.

For more information, see Tagging Auto Scaling Groups and Instances in the Auto Scaling User Guide.

This is a convenience that creates an instance of the List.Builder avoiding the need to create one manually via List#builder(). When the Consumer completes, List.Builder#build() is called immediately and its result is passed to #tags(List).

Parameters:

tags - a consumer that will call methods on List.Builder

Returns:

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

See Also:

#tags(List)

overrideConfiguration

CreateAutoScalingGroupRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)

Description copied from interface: AwsRequest.Builder

Add an optional request override configuration.

Specified by:

overrideConfiguration in interface AwsRequest.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 interface AwsRequest.Builder

Parameters:

builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.

Returns:

This object for method chaining.