software.amazon.awssdk.services.autoscaling.model

Interface AutoScalingGroup.Builder

All Superinterfaces:

Buildable, CopyableBuilder<AutoScalingGroup.Builder,AutoScalingGroup>, SdkBuilder<AutoScalingGroup.Builder,AutoScalingGroup>, SdkPojo

Enclosing class:

AutoScalingGroup

public static interface AutoScalingGroup.Builder
extends SdkPojo, CopyableBuilder<AutoScalingGroup.Builder,AutoScalingGroup>

Method Summary

Modifier and Type	Method and Description
AutoScalingGroup.Builder	autoScalingGroupARN(String autoScalingGroupARN) The Amazon Resource Name (ARN) of the Auto Scaling group.
AutoScalingGroup.Builder	autoScalingGroupName(String autoScalingGroupName) The name of the Auto Scaling group.
AutoScalingGroup.Builder	availabilityZones(Collection<String> availabilityZones) One or more Availability Zones for the group.
AutoScalingGroup.Builder	availabilityZones(String... availabilityZones) One or more Availability Zones for the group.
AutoScalingGroup.Builder	createdTime(Instant createdTime) The date and time the group was created.
AutoScalingGroup.Builder	defaultCooldown(Integer defaultCooldown) The amount of time, in seconds, after a scaling activity completes before another scaling activity can start.
AutoScalingGroup.Builder	desiredCapacity(Integer desiredCapacity) The desired size of the group.
AutoScalingGroup.Builder	enabledMetrics(Collection<EnabledMetric> enabledMetrics) The metrics enabled for the group.
AutoScalingGroup.Builder	enabledMetrics(Consumer<EnabledMetric.Builder>... enabledMetrics) The metrics enabled for the group.
AutoScalingGroup.Builder	enabledMetrics(EnabledMetric... enabledMetrics) The metrics enabled for the group.
AutoScalingGroup.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.
AutoScalingGroup.Builder	healthCheckType(String healthCheckType) The service to use for the health checks.
AutoScalingGroup.Builder	instances(Collection<Instance> instances) The EC2 instances associated with the group.
AutoScalingGroup.Builder	instances(Consumer<Instance.Builder>... instances) The EC2 instances associated with the group.
AutoScalingGroup.Builder	instances(Instance... instances) The EC2 instances associated with the group.
AutoScalingGroup.Builder	launchConfigurationName(String launchConfigurationName) The name of the associated launch configuration.
default AutoScalingGroup.Builder	launchTemplate(Consumer<LaunchTemplateSpecification.Builder> launchTemplate) The launch template for the group.
AutoScalingGroup.Builder	launchTemplate(LaunchTemplateSpecification launchTemplate) The launch template for the group.
AutoScalingGroup.Builder	loadBalancerNames(Collection<String> loadBalancerNames) One or more load balancers associated with the group.
AutoScalingGroup.Builder	loadBalancerNames(String... loadBalancerNames) One or more load balancers associated with the group.
AutoScalingGroup.Builder	maxSize(Integer maxSize) The maximum size of the group.
AutoScalingGroup.Builder	minSize(Integer minSize) The minimum size of the group.
default AutoScalingGroup.Builder	mixedInstancesPolicy(Consumer<MixedInstancesPolicy.Builder> mixedInstancesPolicy) The mixed instances policy for the group.
AutoScalingGroup.Builder	mixedInstancesPolicy(MixedInstancesPolicy mixedInstancesPolicy) The mixed instances policy for the group.
AutoScalingGroup.Builder	newInstancesProtectedFromScaleIn(Boolean newInstancesProtectedFromScaleIn) Indicates whether newly launched instances are protected from termination by Auto Scaling when scaling in.
AutoScalingGroup.Builder	placementGroup(String placementGroup) The name of the placement group into which to launch your instances, if any.
AutoScalingGroup.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.
AutoScalingGroup.Builder	status(String status) The current state of the group when DeleteAutoScalingGroup is in progress.
AutoScalingGroup.Builder	suspendedProcesses(Collection<SuspendedProcess> suspendedProcesses) The suspended processes associated with the group.
AutoScalingGroup.Builder	suspendedProcesses(Consumer<SuspendedProcess.Builder>... suspendedProcesses) The suspended processes associated with the group.
AutoScalingGroup.Builder	suspendedProcesses(SuspendedProcess... suspendedProcesses) The suspended processes associated with the group.
AutoScalingGroup.Builder	tags(Collection<TagDescription> tags) The tags for the group.
AutoScalingGroup.Builder	tags(Consumer<TagDescription.Builder>... tags) The tags for the group.
AutoScalingGroup.Builder	tags(TagDescription... tags) The tags for the group.
AutoScalingGroup.Builder	targetGroupARNs(Collection<String> targetGroupARNs) The Amazon Resource Names (ARN) of the target groups for your load balancer.
AutoScalingGroup.Builder	targetGroupARNs(String... targetGroupARNs) The Amazon Resource Names (ARN) of the target groups for your load balancer.
AutoScalingGroup.Builder	terminationPolicies(Collection<String> terminationPolicies) The termination policies for the group.
AutoScalingGroup.Builder	terminationPolicies(String... terminationPolicies) The termination policies for the group.
AutoScalingGroup.Builder	vpcZoneIdentifier(String vpcZoneIdentifier) One or more subnet IDs, if applicable, separated by commas.

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

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

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

