Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.ECS.Types.ManagedScaling

Description

Documentation

data ManagedScaling Source #

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.

See: newManagedScaling smart constructor.

Constructors

ManagedScaling'

Fields

instanceWarmupPeriod :: Maybe Natural
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.
maximumScalingStepSize :: Maybe Natural
The maximum number of Amazon EC2 instances that Amazon ECS will scale out at one time. The scale in process is not affected by this parameter. If this parameter is omitted, the default value of 1 is used.
minimumScalingStepSize :: Maybe Natural
The minimum number of Amazon EC2 instances that Amazon ECS will scale out at one time. The scale in process is not affected by this parameter If this parameter is omitted, the default value of 1 is used.
When additional capacity is required, Amazon ECS will scale up the minimum scaling step size even if the actual demand is less than the minimum scaling step size.
If you use a capacity provider with an Auto Scaling group configured with more than one Amazon EC2 instance type or Availability Zone, Amazon ECS will scale up by the exact minimum scaling step size value and will ignore both the maximum scaling step size as well as the capacity demand.
status :: Maybe ManagedScalingStatus
Determines whether to use managed scaling for the capacity provider.
targetCapacity :: Maybe Natural
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.

Instances

Instances details

FromJSON ManagedScaling Source #
Instance details Defined in Amazonka.ECS.Types.ManagedScaling Methods parseJSON :: Value -> Parser ManagedScaling # parseJSONList :: Value -> Parser [ManagedScaling] #
ToJSON ManagedScaling Source #
Instance details Defined in Amazonka.ECS.Types.ManagedScaling Methods toJSON :: ManagedScaling -> Value # toEncoding :: ManagedScaling -> Encoding # toJSONList :: [ManagedScaling] -> Value # toEncodingList :: [ManagedScaling] -> Encoding #
Generic ManagedScaling Source #
Instance details Defined in Amazonka.ECS.Types.ManagedScaling Associated Types type Rep ManagedScaling :: Type -> Type # Methods from :: ManagedScaling -> Rep ManagedScaling x # to :: Rep ManagedScaling x -> ManagedScaling #
Read ManagedScaling Source #
Instance details Defined in Amazonka.ECS.Types.ManagedScaling Methods readsPrec :: Int -> ReadS ManagedScaling # readList :: ReadS [ManagedScaling] # readPrec :: ReadPrec ManagedScaling # readListPrec :: ReadPrec [ManagedScaling] #
Show ManagedScaling Source #
Instance details Defined in Amazonka.ECS.Types.ManagedScaling Methods showsPrec :: Int -> ManagedScaling -> ShowS # show :: ManagedScaling -> String # showList :: [ManagedScaling] -> ShowS #
NFData ManagedScaling Source #
Instance details Defined in Amazonka.ECS.Types.ManagedScaling Methods rnf :: ManagedScaling -> () #
Eq ManagedScaling Source #
Instance details Defined in Amazonka.ECS.Types.ManagedScaling Methods (==) :: ManagedScaling -> ManagedScaling -> Bool # (/=) :: ManagedScaling -> ManagedScaling -> Bool #
Hashable ManagedScaling Source #
Instance details Defined in Amazonka.ECS.Types.ManagedScaling Methods hashWithSalt :: Int -> ManagedScaling -> Int # hash :: ManagedScaling -> Int #
type Rep ManagedScaling Source #
Instance details Defined in Amazonka.ECS.Types.ManagedScaling type Rep ManagedScaling = D1 ('MetaData "ManagedScaling" "Amazonka.ECS.Types.ManagedScaling" "amazonka-ecs-2.0-3xFxVqi9x5nBZ44jBEC5G8" 'False) (C1 ('MetaCons "ManagedScaling'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "instanceWarmupPeriod") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :: S1 ('MetaSel ('Just "maximumScalingStepSize") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural))) :: (S1 ('MetaSel ('Just "minimumScalingStepSize") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :: (S1 ('MetaSel ('Just "status") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ManagedScalingStatus)) :: S1 ('MetaSel ('Just "targetCapacity") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural))))))

newManagedScaling :: ManagedScaling Source #

Create a value of ManagedScaling with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:instanceWarmupPeriod:ManagedScaling', managedScaling_instanceWarmupPeriod - 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.

$sel:maximumScalingStepSize:ManagedScaling', managedScaling_maximumScalingStepSize - The maximum number of Amazon EC2 instances that Amazon ECS will scale out at one time. The scale in process is not affected by this parameter. If this parameter is omitted, the default value of 1 is used.

$sel:minimumScalingStepSize:ManagedScaling', managedScaling_minimumScalingStepSize - The minimum number of Amazon EC2 instances that Amazon ECS will scale out at one time. The scale in process is not affected by this parameter If this parameter is omitted, the default value of 1 is used.

When additional capacity is required, Amazon ECS will scale up the minimum scaling step size even if the actual demand is less than the minimum scaling step size.

If you use a capacity provider with an Auto Scaling group configured with more than one Amazon EC2 instance type or Availability Zone, Amazon ECS will scale up by the exact minimum scaling step size value and will ignore both the maximum scaling step size as well as the capacity demand.

$sel:status:ManagedScaling', managedScaling_status - Determines whether to use managed scaling for the capacity provider.

$sel:targetCapacity:ManagedScaling', managedScaling_targetCapacity - 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.

managedScaling_instanceWarmupPeriod :: Lens' ManagedScaling (Maybe Natural) Source #

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.

managedScaling_maximumScalingStepSize :: Lens' ManagedScaling (Maybe Natural) Source #

The maximum number of Amazon EC2 instances that Amazon ECS will scale out at one time. The scale in process is not affected by this parameter. If this parameter is omitted, the default value of 1 is used.

managedScaling_minimumScalingStepSize :: Lens' ManagedScaling (Maybe Natural) Source #

The minimum number of Amazon EC2 instances that Amazon ECS will scale out at one time. The scale in process is not affected by this parameter If this parameter is omitted, the default value of 1 is used.

When additional capacity is required, Amazon ECS will scale up the minimum scaling step size even if the actual demand is less than the minimum scaling step size.

If you use a capacity provider with an Auto Scaling group configured with more than one Amazon EC2 instance type or Availability Zone, Amazon ECS will scale up by the exact minimum scaling step size value and will ignore both the maximum scaling step size as well as the capacity demand.

managedScaling_status :: Lens' ManagedScaling (Maybe ManagedScalingStatus) Source #

Determines whether to use managed scaling for the capacity provider.

managedScaling_targetCapacity :: Lens' ManagedScaling (Maybe Natural) Source #

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.