amazonka-autoscaling-1.2.0: Amazon Auto Scaling SDK.

Copyright(c) 2013-2015 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone
LanguageHaskell2010

Network.AWS.AutoScaling.Types

Contents

Description

 

Synopsis

Service Configuration

autoScaling :: Service Source

API version '2011-01-01' of the Amazon Auto Scaling SDK configuration.

Errors

_LimitExceededFault :: AsError a => Getting (First ServiceError) a ServiceError Source

You have already reached a limit for your Auto Scaling resources (for example, groups, launch configurations, or lifecycle hooks). For more information, see DescribeAccountLimits.

_AlreadyExistsFault :: AsError a => Getting (First ServiceError) a ServiceError Source

You already have an Auto Scaling group or launch configuration with this name.

_ResourceInUseFault :: AsError a => Getting (First ServiceError) a ServiceError Source

The Auto Scaling group or launch configuration can't be deleted because it is in use.

_InvalidNextToken :: AsError a => Getting (First ServiceError) a ServiceError Source

The NextToken value is not valid.

_ScalingActivityInProgressFault :: AsError a => Getting (First ServiceError) a ServiceError Source

The Auto Scaling group can't be deleted because there are scaling activities in progress.

_ResourceContentionFault :: AsError a => Getting (First ServiceError) a ServiceError Source

You already have a pending update to an Auto Scaling resource (for example, a group, instance, or load balancer).

LifecycleState

data LifecycleState Source

Constructors

Detached 
Detaching 
EnteringStandby 
InService 
Pending 
PendingProceed 
PendingWait 
Quarantined 
Standby 
Terminated 
Terminating 
TerminatingProceed 
TerminatingWait 

Instances

ScalingActivityStatusCode

data ScalingActivityStatusCode Source

Constructors

Cancelled 
Failed 
InProgress 
MidLifecycleAction 
PreInService 
Successful 
WaitingForELBConnectionDraining 
WaitingForInstanceId 
WaitingForInstanceWarmup 
WaitingForSpotInstanceId 
WaitingForSpotInstanceRequestId 

Instances

Activity

data Activity Source

Describes scaling activity, which is a long-running process that represents a change to your Auto Scaling group, such as changing its size or replacing an instance.

See: activity smart constructor.

Instances

activity Source

Arguments

:: Text

aActivityId

-> Text

aAutoScalingGroupName

-> Text

aCause

-> UTCTime

aStartTime

-> ScalingActivityStatusCode

aStatusCode

-> Activity 

Creates a value of Activity with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

aProgress :: Lens' Activity (Maybe Int) Source

A value between 0 and 100 that indicates the progress of the activity.

aStatusMessage :: Lens' Activity (Maybe Text) Source

A friendly, more verbose description of the activity status.

aDetails :: Lens' Activity (Maybe Text) Source

The details about the activity.

aEndTime :: Lens' Activity (Maybe UTCTime) Source

The end time of the activity.

aDescription :: Lens' Activity (Maybe Text) Source

A friendly, more verbose description of the activity.

aActivityId :: Lens' Activity Text Source

The ID of the activity.

aAutoScalingGroupName :: Lens' Activity Text Source

The name of the Auto Scaling group.

aCause :: Lens' Activity Text Source

The reason the activity began.

aStartTime :: Lens' Activity UTCTime Source

The start time of the activity.

aStatusCode :: Lens' Activity ScalingActivityStatusCode Source

The current status of the activity.

AdjustmentType

data AdjustmentType Source

Describes a policy adjustment type.

For more information, see Dynamic Scaling in the Auto Scaling Developer Guide.

See: adjustmentType smart constructor.

Instances

adjustmentType :: AdjustmentType Source

Creates a value of AdjustmentType with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

atAdjustmentType :: Lens' AdjustmentType (Maybe Text) Source

The policy adjustment type. The valid values are ChangeInCapacity, ExactCapacity, and PercentChangeInCapacity.

Alarm

data Alarm Source

Describes an alarm.

See: alarm smart constructor.

Instances

alarm :: Alarm Source