autoScalingGroupARN

AutoScalingGroup.Builder autoScalingGroupARN(String autoScalingGroupARN)

The Amazon Resource Name (ARN) of the Auto Scaling group.

Parameters:

autoScalingGroupARN - The Amazon Resource Name (ARN) of the Auto Scaling group.

Returns:

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

launchConfigurationName

AutoScalingGroup.Builder launchConfigurationName(String launchConfigurationName)

The name of the associated launch configuration.

Parameters:

launchConfigurationName - The name of the associated launch configuration.

Returns:

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

launchTemplate

AutoScalingGroup.Builder launchTemplate(LaunchTemplateSpecification launchTemplate)

The launch template for the group.

Parameters:

launchTemplate - The launch template for the group.

Returns:

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

launchTemplate

default AutoScalingGroup.Builder launchTemplate(Consumer<LaunchTemplateSpecification.Builder> launchTemplate)

The launch template for the group.

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

AutoScalingGroup.Builder mixedInstancesPolicy(MixedInstancesPolicy mixedInstancesPolicy)

The mixed instances policy for the group.

Parameters:

mixedInstancesPolicy - The mixed instances policy for the group.

Returns:

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

mixedInstancesPolicy

default AutoScalingGroup.Builder mixedInstancesPolicy(Consumer<MixedInstancesPolicy.Builder> mixedInstancesPolicy)

The mixed instances policy for the group.

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

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

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

AutoScalingGroup.Builder desiredCapacity(Integer desiredCapacity)

The desired size of the group.

Parameters:

desiredCapacity - The desired size of the group.

Returns:

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

defaultCooldown

AutoScalingGroup.Builder defaultCooldown(Integer defaultCooldown)

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

Parameters:

defaultCooldown - The amount of time, in seconds, after a scaling activity completes before another scaling activity can start.

Returns:

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

availabilityZones

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

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

loadBalancerNames

AutoScalingGroup.Builder loadBalancerNames(Collection<String> loadBalancerNames)

One or more load balancers associated with the group.

Parameters:

loadBalancerNames - One or more load balancers associated with the group.

Returns:

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

loadBalancerNames

AutoScalingGroup.Builder loadBalancerNames(String... loadBalancerNames)

One or more load balancers associated with the group.

Parameters:

loadBalancerNames - One or more load balancers associated with the group.

Returns:

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

targetGroupARNs

AutoScalingGroup.Builder targetGroupARNs(Collection<String> targetGroupARNs)

The Amazon Resource Names (ARN) of the target groups for your load balancer.

Parameters:

targetGroupARNs - The Amazon Resource Names (ARN) of the target groups for your load balancer.

Returns:

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

targetGroupARNs

AutoScalingGroup.Builder targetGroupARNs(String... targetGroupARNs)

The Amazon Resource Names (ARN) of the target groups for your load balancer.

Parameters:

targetGroupARNs - The Amazon Resource Names (ARN) of the target groups for your load balancer.

Returns:

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

healthCheckType

AutoScalingGroup.Builder healthCheckType(String healthCheckType)

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

Parameters:

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

