Interface AutoScalingGroup.Builder
- All Superinterfaces:
Buildable
,CopyableBuilder<AutoScalingGroup.Builder,
,AutoScalingGroup> SdkBuilder<AutoScalingGroup.Builder,
,AutoScalingGroup> SdkPojo
- Enclosing class:
AutoScalingGroup
-
Method Summary
Modifier and TypeMethodDescriptionautoScalingGroupARN
(String autoScalingGroupARN) The Amazon Resource Name (ARN) of the Auto Scaling group.autoScalingGroupName
(String autoScalingGroupName) The name of the Auto Scaling group.availabilityZones
(String... availabilityZones) One or more Availability Zones for the group.availabilityZones
(Collection<String> availabilityZones) One or more Availability Zones for the group.capacityRebalance
(Boolean capacityRebalance) Indicates whether Capacity Rebalancing is enabled.Reserved.createdTime
(Instant createdTime) The date and time the group was created.defaultCooldown
(Integer defaultCooldown) The duration of the default cooldown period, in seconds.defaultInstanceWarmup
(Integer defaultInstanceWarmup) The duration of the default instance warmup, in seconds.desiredCapacity
(Integer desiredCapacity) The desired size of the group.desiredCapacityType
(String desiredCapacityType) The unit of measurement for the value specified for desired capacity.enabledMetrics
(Collection<EnabledMetric> enabledMetrics) The metrics enabled for the group.enabledMetrics
(Consumer<EnabledMetric.Builder>... enabledMetrics) The metrics enabled for the group.enabledMetrics
(EnabledMetric... enabledMetrics) The metrics enabled for the group.healthCheckGracePeriod
(Integer healthCheckGracePeriod) The duration of the health check grace period, in seconds.healthCheckType
(String healthCheckType) A comma-separated value string of one or more health check types.default AutoScalingGroup.Builder
instanceMaintenancePolicy
(Consumer<InstanceMaintenancePolicy.Builder> instanceMaintenancePolicy) An instance maintenance policy.instanceMaintenancePolicy
(InstanceMaintenancePolicy instanceMaintenancePolicy) An instance maintenance policy.instances
(Collection<Instance> instances) The EC2 instances associated with the group.instances
(Consumer<Instance.Builder>... instances) The EC2 instances associated with the group.The EC2 instances associated with the group.launchConfigurationName
(String launchConfigurationName) The name of the associated launch configuration.default AutoScalingGroup.Builder
launchTemplate
(Consumer<LaunchTemplateSpecification.Builder> launchTemplate) The launch template for the group.launchTemplate
(LaunchTemplateSpecification launchTemplate) The launch template for the group.loadBalancerNames
(String... loadBalancerNames) One or more load balancers associated with the group.loadBalancerNames
(Collection<String> loadBalancerNames) One or more load balancers associated with the group.maxInstanceLifetime
(Integer maxInstanceLifetime) The maximum amount of time, in seconds, that an instance can be in service.The maximum size of the group.The minimum size of the group.default AutoScalingGroup.Builder
mixedInstancesPolicy
(Consumer<MixedInstancesPolicy.Builder> mixedInstancesPolicy) The mixed instances policy for the group.mixedInstancesPolicy
(MixedInstancesPolicy mixedInstancesPolicy) The mixed instances policy for the group.newInstancesProtectedFromScaleIn
(Boolean newInstancesProtectedFromScaleIn) Indicates whether newly launched instances are protected from termination by Amazon EC2 Auto Scaling when scaling in.placementGroup
(String placementGroup) The name of the placement group into which to launch your instances, if any.predictedCapacity
(Integer predictedCapacity) The predicted capacity of the group when it has a predictive scaling policy.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.The current state of the group when the DeleteAutoScalingGroup operation is in progress.suspendedProcesses
(Collection<SuspendedProcess> suspendedProcesses) The suspended processes associated with the group.suspendedProcesses
(Consumer<SuspendedProcess.Builder>... suspendedProcesses) The suspended processes associated with the group.suspendedProcesses
(SuspendedProcess... suspendedProcesses) The suspended processes associated with the group.tags
(Collection<TagDescription> tags) The tags for the group.tags
(Consumer<TagDescription.Builder>... tags) The tags for the group.tags
(TagDescription... tags) The tags for the group.targetGroupARNs
(String... targetGroupARNs) The Amazon Resource Names (ARN) of the target groups for your load balancer.targetGroupARNs
(Collection<String> targetGroupARNs) The Amazon Resource Names (ARN) of the target groups for your load balancer.terminationPolicies
(String... terminationPolicies) The termination policies for the group.terminationPolicies
(Collection<String> terminationPolicies) The termination policies for the group.trafficSources
(Collection<TrafficSourceIdentifier> trafficSources) The traffic sources associated with this Auto Scaling group.trafficSources
(Consumer<TrafficSourceIdentifier.Builder>... trafficSources) The traffic sources associated with this Auto Scaling group.trafficSources
(TrafficSourceIdentifier... trafficSources) The traffic sources associated with this Auto Scaling group.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.warmPoolConfiguration
(WarmPoolConfiguration warmPoolConfiguration) The warm pool for the group.warmPoolSize
(Integer warmPoolSize) The current size of the warm pool.Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFields
-
Method Details
-
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
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
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
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 theLaunchTemplateSpecification.Builder
avoiding the need to create one manually viaLaunchTemplateSpecification.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tolaunchTemplate(LaunchTemplateSpecification)
.- Parameters:
launchTemplate
- a consumer that will call methods onLaunchTemplateSpecification.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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 theMixedInstancesPolicy.Builder
avoiding the need to create one manually viaMixedInstancesPolicy.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tomixedInstancesPolicy(MixedInstancesPolicy)
.- Parameters:
mixedInstancesPolicy
- a consumer that will call methods onMixedInstancesPolicy.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
The EC2 instances associated with the group.
This is a convenience method that creates an instance of theInstance.Builder
avoiding the need to create one manually viaInstance.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed toinstances(List<Instance>)
.- Parameters:
instances
- a consumer that will call methods onInstance.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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
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
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 theSuspendedProcess.Builder
avoiding the need to create one manually viaSuspendedProcess.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tosuspendedProcesses(List<SuspendedProcess>)
.- Parameters:
suspendedProcesses
- a consumer that will call methods onSuspendedProcess.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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
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
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
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
The metrics enabled for the group.
This is a convenience method that creates an instance of theEnabledMetric.Builder
avoiding the need to create one manually viaEnabledMetric.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed toenabledMetrics(List<EnabledMetric>)
.- Parameters:
enabledMetrics
- a consumer that will call methods onEnabledMetric.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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
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
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
The tags for the group.
This is a convenience method that creates an instance of theTagDescription.Builder
avoiding the need to create one manually viaTagDescription.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed totags(List<TagDescription>)
.- Parameters:
tags
- a consumer that will call methods onTagDescription.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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
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
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
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
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
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
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 theWarmPoolConfiguration.Builder
avoiding the need to create one manually viaWarmPoolConfiguration.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed towarmPoolConfiguration(WarmPoolConfiguration)
.- Parameters:
warmPoolConfiguration
- a consumer that will call methods onWarmPoolConfiguration.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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
Reserved.
- Parameters:
context
- Reserved.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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 supportsDesiredCapacityType
for attribute-based instance type selection only.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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
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
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 theTrafficSourceIdentifier.Builder
avoiding the need to create one manually viaTrafficSourceIdentifier.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed totrafficSources(List<TrafficSourceIdentifier>)
.- Parameters:
trafficSources
- a consumer that will call methods onTrafficSourceIdentifier.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
instanceMaintenancePolicy
AutoScalingGroup.Builder instanceMaintenancePolicy(InstanceMaintenancePolicy instanceMaintenancePolicy) An instance maintenance policy.
- Parameters:
instanceMaintenancePolicy
- An instance maintenance policy.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
instanceMaintenancePolicy
default AutoScalingGroup.Builder instanceMaintenancePolicy(Consumer<InstanceMaintenancePolicy.Builder> instanceMaintenancePolicy) An instance maintenance policy.
This is a convenience method that creates an instance of theInstanceMaintenancePolicy.Builder
avoiding the need to create one manually viaInstanceMaintenancePolicy.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed toinstanceMaintenancePolicy(InstanceMaintenancePolicy)
.- Parameters:
instanceMaintenancePolicy
- a consumer that will call methods onInstanceMaintenancePolicy.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-