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	capacityRebalance(Boolean capacityRebalance) Indicates whether Capacity Rebalancing is enabled.
AutoScalingGroup.Builder	context(String context) Reserved.
AutoScalingGroup.Builder	createdTime(Instant createdTime) The date and time the group was created.
AutoScalingGroup.Builder	defaultCooldown(Integer defaultCooldown) The duration of the default cooldown period, in seconds.
AutoScalingGroup.Builder	defaultInstanceWarmup(Integer defaultInstanceWarmup) The duration of the default instance warmup, in seconds.
AutoScalingGroup.Builder	desiredCapacity(Integer desiredCapacity) The desired size of the group.
AutoScalingGroup.Builder	desiredCapacityType(String desiredCapacityType) The unit of measurement for the value specified for desired capacity.
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 duration of the health check grace period, in seconds.
AutoScalingGroup.Builder	healthCheckType(String healthCheckType) A comma-separated value string of one or more health check types.
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	maxInstanceLifetime(Integer maxInstanceLifetime) The maximum amount of time, in seconds, that an instance can be in service.
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 Amazon EC2 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	predictedCapacity(Integer predictedCapacity) The predicted capacity of the group when it has a predictive scaling policy.
AutoScalingGroup.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.
AutoScalingGroup.Builder	status(String status) The current state of the group when the DeleteAutoScalingGroup operation 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	trafficSources(Collection<TrafficSourceIdentifier> trafficSources) The traffic sources associated with this Auto Scaling group.
AutoScalingGroup.Builder	trafficSources(Consumer<TrafficSourceIdentifier.Builder>... trafficSources) The traffic sources associated with this Auto Scaling group.
AutoScalingGroup.Builder	trafficSources(TrafficSourceIdentifier... trafficSources) The traffic sources associated with this Auto Scaling group.
AutoScalingGroup.Builder	vpcZoneIdentifier(String vpcZoneIdentifier) One or more subnet IDs, if applicable, separated by commas.
default AutoScalingGroup.Builder	warmPoolConfiguration(Consumer<WarmPoolConfiguration.Builder> warmPoolConfiguration) The warm pool for the group.
AutoScalingGroup.Builder	warmPoolConfiguration(WarmPoolConfiguration warmPoolConfiguration) The warm pool for the group.
AutoScalingGroup.Builder	warmPoolSize(Integer warmPoolSize) The current size of the warm pool.

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

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

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

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.

predictedCapacity

AutoScalingGroup.Builder predictedCapacity(Integer predictedCapacity)

The predicted capacity of the group when it has a predictive scaling policy.

Parameters:

predictedCapacity - The predicted capacity of the group when it has a predictive scaling policy.

Returns:

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

defaultCooldown

AutoScalingGroup.Builder defaultCooldown(Integer defaultCooldown)

The duration of the default cooldown period, in seconds.

Parameters:

defaultCooldown - The duration of the default cooldown period, in seconds.

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)

A comma-separated value string of one or more health check types.

Parameters:

healthCheckType - A comma-separated value string of one or more health check types.

Returns:

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

healthCheckGracePeriod

AutoScalingGroup.Builder healthCheckGracePeriod(Integer healthCheckGracePeriod)

The duration of the health check grace period, in seconds.

Parameters:

healthCheckGracePeriod - The duration of the health check grace period, in seconds.

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 method that creates an instance of the Instance.Builder avoiding the need to create one manually via Instance.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to #instances(List).

Parameters:

instances - a consumer that will call methods on Instance.Builder

Returns:

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

See Also:

#instances(java.util.Collection)

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 method that creates an instance of the SuspendedProcess.Builder avoiding the need to create one manually via SuspendedProcess.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to #suspendedProcesses(List).

Parameters:

suspendedProcesses - a consumer that will call methods on SuspendedProcess.Builder

Returns:

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

See Also:

#suspendedProcesses(java.util.Collection)

placementGroup

AutoScalingGroup.Builder placementGroup(String placementGroup)

The name of the placement group into which to launch your instances, if any.

Parameters:

