Class: Aws::ECS::Types::ManagedScaling

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

Overview

Note:

When making an API call, you may pass ManagedScaling data as a hash:

{
  status: "ENABLED", # accepts ENABLED, DISABLED
  target_capacity: 1,
  minimum_scaling_step_size: 1,
  maximum_scaling_step_size: 1,
  instance_warmup_period: 1,
}

The managed scaling settings for the Auto Scaling group capacity provider.

When managed scaling is enabled, Amazon ECS manages the scale-in and scale-out actions of the Auto Scaling group. Amazon ECS manages a target tracking scaling policy using an Amazon ECS managed CloudWatch metric with the specified `targetCapacity` value as the target value for the metric. For more information, see [Using Managed Scaling] in the *Amazon Elastic Container Service Developer Guide*.

If managed scaling is disabled, the user must manage the scaling of the Auto Scaling group.

[1]: docs.aws.amazon.com/AmazonECS/latest/developerguide/asg-capacity-providers.html#asg-capacity-providers-managed-scaling

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#instance_warmup_periodInteger

The period of time, in seconds, after a newly launched Amazon EC2 instance can contribute to CloudWatch metrics for Auto Scaling group. If this parameter is omitted, the default value of `300` seconds is used.

Returns:

  • (Integer)

7004
7005
7006
7007
7008
7009
7010
7011
7012
# File 'lib/aws-sdk-ecs/types.rb', line 7004

class ManagedScaling < Struct.new(
  :status,
  :target_capacity,
  :minimum_scaling_step_size,
  :maximum_scaling_step_size,
  :instance_warmup_period)
  SENSITIVE = []
  include Aws::Structure
end

#maximum_scaling_step_sizeInteger

The maximum number of container instances that Amazon ECS scales in or scales out at one time. If this parameter is omitted, the default value of `10000` is used.

Returns:

  • (Integer)

7004
7005
7006
7007
7008
7009
7010
7011
7012
# File 'lib/aws-sdk-ecs/types.rb', line 7004

class ManagedScaling < Struct.new(
  :status,
  :target_capacity,
  :minimum_scaling_step_size,
  :maximum_scaling_step_size,
  :instance_warmup_period)
  SENSITIVE = []
  include Aws::Structure
end

#minimum_scaling_step_sizeInteger

The minimum number of container instances that Amazon ECS scales in or scales out at one time. If this parameter is omitted, the default value of `1` is used.

Returns:

  • (Integer)

7004
7005
7006
7007
7008
7009
7010
7011
7012
# File 'lib/aws-sdk-ecs/types.rb', line 7004

class ManagedScaling < Struct.new(
  :status,
  :target_capacity,
  :minimum_scaling_step_size,
  :maximum_scaling_step_size,
  :instance_warmup_period)
  SENSITIVE = []
  include Aws::Structure
end

#statusString

Determines whether to enable managed scaling for the capacity provider.

Returns:

  • (String)

7004
7005
7006
7007
7008
7009
7010
7011
7012
# File 'lib/aws-sdk-ecs/types.rb', line 7004

class ManagedScaling < Struct.new(
  :status,
  :target_capacity,
  :minimum_scaling_step_size,
  :maximum_scaling_step_size,
  :instance_warmup_period)
  SENSITIVE = []
  include Aws::Structure
end

#target_capacityInteger

The target capacity value for the capacity provider. The specified value must be greater than `0` and less than or equal to `100`. A value of `100` results in the Amazon EC2 instances in your Auto Scaling group being completely used.

Returns:

  • (Integer)

7004
7005
7006
7007
7008
7009
7010
7011
7012
# File 'lib/aws-sdk-ecs/types.rb', line 7004

class ManagedScaling < Struct.new(
  :status,
  :target_capacity,
  :minimum_scaling_step_size,
  :maximum_scaling_step_size,
  :instance_warmup_period)
  SENSITIVE = []
  include Aws::Structure
end