Package software.amazon.awssdk.services.autoscaling.model

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 Details

    • 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 for MaxGroupPreparedCapacity, Amazon EC2 Auto Scaling uses the difference between the MaxGroupPreparedCapacity and the desired capacity instead.

      The size of the warm pool is dynamic. Only when MaxGroupPreparedCapacity and MinSize 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 for MinSize. 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 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 for MaxGroupPreparedCapacity, Amazon EC2 Auto Scaling uses the difference between the MaxGroupPreparedCapacity and the desired capacity instead.

      The size of the warm pool is dynamic. Only when MaxGroupPreparedCapacity and MinSize 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 for MinSize. 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 is Stopped.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • 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 is Stopped.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • 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 the InstanceReusePolicy.Builder avoiding the need to create one manually via InstanceReusePolicy.builder().

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

      Parameters:
      instanceReusePolicy - a consumer that will call methods on InstanceReusePolicy.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • overrideConfiguration

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

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