Amazonka.AutoScaling.Types.AutoScalingGroup

Documentation

data AutoScalingGroup

Describes an Auto Scaling group.

See: newAutoScalingGroup smart constructor.

Constructors

AutoScalingGroup'

Fields

• autoScalingGroupARN :: Maybe Text

  The Amazon Resource Name (ARN) of the Auto Scaling group.

• capacityRebalance :: Maybe Bool

  Indicates whether Capacity Rebalancing is enabled.

• context :: Maybe Text

  Reserved.

• defaultInstanceWarmup :: Maybe Int

  The duration of the default instance warmup, in seconds.

• desiredCapacityType :: Maybe Text

  The unit of measurement for the value specified for desired capacity. Amazon EC2 Auto Scaling supports DesiredCapacityType for attribute-based instance type selection only.

• enabledMetrics :: Maybe [EnabledMetric]

  The metrics enabled for the group.

• healthCheckGracePeriod :: Maybe Int

  The duration of the health check grace period, in seconds.

• instances :: Maybe [Instance]

  The EC2 instances associated with the group.

• launchConfigurationName :: Maybe Text

  The name of the associated launch configuration.

• launchTemplate :: Maybe LaunchTemplateSpecification

  The launch template for the group.

• loadBalancerNames :: Maybe [Text]

  One or more load balancers associated with the group.

• maxInstanceLifetime :: Maybe Int

  The maximum amount of time, in seconds, that an instance can be in service.

  Valid Range: Minimum value of 0.

• mixedInstancesPolicy :: Maybe MixedInstancesPolicy

  The mixed instances policy for the group.

• newInstancesProtectedFromScaleIn' :: Maybe Bool

  Indicates whether newly launched instances are protected from termination by Amazon EC2 Auto Scaling when scaling in.

• placementGroup :: Maybe Text

  The name of the placement group into which to launch your instances, if any.

• predictedCapacity :: Maybe Int

  The predicted capacity of the group when it has a predictive scaling policy.

• serviceLinkedRoleARN :: Maybe Text

  The Amazon Resource Name (ARN) of the service-linked role that the Auto Scaling group uses to call other Amazon Web Services on your behalf.

• status :: Maybe Text

  The current state of the group when the DeleteAutoScalingGroup operation is in progress.

• suspendedProcesses :: Maybe [SuspendedProcess]

  The suspended processes associated with the group.

• tags :: Maybe [TagDescription]

  The tags for the group.

• targetGroupARNs :: Maybe [Text]

  The Amazon Resource Names (ARN) of the target groups for your load balancer.

• terminationPolicies :: Maybe [Text]

  The termination policies for the group.

• trafficSources :: Maybe [TrafficSourceIdentifier]

  The unique identifiers of the traffic sources.

• vPCZoneIdentifier :: Maybe Text

  One or more subnet IDs, if applicable, separated by commas.

• warmPoolConfiguration :: Maybe WarmPoolConfiguration

  The warm pool for the group.

• warmPoolSize :: Maybe Int

  The current size of the warm pool.

• autoScalingGroupName :: Text

  The name of the Auto Scaling group.

• minSize :: Int

  The minimum size of the group.

• maxSize :: Int

  The maximum size of the group.

• desiredCapacity :: Int

  The desired size of the group.

• defaultCooldown :: Int

  The duration of the default cooldown period, in seconds.

• availabilityZones :: [Text]

  One or more Availability Zones for the group.

• healthCheckType :: Text

  Determines whether any additional health checks are performed on the instances in this group. Amazon EC2 health checks are always on.

  The valid values are EC2 (default), ELB, and VPC_LATTICE. The VPC_LATTICE health check type is reserved for use with VPC Lattice, which is in preview release and is subject to change.

• createdTime :: ISO8601

  The date and time the group was created.

Instances

FromXML AutoScalingGroup

Defined in Amazonka.AutoScaling.Types.AutoScalingGroup