Creates a value of Alarm with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

aAlarmName :: Lens' Alarm (Maybe Text) Source

The name of the alarm.

aAlarmARN :: Lens' Alarm (Maybe Text) Source

The Amazon Resource Name (ARN) of the alarm.

AutoScalingGroup

data AutoScalingGroup Source

Describes an Auto Scaling group.

See: autoScalingGroup smart constructor.

Instances

autoScalingGroup Source

Arguments

:: Text

asgAutoScalingGroupName

-> Int

asgMinSize

-> Int

asgMaxSize

-> Int

asgDesiredCapacity

-> Int

asgDefaultCooldown

-> NonEmpty Text

asgAvailabilityZones

-> Text

asgHealthCheckType

-> UTCTime

asgCreatedTime

-> AutoScalingGroup 

Creates a value of AutoScalingGroup with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

asgStatus :: Lens' AutoScalingGroup (Maybe Text) Source

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

asgTerminationPolicies :: Lens' AutoScalingGroup [Text] Source

The termination policies for the group.

asgHealthCheckGracePeriod :: Lens' AutoScalingGroup (Maybe Int) Source

The amount of time that Auto Scaling waits before checking an instance's health status. The grace period begins when an instance comes into service.

asgVPCZoneIdentifier :: Lens' AutoScalingGroup (Maybe Text) Source

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

If you specify VPCZoneIdentifier and AvailabilityZones, ensure that the Availability Zones of the subnets match the values for AvailabilityZones.

asgEnabledMetrics :: Lens' AutoScalingGroup [EnabledMetric] Source

The metrics enabled for the group.

asgInstances :: Lens' AutoScalingGroup [Instance] Source

The EC2 instances associated with the group.

asgLaunchConfigurationName :: Lens' AutoScalingGroup (Maybe Text) Source

The name of the associated launch configuration.

asgAutoScalingGroupARN :: Lens' AutoScalingGroup (Maybe Text) Source

The Amazon Resource Name (ARN) of the group.

asgSuspendedProcesses :: Lens' AutoScalingGroup [SuspendedProcess] Source

The suspended processes associated with the group.

asgPlacementGroup :: Lens' AutoScalingGroup (Maybe Text) Source

The name of the placement group into which you'll launch your instances, if any. For more information, see Placement Groups.

asgLoadBalancerNames :: Lens' AutoScalingGroup [Text] Source

One or more load balancers associated with the group.

asgTags :: Lens' AutoScalingGroup [TagDescription] Source

The tags for the group.

asgAutoScalingGroupName :: Lens' AutoScalingGroup Text Source

The name of the group.

asgMinSize :: Lens' AutoScalingGroup Int Source

The minimum size of the group.

asgMaxSize :: Lens' AutoScalingGroup Int Source

The maximum size of the group.

asgDesiredCapacity :: Lens' AutoScalingGroup Int Source

The desired size of the group.

asgDefaultCooldown :: Lens' AutoScalingGroup Int Source

The number of seconds after a scaling activity completes before any further scaling activities can start.

asgAvailabilityZones :: Lens' AutoScalingGroup (NonEmpty Text) Source

One or more Availability Zones for the group.

asgHealthCheckType :: Lens' AutoScalingGroup Text Source

The service of interest for the health status check, which can be either EC2 for Amazon EC2 or ELB for Elastic Load Balancing.

asgCreatedTime :: Lens' AutoScalingGroup UTCTime Source

The date and time the group was created.

AutoScalingInstanceDetails

data AutoScalingInstanceDetails Source

Describes an EC2 instance associated with an Auto Scaling group.

See: autoScalingInstanceDetails smart constructor.

Instances

autoScalingInstanceDetails Source

Arguments

:: Text

asidInstanceId

-> Text

asidAutoScalingGroupName

-> Text

asidAvailabilityZone

-> Text

asidLifecycleState

-> Text

asidHealthStatus

-> Text

asidLaunchConfigurationName

-> AutoScalingInstanceDetails 

Creates a value of AutoScalingInstanceDetails with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

