1. Packages
  2. AWS Native
  3. API Docs
  4. autoscaling
  5. getWarmPool

AWS Native is in preview. AWS Classic is fully supported.

AWS Native v0.111.0 published on Tuesday, Jul 9, 2024 by Pulumi

aws-native.autoscaling.getWarmPool

Explore with Pulumi AI

aws-native logo

AWS Native is in preview. AWS Classic is fully supported.

AWS Native v0.111.0 published on Tuesday, Jul 9, 2024 by Pulumi

    Resource schema for AWS::AutoScaling::WarmPool.

    Using getWarmPool

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getWarmPool(args: GetWarmPoolArgs, opts?: InvokeOptions): Promise<GetWarmPoolResult>
    function getWarmPoolOutput(args: GetWarmPoolOutputArgs, opts?: InvokeOptions): Output<GetWarmPoolResult>
    def get_warm_pool(auto_scaling_group_name: Optional[str] = None,
                      opts: Optional[InvokeOptions] = None) -> GetWarmPoolResult
    def get_warm_pool_output(auto_scaling_group_name: Optional[pulumi.Input[str]] = None,
                      opts: Optional[InvokeOptions] = None) -> Output[GetWarmPoolResult]
    func LookupWarmPool(ctx *Context, args *LookupWarmPoolArgs, opts ...InvokeOption) (*LookupWarmPoolResult, error)
    func LookupWarmPoolOutput(ctx *Context, args *LookupWarmPoolOutputArgs, opts ...InvokeOption) LookupWarmPoolResultOutput

    > Note: This function is named LookupWarmPool in the Go SDK.

    public static class GetWarmPool 
    {
        public static Task<GetWarmPoolResult> InvokeAsync(GetWarmPoolArgs args, InvokeOptions? opts = null)
        public static Output<GetWarmPoolResult> Invoke(GetWarmPoolInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetWarmPoolResult> getWarmPool(GetWarmPoolArgs args, InvokeOptions options)
    // Output-based functions aren't available in Java yet
    
    fn::invoke:
      function: aws-native:autoscaling:getWarmPool
      arguments:
        # arguments dictionary

    The following arguments are supported:

    AutoScalingGroupName string
    The name of the Auto Scaling group.
    AutoScalingGroupName string
    The name of the Auto Scaling group.
    autoScalingGroupName String
    The name of the Auto Scaling group.
    autoScalingGroupName string
    The name of the Auto Scaling group.
    auto_scaling_group_name str
    The name of the Auto Scaling group.
    autoScalingGroupName String
    The name of the Auto Scaling group.

    getWarmPool Result

    The following output properties are available:

    InstanceReusePolicy Pulumi.AwsNative.AutoScaling.Outputs.WarmPoolInstanceReusePolicy
    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.
    MaxGroupPreparedCapacity int

    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.

    MinSize int
    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.
    PoolState string
    Sets the instance state to transition to after the lifecycle actions are complete. Default is Stopped .
    InstanceReusePolicy WarmPoolInstanceReusePolicy
    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.
    MaxGroupPreparedCapacity int

    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.

    MinSize int
    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.
    PoolState string
    Sets the instance state to transition to after the lifecycle actions are complete. Default is Stopped .
    instanceReusePolicy WarmPoolInstanceReusePolicy
    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.
    maxGroupPreparedCapacity Integer

    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.

    minSize Integer
    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.
    poolState String
    Sets the instance state to transition to after the lifecycle actions are complete. Default is Stopped .
    instanceReusePolicy WarmPoolInstanceReusePolicy
    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.
    maxGroupPreparedCapacity number

    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.

    minSize number
    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.
    poolState string
    Sets the instance state to transition to after the lifecycle actions are complete. Default is Stopped .
    instance_reuse_policy WarmPoolInstanceReusePolicy
    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.
    max_group_prepared_capacity int

    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.

    min_size int
    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.
    pool_state str
    Sets the instance state to transition to after the lifecycle actions are complete. Default is Stopped .
    instanceReusePolicy Property Map
    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.
    maxGroupPreparedCapacity Number

    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.

    minSize Number
    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.
    poolState String
    Sets the instance state to transition to after the lifecycle actions are complete. Default is Stopped .

    Supporting Types

    WarmPoolInstanceReusePolicy

    ReuseOnScaleIn bool
    Specifies whether instances in the Auto Scaling group can be returned to the warm pool on scale in.
    ReuseOnScaleIn bool
    Specifies whether instances in the Auto Scaling group can be returned to the warm pool on scale in.
    reuseOnScaleIn Boolean
    Specifies whether instances in the Auto Scaling group can be returned to the warm pool on scale in.
    reuseOnScaleIn boolean
    Specifies whether instances in the Auto Scaling group can be returned to the warm pool on scale in.
    reuse_on_scale_in bool
    Specifies whether instances in the Auto Scaling group can be returned to the warm pool on scale in.
    reuseOnScaleIn Boolean
    Specifies whether instances in the Auto Scaling group can be returned to the warm pool on scale in.

    Package Details

    Repository
    AWS Native pulumi/pulumi-aws-native
    License
    Apache-2.0
    aws-native logo

    AWS Native is in preview. AWS Classic is fully supported.

    AWS Native v0.111.0 published on Tuesday, Jul 9, 2024 by Pulumi