Returns:

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

healthCheckGracePeriod

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

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.

Returns:

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

instances

AutoScalingGroup.Builder instances(Collection<Instance> instances)

The EC2 instances associated with the group.

Parameters:

instances - The EC2 instances associated with the group.

Returns:

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

instances

AutoScalingGroup.Builder instances(Instance... instances)

The EC2 instances associated with the group.

Parameters:

instances - The EC2 instances associated with the group.

Returns:

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

instances

AutoScalingGroup.Builder instances(Consumer<Instance.Builder>... instances)

The EC2 instances associated with the group.

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 #instances(List).

Parameters:

instances - 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:

#instances(List)

createdTime

AutoScalingGroup.Builder createdTime(Instant createdTime)

The date and time the group was created.

Parameters:

createdTime - The date and time the group was created.

Returns:

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

suspendedProcesses

AutoScalingGroup.Builder suspendedProcesses(Collection<SuspendedProcess> suspendedProcesses)

The suspended processes associated with the group.

Parameters:

suspendedProcesses - The suspended processes associated with the group.

Returns:

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

suspendedProcesses

AutoScalingGroup.Builder suspendedProcesses(SuspendedProcess... suspendedProcesses)

The suspended processes associated with the group.

Parameters:

suspendedProcesses - The suspended processes associated with the group.

Returns:

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

suspendedProcesses

AutoScalingGroup.Builder suspendedProcesses(Consumer<SuspendedProcess.Builder>... suspendedProcesses)

The suspended processes associated with the group.

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 #suspendedProcesses(List).

Parameters:

suspendedProcesses - 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:

#suspendedProcesses(List)

placementGroup

AutoScalingGroup.Builder placementGroup(String placementGroup)

The name of the placement group into which to 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 to 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

AutoScalingGroup.Builder vpcZoneIdentifier(String vpcZoneIdentifier)

One or more subnet IDs, if applicable, separated by commas.

If you specify VPCZoneIdentifier and AvailabilityZones, ensure that the Availability Zones of the subnets match the values for AvailabilityZones.

Parameters:

vpcZoneIdentifier - One or more subnet IDs, if applicable, separated by commas.

If you specify VPCZoneIdentifier and AvailabilityZones, ensure that the Availability Zones of the subnets match the values for AvailabilityZones.

Returns:

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

enabledMetrics

AutoScalingGroup.Builder enabledMetrics(Collection<EnabledMetric> enabledMetrics)

The metrics enabled for the group.

Parameters:

enabledMetrics - The metrics enabled for the group.

Returns:

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

enabledMetrics

AutoScalingGroup.Builder enabledMetrics(EnabledMetric... enabledMetrics)

The metrics enabled for the group.

Parameters:

enabledMetrics - The metrics enabled for the group.

Returns:

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

enabledMetrics

AutoScalingGroup.Builder enabledMetrics(Consumer<EnabledMetric.Builder>... enabledMetrics)

The metrics enabled for the group.

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 #enabledMetrics(List).

Parameters:

enabledMetrics - 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:

#enabledMetrics(List)

status

AutoScalingGroup.Builder status(String status)

The current state of the group when DeleteAutoScalingGroup is in progress.

Parameters:

status - The current state of the group when DeleteAutoScalingGroup is in progress.

Returns:

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

tags

AutoScalingGroup.Builder tags(Collection<TagDescription> tags)

The tags for the group.

Parameters:

tags - The tags for the group.

Returns:

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

tags

AutoScalingGroup.Builder tags(TagDescription... tags)

The tags for the group.

Parameters:

tags - The tags for the group.

Returns:

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

tags

AutoScalingGroup.Builder tags(Consumer<TagDescription.Builder>... tags)

The tags for the group.

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)

terminationPolicies

AutoScalingGroup.Builder terminationPolicies(Collection<String> terminationPolicies)

The termination policies for the group.

Parameters:

terminationPolicies - The termination policies for the group.

Returns:

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

terminationPolicies

AutoScalingGroup.Builder terminationPolicies(String... terminationPolicies)

The termination policies for the group.

Parameters:

terminationPolicies - The termination policies for the group.

Returns:

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

newInstancesProtectedFromScaleIn

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

serviceLinkedRoleARN

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

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.

Returns:

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