asidInstanceId :: Lens' AutoScalingInstanceDetails Text Source

The ID of the instance.

asidAutoScalingGroupName :: Lens' AutoScalingInstanceDetails Text Source

The name of the Auto Scaling group associated with the instance.

asidAvailabilityZone :: Lens' AutoScalingInstanceDetails Text Source

The Availability Zone for the instance.

asidLifecycleState :: Lens' AutoScalingInstanceDetails Text Source

The lifecycle state for the instance. For more information, see Auto Scaling Instance States in the Auto Scaling Developer Guide.

asidHealthStatus :: Lens' AutoScalingInstanceDetails Text Source

The health status of this instance. "Healthy" means that the instance is healthy and should remain in service. "Unhealthy" means that the instance is unhealthy and Auto Scaling should terminate and replace it.

asidLaunchConfigurationName :: Lens' AutoScalingInstanceDetails Text Source

The launch configuration associated with the instance.

BlockDeviceMapping

data BlockDeviceMapping Source

Describes a block device mapping.

See: blockDeviceMapping smart constructor.

Instances

blockDeviceMapping Source

Arguments

:: Text

bdmDeviceName

-> BlockDeviceMapping 

Creates a value of BlockDeviceMapping with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

bdmVirtualName :: Lens' BlockDeviceMapping (Maybe Text) Source

The name of the virtual device, ephemeral0 to ephemeral3.

bdmNoDevice :: Lens' BlockDeviceMapping (Maybe Bool) Source

Suppresses a device mapping.

If this parameter is true for the root device, the instance might fail the EC2 health check. Auto Scaling launches a replacement instance if the instance fails the health check.

bdmEBS :: Lens' BlockDeviceMapping (Maybe EBS) Source

The information about the Amazon EBS volume.

bdmDeviceName :: Lens' BlockDeviceMapping Text Source

The device name exposed to the EC2 instance (for example, '\/dev\/sdh' or xvdh).

EBS

data EBS Source

Describes an Amazon EBS volume.

See: ebs smart constructor.

Instances

ebs :: EBS Source

Creates a value of EBS with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

ebsDeleteOnTermination :: Lens' EBS (Maybe Bool) Source

Indicates whether to delete the volume on instance termination.

Default: true

ebsVolumeSize :: Lens' EBS (Maybe Natural) Source

The volume size, in gigabytes.

Valid values: If the volume type is io1, the minimum size of the volume is 10 GiB. If you specify SnapshotId and VolumeSize, VolumeSize must be equal to or larger than the size of the snapshot.

Default: If you create a volume from a snapshot and you don't specify a volume size, the default is the size of the snapshot.

Required: Required when the volume type is io1.

ebsIOPS :: Lens' EBS (Maybe Natural) Source

For Provisioned IOPS (SSD) volumes only. The number of I/O operations per second (IOPS) to provision for the volume.

Valid values: Range is 100 to 4000.

Default: None

ebsVolumeType :: Lens' EBS (Maybe Text) Source

The volume type.

Valid values: 'standard | io1 | gp2'

Default: standard

ebsSnapshotId :: Lens' EBS (Maybe Text) Source

The ID of the snapshot.

EnabledMetric

data EnabledMetric Source

Describes an enabled metric.

See: enabledMetric smart constructor.

Instances

enabledMetric :: EnabledMetric Source

Creates a value of EnabledMetric with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

emGranularity :: Lens' EnabledMetric (Maybe Text) Source

The granularity of the metric. The only valid value is '1Minute'.

emMetric :: Lens' EnabledMetric (Maybe Text) Source

The name of the metric.

  • GroupMinSize
  • GroupMaxSize
  • GroupDesiredCapacity
  • GroupInServiceInstances
  • GroupPendingInstances
  • GroupStandbyInstances
  • GroupTerminatingInstances
  • GroupTotalInstances

Filter

data Filter Source

Describes a filter.

See: filter' smart constructor.

Instances

filter' Source

Arguments

:: Text

fName

-> Filter 

Creates a value of Filter with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

fValues :: Lens' Filter [Text] Source