Methods

parseXML :: [Node] -> Either String AutoScalingGroup

Generic AutoScalingGroup

Defined in Amazonka.AutoScaling.Types.AutoScalingGroup

Associated Types

type Rep AutoScalingGroup :: Type -> Type

Methods

from :: AutoScalingGroup -> Rep AutoScalingGroup x

to :: Rep AutoScalingGroup x -> AutoScalingGroup

Read AutoScalingGroup

Defined in Amazonka.AutoScaling.Types.AutoScalingGroup

Methods

readsPrec :: Int -> ReadS AutoScalingGroup

readList :: ReadS [AutoScalingGroup]

readPrec :: ReadPrec AutoScalingGroup

readListPrec :: ReadPrec [AutoScalingGroup]

Show AutoScalingGroup

Defined in Amazonka.AutoScaling.Types.AutoScalingGroup

Methods

showsPrec :: Int -> AutoScalingGroup -> ShowS

show :: AutoScalingGroup -> String

showList :: [AutoScalingGroup] -> ShowS

NFData AutoScalingGroup

Defined in Amazonka.AutoScaling.Types.AutoScalingGroup

Methods

rnf :: AutoScalingGroup -> ()

Eq AutoScalingGroup

Defined in Amazonka.AutoScaling.Types.AutoScalingGroup

Methods

(==) :: AutoScalingGroup -> AutoScalingGroup -> Bool

(/=) :: AutoScalingGroup -> AutoScalingGroup -> Bool

Hashable AutoScalingGroup

Defined in Amazonka.AutoScaling.Types.AutoScalingGroup

Methods

hashWithSalt :: Int -> AutoScalingGroup -> Int

hash :: AutoScalingGroup -> Int

type Rep AutoScalingGroup

Defined in Amazonka.AutoScaling.Types.AutoScalingGroup