placementGroup - The name of the placement group into which to launch your instances, if any.

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.

Parameters:

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

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 method that creates an instance of the EnabledMetric.Builder avoiding the need to create one manually via EnabledMetric.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to #enabledMetrics(List).

Parameters:

enabledMetrics - a consumer that will call methods on EnabledMetric.Builder

Returns:

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

See Also:

#enabledMetrics(java.util.Collection)

status

AutoScalingGroup.Builder status(String status)

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

Parameters:

status - The current state of the group when the DeleteAutoScalingGroup operation 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 method that creates an instance of the TagDescription.Builder avoiding the need to create one manually via TagDescription.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to #tags(List).

Parameters:

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

Returns:

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

See Also:

#tags(java.util.Collection)

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

Parameters:

newInstancesProtectedFromScaleIn - Indicates whether newly launched instances are protected from termination by Amazon EC2 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 Amazon Web 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 Amazon Web Services on your behalf.

Returns:

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

maxInstanceLifetime

AutoScalingGroup.Builder maxInstanceLifetime(Integer maxInstanceLifetime)

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

Valid Range: Minimum value of 0.

Parameters:

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

Valid Range: Minimum value of 0.

Returns:

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

capacityRebalance

AutoScalingGroup.Builder capacityRebalance(Boolean capacityRebalance)

Indicates whether Capacity Rebalancing is enabled.

Parameters:

capacityRebalance - Indicates whether Capacity Rebalancing is enabled.

Returns:

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

warmPoolConfiguration

AutoScalingGroup.Builder warmPoolConfiguration(WarmPoolConfiguration warmPoolConfiguration)

The warm pool for the group.

Parameters:

warmPoolConfiguration - The warm pool for the group.

Returns:

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

warmPoolConfiguration

default AutoScalingGroup.Builder warmPoolConfiguration(Consumer<WarmPoolConfiguration.Builder> warmPoolConfiguration)

The warm pool for the group.

This is a convenience method that creates an instance of the WarmPoolConfiguration.Builder avoiding the need to create one manually via WarmPoolConfiguration.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to warmPoolConfiguration(WarmPoolConfiguration).

Parameters:

warmPoolConfiguration - a consumer that will call methods on WarmPoolConfiguration.Builder

Returns:

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

See Also:

warmPoolConfiguration(WarmPoolConfiguration)

warmPoolSize

AutoScalingGroup.Builder warmPoolSize(Integer warmPoolSize)

The current size of the warm pool.

Parameters:

warmPoolSize - The current size of the warm pool.

Returns:

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

context

AutoScalingGroup.Builder context(String context)

Reserved.

Parameters:

context - Reserved.

Returns:

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

desiredCapacityType

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

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.

Returns:

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

defaultInstanceWarmup

AutoScalingGroup.Builder defaultInstanceWarmup(Integer defaultInstanceWarmup)

The duration of the default instance warmup, in seconds.

Parameters:

defaultInstanceWarmup - The duration of the default instance warmup, in seconds.

Returns:

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

trafficSources

AutoScalingGroup.Builder trafficSources(Collection<TrafficSourceIdentifier> trafficSources)

The traffic sources associated with this Auto Scaling group.

Parameters:

trafficSources - The traffic sources associated with this Auto Scaling group.

Returns:

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

trafficSources

AutoScalingGroup.Builder trafficSources(TrafficSourceIdentifier... trafficSources)

The traffic sources associated with this Auto Scaling group.

Parameters:

trafficSources - The traffic sources associated with this Auto Scaling group.

Returns:

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

trafficSources

AutoScalingGroup.Builder trafficSources(Consumer<TrafficSourceIdentifier.Builder>... trafficSources)

The traffic sources associated with this Auto Scaling group.

This is a convenience method that creates an instance of the TrafficSourceIdentifier.Builder avoiding the need to create one manually via TrafficSourceIdentifier.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to #trafficSources(List).

Parameters:

trafficSources - a consumer that will call methods on TrafficSourceIdentifier.Builder

Returns:

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

See Also:

#trafficSources(java.util.Collection)