The value of the filter.

fName :: Lens' Filter Text Source

The name of the filter. The valid values are: '"auto-scaling-group"', '"key"', '"value"', and '"propagate-at-launch"'.

Instance

data Instance Source

Describes an EC2 instance.

See: instance' smart constructor.

Instances

instance' Source

Arguments

:: Text

iInstanceId

-> Text

iAvailabilityZone

-> LifecycleState

iLifecycleState

-> Text

iHealthStatus

-> Instance 

Creates a value of Instance with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

iLaunchConfigurationName :: Lens' Instance (Maybe Text) Source

The launch configuration associated with the instance.

iInstanceId :: Lens' Instance Text Source

The ID of the instance.

iAvailabilityZone :: Lens' Instance Text Source

The Availability Zone in which the instance is running.

iLifecycleState :: Lens' Instance LifecycleState Source

A description of the current lifecycle state. Note that the Quarantined state is not used.

iHealthStatus :: Lens' Instance Text Source

The health status of the instance.

InstanceMonitoring

data InstanceMonitoring Source

Describes whether instance monitoring is enabled.

See: instanceMonitoring smart constructor.

Instances

instanceMonitoring :: InstanceMonitoring Source

Creates a value of InstanceMonitoring with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

imEnabled :: Lens' InstanceMonitoring (Maybe Bool) Source

If True, instance monitoring is enabled.

LaunchConfiguration

data LaunchConfiguration Source

Describes a launch configuration.

See: launchConfiguration smart constructor.

Instances

launchConfiguration Source

Arguments

:: Text

lcLaunchConfigurationName

-> Text

lcImageId

-> Text

lcInstanceType

-> UTCTime

lcCreatedTime

-> LaunchConfiguration 

Creates a value of LaunchConfiguration with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

lcSecurityGroups :: Lens' LaunchConfiguration [Text] Source

The security groups to associate with the instances.

lcAssociatePublicIPAddress :: Lens' LaunchConfiguration (Maybe Bool) Source

Specifies whether the instances are associated with a public IP address (true) or not (false).

lcInstanceMonitoring :: Lens' LaunchConfiguration (Maybe InstanceMonitoring) Source

Controls whether instances in this group are launched with detailed monitoring.

lcSpotPrice :: Lens' LaunchConfiguration (Maybe Text) Source

The price to bid when launching Spot Instances.

lcKeyName :: Lens' LaunchConfiguration (Maybe Text) Source

The name of the key pair.

lcClassicLinkVPCSecurityGroups :: Lens' LaunchConfiguration [Text] Source

The IDs of one or more security groups for the VPC specified in ClassicLinkVPCId. This parameter is required if ClassicLinkVPCId is specified, and cannot be used otherwise. For more information, see ClassicLink in the Amazon Elastic Compute Cloud User Guide.

lcRAMDiskId :: Lens' LaunchConfiguration (Maybe Text) Source

The ID of the RAM disk associated with the AMI.

lcKernelId :: Lens' LaunchConfiguration (Maybe Text) Source

The ID of the kernel associated with the AMI.

lcEBSOptimized :: Lens' LaunchConfiguration (Maybe Bool) Source

Controls whether the instance is optimized for EBS I/O (true) or not (false).

lcUserData :: Lens' LaunchConfiguration (Maybe Text) Source

The user data available to the instances.

lcClassicLinkVPCId :: Lens' LaunchConfiguration (Maybe Text) Source

The ID of a ClassicLink-enabled VPC to link your EC2-Classic instances to. This parameter can only be used if you are launching EC2-Classic instances. For more information, see ClassicLink in the Amazon Elastic Compute Cloud User Guide.

lcIAMInstanceProfile :: Lens' LaunchConfiguration (Maybe Text) Source

The name or Amazon Resource Name (ARN) of the instance profile associated with the IAM role for the instance.

lcLaunchConfigurationARN :: Lens' LaunchConfiguration (Maybe Text) Source

The Amazon Resource Name (ARN) of the launch configuration.

