Interface PutWarmPoolRequest.Builder
-
- All Superinterfaces:
AutoScalingRequest.Builder
,AwsRequest.Builder
,Buildable
,CopyableBuilder<PutWarmPoolRequest.Builder,PutWarmPoolRequest>
,SdkBuilder<PutWarmPoolRequest.Builder,PutWarmPoolRequest>
,SdkPojo
,SdkRequest.Builder
- Enclosing class:
- PutWarmPoolRequest
public static interface PutWarmPoolRequest.Builder extends AutoScalingRequest.Builder, SdkPojo, CopyableBuilder<PutWarmPoolRequest.Builder,PutWarmPoolRequest>
-
-
Method Summary
All Methods Instance Methods Abstract Methods Default Methods Modifier and Type Method Description PutWarmPoolRequest.Builder
autoScalingGroupName(String autoScalingGroupName)
The name of the Auto Scaling group.default PutWarmPoolRequest.Builder
instanceReusePolicy(Consumer<InstanceReusePolicy.Builder> instanceReusePolicy)
Indicates whether instances in the Auto Scaling group can be returned to the warm pool on scale in.PutWarmPoolRequest.Builder
instanceReusePolicy(InstanceReusePolicy instanceReusePolicy)
Indicates whether instances in the Auto Scaling group can be returned to the warm pool on scale in.PutWarmPoolRequest.Builder
maxGroupPreparedCapacity(Integer maxGroupPreparedCapacity)
Specifies the maximum number of instances that are allowed to be in the warm pool or in any state exceptTerminated
for the Auto Scaling group.PutWarmPoolRequest.Builder
minSize(Integer minSize)
Specifies the minimum number of instances to maintain in the warm pool.PutWarmPoolRequest.Builder
overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
PutWarmPoolRequest.Builder
overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
PutWarmPoolRequest.Builder
poolState(String poolState)
Sets the instance state to transition to after the lifecycle actions are complete.PutWarmPoolRequest.Builder
poolState(WarmPoolState poolState)
Sets the instance state to transition to after the lifecycle actions are complete.-
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
-
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFields
-
-
-
-
Method Detail
-
autoScalingGroupName
PutWarmPoolRequest.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.
-
maxGroupPreparedCapacity
PutWarmPoolRequest.Builder maxGroupPreparedCapacity(Integer maxGroupPreparedCapacity)
Specifies the maximum number of instances that are allowed to be in the warm pool or in any state except
Terminated
for the Auto Scaling group. This is an optional property. Specify it only if you do not want the warm pool size to be determined by the difference between the group's maximum capacity and its desired capacity.If a value for
MaxGroupPreparedCapacity
is not specified, Amazon EC2 Auto Scaling launches and maintains the difference between the group's maximum capacity and its desired capacity. If you specify a value forMaxGroupPreparedCapacity
, Amazon EC2 Auto Scaling uses the difference between theMaxGroupPreparedCapacity
and the desired capacity instead.The size of the warm pool is dynamic. Only when
MaxGroupPreparedCapacity
andMinSize
are set to the same value does the warm pool have an absolute size.If the desired capacity of the Auto Scaling group is higher than the
MaxGroupPreparedCapacity
, the capacity of the warm pool is 0, unless you specify a value forMinSize
. To remove a value that you previously set, include the property but specify -1 for the value.- Parameters:
maxGroupPreparedCapacity
- Specifies the maximum number of instances that are allowed to be in the warm pool or in any state exceptTerminated
for the Auto Scaling group. This is an optional property. Specify it only if you do not want the warm pool size to be determined by the difference between the group's maximum capacity and its desired capacity.If a value for
MaxGroupPreparedCapacity
is not specified, Amazon EC2 Auto Scaling launches and maintains the difference between the group's maximum capacity and its desired capacity. If you specify a value forMaxGroupPreparedCapacity
, Amazon EC2 Auto Scaling uses the difference between theMaxGroupPreparedCapacity
and the desired capacity instead.The size of the warm pool is dynamic. Only when
MaxGroupPreparedCapacity
andMinSize
are set to the same value does the warm pool have an absolute size.If the desired capacity of the Auto Scaling group is higher than the
MaxGroupPreparedCapacity
, the capacity of the warm pool is 0, unless you specify a value forMinSize
. To remove a value that you previously set, include the property but specify -1 for the value.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
minSize
PutWarmPoolRequest.Builder minSize(Integer minSize)
Specifies the minimum number of instances to maintain in the warm pool. This helps you to ensure that there is always a certain number of warmed instances available to handle traffic spikes. Defaults to 0 if not specified.
- Parameters:
minSize
- Specifies the minimum number of instances to maintain in the warm pool. This helps you to ensure that there is always a certain number of warmed instances available to handle traffic spikes. Defaults to 0 if not specified.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
poolState
PutWarmPoolRequest.Builder poolState(String poolState)
Sets the instance state to transition to after the lifecycle actions are complete. Default is
Stopped
.- Parameters:
poolState
- Sets the instance state to transition to after the lifecycle actions are complete. Default isStopped
.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
WarmPoolState
,WarmPoolState
-
poolState
PutWarmPoolRequest.Builder poolState(WarmPoolState poolState)
Sets the instance state to transition to after the lifecycle actions are complete. Default is
Stopped
.- Parameters:
poolState
- Sets the instance state to transition to after the lifecycle actions are complete. Default isStopped
.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
WarmPoolState
,WarmPoolState
-
instanceReusePolicy
PutWarmPoolRequest.Builder instanceReusePolicy(InstanceReusePolicy instanceReusePolicy)
Indicates whether instances in the Auto Scaling group can be returned to the warm pool on scale in. The default is to terminate instances in the Auto Scaling group when the group scales in.
- Parameters:
instanceReusePolicy
- Indicates whether instances in the Auto Scaling group can be returned to the warm pool on scale in. The default is to terminate instances in the Auto Scaling group when the group scales in.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
instanceReusePolicy
default PutWarmPoolRequest.Builder instanceReusePolicy(Consumer<InstanceReusePolicy.Builder> instanceReusePolicy)
Indicates whether instances in the Auto Scaling group can be returned to the warm pool on scale in. The default is to terminate instances in the Auto Scaling group when the group scales in.
This is a convenience method that creates an instance of theInstanceReusePolicy.Builder
avoiding the need to create one manually viaInstanceReusePolicy.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed toinstanceReusePolicy(InstanceReusePolicy)
.- Parameters:
instanceReusePolicy
- a consumer that will call methods onInstanceReusePolicy.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
instanceReusePolicy(InstanceReusePolicy)
-
overrideConfiguration
PutWarmPoolRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
- Specified by:
overrideConfiguration
in interfaceAwsRequest.Builder
-
overrideConfiguration
PutWarmPoolRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
- Specified by:
overrideConfiguration
in interfaceAwsRequest.Builder
-
-