Class: Aws::AutoScaling::Types::PutWarmPoolType

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
lib/aws-sdk-autoscaling/types.rb

Overview

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#auto_scaling_group_name ⇒ String

The name of the Auto Scaling group.

Returns:

  • (String) 


6256
6257
6258
6259
6260
6261
6262
6263
6264
 
# File 'lib/aws-sdk-autoscaling/types.rb', line 6256

class PutWarmPoolType < Struct.new(
  :auto_scaling_group_name,
  :max_group_prepared_capacity,
  :min_size,
  :pool_state,
  :instance_reuse_policy)
  SENSITIVE = []
  include Aws::Structure
end

#instance_reuse_policy ⇒ Types::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:



6256
6257
6258
6259
6260
6261
6262
6263
6264
 
# File 'lib/aws-sdk-autoscaling/types.rb', line 6256

class PutWarmPoolType < Struct.new(
  :auto_scaling_group_name,
  :max_group_prepared_capacity,
  :min_size,
  :pool_state,
  :instance_reuse_policy)
  SENSITIVE = []
  include Aws::Structure
end

#max_group_prepared_capacity ⇒ 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.

Returns:

  • (Integer) 


6256
6257
6258
6259
6260
6261
6262
6263
6264
 
# File 'lib/aws-sdk-autoscaling/types.rb', line 6256

class PutWarmPoolType < Struct.new(
  :auto_scaling_group_name,
  :max_group_prepared_capacity,
  :min_size,
  :pool_state,
  :instance_reuse_policy)
  SENSITIVE = []
  include Aws::Structure
end

#min_size ⇒ 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.

Returns:

  • (Integer) 


6256
6257
6258
6259
6260
6261
6262
6263
6264
 
# File 'lib/aws-sdk-autoscaling/types.rb', line 6256

class PutWarmPoolType < Struct.new(
  :auto_scaling_group_name,
  :max_group_prepared_capacity,
  :min_size,
  :pool_state,
  :instance_reuse_policy)
  SENSITIVE = []
  include Aws::Structure
end

#pool_state ⇒ String

Sets the instance state to transition to after the lifecycle actions are complete. Default is ‘Stopped`.

Returns:

  • (String) 


6256
6257
6258
6259
6260
6261
6262
6263
6264
 
# File 'lib/aws-sdk-autoscaling/types.rb', line 6256

class PutWarmPoolType < Struct.new(
  :auto_scaling_group_name,
  :max_group_prepared_capacity,
  :min_size,
  :pool_state,
  :instance_reuse_policy)
  SENSITIVE = []
  include Aws::Structure
end