lcPlacementTenancy :: Lens' LaunchConfiguration (Maybe Text) Source

The tenancy of the instance, either 'default' or dedicated. An instance with dedicated tenancy runs in an isolated, single-tenant hardware and can only be launched into a VPC.

lcBlockDeviceMappings :: Lens' LaunchConfiguration [BlockDeviceMapping] Source

A block device mapping, which specifies the block devices for the instance.

lcLaunchConfigurationName :: Lens' LaunchConfiguration Text Source

The name of the launch configuration.

lcImageId :: Lens' LaunchConfiguration Text Source

The ID of the Amazon Machine Image (AMI).

lcInstanceType :: Lens' LaunchConfiguration Text Source

The instance type for the instances.

lcCreatedTime :: Lens' LaunchConfiguration UTCTime Source

The creation date and time for the launch configuration.

LifecycleHook

data LifecycleHook Source

Describes a lifecycle hook, which tells Auto Scaling that you want to perform an action when an instance launches or terminates. When you have a lifecycle hook in place, the Auto Scaling group will either:

  • Pause the instance after it launches, but before it is put into service
  • Pause the instance as it terminates, but before it is fully terminated

For more information, see Auto Scaling Pending State and Auto Scaling Terminating State in the Auto Scaling Developer Guide.

See: lifecycleHook smart constructor.

Instances

lifecycleHook :: LifecycleHook Source

Creates a value of LifecycleHook with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

lhDefaultResult :: Lens' LifecycleHook (Maybe Text) Source

Defines the action the Auto Scaling group should take when the lifecycle hook timeout elapses or if an unexpected failure occurs. The valid values are CONTINUE and ABANDON. The default value is CONTINUE.

lhLifecycleHookName :: Lens' LifecycleHook (Maybe Text) Source

The name of the lifecycle hook.

lhHeartbeatTimeout :: Lens' LifecycleHook (Maybe Int) Source

The amount of time that can elapse before the lifecycle hook times out. When the lifecycle hook times out, Auto Scaling performs the action defined in the DefaultResult parameter. You can prevent the lifecycle hook from timing out by calling RecordLifecycleActionHeartbeat.

lhAutoScalingGroupName :: Lens' LifecycleHook (Maybe Text) Source

The name of the Auto Scaling group for the lifecycle hook.

lhNotificationMetadata :: Lens' LifecycleHook (Maybe Text) Source

Additional information that you want to include any time Auto Scaling sends a message to the notification target.

lhGlobalTimeout :: Lens' LifecycleHook (Maybe Int) Source

The maximum length of time an instance can remain in a 'Pending:Wait' or 'Terminating:Wait' state. Currently, the maximum is set to 48 hours.

lhRoleARN :: Lens' LifecycleHook (Maybe Text) Source

The ARN of the IAM role that allows the Auto Scaling group to publish to the specified notification target.

lhLifecycleTransition :: Lens' LifecycleHook (Maybe Text) Source

The state of the EC2 instance to which you want to attach the lifecycle hook. For a list of lifecycle hook types, see DescribeLifecycleHookTypes.

lhNotificationTargetARN :: Lens' LifecycleHook (Maybe Text) Source

The ARN of the notification target that Auto Scaling uses to notify you when an instance is in the transition state for the lifecycle hook. This ARN target can be either an SQS queue or an SNS topic. The notification message sent to the target includes the following:

  • Lifecycle action token
  • User account ID
  • Name of the Auto Scaling group
  • Lifecycle hook name
  • EC2 instance ID
  • Lifecycle transition
  • Notification metadata

LoadBalancerState

data LoadBalancerState Source

Describes the state of a load balancer.

See: loadBalancerState smart constructor.

Instances

loadBalancerState :: LoadBalancerState Source

Creates a value of LoadBalancerState with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

lbsState :: Lens' LoadBalancerState (Maybe Text) Source

The state of the load balancer.

  • Adding - The instances in the group are being registered with the load balancer.
  • Added - All instances in the group are registered with the load balancer.
  • InService - At least one instance in the group passed an ELB health check.
  • Removing - The instances are being deregistered from the load balancer. If connection draining is enabled, Elastic Load Balancing waits for in-flight requests to complete before deregistering the instances.