type Rep AutoScalingGroup = D1 ('MetaData "AutoScalingGroup" "Amazonka.AutoScaling.Types.AutoScalingGroup" "amazonka-autoscaling-2.0-IerpHfP4BA3Ir4ZL2IR1De" 'False) (C1 ('MetaCons "AutoScalingGroup'" 'PrefixI 'True) (((((S1 ('MetaSel ('Just "autoScalingGroupARN") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "capacityRebalance") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool))) :*: (S1 ('MetaSel ('Just "context") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "defaultInstanceWarmup") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)))) :*: ((S1 ('MetaSel ('Just "desiredCapacityType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "enabledMetrics") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [EnabledMetric]))) :*: (S1 ('MetaSel ('Just "healthCheckGracePeriod") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :*: S1 ('MetaSel ('Just "instances") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Instance]))))) :*: (((S1 ('MetaSel ('Just "launchConfigurationName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "launchTemplate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe LaunchTemplateSpecification))) :*: (S1 ('MetaSel ('Just "loadBalancerNames") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :*: S1 ('MetaSel ('Just "maxInstanceLifetime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)))) :*: ((S1 ('MetaSel ('Just "mixedInstancesPolicy") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe MixedInstancesPolicy)) :*: S1 ('MetaSel ('Just "newInstancesProtectedFromScaleIn'") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool))) :*: (S1 ('MetaSel ('Just "placementGroup") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "predictedCapacity") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :*: S1 ('MetaSel ('Just "serviceLinkedRoleARN") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))))) :*: ((((S1 ('MetaSel ('Just "status") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "suspendedProcesses") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [SuspendedProcess]))) :*: (S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [TagDescription])) :*: S1 ('MetaSel ('Just "targetGroupARNs") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])))) :*: ((S1 ('MetaSel ('Just "terminationPolicies") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :*: S1 ('MetaSel ('Just "trafficSources") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [TrafficSourceIdentifier]))) :*: (S1 ('MetaSel ('Just "vPCZoneIdentifier") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "warmPoolConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe WarmPoolConfiguration))))) :*: (((S1 ('MetaSel ('Just "warmPoolSize") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :*: S1 ('MetaSel ('Just "autoScalingGroupName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)) :*: (S1 ('MetaSel ('Just "minSize") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int) :*: S1 ('MetaSel ('Just "maxSize") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))) :*: ((S1 ('MetaSel ('Just "desiredCapacity") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int) :*: S1 ('MetaSel ('Just "defaultCooldown") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)) :*: (S1 ('MetaSel ('Just "availabilityZones") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [Text]) :*: (S1 ('MetaSel ('Just "healthCheckType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "createdTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 ISO8601))))))))

newAutoScalingGroup

Arguments

:: Text

$sel:autoScalingGroupName:AutoScalingGroup'

-> Int

AutoScalingGroup

-> Int

$sel:maxSize:AutoScalingGroup'

-> Int

$sel:desiredCapacity:AutoScalingGroup'

-> Int

$sel:defaultCooldown:AutoScalingGroup'

-> Text

$sel:healthCheckType:AutoScalingGroup'

-> UTCTime

$sel:createdTime:AutoScalingGroup'

-> AutoScalingGroup

Create a value of AutoScalingGroup 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:autoScalingGroupARN:AutoScalingGroup', autoScalingGroup_autoScalingGroupARN - The Amazon Resource Name (ARN) of the Auto Scaling group.

$sel:capacityRebalance:AutoScalingGroup', autoScalingGroup_capacityRebalance - Indicates whether Capacity Rebalancing is enabled.

$sel:context:AutoScalingGroup', autoScalingGroup_context - Reserved.

$sel:defaultInstanceWarmup:AutoScalingGroup', autoScalingGroup_defaultInstanceWarmup - The duration of the default instance warmup, in seconds.

$sel:desiredCapacityType:AutoScalingGroup', autoScalingGroup_desiredCapacityType - The unit of measurement for the value specified for desired capacity. Amazon EC2 Auto Scaling supports DesiredCapacityType for attribute-based instance type selection only.

$sel:enabledMetrics:AutoScalingGroup', autoScalingGroup_enabledMetrics - The metrics enabled for the group.

$sel:healthCheckGracePeriod:AutoScalingGroup', autoScalingGroup_healthCheckGracePeriod - The duration of the health check grace period, in seconds.

$sel:instances:AutoScalingGroup', autoScalingGroup_instances - The EC2 instances associated with the group.

AutoScalingGroup, autoScalingGroup_launchConfigurationName - The name of the associated launch configuration.

AutoScalingGroup, autoScalingGroup_launchTemplate - The launch template for the group.

$sel:loadBalancerNames:AutoScalingGroup', autoScalingGroup_loadBalancerNames - One or more load balancers associated with the group.

$sel:maxInstanceLifetime:AutoScalingGroup', autoScalingGroup_maxInstanceLifetime - The maximum amount of time, in seconds, that an instance can be in service.

Valid Range: Minimum value of 0.

$sel:mixedInstancesPolicy:AutoScalingGroup', autoScalingGroup_mixedInstancesPolicy - The mixed instances policy for the group.

$sel:newInstancesProtectedFromScaleIn':AutoScalingGroup', autoScalingGroup_newInstancesProtectedFromScaleIn - Indicates whether newly launched instances are protected from termination by Amazon EC2 Auto Scaling when scaling in.

$sel:placementGroup:AutoScalingGroup', autoScalingGroup_placementGroup - The name of the placement group into which to launch your instances, if any.

$sel:predictedCapacity:AutoScalingGroup', autoScalingGroup_predictedCapacity - The predicted capacity of the group when it has a predictive scaling policy.

$sel:serviceLinkedRoleARN:AutoScalingGroup', autoScalingGroup_serviceLinkedRoleARN - The Amazon Resource Name (ARN) of the service-linked role that the Auto Scaling group uses to call other Amazon Web Services on your behalf.

AutoScalingGroup, autoScalingGroup_status - The current state of the group when the DeleteAutoScalingGroup operation is in progress.

$sel:suspendedProcesses:AutoScalingGroup', autoScalingGroup_suspendedProcesses - The suspended processes associated with the group.

$sel:tags:AutoScalingGroup', autoScalingGroup_tags - The tags for the group.

$sel:targetGroupARNs:AutoScalingGroup', autoScalingGroup_targetGroupARNs - The Amazon Resource Names (ARN) of the target groups for your load balancer.

$sel:terminationPolicies:AutoScalingGroup', autoScalingGroup_terminationPolicies - The termination policies for the group.

$sel:trafficSources:AutoScalingGroup', autoScalingGroup_trafficSources - The unique identifiers of the traffic sources.

$sel:vPCZoneIdentifier:AutoScalingGroup', autoScalingGroup_vPCZoneIdentifier - One or more subnet IDs, if applicable, separated by commas.

$sel:warmPoolConfiguration:AutoScalingGroup', autoScalingGroup_warmPoolConfiguration - The warm pool for the group.

$sel:warmPoolSize:AutoScalingGroup', autoScalingGroup_warmPoolSize - The current size of the warm pool.

$sel:autoScalingGroupName:AutoScalingGroup', autoScalingGroup_autoScalingGroupName - The name of the Auto Scaling group.

AutoScalingGroup, autoScalingGroup_minSize - The minimum size of the group.

$sel:maxSize:AutoScalingGroup', autoScalingGroup_maxSize - The maximum size of the group.

$sel:desiredCapacity:AutoScalingGroup', autoScalingGroup_desiredCapacity - The desired size of the group.

$sel:defaultCooldown:AutoScalingGroup', autoScalingGroup_defaultCooldown - The duration of the default cooldown period, in seconds.

$sel:availabilityZones:AutoScalingGroup', autoScalingGroup_availabilityZones - One or more Availability Zones for the group.

$sel:healthCheckType:AutoScalingGroup', autoScalingGroup_healthCheckType - Determines whether any additional health checks are performed on the instances in this group. Amazon EC2 health checks are always on.

The valid values are EC2 (default), ELB, and VPC_LATTICE. The VPC_LATTICE health check type is reserved for use with VPC Lattice, which is in preview release and is subject to change.

$sel:createdTime:AutoScalingGroup', autoScalingGroup_createdTime - The date and time the group was created.

autoScalingGroup_autoScalingGroupARN :: Lens' AutoScalingGroup (Maybe Text)

The Amazon Resource Name (ARN) of the Auto Scaling group.

autoScalingGroup_capacityRebalance :: Lens' AutoScalingGroup (Maybe Bool)

Indicates whether Capacity Rebalancing is enabled.

autoScalingGroup_context :: Lens' AutoScalingGroup (Maybe Text)

Reserved.

autoScalingGroup_defaultInstanceWarmup :: Lens' AutoScalingGroup (Maybe Int)

The duration of the default instance warmup, in seconds.

autoScalingGroup_desiredCapacityType :: Lens' AutoScalingGroup (Maybe Text)

The unit of measurement for the value specified for desired capacity. Amazon EC2 Auto Scaling supports DesiredCapacityType for attribute-based instance type selection only.

autoScalingGroup_enabledMetrics :: Lens' AutoScalingGroup (Maybe [EnabledMetric])

The metrics enabled for the group.

autoScalingGroup_healthCheckGracePeriod :: Lens' AutoScalingGroup (Maybe Int)

The duration of the health check grace period, in seconds.

autoScalingGroup_instances :: Lens' AutoScalingGroup (Maybe [Instance])

The EC2 instances associated with the group.

autoScalingGroup_launchConfigurationName :: Lens' AutoScalingGroup (Maybe Text)

The name of the associated launch configuration.

autoScalingGroup_launchTemplate :: Lens' AutoScalingGroup (Maybe LaunchTemplateSpecification)

The launch template for the group.

autoScalingGroup_loadBalancerNames :: Lens' AutoScalingGroup (Maybe [Text])

One or more load balancers associated with the group.

autoScalingGroup_maxInstanceLifetime :: Lens' AutoScalingGroup (Maybe Int)

The maximum amount of time, in seconds, that an instance can be in service.

Valid Range: Minimum value of 0.

autoScalingGroup_mixedInstancesPolicy :: Lens' AutoScalingGroup (Maybe MixedInstancesPolicy)

The mixed instances policy for the group.

autoScalingGroup_newInstancesProtectedFromScaleIn :: Lens' AutoScalingGroup (Maybe Bool)

Indicates whether newly launched instances are protected from termination by Amazon EC2 Auto Scaling when scaling in.

autoScalingGroup_placementGroup :: Lens' AutoScalingGroup (Maybe Text)

The name of the placement group into which to launch your instances, if any.

autoScalingGroup_predictedCapacity :: Lens' AutoScalingGroup (Maybe Int)

The predicted capacity of the group when it has a predictive scaling policy.

autoScalingGroup_serviceLinkedRoleARN :: Lens' AutoScalingGroup (Maybe Text)

The Amazon Resource Name (ARN) of the service-linked role that the Auto Scaling group uses to call other Amazon Web Services on your behalf.

autoScalingGroup_status :: Lens' AutoScalingGroup (Maybe Text)

The current state of the group when the DeleteAutoScalingGroup operation is in progress.

autoScalingGroup_suspendedProcesses :: Lens' AutoScalingGroup (Maybe [SuspendedProcess])

The suspended processes associated with the group.

autoScalingGroup_tags :: Lens' AutoScalingGroup (Maybe [TagDescription])

The tags for the group.

autoScalingGroup_targetGroupARNs :: Lens' AutoScalingGroup (Maybe [Text])

The Amazon Resource Names (ARN) of the target groups for your load balancer.

autoScalingGroup_terminationPolicies :: Lens' AutoScalingGroup (Maybe [Text])

The termination policies for the group.

autoScalingGroup_trafficSources :: Lens' AutoScalingGroup (Maybe [TrafficSourceIdentifier])

The unique identifiers of the traffic sources.

autoScalingGroup_vPCZoneIdentifier :: Lens' AutoScalingGroup (Maybe Text)

One or more subnet IDs, if applicable, separated by commas.

autoScalingGroup_warmPoolConfiguration :: Lens' AutoScalingGroup (Maybe WarmPoolConfiguration)

The warm pool for the group.

autoScalingGroup_warmPoolSize :: Lens' AutoScalingGroup (Maybe Int)

The current size of the warm pool.

autoScalingGroup_autoScalingGroupName :: Lens' AutoScalingGroup Text

The name of the Auto Scaling group.

autoScalingGroup_minSize :: Lens' AutoScalingGroup Int

The minimum size of the group.

autoScalingGroup_maxSize :: Lens' AutoScalingGroup Int

The maximum size of the group.

autoScalingGroup_desiredCapacity :: Lens' AutoScalingGroup Int

The desired size of the group.

autoScalingGroup_defaultCooldown :: Lens' AutoScalingGroup Int

The duration of the default cooldown period, in seconds.

autoScalingGroup_availabilityZones :: Lens' AutoScalingGroup [Text]

One or more Availability Zones for the group.

autoScalingGroup_healthCheckType :: Lens' AutoScalingGroup Text

Determines whether any additional health checks are performed on the instances in this group. Amazon EC2 health checks are always on.

The valid values are EC2 (default), ELB, and VPC_LATTICE. The VPC_LATTICE health check type is reserved for use with VPC Lattice, which is in preview release and is subject to change.

autoScalingGroup_createdTime :: Lens' AutoScalingGroup UTCTime

The date and time the group was created.