lbsLoadBalancerName :: Lens' LoadBalancerState (Maybe Text) Source

The name of the load balancer.

MetricCollectionType

data MetricCollectionType Source

Describes a metric.

See: metricCollectionType smart constructor.

Instances

metricCollectionType :: MetricCollectionType Source

Creates a value of MetricCollectionType with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

mctMetric :: Lens' MetricCollectionType (Maybe Text) Source

The metric.

  • GroupMinSize
  • GroupMaxSize
  • GroupDesiredCapacity
  • GroupInServiceInstances
  • GroupPendingInstances
  • GroupStandbyInstances
  • GroupTerminatingInstances
  • GroupTotalInstances

MetricGranularityType

data MetricGranularityType Source

Describes a granularity of a metric.

See: metricGranularityType smart constructor.

Instances

metricGranularityType :: MetricGranularityType Source

Creates a value of MetricGranularityType with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

mgtGranularity :: Lens' MetricGranularityType (Maybe Text) Source

The granularity. The only valid value is '1Minute'.

NotificationConfiguration

data NotificationConfiguration Source

Describes a notification.

See: notificationConfiguration smart constructor.

Instances

notificationConfiguration :: NotificationConfiguration Source

Creates a value of NotificationConfiguration with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

ncTopicARN :: Lens' NotificationConfiguration (Maybe Text) Source

The Amazon Resource Name (ARN) of the Amazon Simple Notification Service (SNS) topic.

ncAutoScalingGroupName :: Lens' NotificationConfiguration (Maybe Text) Source

The name of the group.

ncNotificationType :: Lens' NotificationConfiguration (Maybe Text) Source

The types of events for an action to start.

  • 'autoscaling:EC2_INSTANCE_LAUNCH'
  • 'autoscaling:EC2_INSTANCE_LAUNCH_ERROR'
  • 'autoscaling:EC2_INSTANCE_TERMINATE'
  • 'autoscaling:EC2_INSTANCE_TERMINATE_ERROR'
  • 'autoscaling:TEST_NOTIFICATION'

ProcessType

data ProcessType Source

Describes a process type.

For more information, see Auto Scaling Processes in the Auto Scaling Developer Guide.

See: processType smart constructor.

Instances

processType Source

Arguments

:: Text

ptProcessName

-> ProcessType 

Creates a value of ProcessType with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

ptProcessName :: Lens' ProcessType Text Source

The name of the process.

  • Launch
  • Terminate
  • AddToLoadBalancer
  • AlarmNotification
  • AZRebalance
  • HealthCheck
  • ReplaceUnhealthy
  • ScheduledActions

ScalingPolicy

data ScalingPolicy Source

Describes a scaling policy.

See: scalingPolicy smart constructor.

Instances

scalingPolicy :: ScalingPolicy Source

Creates a value of ScalingPolicy with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

sEstimatedInstanceWarmup :: Lens' ScalingPolicy (Maybe Int) Source

The estimated time, in seconds, until a newly launched instance can contribute to the CloudWatch metrics.

sMinAdjustmentStep :: Lens' ScalingPolicy (Maybe Int) Source

Available for backward compatibility. Use MinAdjustmentMagnitude instead.

sPolicyName :: Lens' ScalingPolicy (Maybe Text) Source

The name of the scaling policy.

sPolicyType :: Lens' ScalingPolicy (Maybe Text) Source

The policy type. Valid values are SimpleScaling and StepScaling.

sStepAdjustments :: Lens' ScalingPolicy [StepAdjustment] Source

A set of adjustments that enable you to scale based on the size of the alarm breach.

sAdjustmentType :: Lens' ScalingPolicy (Maybe Text) Source

The adjustment type, which specifies how ScalingAdjustment is interpreted. Valid values are ChangeInCapacity, ExactCapacity, and PercentChangeInCapacity.

sScalingAdjustment :: Lens' ScalingPolicy (Maybe Int) Source

The amount by which to scale, based on the specified adjustment type. A positive value adds to the current capacity while a negative number removes from the current capacity.

sAutoScalingGroupName :: Lens' ScalingPolicy (Maybe Text) Source

The name of the Auto Scaling group associated with this scaling policy.

sCooldown :: Lens' ScalingPolicy (Maybe Int) Source

The amount of time, in seconds, after a scaling activity completes before any further trigger-related scaling activities can start.

sPolicyARN :: Lens' ScalingPolicy (Maybe Text) Source

The Amazon Resource Name (ARN) of the policy.

sAlarms :: Lens' ScalingPolicy [Alarm] Source

The CloudWatch alarms related to the policy.

sMetricAggregationType :: Lens' ScalingPolicy (Maybe Text) Source

The aggregation type for the CloudWatch metrics. Valid values are Minimum, Maximum, and Average.

sMinAdjustmentMagnitude :: Lens' ScalingPolicy (Maybe Int) Source

The minimum number of instances to scale. If the value of AdjustmentType is PercentChangeInCapacity, the scaling policy changes the DesiredCapacity of the Auto Scaling group by at least this many instances. Otherwise, the error is ValidationError.

ScalingProcessQuery

data ScalingProcessQuery Source

See: scalingProcessQuery smart constructor.

Instances

scalingProcessQuery Source

Arguments

:: Text

spqAutoScalingGroupName

-> ScalingProcessQuery 

Creates a value of ScalingProcessQuery with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

spqScalingProcesses :: Lens' ScalingProcessQuery [Text] Source

One or more of the following processes:

  • Launch
  • Terminate
  • HealthCheck
  • ReplaceUnhealthy
  • AZRebalance
  • AlarmNotification
  • ScheduledActions
  • AddToLoadBalancer

spqAutoScalingGroupName :: Lens' ScalingProcessQuery Text Source

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

ScheduledUpdateGroupAction

data ScheduledUpdateGroupAction Source

Describes a scheduled update to an Auto Scaling group.

See: scheduledUpdateGroupAction smart constructor.

Instances

scheduledUpdateGroupAction :: ScheduledUpdateGroupAction Source

Creates a value of ScheduledUpdateGroupAction with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

sugaScheduledActionARN :: Lens' ScheduledUpdateGroupAction (Maybe Text) Source

The Amazon Resource Name (ARN) of the scheduled action.

sugaTime :: Lens' ScheduledUpdateGroupAction (Maybe UTCTime) Source

This parameter is deprecated; use StartTime instead.

sugaStartTime :: Lens' ScheduledUpdateGroupAction (Maybe UTCTime) Source

The date and time that the action is scheduled to begin. This date and time can be up to one month in the future.

When StartTime and EndTime are specified with Recurrence, they form the boundaries of when the recurring action will start and stop.

sugaScheduledActionName :: Lens' ScheduledUpdateGroupAction (Maybe Text) Source

The name of the scheduled action.

sugaMaxSize :: Lens' ScheduledUpdateGroupAction (Maybe Int) Source

The maximum size of the group.

sugaDesiredCapacity :: Lens' ScheduledUpdateGroupAction (Maybe Int) Source

The number of instances you prefer to maintain in the group.

sugaRecurrence :: Lens' ScheduledUpdateGroupAction (Maybe Text) Source

The recurring schedule for the action.

sugaMinSize :: Lens' ScheduledUpdateGroupAction (Maybe Int) Source

The minimum size of the group.

sugaEndTime :: Lens' ScheduledUpdateGroupAction (Maybe UTCTime) Source

The date and time that the action is scheduled to end. This date and time can be up to one month in the future.

sugaAutoScalingGroupName :: Lens' ScheduledUpdateGroupAction (Maybe Text) Source

The name of the group.

StepAdjustment

data StepAdjustment Source

Describes an adjustment based on the difference between the value of the aggregated CloudWatch metric and the breach threshold that you've defined for the alarm.

For the following examples, suppose that you have an alarm with a breach threshold of 50:

  • If you want the adjustment to be triggered when the metric is greater than or equal to 50 and less than 60, specify a lower bound of 0 and an upper bound of 10.
  • If you want the adjustment to be triggered when the metric is greater than 40 and less than or equal to 50, specify a lower bound of -10 and an upper bound of 0.

There are a few rules for the step adjustments for your step policy:

  • The ranges of your step adjustments can't overlap or have a gap.
  • At most one step adjustment can have a null lower bound. If one step adjustment has a negative lower bound, then there must be a step adjustment with a null lower bound.
  • At most one step adjustment can have a null upper bound. If one step adjustment has a positive upper bound, then there must be a step adjustment with a null upper bound.
  • The upper and lower bound can't be null in the same step adjustment.

See: stepAdjustment smart constructor.

Instances

stepAdjustment Source

Arguments

:: Int

saScalingAdjustment

-> StepAdjustment 

Creates a value of StepAdjustment with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

saMetricIntervalLowerBound :: Lens' StepAdjustment (Maybe Double) Source

The lower bound for the difference between the alarm threshold and the CloudWatch metric. If the metric value is above the breach threshold, the lower bound is inclusive (the metric must be greater than or equal to the threshold plus the lower bound). Otherwise, it is exclusive (the metric must be greater than the threshold plus the lower bound). A null value indicates negative infinity.

saMetricIntervalUpperBound :: Lens' StepAdjustment (Maybe Double) Source

The upper bound for the difference between the alarm threshold and the CloudWatch metric. If the metric value is above the breach threshold, the upper bound is exclusive (the metric must be less than the threshold plus the upper bound). Otherwise, it is inclusive (the metric must be less than or equal to the threshold plus the upper bound). A null value indicates positive infinity.

The upper bound must be greater than the lower bound.

saScalingAdjustment :: Lens' StepAdjustment Int Source

The amount by which to scale, based on the specified adjustment type. A positive value adds to the current capacity while a negative number removes from the current capacity.

SuspendedProcess

data SuspendedProcess Source

Describes an Auto Scaling process that has been suspended. For more information, see ProcessType.

See: suspendedProcess smart constructor.

Instances

suspendedProcess :: SuspendedProcess Source

Creates a value of SuspendedProcess with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

spProcessName :: Lens' SuspendedProcess (Maybe Text) Source

The name of the suspended process.

spSuspensionReason :: Lens' SuspendedProcess (Maybe Text) Source

The reason that the process was suspended.

Tag

data Tag Source

Describes a tag for an Auto Scaling group.

See: tag smart constructor.

Instances

tag Source

Arguments

:: Text

tagKey

-> Text

tagResourceId

-> Text

tagResourceType

-> Bool

tagPropagateAtLaunch

-> Text

tagValue

-> Tag 

Creates a value of Tag with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

tagKey :: Lens' Tag Text Source

The tag key.

tagResourceId :: Lens' Tag Text Source

The name of the group.

tagResourceType :: Lens' Tag Text Source

The type of resource. The only supported value is 'auto-scaling-group'.

tagPropagateAtLaunch :: Lens' Tag Bool Source

Determines whether the tag is added to new instances as they are launched in the group.

tagValue :: Lens' Tag Text Source

The tag value.

TagDescription

data TagDescription Source

Describes a tag for an Auto Scaling group.

See: tagDescription smart constructor.

Instances

tagDescription Source

Arguments

:: Text

tdResourceId

-> Text

tdResourceType

-> Text

tdKey

-> Bool

tdPropagateAtLaunch

-> Text

tdValue

-> TagDescription 

Creates a value of TagDescription with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

tdResourceId :: Lens' TagDescription Text Source

The name of the group.

tdResourceType :: Lens' TagDescription Text Source

The type of resource. The only supported value is 'auto-scaling-group'.

tdKey :: Lens' TagDescription Text Source

The tag key.

tdPropagateAtLaunch :: Lens' TagDescription Bool Source

Determines whether the tag is added to new instances as they are launched in the group.

tdValue :: Lens' TagDescription Text Source

The tag value.