amazonka-autoscaling-2.0: Amazon Auto Scaling SDK.
Copyright(c) 2013-2023 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellSafe-Inferred
LanguageHaskell2010

Amazonka.AutoScaling.Lens

Contents

Description

 
Synopsis

Operations

AttachInstances

attachInstances_instanceIds :: Lens' AttachInstances (Maybe [Text]) Source #

The IDs of the instances. You can specify up to 20 instances.

AttachLoadBalancerTargetGroups

attachLoadBalancerTargetGroups_targetGroupARNs :: Lens' AttachLoadBalancerTargetGroups [Text] Source #

The Amazon Resource Names (ARNs) of the target groups. You can specify up to 10 target groups. To get the ARN of a target group, use the Elastic Load Balancing DescribeTargetGroups API operation.

AttachLoadBalancers

attachLoadBalancers_loadBalancerNames :: Lens' AttachLoadBalancers [Text] Source #

The names of the load balancers. You can specify up to 10 load balancers.

AttachTrafficSources

attachTrafficSources_trafficSources :: Lens' AttachTrafficSources [TrafficSourceIdentifier] Source #

The unique identifiers of one or more traffic sources. You can specify up to 10 traffic sources.

Currently, you must specify an Amazon Resource Name (ARN) for an existing VPC Lattice target group. Amazon EC2 Auto Scaling registers the running instances with the attached target groups. The target groups receive incoming traffic and route requests to one or more registered targets.

BatchDeleteScheduledAction

batchDeleteScheduledAction_scheduledActionNames :: Lens' BatchDeleteScheduledAction [Text] Source #

The names of the scheduled actions to delete. The maximum number allowed is 50.

batchDeleteScheduledActionResponse_failedScheduledActions :: Lens' BatchDeleteScheduledActionResponse (Maybe [FailedScheduledUpdateGroupActionRequest]) Source #

The names of the scheduled actions that could not be deleted, including an error message.

BatchPutScheduledUpdateGroupAction

CancelInstanceRefresh

CompleteLifecycleAction

completeLifecycleAction_lifecycleActionToken :: Lens' CompleteLifecycleAction (Maybe Text) Source #

A universally unique identifier (UUID) that identifies a specific lifecycle action associated with an instance. Amazon EC2 Auto Scaling sends this token to the notification target you specified when you created the lifecycle hook.

completeLifecycleAction_lifecycleActionResult :: Lens' CompleteLifecycleAction Text Source #

The action for the group to take. You can specify either CONTINUE or ABANDON.

CreateAutoScalingGroup

createAutoScalingGroup_availabilityZones :: Lens' CreateAutoScalingGroup (Maybe [Text]) Source #

A list of Availability Zones where instances in the Auto Scaling group can be created. Used for launching into the default VPC subnet in each Availability Zone when not using the VPCZoneIdentifier property, or for attaching a network interface when an existing network interface ID is specified in a launch template.

createAutoScalingGroup_capacityRebalance :: Lens' CreateAutoScalingGroup (Maybe Bool) Source #

Indicates whether Capacity Rebalancing is enabled. Otherwise, Capacity Rebalancing is disabled. When you turn on Capacity Rebalancing, Amazon EC2 Auto Scaling attempts to launch a Spot Instance whenever Amazon EC2 notifies that a Spot Instance is at an elevated risk of interruption. After launching a new instance, it then terminates an old instance. For more information, see Use Capacity Rebalancing to handle Amazon EC2 Spot Interruptions in the in the Amazon EC2 Auto Scaling User Guide.

createAutoScalingGroup_defaultCooldown :: Lens' CreateAutoScalingGroup (Maybe Int) Source #

Only needed if you use simple scaling policies.

The amount of time, in seconds, between one scaling activity ending and another one starting due to simple scaling policies. For more information, see Scaling cooldowns for Amazon EC2 Auto Scaling in the Amazon EC2 Auto Scaling User Guide.

Default: 300 seconds

createAutoScalingGroup_defaultInstanceWarmup :: Lens' CreateAutoScalingGroup (Maybe Int) Source #

The amount of time, in seconds, until a newly launched instance can contribute to the Amazon CloudWatch metrics. This delay lets an instance finish initializing before Amazon EC2 Auto Scaling aggregates instance metrics, resulting in more reliable usage data. Set this value equal to the amount of time that it takes for resource consumption to become stable after an instance reaches the InService state. For more information, see Set the default instance warmup for an Auto Scaling group in the Amazon EC2 Auto Scaling User Guide.

To manage your warm-up settings at the group level, we recommend that you set the default instance warmup, /even if its value is set to 0 seconds/. This also optimizes the performance of scaling policies that scale continuously, such as target tracking and step scaling policies.

If you need to remove a value that you previously set, include the property but specify -1 for the value. However, we strongly recommend keeping the default instance warmup enabled by specifying a minimum value of 0.

Default: None

createAutoScalingGroup_desiredCapacity :: Lens' CreateAutoScalingGroup (Maybe Int) Source #

The desired capacity is the initial capacity of the Auto Scaling group at the time of its creation and the capacity it attempts to maintain. It can scale beyond this capacity if you configure auto scaling. This number must be greater than or equal to the minimum size of the group and less than or equal to the maximum size of the group. If you do not specify a desired capacity, the default is the minimum size of the group.

createAutoScalingGroup_desiredCapacityType :: Lens' CreateAutoScalingGroup (Maybe Text) Source #

The unit of measurement for the value specified for desired capacity. Amazon EC2 Auto Scaling supports DesiredCapacityType for attribute-based instance type selection only. For more information, see Creating an Auto Scaling group using attribute-based instance type selection in the Amazon EC2 Auto Scaling User Guide.

By default, Amazon EC2 Auto Scaling specifies units, which translates into number of instances.

Valid values: units | vcpu | memory-mib

createAutoScalingGroup_healthCheckGracePeriod :: Lens' CreateAutoScalingGroup (Maybe Int) Source #

The amount of time, in seconds, that Amazon EC2 Auto Scaling waits before checking the health status of an EC2 instance that has come into service and marking it unhealthy due to a failed health check. This is useful if your instances do not immediately pass their health checks after they enter the InService state. For more information, see Set the health check grace period for an Auto Scaling group in the Amazon EC2 Auto Scaling User Guide.

Default: 0 seconds

createAutoScalingGroup_healthCheckType :: Lens' CreateAutoScalingGroup (Maybe Text) Source #

Determines whether any additional health checks are performed on the instances in this group. Amazon EC2 health checks are always on. For more information, see Health checks for Auto Scaling instances in the Amazon EC2 Auto Scaling User Guide.

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.

createAutoScalingGroup_instanceId :: Lens' CreateAutoScalingGroup (Maybe Text) Source #

The ID of the instance used to base the launch configuration on. If specified, Amazon EC2 Auto Scaling uses the configuration values from the specified instance to create a new launch configuration. To get the instance ID, use the Amazon EC2 DescribeInstances API operation. For more information, see Creating an Auto Scaling group using an EC2 instance in the Amazon EC2 Auto Scaling User Guide.

createAutoScalingGroup_launchConfigurationName :: Lens' CreateAutoScalingGroup (Maybe Text) Source #

The name of the launch configuration to use to launch instances.

Conditional: You must specify either a launch template (LaunchTemplate or MixedInstancesPolicy) or a launch configuration (LaunchConfigurationName or InstanceId).

createAutoScalingGroup_launchTemplate :: Lens' CreateAutoScalingGroup (Maybe LaunchTemplateSpecification) Source #

Information used to specify the launch template and version to use to launch instances.

Conditional: You must specify either a launch template (LaunchTemplate or MixedInstancesPolicy) or a launch configuration (LaunchConfigurationName or InstanceId).

The launch template that is specified must be configured for use with an Auto Scaling group. For more information, see Creating a launch template for an Auto Scaling group in the Amazon EC2 Auto Scaling User Guide.

createAutoScalingGroup_lifecycleHookSpecificationList :: Lens' CreateAutoScalingGroup (Maybe [LifecycleHookSpecification]) Source #

One or more lifecycle hooks to add to the Auto Scaling group before instances are launched.

createAutoScalingGroup_loadBalancerNames :: Lens' CreateAutoScalingGroup (Maybe [Text]) Source #

A list of Classic Load Balancers associated with this Auto Scaling group. For Application Load Balancers, Network Load Balancers, and Gateway Load Balancer, specify the TargetGroupARNs property instead.

createAutoScalingGroup_maxInstanceLifetime :: Lens' CreateAutoScalingGroup (Maybe Int) Source #

The maximum amount of time, in seconds, that an instance can be in service. The default is null. If specified, the value must be either 0 or a number equal to or greater than 86,400 seconds (1 day). For more information, see Replacing Auto Scaling instances based on maximum instance lifetime in the Amazon EC2 Auto Scaling User Guide.

createAutoScalingGroup_newInstancesProtectedFromScaleIn :: Lens' CreateAutoScalingGroup (Maybe Bool) Source #

Indicates whether newly launched instances are protected from termination by Amazon EC2 Auto Scaling when scaling in. For more information about preventing instances from terminating on scale in, see Using instance scale-in protection in the Amazon EC2 Auto Scaling User Guide.

createAutoScalingGroup_placementGroup :: Lens' CreateAutoScalingGroup (Maybe Text) Source #

The name of the placement group into which to launch your instances. For more information, see Placement groups in the Amazon EC2 User Guide for Linux Instances.

A cluster placement group is a logical grouping of instances within a single Availability Zone. You cannot specify multiple Availability Zones and a cluster placement group.

createAutoScalingGroup_serviceLinkedRoleARN :: Lens' CreateAutoScalingGroup (Maybe Text) Source #

The Amazon Resource Name (ARN) of the service-linked role that the Auto Scaling group uses to call other Amazon Web Services service on your behalf. By default, Amazon EC2 Auto Scaling uses a service-linked role named AWSServiceRoleForAutoScaling, which it creates if it does not exist. For more information, see Service-linked roles in the Amazon EC2 Auto Scaling User Guide.

createAutoScalingGroup_tags :: Lens' CreateAutoScalingGroup (Maybe [Tag]) Source #

One or more tags. You can tag your Auto Scaling group and propagate the tags to the Amazon EC2 instances it launches. Tags are not propagated to Amazon EBS volumes. To add tags to Amazon EBS volumes, specify the tags in a launch template but use caution. If the launch template specifies an instance tag with a key that is also specified for the Auto Scaling group, Amazon EC2 Auto Scaling overrides the value of that instance tag with the value specified by the Auto Scaling group. For more information, see Tag Auto Scaling groups and instances in the Amazon EC2 Auto Scaling User Guide.

createAutoScalingGroup_targetGroupARNs :: Lens' CreateAutoScalingGroup (Maybe [Text]) Source #

The Amazon Resource Names (ARN) of the Elastic Load Balancing target groups to associate with the Auto Scaling group. Instances are registered as targets with the target groups. The target groups receive incoming traffic and route requests to one or more registered targets. For more information, see Use Elastic Load Balancing to distribute traffic across the instances in your Auto Scaling group in the Amazon EC2 Auto Scaling User Guide.

createAutoScalingGroup_terminationPolicies :: Lens' CreateAutoScalingGroup (Maybe [Text]) Source #

A policy or a list of policies that are used to select the instance to terminate. These policies are executed in the order that you list them. For more information, see Work with Amazon EC2 Auto Scaling termination policies in the Amazon EC2 Auto Scaling User Guide.

Valid values: Default | AllocationStrategy | ClosestToNextInstanceHour | NewestInstance | OldestInstance | OldestLaunchConfiguration | OldestLaunchTemplate | arn:aws:lambda:region:account-id:function:my-function:my-alias

createAutoScalingGroup_trafficSources :: Lens' CreateAutoScalingGroup (Maybe [TrafficSourceIdentifier]) Source #

__Reserved for use with Amazon VPC Lattice, which is in preview release and is subject to change. Do not use this parameter for production workloads. It is also subject to change.__

The unique identifiers of one or more traffic sources.

Currently, you must specify an Amazon Resource Name (ARN) for an existing VPC Lattice target group. Amazon EC2 Auto Scaling registers the running instances with the attached target groups. The target groups receive incoming traffic and route requests to one or more registered targets.

createAutoScalingGroup_vPCZoneIdentifier :: Lens' CreateAutoScalingGroup (Maybe Text) Source #

A comma-separated list of subnet IDs for a virtual private cloud (VPC) where instances in the Auto Scaling group can be created. If you specify VPCZoneIdentifier with AvailabilityZones, the subnets that you specify must reside in those Availability Zones.

createAutoScalingGroup_autoScalingGroupName :: Lens' CreateAutoScalingGroup Text Source #

The name of the Auto Scaling group. This name must be unique per Region per account.

The name can contain any ASCII character 33 to 126 including most punctuation characters, digits, and upper and lowercased letters.

You cannot use a colon (:) in the name.

createAutoScalingGroup_maxSize :: Lens' CreateAutoScalingGroup Int Source #

The maximum size of the group.

With a mixed instances policy that uses instance weighting, Amazon EC2 Auto Scaling may need to go above MaxSize to meet your capacity requirements. In this event, Amazon EC2 Auto Scaling will never go above MaxSize by more than your largest instance weight (weights that define how many units each instance contributes to the desired capacity of the group).

CreateLaunchConfiguration

createLaunchConfiguration_associatePublicIpAddress :: Lens' CreateLaunchConfiguration (Maybe Bool) Source #

Specifies whether to assign a public IPv4 address to the group's instances. If the instance is launched into a default subnet, the default is to assign a public IPv4 address, unless you disabled the option to assign a public IPv4 address on the subnet. If the instance is launched into a nondefault subnet, the default is not to assign a public IPv4 address, unless you enabled the option to assign a public IPv4 address on the subnet.

If you specify true, each instance in the Auto Scaling group receives a unique public IPv4 address. For more information, see Launching Auto Scaling instances in a VPC in the Amazon EC2 Auto Scaling User Guide.

If you specify this property, you must specify at least one subnet for VPCZoneIdentifier when you create your group.

createLaunchConfiguration_blockDeviceMappings :: Lens' CreateLaunchConfiguration (Maybe [BlockDeviceMapping]) Source #

The block device mapping entries that define the block devices to attach to the instances at launch. By default, the block devices specified in the block device mapping for the AMI are used. For more information, see Block device mappings in the Amazon EC2 User Guide for Linux Instances.

createLaunchConfiguration_ebsOptimized :: Lens' CreateLaunchConfiguration (Maybe Bool) Source #

Specifies whether the launch configuration is optimized for EBS I/O (true) or not (false). The optimization provides dedicated throughput to Amazon EBS and an optimized configuration stack to provide optimal I/O performance. This optimization is not available with all instance types. Additional fees are incurred when you enable EBS optimization for an instance type that is not EBS-optimized by default. For more information, see Amazon EBS-optimized instances in the Amazon EC2 User Guide for Linux Instances.

The default value is false.

createLaunchConfiguration_iamInstanceProfile :: Lens' CreateLaunchConfiguration (Maybe Text) Source #

The name or the Amazon Resource Name (ARN) of the instance profile associated with the IAM role for the instance. The instance profile contains the IAM role. For more information, see IAM role for applications that run on Amazon EC2 instances in the Amazon EC2 Auto Scaling User Guide.

createLaunchConfiguration_imageId :: Lens' CreateLaunchConfiguration (Maybe Text) Source #

The ID of the Amazon Machine Image (AMI) that was assigned during registration. For more information, see Finding a Linux AMI in the Amazon EC2 User Guide for Linux Instances.

If you specify InstanceId, an ImageId is not required.

createLaunchConfiguration_instanceId :: Lens' CreateLaunchConfiguration (Maybe Text) Source #

The ID of the instance to use to create the launch configuration. The new launch configuration derives attributes from the instance, except for the block device mapping.

To create a launch configuration with a block device mapping or override any other instance attributes, specify them as part of the same request.

For more information, see Creating a launch configuration using an EC2 instance in the Amazon EC2 Auto Scaling User Guide.

createLaunchConfiguration_instanceMonitoring :: Lens' CreateLaunchConfiguration (Maybe InstanceMonitoring) Source #

Controls whether instances in this group are launched with detailed (true) or basic (false) monitoring.

The default value is true (enabled).

When detailed monitoring is enabled, Amazon CloudWatch generates metrics every minute and your account is charged a fee. When you disable detailed monitoring, CloudWatch generates metrics every 5 minutes. For more information, see Configure Monitoring for Auto Scaling Instances in the Amazon EC2 Auto Scaling User Guide.

createLaunchConfiguration_instanceType :: Lens' CreateLaunchConfiguration (Maybe Text) Source #

Specifies the instance type of the EC2 instance. For information about available instance types, see Available instance types in the Amazon EC2 User Guide for Linux Instances.

If you specify InstanceId, an InstanceType is not required.

createLaunchConfiguration_kernelId :: Lens' CreateLaunchConfiguration (Maybe Text) Source #

The ID of the kernel associated with the AMI.

We recommend that you use PV-GRUB instead of kernels and RAM disks. For more information, see User provided kernels in the Amazon EC2 User Guide for Linux Instances.

createLaunchConfiguration_keyName :: Lens' CreateLaunchConfiguration (Maybe Text) Source #

The name of the key pair. For more information, see Amazon EC2 key pairs and Linux instances in the Amazon EC2 User Guide for Linux Instances.

createLaunchConfiguration_metadataOptions :: Lens' CreateLaunchConfiguration (Maybe InstanceMetadataOptions) Source #

The metadata options for the instances. For more information, see Configuring the Instance Metadata Options in the Amazon EC2 Auto Scaling User Guide.

createLaunchConfiguration_placementTenancy :: Lens' CreateLaunchConfiguration (Maybe Text) Source #

The tenancy of the instance, either default or dedicated. An instance with dedicated tenancy runs on isolated, single-tenant hardware and can only be launched into a VPC. To launch dedicated instances into a shared tenancy VPC (a VPC with the instance placement tenancy attribute set to default), you must set the value of this property to dedicated. For more information, see Configuring instance tenancy with Amazon EC2 Auto Scaling in the Amazon EC2 Auto Scaling User Guide.

If you specify PlacementTenancy, you must specify at least one subnet for VPCZoneIdentifier when you create your group.

Valid values: default | dedicated

createLaunchConfiguration_ramdiskId :: Lens' CreateLaunchConfiguration (Maybe Text) Source #

The ID of the RAM disk to select.

We recommend that you use PV-GRUB instead of kernels and RAM disks. For more information, see User provided kernels in the Amazon EC2 User Guide for Linux Instances.

createLaunchConfiguration_securityGroups :: Lens' CreateLaunchConfiguration (Maybe [Text]) Source #

A list that contains the security group IDs to assign to the instances in the Auto Scaling group. For more information, see Control traffic to resources using security groups in the Amazon Virtual Private Cloud User Guide.

createLaunchConfiguration_spotPrice :: Lens' CreateLaunchConfiguration (Maybe Text) Source #

The maximum hourly price to be paid for any Spot Instance launched to fulfill the request. Spot Instances are launched when the price you specify exceeds the current Spot price. For more information, see Request Spot Instances for fault-tolerant and flexible applications in the Amazon EC2 Auto Scaling User Guide.

Valid Range: Minimum value of 0.001

When you change your maximum price by creating a new launch configuration, running instances will continue to run as long as the maximum price for those running instances is higher than the current Spot price.

createLaunchConfiguration_userData :: Lens' CreateLaunchConfiguration (Maybe Text) Source #

The user data to make available to the launched EC2 instances. For more information, see Instance metadata and user data (Linux) and Instance metadata and user data (Windows). If you are using a command line tool, base64-encoding is performed for you, and you can load the text from a file. Otherwise, you must provide base64-encoded text. User data is limited to 16 KB.

createLaunchConfiguration_launchConfigurationName :: Lens' CreateLaunchConfiguration Text Source #

The name of the launch configuration. This name must be unique per Region per account.

CreateOrUpdateTags

DeleteAutoScalingGroup

deleteAutoScalingGroup_forceDelete :: Lens' DeleteAutoScalingGroup (Maybe Bool) Source #

Specifies that the group is to be deleted along with all instances associated with the group, without waiting for all instances to be terminated. This action also deletes any outstanding lifecycle actions associated with the group.

DeleteLaunchConfiguration

DeleteLifecycleHook

DeleteNotificationConfiguration

deleteNotificationConfiguration_topicARN :: Lens' DeleteNotificationConfiguration Text Source #

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

DeletePolicy

deletePolicy_autoScalingGroupName :: Lens' DeletePolicy (Maybe Text) Source #

The name of the Auto Scaling group.

deletePolicy_policyName :: Lens' DeletePolicy Text Source #

The name or Amazon Resource Name (ARN) of the policy.

DeleteScheduledAction

DeleteTags

deleteTags_tags :: Lens' DeleteTags [Tag] Source #

One or more tags.

DeleteWarmPool

deleteWarmPool_forceDelete :: Lens' DeleteWarmPool (Maybe Bool) Source #

Specifies that the warm pool is to be deleted along with all of its associated instances, without waiting for all instances to be terminated. This parameter also deletes any outstanding lifecycle actions associated with the warm pool instances.

DescribeAccountLimits

describeAccountLimitsResponse_maxNumberOfAutoScalingGroups :: Lens' DescribeAccountLimitsResponse (Maybe Int) Source #

The maximum number of groups allowed for your account. The default is 200 groups per Region.

describeAccountLimitsResponse_maxNumberOfLaunchConfigurations :: Lens' DescribeAccountLimitsResponse (Maybe Int) Source #

The maximum number of launch configurations allowed for your account. The default is 200 launch configurations per Region.

describeAccountLimitsResponse_numberOfLaunchConfigurations :: Lens' DescribeAccountLimitsResponse (Maybe Int) Source #

The current number of launch configurations for your account.

DescribeAdjustmentTypes

DescribeAutoScalingGroups

describeAutoScalingGroups_autoScalingGroupNames :: Lens' DescribeAutoScalingGroups (Maybe [Text]) Source #

The names of the Auto Scaling groups. By default, you can only specify up to 50 names. You can optionally increase this limit using the MaxRecords property.

If you omit this property, all Auto Scaling groups are described.

describeAutoScalingGroups_filters :: Lens' DescribeAutoScalingGroups (Maybe [Filter]) Source #

One or more filters to limit the results based on specific tags.

describeAutoScalingGroups_maxRecords :: Lens' DescribeAutoScalingGroups (Maybe Int) Source #

The maximum number of items to return with this call. The default value is 50 and the maximum value is 100.

describeAutoScalingGroups_nextToken :: Lens' DescribeAutoScalingGroups (Maybe Text) Source #

The token for the next set of items to return. (You received this token from a previous call.)

describeAutoScalingGroupsResponse_nextToken :: Lens' DescribeAutoScalingGroupsResponse (Maybe Text) Source #

A string that indicates that the response contains more items than can be returned in a single response. To receive additional items, specify this string for the NextToken value when requesting the next set of items. This value is null when there are no more items to return.

DescribeAutoScalingInstances

describeAutoScalingInstances_instanceIds :: Lens' DescribeAutoScalingInstances (Maybe [Text]) Source #

The IDs of the instances. If you omit this property, all Auto Scaling instances are described. If you specify an ID that does not exist, it is ignored with no error.

Array Members: Maximum number of 50 items.

describeAutoScalingInstances_maxRecords :: Lens' DescribeAutoScalingInstances (Maybe Int) Source #

The maximum number of items to return with this call. The default value is 50 and the maximum value is 50.

describeAutoScalingInstances_nextToken :: Lens' DescribeAutoScalingInstances (Maybe Text) Source #

The token for the next set of items to return. (You received this token from a previous call.)

describeAutoScalingInstancesResponse_nextToken :: Lens' DescribeAutoScalingInstancesResponse (Maybe Text) Source #

A string that indicates that the response contains more items than can be returned in a single response. To receive additional items, specify this string for the NextToken value when requesting the next set of items. This value is null when there are no more items to return.

DescribeAutoScalingNotificationTypes

DescribeInstanceRefreshes

describeInstanceRefreshes_maxRecords :: Lens' DescribeInstanceRefreshes (Maybe Int) Source #

The maximum number of items to return with this call. The default value is 50 and the maximum value is 100.

describeInstanceRefreshes_nextToken :: Lens' DescribeInstanceRefreshes (Maybe Text) Source #

The token for the next set of items to return. (You received this token from a previous call.)

describeInstanceRefreshesResponse_instanceRefreshes :: Lens' DescribeInstanceRefreshesResponse (Maybe [InstanceRefresh]) Source #

The instance refreshes for the specified group, sorted by creation timestamp in descending order.

describeInstanceRefreshesResponse_nextToken :: Lens' DescribeInstanceRefreshesResponse (Maybe Text) Source #

A string that indicates that the response contains more items than can be returned in a single response. To receive additional items, specify this string for the NextToken value when requesting the next set of items. This value is null when there are no more items to return.

DescribeLaunchConfigurations

describeLaunchConfigurations_launchConfigurationNames :: Lens' DescribeLaunchConfigurations (Maybe [Text]) Source #

The launch configuration names. If you omit this property, all launch configurations are described.

Array Members: Maximum number of 50 items.

describeLaunchConfigurations_maxRecords :: Lens' DescribeLaunchConfigurations (Maybe Int) Source #

The maximum number of items to return with this call. The default value is 50 and the maximum value is 100.

describeLaunchConfigurations_nextToken :: Lens' DescribeLaunchConfigurations (Maybe Text) Source #

The token for the next set of items to return. (You received this token from a previous call.)

describeLaunchConfigurationsResponse_nextToken :: Lens' DescribeLaunchConfigurationsResponse (Maybe Text) Source #

A string that indicates that the response contains more items than can be returned in a single response. To receive additional items, specify this string for the NextToken value when requesting the next set of items. This value is null when there are no more items to return.

DescribeLifecycleHookTypes

DescribeLifecycleHooks

describeLifecycleHooks_lifecycleHookNames :: Lens' DescribeLifecycleHooks (Maybe [Text]) Source #

The names of one or more lifecycle hooks. If you omit this property, all lifecycle hooks are described.

DescribeLoadBalancerTargetGroups

describeLoadBalancerTargetGroups_maxRecords :: Lens' DescribeLoadBalancerTargetGroups (Maybe Int) Source #

The maximum number of items to return with this call. The default value is 100 and the maximum value is 100.

describeLoadBalancerTargetGroups_nextToken :: Lens' DescribeLoadBalancerTargetGroups (Maybe Text) Source #

The token for the next set of items to return. (You received this token from a previous call.)

describeLoadBalancerTargetGroupsResponse_nextToken :: Lens' DescribeLoadBalancerTargetGroupsResponse (Maybe Text) Source #

A string that indicates that the response contains more items than can be returned in a single response. To receive additional items, specify this string for the NextToken value when requesting the next set of items. This value is null when there are no more items to return.

DescribeLoadBalancers

describeLoadBalancers_maxRecords :: Lens' DescribeLoadBalancers (Maybe Int) Source #

The maximum number of items to return with this call. The default value is 100 and the maximum value is 100.

describeLoadBalancers_nextToken :: Lens' DescribeLoadBalancers (Maybe Text) Source #

The token for the next set of items to return. (You received this token from a previous call.)

describeLoadBalancersResponse_nextToken :: Lens' DescribeLoadBalancersResponse (Maybe Text) Source #

A string that indicates that the response contains more items than can be returned in a single response. To receive additional items, specify this string for the NextToken value when requesting the next set of items. This value is null when there are no more items to return.

DescribeMetricCollectionTypes

DescribeNotificationConfigurations

describeNotificationConfigurations_maxRecords :: Lens' DescribeNotificationConfigurations (Maybe Int) Source #

The maximum number of items to return with this call. The default value is 50 and the maximum value is 100.

describeNotificationConfigurations_nextToken :: Lens' DescribeNotificationConfigurations (Maybe Text) Source #

The token for the next set of items to return. (You received this token from a previous call.)

describeNotificationConfigurationsResponse_nextToken :: Lens' DescribeNotificationConfigurationsResponse (Maybe Text) Source #

A string that indicates that the response contains more items than can be returned in a single response. To receive additional items, specify this string for the NextToken value when requesting the next set of items. This value is null when there are no more items to return.

DescribePolicies

describePolicies_maxRecords :: Lens' DescribePolicies (Maybe Int) Source #

The maximum number of items to be returned with each call. The default value is 50 and the maximum value is 100.

describePolicies_nextToken :: Lens' DescribePolicies (Maybe Text) Source #

The token for the next set of items to return. (You received this token from a previous call.)

describePolicies_policyNames :: Lens' DescribePolicies (Maybe [Text]) Source #

The names of one or more policies. If you omit this property, all policies are described. If a group name is provided, the results are limited to that group. If you specify an unknown policy name, it is ignored with no error.

Array Members: Maximum number of 50 items.

describePolicies_policyTypes :: Lens' DescribePolicies (Maybe [Text]) Source #

One or more policy types. The valid values are SimpleScaling, StepScaling, TargetTrackingScaling, and PredictiveScaling.

describePoliciesResponse_nextToken :: Lens' DescribePoliciesResponse (Maybe Text) Source #

A string that indicates that the response contains more items than can be returned in a single response. To receive additional items, specify this string for the NextToken value when requesting the next set of items. This value is null when there are no more items to return.

DescribeScalingActivities

describeScalingActivities_activityIds :: Lens' DescribeScalingActivities (Maybe [Text]) Source #

The activity IDs of the desired scaling activities. If you omit this property, all activities for the past six weeks are described. If unknown activities are requested, they are ignored with no error. If you specify an Auto Scaling group, the results are limited to that group.

Array Members: Maximum number of 50 IDs.

describeScalingActivities_includeDeletedGroups :: Lens' DescribeScalingActivities (Maybe Bool) Source #

Indicates whether to include scaling activity from deleted Auto Scaling groups.

describeScalingActivities_maxRecords :: Lens' DescribeScalingActivities (Maybe Int) Source #

The maximum number of items to return with this call. The default value is 100 and the maximum value is 100.

describeScalingActivities_nextToken :: Lens' DescribeScalingActivities (Maybe Text) Source #

The token for the next set of items to return. (You received this token from a previous call.)

describeScalingActivitiesResponse_nextToken :: Lens' DescribeScalingActivitiesResponse (Maybe Text) Source #

A string that indicates that the response contains more items than can be returned in a single response. To receive additional items, specify this string for the NextToken value when requesting the next set of items. This value is null when there are no more items to return.

describeScalingActivitiesResponse_activities :: Lens' DescribeScalingActivitiesResponse [Activity] Source #

The scaling activities. Activities are sorted by start time. Activities still in progress are described first.

DescribeScalingProcessTypes

DescribeScheduledActions

describeScheduledActions_endTime :: Lens' DescribeScheduledActions (Maybe UTCTime) Source #

The latest scheduled start time to return. If scheduled action names are provided, this property is ignored.

describeScheduledActions_maxRecords :: Lens' DescribeScheduledActions (Maybe Int) Source #

The maximum number of items to return with this call. The default value is 50 and the maximum value is 100.

describeScheduledActions_nextToken :: Lens' DescribeScheduledActions (Maybe Text) Source #

The token for the next set of items to return. (You received this token from a previous call.)

describeScheduledActions_scheduledActionNames :: Lens' DescribeScheduledActions (Maybe [Text]) Source #

The names of one or more scheduled actions. If you omit this property, all scheduled actions are described. If you specify an unknown scheduled action, it is ignored with no error.

Array Members: Maximum number of 50 actions.

describeScheduledActions_startTime :: Lens' DescribeScheduledActions (Maybe UTCTime) Source #

The earliest scheduled start time to return. If scheduled action names are provided, this property is ignored.

describeScheduledActionsResponse_nextToken :: Lens' DescribeScheduledActionsResponse (Maybe Text) Source #

A string that indicates that the response contains more items than can be returned in a single response. To receive additional items, specify this string for the NextToken value when requesting the next set of items. This value is null when there are no more items to return.

DescribeTags

describeTags_filters :: Lens' DescribeTags (Maybe [Filter]) Source #

One or more filters to scope the tags to return. The maximum number of filters per filter type (for example, auto-scaling-group) is 1000.

describeTags_maxRecords :: Lens' DescribeTags (Maybe Int) Source #

The maximum number of items to return with this call. The default value is 50 and the maximum value is 100.

describeTags_nextToken :: Lens' DescribeTags (Maybe Text) Source #

The token for the next set of items to return. (You received this token from a previous call.)

describeTagsResponse_nextToken :: Lens' DescribeTagsResponse (Maybe Text) Source #

A string that indicates that the response contains more items than can be returned in a single response. To receive additional items, specify this string for the NextToken value when requesting the next set of items. This value is null when there are no more items to return.

DescribeTerminationPolicyTypes

describeTerminationPolicyTypesResponse_terminationPolicyTypes :: Lens' DescribeTerminationPolicyTypesResponse (Maybe [Text]) Source #

The termination policies supported by Amazon EC2 Auto Scaling: OldestInstance, OldestLaunchConfiguration, NewestInstance, ClosestToNextInstanceHour, Default, OldestLaunchTemplate, and AllocationStrategy.

DescribeTrafficSources

describeTrafficSources_maxRecords :: Lens' DescribeTrafficSources (Maybe Int) Source #

The maximum number of items to return with this call. The maximum value is 50.

describeTrafficSources_nextToken :: Lens' DescribeTrafficSources (Maybe Text) Source #

The token for the next set of items to return. (You received this token from a previous call.)

describeTrafficSources_trafficSourceType :: Lens' DescribeTrafficSources Text Source #

The type of traffic source you are describing. Currently, the only valid value is vpc-lattice.

describeTrafficSourcesResponse_nextToken :: Lens' DescribeTrafficSourcesResponse (Maybe Text) Source #

This string indicates that the response contains more items than can be returned in a single response. To receive additional items, specify this string for the NextToken value when requesting the next set of items. This value is null when there are no more items to return.

DescribeWarmPool

describeWarmPool_maxRecords :: Lens' DescribeWarmPool (Maybe Int) Source #

The maximum number of instances to return with this call. The maximum value is 50.

describeWarmPool_nextToken :: Lens' DescribeWarmPool (Maybe Text) Source #

The token for the next set of instances to return. (You received this token from a previous call.)

describeWarmPoolResponse_instances :: Lens' DescribeWarmPoolResponse (Maybe [Instance]) Source #

The instances that are currently in the warm pool.

describeWarmPoolResponse_nextToken :: Lens' DescribeWarmPoolResponse (Maybe Text) Source #

This string indicates that the response contains more items than can be returned in a single response. To receive additional items, specify this string for the NextToken value when requesting the next set of items. This value is null when there are no more items to return.

DetachInstances

detachInstances_instanceIds :: Lens' DetachInstances (Maybe [Text]) Source #

The IDs of the instances. You can specify up to 20 instances.

detachInstances_shouldDecrementDesiredCapacity :: Lens' DetachInstances Bool Source #

Indicates whether the Auto Scaling group decrements the desired capacity value by the number of instances detached.

detachInstancesResponse_activities :: Lens' DetachInstancesResponse (Maybe [Activity]) Source #

The activities related to detaching the instances from the Auto Scaling group.

DetachLoadBalancerTargetGroups

detachLoadBalancerTargetGroups_targetGroupARNs :: Lens' DetachLoadBalancerTargetGroups [Text] Source #

The Amazon Resource Names (ARN) of the target groups. You can specify up to 10 target groups.

DetachLoadBalancers

detachLoadBalancers_loadBalancerNames :: Lens' DetachLoadBalancers [Text] Source #

The names of the load balancers. You can specify up to 10 load balancers.

DetachTrafficSources

detachTrafficSources_trafficSources :: Lens' DetachTrafficSources [TrafficSourceIdentifier] Source #

The unique identifiers of one or more traffic sources you are detaching. You can specify up to 10 traffic sources.

Currently, you must specify an Amazon Resource Name (ARN) for an existing VPC Lattice target group. When you detach a target group, it enters the Removing state while deregistering the instances in the group. When all instances are deregistered, then you can no longer describe the target group using the DescribeTrafficSources API call. The instances continue to run.

DisableMetricsCollection

disableMetricsCollection_metrics :: Lens' DisableMetricsCollection (Maybe [Text]) Source #

Identifies the metrics to disable.

You can specify one or more of the following metrics:

  • GroupMinSize
  • GroupMaxSize
  • GroupDesiredCapacity
  • GroupInServiceInstances
  • GroupPendingInstances
  • GroupStandbyInstances
  • GroupTerminatingInstances
  • GroupTotalInstances
  • GroupInServiceCapacity
  • GroupPendingCapacity
  • GroupStandbyCapacity
  • GroupTerminatingCapacity
  • GroupTotalCapacity
  • WarmPoolDesiredCapacity
  • WarmPoolWarmedCapacity
  • WarmPoolPendingCapacity
  • WarmPoolTerminatingCapacity
  • WarmPoolTotalCapacity
  • GroupAndWarmPoolDesiredCapacity
  • GroupAndWarmPoolTotalCapacity

If you omit this property, all metrics are disabled.

For more information, see Auto Scaling group metrics in the Amazon EC2 Auto Scaling User Guide.

EnableMetricsCollection

enableMetricsCollection_metrics :: Lens' EnableMetricsCollection (Maybe [Text]) Source #

Identifies the metrics to enable.

You can specify one or more of the following metrics:

  • GroupMinSize
  • GroupMaxSize
  • GroupDesiredCapacity
  • GroupInServiceInstances
  • GroupPendingInstances
  • GroupStandbyInstances
  • GroupTerminatingInstances
  • GroupTotalInstances
  • GroupInServiceCapacity
  • GroupPendingCapacity
  • GroupStandbyCapacity
  • GroupTerminatingCapacity
  • GroupTotalCapacity
  • WarmPoolDesiredCapacity
  • WarmPoolWarmedCapacity
  • WarmPoolPendingCapacity
  • WarmPoolTerminatingCapacity
  • WarmPoolTotalCapacity
  • GroupAndWarmPoolDesiredCapacity
  • GroupAndWarmPoolTotalCapacity

If you specify Granularity and don't specify any metrics, all metrics are enabled.

For more information, see Auto Scaling group metrics in the Amazon EC2 Auto Scaling User Guide.

enableMetricsCollection_granularity :: Lens' EnableMetricsCollection Text Source #

The frequency at which Amazon EC2 Auto Scaling sends aggregated data to CloudWatch. The only valid value is 1Minute.

EnterStandby

enterStandby_instanceIds :: Lens' EnterStandby (Maybe [Text]) Source #

The IDs of the instances. You can specify up to 20 instances.

enterStandby_autoScalingGroupName :: Lens' EnterStandby Text Source #

The name of the Auto Scaling group.

enterStandby_shouldDecrementDesiredCapacity :: Lens' EnterStandby Bool Source #

Indicates whether to decrement the desired capacity of the Auto Scaling group by the number of instances moved to Standby mode.

enterStandbyResponse_activities :: Lens' EnterStandbyResponse (Maybe [Activity]) Source #

The activities related to moving instances into Standby mode.

ExecutePolicy

executePolicy_autoScalingGroupName :: Lens' ExecutePolicy (Maybe Text) Source #

The name of the Auto Scaling group.

executePolicy_breachThreshold :: Lens' ExecutePolicy (Maybe Double) Source #

The breach threshold for the alarm.

Required if the policy type is StepScaling and not supported otherwise.

executePolicy_honorCooldown :: Lens' ExecutePolicy (Maybe Bool) Source #

Indicates whether Amazon EC2 Auto Scaling waits for the cooldown period to complete before executing the policy.

Valid only if the policy type is SimpleScaling. For more information, see Scaling cooldowns for Amazon EC2 Auto Scaling in the Amazon EC2 Auto Scaling User Guide.

executePolicy_metricValue :: Lens' ExecutePolicy (Maybe Double) Source #

The metric value to compare to BreachThreshold. This enables you to execute a policy of type StepScaling and determine which step adjustment to use. For example, if the breach threshold is 50 and you want to use a step adjustment with a lower bound of 0 and an upper bound of 10, you can set the metric value to 59.

If you specify a metric value that doesn't correspond to a step adjustment for the policy, the call returns an error.

Required if the policy type is StepScaling and not supported otherwise.

executePolicy_policyName :: Lens' ExecutePolicy Text Source #

The name or ARN of the policy.

ExitStandby

exitStandby_instanceIds :: Lens' ExitStandby (Maybe [Text]) Source #

The IDs of the instances. You can specify up to 20 instances.

exitStandby_autoScalingGroupName :: Lens' ExitStandby Text Source #

The name of the Auto Scaling group.

exitStandbyResponse_activities :: Lens' ExitStandbyResponse (Maybe [Activity]) Source #

The activities related to moving instances out of Standby mode.

GetPredictiveScalingForecast

getPredictiveScalingForecast_startTime :: Lens' GetPredictiveScalingForecast UTCTime Source #

The inclusive start time of the time range for the forecast data to get. At most, the date and time can be one year before the current date and time.

getPredictiveScalingForecast_endTime :: Lens' GetPredictiveScalingForecast UTCTime Source #

The exclusive end time of the time range for the forecast data to get. The maximum time duration between the start and end time is 30 days.

Although this parameter can accept a date and time that is more than two days in the future, the availability of forecast data has limits. Amazon EC2 Auto Scaling only issues forecasts for periods of two days in advance.

PutLifecycleHook

putLifecycleHook_defaultResult :: Lens' PutLifecycleHook (Maybe Text) Source #

The action the Auto Scaling group takes when the lifecycle hook timeout elapses or if an unexpected failure occurs. The default value is ABANDON.

Valid values: CONTINUE | ABANDON

putLifecycleHook_heartbeatTimeout :: Lens' PutLifecycleHook (Maybe Int) Source #

The maximum time, in seconds, that can elapse before the lifecycle hook times out. The range is from 30 to 7200 seconds. The default value is 3600 seconds (1 hour).

putLifecycleHook_lifecycleTransition :: Lens' PutLifecycleHook (Maybe Text) Source #

The lifecycle transition. For Auto Scaling groups, there are two major lifecycle transitions.

  • To create a lifecycle hook for scale-out events, specify autoscaling:EC2_INSTANCE_LAUNCHING.
  • To create a lifecycle hook for scale-in events, specify autoscaling:EC2_INSTANCE_TERMINATING.

Required for new lifecycle hooks, but optional when updating existing hooks.

putLifecycleHook_notificationMetadata :: Lens' PutLifecycleHook (Maybe Text) Source #

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

putLifecycleHook_notificationTargetARN :: Lens' PutLifecycleHook (Maybe Text) Source #

The Amazon Resource Name (ARN) of the notification target that Amazon EC2 Auto Scaling uses to notify you when an instance is in a wait state for the lifecycle hook. You can specify either an Amazon SNS topic or an Amazon SQS queue.

If you specify an empty string, this overrides the current ARN.

This operation uses the JSON format when sending notifications to an Amazon SQS queue, and an email key-value pair format when sending notifications to an Amazon SNS topic.

When you specify a notification target, Amazon EC2 Auto Scaling sends it a test message. Test messages contain the following additional key-value pair: "Event": "autoscaling:TEST_NOTIFICATION".

putLifecycleHook_roleARN :: Lens' PutLifecycleHook (Maybe Text) Source #

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

Valid only if the notification target is an Amazon SNS topic or an Amazon SQS queue. Required for new lifecycle hooks, but optional when updating existing hooks.

PutNotificationConfiguration

putNotificationConfiguration_topicARN :: Lens' PutNotificationConfiguration Text Source #

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

putNotificationConfiguration_notificationTypes :: Lens' PutNotificationConfiguration [Text] Source #

The type of event that causes the notification to be sent. To query the notification types supported by Amazon EC2 Auto Scaling, call the DescribeAutoScalingNotificationTypes API.

PutScalingPolicy

putScalingPolicy_adjustmentType :: Lens' PutScalingPolicy (Maybe Text) Source #

Specifies how the scaling adjustment is interpreted (for example, an absolute number or a percentage). The valid values are ChangeInCapacity, ExactCapacity, and PercentChangeInCapacity.

Required if the policy type is StepScaling or SimpleScaling. For more information, see Scaling adjustment types in the Amazon EC2 Auto Scaling User Guide.

putScalingPolicy_cooldown :: Lens' PutScalingPolicy (Maybe Int) Source #

A cooldown period, in seconds, that applies to a specific simple scaling policy. When a cooldown period is specified here, it overrides the default cooldown.

Valid only if the policy type is SimpleScaling. For more information, see Scaling cooldowns for Amazon EC2 Auto Scaling in the Amazon EC2 Auto Scaling User Guide.

Default: None

putScalingPolicy_enabled :: Lens' PutScalingPolicy (Maybe Bool) Source #

Indicates whether the scaling policy is enabled or disabled. The default is enabled. For more information, see Disabling a scaling policy for an Auto Scaling group in the Amazon EC2 Auto Scaling User Guide.

putScalingPolicy_estimatedInstanceWarmup :: Lens' PutScalingPolicy (Maybe Int) Source #

Not needed if the default instance warmup is defined for the group.

The estimated time, in seconds, until a newly launched instance can contribute to the CloudWatch metrics. This warm-up period applies to instances launched due to a specific target tracking or step scaling policy. When a warm-up period is specified here, it overrides the default instance warmup.

Valid only if the policy type is TargetTrackingScaling or StepScaling.

The default is to use the value for the default instance warmup defined for the group. If default instance warmup is null, then EstimatedInstanceWarmup falls back to the value of default cooldown.

putScalingPolicy_metricAggregationType :: Lens' PutScalingPolicy (Maybe Text) Source #

The aggregation type for the CloudWatch metrics. The valid values are Minimum, Maximum, and Average. If the aggregation type is null, the value is treated as Average.

Valid only if the policy type is StepScaling.

putScalingPolicy_minAdjustmentMagnitude :: Lens' PutScalingPolicy (Maybe Int) Source #

The minimum value to scale by when the adjustment type is PercentChangeInCapacity. For example, suppose that you create a step scaling policy to scale out an Auto Scaling group by 25 percent and you specify a MinAdjustmentMagnitude of 2. If the group has 4 instances and the scaling policy is performed, 25 percent of 4 is 1. However, because you specified a MinAdjustmentMagnitude of 2, Amazon EC2 Auto Scaling scales out the group by 2 instances.

Valid only if the policy type is StepScaling or SimpleScaling. For more information, see Scaling adjustment types in the Amazon EC2 Auto Scaling User Guide.

Some Auto Scaling groups use instance weights. In this case, set the MinAdjustmentMagnitude to a value that is at least as large as your largest instance weight.

putScalingPolicy_minAdjustmentStep :: Lens' PutScalingPolicy (Maybe Int) Source #

Available for backward compatibility. Use MinAdjustmentMagnitude instead.

putScalingPolicy_policyType :: Lens' PutScalingPolicy (Maybe Text) Source #

One of the following policy types:

  • TargetTrackingScaling
  • StepScaling
  • SimpleScaling (default)
  • PredictiveScaling

putScalingPolicy_predictiveScalingConfiguration :: Lens' PutScalingPolicy (Maybe PredictiveScalingConfiguration) Source #

A predictive scaling policy. Provides support for predefined and custom metrics.

Predefined metrics include CPU utilization, network in/out, and the Application Load Balancer request count.

For more information, see PredictiveScalingConfiguration in the Amazon EC2 Auto Scaling API Reference.

Required if the policy type is PredictiveScaling.

putScalingPolicy_scalingAdjustment :: Lens' PutScalingPolicy (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. For exact capacity, you must specify a positive value.

Required if the policy type is SimpleScaling. (Not used with any other policy type.)

putScalingPolicy_stepAdjustments :: Lens' PutScalingPolicy (Maybe [StepAdjustment]) Source #

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

Required if the policy type is StepScaling. (Not used with any other policy type.)

putScalingPolicy_targetTrackingConfiguration :: Lens' PutScalingPolicy (Maybe TargetTrackingConfiguration) Source #

A target tracking scaling policy. Provides support for predefined or custom metrics.

The following predefined metrics are available:

  • ASGAverageCPUUtilization
  • ASGAverageNetworkIn
  • ASGAverageNetworkOut
  • ALBRequestCountPerTarget

If you specify ALBRequestCountPerTarget for the metric, you must specify the ResourceLabel property with the PredefinedMetricSpecification.

For more information, see TargetTrackingConfiguration in the Amazon EC2 Auto Scaling API Reference.

Required if the policy type is TargetTrackingScaling.

putScalingPolicyResponse_alarms :: Lens' PutScalingPolicyResponse (Maybe [Alarm]) Source #

The CloudWatch alarms created for the target tracking scaling policy.

putScalingPolicyResponse_policyARN :: Lens' PutScalingPolicyResponse (Maybe Text) Source #

The Amazon Resource Name (ARN) of the policy.

PutScheduledUpdateGroupAction

putScheduledUpdateGroupAction_desiredCapacity :: Lens' PutScheduledUpdateGroupAction (Maybe Int) Source #

The desired capacity is the initial capacity of the Auto Scaling group after the scheduled action runs and the capacity it attempts to maintain. It can scale beyond this capacity if you add more scaling conditions.

You must specify at least one of the following properties: MaxSize, MinSize, or DesiredCapacity.

putScheduledUpdateGroupAction_endTime :: Lens' PutScheduledUpdateGroupAction (Maybe UTCTime) Source #

The date and time for the recurring schedule to end, in UTC. For example, "2021-06-01T00:00:00Z".

putScheduledUpdateGroupAction_recurrence :: Lens' PutScheduledUpdateGroupAction (Maybe Text) Source #

The recurring schedule for this action. This format consists of five fields separated by white spaces: [Minute] [Hour] [Day_of_Month] [Month_of_Year] [Day_of_Week]. The value must be in quotes (for example, "30 0 1 1,6,12 *"). For more information about this format, see Crontab.

When StartTime and EndTime are specified with Recurrence, they form the boundaries of when the recurring action starts and stops.

Cron expressions use Universal Coordinated Time (UTC) by default.

putScheduledUpdateGroupAction_startTime :: Lens' PutScheduledUpdateGroupAction (Maybe UTCTime) Source #

The date and time for this action to start, in YYYY-MM-DDThh:mm:ssZ format in UTC/GMT only and in quotes (for example, "2021-06-01T00:00:00Z").

If you specify Recurrence and StartTime, Amazon EC2 Auto Scaling performs the action at this time, and then performs the action based on the specified recurrence.

putScheduledUpdateGroupAction_timeZone :: Lens' PutScheduledUpdateGroupAction (Maybe Text) Source #

Specifies the time zone for a cron expression. If a time zone is not provided, UTC is used by default.

Valid values are the canonical names of the IANA time zones, derived from the IANA Time Zone Database (such as Etc/GMT+9 or Pacific/Tahiti). For more information, see https://en.wikipedia.org/wiki/List_of_tz_database_time_zones.

PutWarmPool

putWarmPool_instanceReusePolicy :: Lens' PutWarmPool (Maybe InstanceReusePolicy) Source #

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.

putWarmPool_maxGroupPreparedCapacity :: Lens' PutWarmPool (Maybe Int) Source #

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.

putWarmPool_minSize :: Lens' PutWarmPool (Maybe Natural) Source #

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.

putWarmPool_poolState :: Lens' PutWarmPool (Maybe WarmPoolState) Source #

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

putWarmPool_autoScalingGroupName :: Lens' PutWarmPool Text Source #

The name of the Auto Scaling group.

RecordLifecycleActionHeartbeat

recordLifecycleActionHeartbeat_lifecycleActionToken :: Lens' RecordLifecycleActionHeartbeat (Maybe Text) Source #

A token that uniquely identifies a specific lifecycle action associated with an instance. Amazon EC2 Auto Scaling sends this token to the notification target that you specified when you created the lifecycle hook.

ResumeProcesses

resumeProcesses_scalingProcesses :: Lens' ResumeProcesses (Maybe [Text]) Source #

One or more of the following processes:

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

If you omit this property, all processes are specified.

SetDesiredCapacity

setDesiredCapacity_honorCooldown :: Lens' SetDesiredCapacity (Maybe Bool) Source #

Indicates whether Amazon EC2 Auto Scaling waits for the cooldown period to complete before initiating a scaling activity to set your Auto Scaling group to its new capacity. By default, Amazon EC2 Auto Scaling does not honor the cooldown period during manual scaling activities.

setDesiredCapacity_desiredCapacity :: Lens' SetDesiredCapacity Int Source #

The desired capacity is the initial capacity of the Auto Scaling group after this operation completes and the capacity it attempts to maintain.

SetInstanceHealth

setInstanceHealth_shouldRespectGracePeriod :: Lens' SetInstanceHealth (Maybe Bool) Source #

If the Auto Scaling group of the specified instance has a HealthCheckGracePeriod specified for the group, by default, this call respects the grace period. Set this to False, to have the call not respect the grace period associated with the group.

For more information about the health check grace period, see CreateAutoScalingGroup in the Amazon EC2 Auto Scaling API Reference.

setInstanceHealth_healthStatus :: Lens' SetInstanceHealth Text Source #

The health status of the instance. Set to Healthy to have the instance remain in service. Set to Unhealthy to have the instance be out of service. Amazon EC2 Auto Scaling terminates and replaces the unhealthy instance.

SetInstanceProtection

setInstanceProtection_instanceIds :: Lens' SetInstanceProtection [Text] Source #

One or more instance IDs. You can specify up to 50 instances.

setInstanceProtection_protectedFromScaleIn :: Lens' SetInstanceProtection Bool Source #

Indicates whether the instance is protected from termination by Amazon EC2 Auto Scaling when scaling in.

StartInstanceRefresh

startInstanceRefresh_desiredConfiguration :: Lens' StartInstanceRefresh (Maybe DesiredConfiguration) Source #

The desired configuration. For example, the desired configuration can specify a new launch template or a new version of the current launch template.

Once the instance refresh succeeds, Amazon EC2 Auto Scaling updates the settings of the Auto Scaling group to reflect the new desired configuration.

When you specify a new launch template or a new version of the current launch template for your desired configuration, consider enabling the SkipMatching property in preferences. If it's enabled, Amazon EC2 Auto Scaling skips replacing instances that already use the specified launch template and version. This can help you reduce the number of replacements that are required to apply updates.

startInstanceRefresh_preferences :: Lens' StartInstanceRefresh (Maybe RefreshPreferences) Source #

Set of preferences associated with the instance refresh request. If not provided, the default values are used.

startInstanceRefresh_strategy :: Lens' StartInstanceRefresh (Maybe RefreshStrategy) Source #

The strategy to use for the instance refresh. The only valid value is Rolling.

A rolling update helps you update your instances gradually. A rolling update can fail due to failed health checks or if instances are on standby or are protected from scale in. If the rolling update process fails, any instances that are replaced are not rolled back to their previous configuration.

startInstanceRefreshResponse_instanceRefreshId :: Lens' StartInstanceRefreshResponse (Maybe Text) Source #

A unique ID for tracking the progress of the request.

SuspendProcesses

suspendProcesses_scalingProcesses :: Lens' SuspendProcesses (Maybe [Text]) Source #

One or more of the following processes:

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

If you omit this property, all processes are specified.

TerminateInstanceInAutoScalingGroup

terminateInstanceInAutoScalingGroup_shouldDecrementDesiredCapacity :: Lens' TerminateInstanceInAutoScalingGroup Bool Source #

Indicates whether terminating the instance also decrements the size of the Auto Scaling group.

UpdateAutoScalingGroup

updateAutoScalingGroup_availabilityZones :: Lens' UpdateAutoScalingGroup (Maybe [Text]) Source #

One or more Availability Zones for the group.

updateAutoScalingGroup_capacityRebalance :: Lens' UpdateAutoScalingGroup (Maybe Bool) Source #

Enables or disables Capacity Rebalancing. For more information, see Use Capacity Rebalancing to handle Amazon EC2 Spot Interruptions in the Amazon EC2 Auto Scaling User Guide.

updateAutoScalingGroup_defaultCooldown :: Lens' UpdateAutoScalingGroup (Maybe Int) Source #

Only needed if you use simple scaling policies.

The amount of time, in seconds, between one scaling activity ending and another one starting due to simple scaling policies. For more information, see Scaling cooldowns for Amazon EC2 Auto Scaling in the Amazon EC2 Auto Scaling User Guide.

updateAutoScalingGroup_defaultInstanceWarmup :: Lens' UpdateAutoScalingGroup (Maybe Int) Source #

The amount of time, in seconds, until a newly launched instance can contribute to the Amazon CloudWatch metrics. This delay lets an instance finish initializing before Amazon EC2 Auto Scaling aggregates instance metrics, resulting in more reliable usage data. Set this value equal to the amount of time that it takes for resource consumption to become stable after an instance reaches the InService state. For more information, see Set the default instance warmup for an Auto Scaling group in the Amazon EC2 Auto Scaling User Guide.

To manage your warm-up settings at the group level, we recommend that you set the default instance warmup, /even if its value is set to 0 seconds/. This also optimizes the performance of scaling policies that scale continuously, such as target tracking and step scaling policies.

If you need to remove a value that you previously set, include the property but specify -1 for the value. However, we strongly recommend keeping the default instance warmup enabled by specifying a minimum value of 0.

updateAutoScalingGroup_desiredCapacity :: Lens' UpdateAutoScalingGroup (Maybe Int) Source #

The desired capacity is the initial capacity of the Auto Scaling group after this operation completes and the capacity it attempts to maintain. This number must be greater than or equal to the minimum size of the group and less than or equal to the maximum size of the group.

updateAutoScalingGroup_desiredCapacityType :: Lens' UpdateAutoScalingGroup (Maybe Text) Source #

The unit of measurement for the value specified for desired capacity. Amazon EC2 Auto Scaling supports DesiredCapacityType for attribute-based instance type selection only. For more information, see Creating an Auto Scaling group using attribute-based instance type selection in the Amazon EC2 Auto Scaling User Guide.

By default, Amazon EC2 Auto Scaling specifies units, which translates into number of instances.

Valid values: units | vcpu | memory-mib

updateAutoScalingGroup_healthCheckGracePeriod :: Lens' UpdateAutoScalingGroup (Maybe Int) Source #

The amount of time, in seconds, that Amazon EC2 Auto Scaling waits before checking the health status of an EC2 instance that has come into service and marking it unhealthy due to a failed health check. This is useful if your instances do not immediately pass their health checks after they enter the InService state. For more information, see Set the health check grace period for an Auto Scaling group in the Amazon EC2 Auto Scaling User Guide.

updateAutoScalingGroup_healthCheckType :: Lens' UpdateAutoScalingGroup (Maybe Text) Source #

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.

updateAutoScalingGroup_launchConfigurationName :: Lens' UpdateAutoScalingGroup (Maybe Text) Source #

The name of the launch configuration. If you specify LaunchConfigurationName in your update request, you can't specify LaunchTemplate or MixedInstancesPolicy.

updateAutoScalingGroup_launchTemplate :: Lens' UpdateAutoScalingGroup (Maybe LaunchTemplateSpecification) Source #

The launch template and version to use to specify the updates. If you specify LaunchTemplate in your update request, you can't specify LaunchConfigurationName or MixedInstancesPolicy.

updateAutoScalingGroup_maxInstanceLifetime :: Lens' UpdateAutoScalingGroup (Maybe Int) Source #

The maximum amount of time, in seconds, that an instance can be in service. The default is null. If specified, the value must be either 0 or a number equal to or greater than 86,400 seconds (1 day). To clear a previously set value, specify a new value of 0. For more information, see Replacing Auto Scaling instances based on maximum instance lifetime in the Amazon EC2 Auto Scaling User Guide.

updateAutoScalingGroup_maxSize :: Lens' UpdateAutoScalingGroup (Maybe Int) Source #

The maximum size of the Auto Scaling group.

With a mixed instances policy that uses instance weighting, Amazon EC2 Auto Scaling may need to go above MaxSize to meet your capacity requirements. In this event, Amazon EC2 Auto Scaling will never go above MaxSize by more than your largest instance weight (weights that define how many units each instance contributes to the desired capacity of the group).

updateAutoScalingGroup_minSize :: Lens' UpdateAutoScalingGroup (Maybe Int) Source #

The minimum size of the Auto Scaling group.

updateAutoScalingGroup_newInstancesProtectedFromScaleIn :: Lens' UpdateAutoScalingGroup (Maybe Bool) Source #

Indicates whether newly launched instances are protected from termination by Amazon EC2 Auto Scaling when scaling in. For more information about preventing instances from terminating on scale in, see Using instance scale-in protection in the Amazon EC2 Auto Scaling User Guide.

updateAutoScalingGroup_placementGroup :: Lens' UpdateAutoScalingGroup (Maybe Text) Source #

The name of an existing placement group into which to launch your instances. For more information, see Placement groups in the Amazon EC2 User Guide for Linux Instances.

A cluster placement group is a logical grouping of instances within a single Availability Zone. You cannot specify multiple Availability Zones and a cluster placement group.

updateAutoScalingGroup_serviceLinkedRoleARN :: Lens' UpdateAutoScalingGroup (Maybe Text) Source #

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. For more information, see Service-linked roles in the Amazon EC2 Auto Scaling User Guide.

updateAutoScalingGroup_terminationPolicies :: Lens' UpdateAutoScalingGroup (Maybe [Text]) Source #

A policy or a list of policies that are used to select the instances to terminate. The policies are executed in the order that you list them. For more information, see Work with Amazon EC2 Auto Scaling termination policies in the Amazon EC2 Auto Scaling User Guide.

Valid values: Default | AllocationStrategy | ClosestToNextInstanceHour | NewestInstance | OldestInstance | OldestLaunchConfiguration | OldestLaunchTemplate | arn:aws:lambda:region:account-id:function:my-function:my-alias

updateAutoScalingGroup_vPCZoneIdentifier :: Lens' UpdateAutoScalingGroup (Maybe Text) Source #

A comma-separated list of subnet IDs for a virtual private cloud (VPC). If you specify VPCZoneIdentifier with AvailabilityZones, the subnets that you specify must reside in those Availability Zones.

Types

AcceleratorCountRequest

AcceleratorTotalMemoryMiBRequest

Activity

activity_autoScalingGroupARN :: Lens' Activity (Maybe Text) Source #

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

activity_autoScalingGroupState :: Lens' Activity (Maybe Text) Source #

The state of the Auto Scaling group, which is either InService or Deleted.

activity_description :: Lens' Activity (Maybe Text) Source #

A friendly, more verbose description of the activity.

activity_details :: Lens' Activity (Maybe Text) Source #

The details about the activity.

activity_endTime :: Lens' Activity (Maybe UTCTime) Source #

The end time of the activity.

activity_progress :: Lens' Activity (Maybe Int) Source #

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

activity_statusMessage :: Lens' Activity (Maybe Text) Source #

A friendly, more verbose description of the activity status.

activity_activityId :: Lens' Activity Text Source #

The ID of the activity.

activity_autoScalingGroupName :: Lens' Activity Text Source #

The name of the Auto Scaling group.

activity_cause :: Lens' Activity Text Source #

The reason the activity began.

activity_startTime :: Lens' Activity UTCTime Source #

The start time of the activity.

activity_statusCode :: Lens' Activity ScalingActivityStatusCode Source #

The current status of the activity.

AdjustmentType

adjustmentType_adjustmentType :: Lens' AdjustmentType (Maybe Text) Source #

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

Alarm

alarm_alarmARN :: Lens' Alarm (Maybe Text) Source #

The Amazon Resource Name (ARN) of the alarm.

alarm_alarmName :: Lens' Alarm (Maybe Text) Source #

The name of the alarm.

AutoScalingGroup

autoScalingGroup_autoScalingGroupARN :: Lens' AutoScalingGroup (Maybe Text) Source #

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

autoScalingGroup_capacityRebalance :: Lens' AutoScalingGroup (Maybe Bool) Source #

Indicates whether Capacity Rebalancing is enabled.

autoScalingGroup_defaultInstanceWarmup :: Lens' AutoScalingGroup (Maybe Int) Source #

The duration of the default instance warmup, in seconds.

autoScalingGroup_desiredCapacityType :: Lens' AutoScalingGroup (Maybe Text) Source #

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_healthCheckGracePeriod :: Lens' AutoScalingGroup (Maybe Int) Source #

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

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

The EC2 instances associated with the group.

autoScalingGroup_launchConfigurationName :: Lens' AutoScalingGroup (Maybe Text) Source #

The name of the associated launch configuration.

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

One or more load balancers associated with the group.

autoScalingGroup_maxInstanceLifetime :: Lens' AutoScalingGroup (Maybe Int) Source #

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

Valid Range: Minimum value of 0.

autoScalingGroup_newInstancesProtectedFromScaleIn :: Lens' AutoScalingGroup (Maybe Bool) Source #

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

autoScalingGroup_placementGroup :: Lens' AutoScalingGroup (Maybe Text) Source #

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

autoScalingGroup_predictedCapacity :: Lens' AutoScalingGroup (Maybe Int) Source #

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

autoScalingGroup_serviceLinkedRoleARN :: Lens' AutoScalingGroup (Maybe Text) Source #

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) Source #

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

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

The suspended processes associated with the group.

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

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

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

The termination policies for the group.

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

The unique identifiers of the traffic sources.

autoScalingGroup_vPCZoneIdentifier :: Lens' AutoScalingGroup (Maybe Text) Source #

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

autoScalingGroup_warmPoolSize :: Lens' AutoScalingGroup (Maybe Int) Source #

The current size of the warm pool.

autoScalingGroup_minSize :: Lens' AutoScalingGroup Int Source #

The minimum size of the group.

autoScalingGroup_maxSize :: Lens' AutoScalingGroup Int Source #

The maximum size of the group.

autoScalingGroup_defaultCooldown :: Lens' AutoScalingGroup Int Source #

The duration of the default cooldown period, in seconds.

autoScalingGroup_availabilityZones :: Lens' AutoScalingGroup [Text] Source #

One or more Availability Zones for the group.

autoScalingGroup_healthCheckType :: Lens' AutoScalingGroup Text Source #

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 Source #

The date and time the group was created.

AutoScalingInstanceDetails

autoScalingInstanceDetails_launchConfigurationName :: Lens' AutoScalingInstanceDetails (Maybe Text) Source #

The launch configuration used to launch the instance. This value is not available if you attached the instance to the Auto Scaling group.

autoScalingInstanceDetails_weightedCapacity :: Lens' AutoScalingInstanceDetails (Maybe Text) Source #

The number of capacity units contributed by the instance based on its instance type.

Valid Range: Minimum value of 1. Maximum value of 999.

autoScalingInstanceDetails_autoScalingGroupName :: Lens' AutoScalingInstanceDetails Text Source #

The name of the Auto Scaling group for the instance.

autoScalingInstanceDetails_lifecycleState :: Lens' AutoScalingInstanceDetails Text Source #

The lifecycle state for the instance. The Quarantined state is not used. For information about lifecycle states, see Instance lifecycle in the Amazon EC2 Auto Scaling User Guide.

Valid values: Pending | Pending:Wait | Pending:Proceed | Quarantined | InService | Terminating | Terminating:Wait | Terminating:Proceed | Terminated | Detaching | Detached | EnteringStandby | Standby | Warmed:Pending | Warmed:Pending:Wait | Warmed:Pending:Proceed | Warmed:Terminating | Warmed:Terminating:Wait | Warmed:Terminating:Proceed | Warmed:Terminated | Warmed:Stopped | Warmed:Running

autoScalingInstanceDetails_healthStatus :: Lens' AutoScalingInstanceDetails Text Source #

The last reported 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 Amazon EC2 Auto Scaling should terminate and replace it.

autoScalingInstanceDetails_protectedFromScaleIn :: Lens' AutoScalingInstanceDetails Bool Source #

Indicates whether the instance is protected from termination by Amazon EC2 Auto Scaling when scaling in.

BaselineEbsBandwidthMbpsRequest

BlockDeviceMapping

blockDeviceMapping_ebs :: Lens' BlockDeviceMapping (Maybe Ebs) Source #

Information to attach an EBS volume to an instance at launch.

blockDeviceMapping_noDevice :: Lens' BlockDeviceMapping (Maybe Bool) Source #

Setting this value to true prevents a volume that is included in the block device mapping of the AMI from being mapped to the specified device name at launch.

If NoDevice is true for the root device, instances might fail the EC2 health check. In that case, Amazon EC2 Auto Scaling launches replacement instances.

blockDeviceMapping_virtualName :: Lens' BlockDeviceMapping (Maybe Text) Source #

The name of the instance store volume (virtual device) to attach to an instance at launch. The name must be in the form ephemeralX where X is a number starting from zero (0), for example, ephemeral0.

blockDeviceMapping_deviceName :: Lens' BlockDeviceMapping Text Source #

The device name assigned to the volume (for example, /dev/sdh or xvdh). For more information, see Device naming on Linux instances in the Amazon EC2 User Guide for Linux Instances.

To define a block device mapping, set the device name and exactly one of the following properties: Ebs, NoDevice, or VirtualName.

CapacityForecast

capacityForecast_timestamps :: Lens' CapacityForecast [UTCTime] Source #

The timestamps for the data points, in UTC format.

capacityForecast_values :: Lens' CapacityForecast [Double] Source #

The values of the data points.

CustomizedMetricSpecification

customizedMetricSpecification_dimensions :: Lens' CustomizedMetricSpecification (Maybe [MetricDimension]) Source #

The dimensions of the metric.

Conditional: If you published your metric with dimensions, you must specify the same dimensions in your scaling policy.

customizedMetricSpecification_metricName :: Lens' CustomizedMetricSpecification (Maybe Text) Source #

The name of the metric. To get the exact metric name, namespace, and dimensions, inspect the Metric object that is returned by a call to ListMetrics.

customizedMetricSpecification_metrics :: Lens' CustomizedMetricSpecification (Maybe [TargetTrackingMetricDataQuery]) Source #

The metrics to include in the target tracking scaling policy, as a metric data query. This can include both raw metric and metric math expressions.

customizedMetricSpecification_unit :: Lens' CustomizedMetricSpecification (Maybe Text) Source #

The unit of the metric. For a complete list of the units that CloudWatch supports, see the MetricDatum data type in the Amazon CloudWatch API Reference.

DesiredConfiguration

Ebs

ebs_deleteOnTermination :: Lens' Ebs (Maybe Bool) Source #

Indicates whether the volume is deleted on instance termination. For Amazon EC2 Auto Scaling, the default value is true.

ebs_encrypted :: Lens' Ebs (Maybe Bool) Source #

Specifies whether the volume should be encrypted. Encrypted EBS volumes can only be attached to instances that support Amazon EBS encryption. For more information, see Supported instance types. If your AMI uses encrypted volumes, you can also only launch it on supported instance types.

If you are creating a volume from a snapshot, you cannot create an unencrypted volume from an encrypted snapshot. Also, you cannot specify a KMS key ID when using a launch configuration.

If you enable encryption by default, the EBS volumes that you create are always encrypted, either using the Amazon Web Services managed KMS key or a customer-managed KMS key, regardless of whether the snapshot was encrypted.

For more information, see Use Amazon Web Services KMS keys to encrypt Amazon EBS volumes in the Amazon EC2 Auto Scaling User Guide.

ebs_iops :: Lens' Ebs (Maybe Natural) Source #

The number of input/output (I/O) operations per second (IOPS) to provision for the volume. For gp3 and io1 volumes, this represents the number of IOPS that are provisioned for the volume. For gp2 volumes, this represents the baseline performance of the volume and the rate at which the volume accumulates I/O credits for bursting.

The following are the supported values for each volume type:

  • gp3: 3,000-16,000 IOPS
  • io1: 100-64,000 IOPS

For io1 volumes, we guarantee 64,000 IOPS only for Instances built on the Nitro System. Other instance families guarantee performance up to 32,000 IOPS.

Iops is supported when the volume type is gp3 or io1 and required only when the volume type is io1. (Not used with standard, gp2, st1, or sc1 volumes.)

ebs_snapshotId :: Lens' Ebs (Maybe Text) Source #

The snapshot ID of the volume to use.

You must specify either a VolumeSize or a SnapshotId.

ebs_throughput :: Lens' Ebs (Maybe Natural) Source #

The throughput (MiBps) to provision for a gp3 volume.

ebs_volumeSize :: Lens' Ebs (Maybe Natural) Source #

The volume size, in GiBs. The following are the supported volumes sizes for each volume type:

  • gp2 and gp3: 1-16,384
  • io1: 4-16,384
  • st1 and sc1: 125-16,384
  • standard: 1-1,024

You must specify either a SnapshotId or a VolumeSize. If you specify both SnapshotId and VolumeSize, the volume size must be equal or greater than the size of the snapshot.

ebs_volumeType :: Lens' Ebs (Maybe Text) Source #

The volume type. For more information, see Amazon EBS volume types in the Amazon EC2 User Guide for Linux Instances.

Valid values: standard | io1 | gp2 | st1 | sc1 | gp3

EnabledMetric

enabledMetric_granularity :: Lens' EnabledMetric (Maybe Text) Source #

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

enabledMetric_metric :: Lens' EnabledMetric (Maybe Text) Source #

One of the following metrics:

  • GroupMinSize
  • GroupMaxSize
  • GroupDesiredCapacity
  • GroupInServiceInstances
  • GroupPendingInstances
  • GroupStandbyInstances
  • GroupTerminatingInstances
  • GroupTotalInstances
  • GroupInServiceCapacity
  • GroupPendingCapacity
  • GroupStandbyCapacity
  • GroupTerminatingCapacity
  • GroupTotalCapacity
  • WarmPoolDesiredCapacity
  • WarmPoolWarmedCapacity
  • WarmPoolPendingCapacity
  • WarmPoolTerminatingCapacity
  • WarmPoolTotalCapacity
  • GroupAndWarmPoolDesiredCapacity
  • GroupAndWarmPoolTotalCapacity

For more information, see Auto Scaling group metrics in the Amazon EC2 Auto Scaling User Guide.

FailedScheduledUpdateGroupActionRequest

Filter

filter_values :: Lens' Filter (Maybe [Text]) Source #

One or more filter values. Filter values are case-sensitive.

If you specify multiple values for a filter, the values are automatically logically joined with an OR, and the request returns all results that match any of the specified values. For example, specify "tag:environment" for the filter name and "production,development" for the filter values to find Auto Scaling groups with the tag "environment=production" or "environment=development".

filter_name :: Lens' Filter Text Source #

The name of the filter.

The valid values for Name depend on which API operation you're using with the filter (DescribeAutoScalingGroups or DescribeTags).

DescribeAutoScalingGroups

Valid values for Name include the following:

  • tag-key - Accepts tag keys. The results only include information about the Auto Scaling groups associated with these tag keys.
  • tag-value - Accepts tag values. The results only include information about the Auto Scaling groups associated with these tag values.
  • tag:<key> - Accepts the key/value combination of the tag. Use the tag key in the filter name and the tag value as the filter value. The results only include information about the Auto Scaling groups associated with the specified key/value combination.

DescribeTags

Valid values for Name include the following:

  • auto-scaling-group - Accepts the names of Auto Scaling groups. The results only include information about the tags associated with these Auto Scaling groups.
  • key - Accepts tag keys. The results only include information about the tags associated with these tag keys.
  • value - Accepts tag values. The results only include information about the tags associated with these tag values.
  • propagate-at-launch - Accepts a Boolean value, which specifies whether tags propagate to instances at launch. The results only include information about the tags associated with the specified Boolean value.

Instance

instance_instanceType :: Lens' Instance (Maybe Text) Source #

The instance type of the EC2 instance.

instance_launchConfigurationName :: Lens' Instance (Maybe Text) Source #

The launch configuration associated with the instance.

instance_weightedCapacity :: Lens' Instance (Maybe Text) Source #

The number of capacity units contributed by the instance based on its instance type.

Valid Range: Minimum value of 1. Maximum value of 999.

instance_instanceId :: Lens' Instance Text Source #

The ID of the instance.

instance_availabilityZone :: Lens' Instance Text Source #

The Availability Zone in which the instance is running.

instance_lifecycleState :: Lens' Instance LifecycleState Source #

A description of the current lifecycle state. The Quarantined state is not used. For information about lifecycle states, see Instance lifecycle in the Amazon EC2 Auto Scaling User Guide.

instance_healthStatus :: Lens' Instance Text Source #

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

instance_protectedFromScaleIn :: Lens' Instance Bool Source #

Indicates whether the instance is protected from termination by Amazon EC2 Auto Scaling when scaling in.

InstanceMetadataOptions

instanceMetadataOptions_httpEndpoint :: Lens' InstanceMetadataOptions (Maybe InstanceMetadataEndpointState) Source #

This parameter enables or disables the HTTP metadata endpoint on your instances. If the parameter is not specified, the default state is enabled.

If you specify a value of disabled, you will not be able to access your instance metadata.

instanceMetadataOptions_httpPutResponseHopLimit :: Lens' InstanceMetadataOptions (Maybe Natural) Source #

The desired HTTP PUT response hop limit for instance metadata requests. The larger the number, the further instance metadata requests can travel.

Default: 1

instanceMetadataOptions_httpTokens :: Lens' InstanceMetadataOptions (Maybe InstanceMetadataHttpTokensState) Source #

The state of token usage for your instance metadata requests. If the parameter is not specified in the request, the default state is optional.

If the state is optional, you can choose to retrieve instance metadata with or without a signed token header on your request. If you retrieve the IAM role credentials without a token, the version 1.0 role credentials are returned. If you retrieve the IAM role credentials using a valid signed token, the version 2.0 role credentials are returned.

If the state is required, you must send a signed token header with any instance metadata retrieval requests. In this state, retrieving the IAM role credentials always returns the version 2.0 credentials; the version 1.0 credentials are not available.

InstanceMonitoring

instanceMonitoring_enabled :: Lens' InstanceMonitoring (Maybe Bool) Source #

If true, detailed monitoring is enabled. Otherwise, basic monitoring is enabled.

InstanceRefresh

instanceRefresh_desiredConfiguration :: Lens' InstanceRefresh (Maybe DesiredConfiguration) Source #

Describes the specific update you want to deploy.

instanceRefresh_endTime :: Lens' InstanceRefresh (Maybe UTCTime) Source #

The date and time at which the instance refresh ended.

instanceRefresh_instancesToUpdate :: Lens' InstanceRefresh (Maybe Natural) Source #

The number of instances remaining to update before the instance refresh is complete.

instanceRefresh_percentageComplete :: Lens' InstanceRefresh (Maybe Natural) Source #

The percentage of the instance refresh that is complete. For each instance replacement, Amazon EC2 Auto Scaling tracks the instance's health status and warm-up time. When the instance's health status changes to healthy and the specified warm-up time passes, the instance is considered updated and is added to the percentage complete.

instanceRefresh_progressDetails :: Lens' InstanceRefresh (Maybe InstanceRefreshProgressDetails) Source #

Additional progress details for an Auto Scaling group that has a warm pool.

instanceRefresh_startTime :: Lens' InstanceRefresh (Maybe UTCTime) Source #

The date and time at which the instance refresh began.

instanceRefresh_status :: Lens' InstanceRefresh (Maybe InstanceRefreshStatus) Source #

The current status for the instance refresh operation:

  • Pending - The request was created, but the operation has not started.
  • InProgress - The operation is in progress.
  • Successful - The operation completed successfully.
  • Failed - The operation failed to complete. You can troubleshoot using the status reason and the scaling activities.
  • Cancelling - An ongoing operation is being cancelled. Cancellation does not roll back any replacements that have already been completed, but it prevents new replacements from being started.
  • Cancelled - The operation is cancelled.

instanceRefresh_statusReason :: Lens' InstanceRefresh (Maybe Text) Source #

Provides more details about the current status of the instance refresh.

InstanceRefreshLivePoolProgress

instanceRefreshLivePoolProgress_percentageComplete :: Lens' InstanceRefreshLivePoolProgress (Maybe Natural) Source #

The percentage of instances in the Auto Scaling group that have been replaced. For each instance replacement, Amazon EC2 Auto Scaling tracks the instance's health status and warm-up time. When the instance's health status changes to healthy and the specified warm-up time passes, the instance is considered updated and is added to the percentage complete.

InstanceRefreshProgressDetails

instanceRefreshProgressDetails_livePoolProgress :: Lens' InstanceRefreshProgressDetails (Maybe InstanceRefreshLivePoolProgress) Source #

Indicates the progress of an instance refresh on instances that are in the Auto Scaling group.

instanceRefreshProgressDetails_warmPoolProgress :: Lens' InstanceRefreshProgressDetails (Maybe InstanceRefreshWarmPoolProgress) Source #

Indicates the progress of an instance refresh on instances that are in the warm pool.

InstanceRefreshWarmPoolProgress

instanceRefreshWarmPoolProgress_percentageComplete :: Lens' InstanceRefreshWarmPoolProgress (Maybe Natural) Source #

The percentage of instances in the warm pool that have been replaced. For each instance replacement, Amazon EC2 Auto Scaling tracks the instance's health status and warm-up time. When the instance's health status changes to healthy and the specified warm-up time passes, the instance is considered updated and is added to the percentage complete.

InstanceRequirements

instanceRequirements_acceleratorCount :: Lens' InstanceRequirements (Maybe AcceleratorCountRequest) Source #

The minimum and maximum number of accelerators (GPUs, FPGAs, or Amazon Web Services Inferentia chips) for an instance type.

To exclude accelerator-enabled instance types, set Max to 0.

Default: No minimum or maximum limits

instanceRequirements_acceleratorManufacturers :: Lens' InstanceRequirements (Maybe [AcceleratorManufacturer]) Source #

Indicates whether instance types must have accelerators by specific manufacturers.

  • For instance types with NVIDIA devices, specify nvidia.
  • For instance types with AMD devices, specify amd.
  • For instance types with Amazon Web Services devices, specify amazon-web-services.
  • For instance types with Xilinx devices, specify xilinx.

Default: Any manufacturer

instanceRequirements_acceleratorNames :: Lens' InstanceRequirements (Maybe [AcceleratorName]) Source #

Lists the accelerators that must be on an instance type.

  • For instance types with NVIDIA A100 GPUs, specify a100.
  • For instance types with NVIDIA V100 GPUs, specify v100.
  • For instance types with NVIDIA K80 GPUs, specify k80.
  • For instance types with NVIDIA T4 GPUs, specify t4.
  • For instance types with NVIDIA M60 GPUs, specify m60.
  • For instance types with AMD Radeon Pro V520 GPUs, specify radeon-pro-v520.
  • For instance types with Xilinx VU9P FPGAs, specify vu9p.

Default: Any accelerator

instanceRequirements_acceleratorTotalMemoryMiB :: Lens' InstanceRequirements (Maybe AcceleratorTotalMemoryMiBRequest) Source #

The minimum and maximum total memory size for the accelerators on an instance type, in MiB.

Default: No minimum or maximum limits

instanceRequirements_acceleratorTypes :: Lens' InstanceRequirements (Maybe [AcceleratorType]) Source #

Lists the accelerator types that must be on an instance type.

  • For instance types with GPU accelerators, specify gpu.
  • For instance types with FPGA accelerators, specify fpga.
  • For instance types with inference accelerators, specify inference.

Default: Any accelerator type

instanceRequirements_allowedInstanceTypes :: Lens' InstanceRequirements (Maybe [Text]) Source #

The instance types to apply your specified attributes against. All other instance types are ignored, even if they match your specified attributes.

You can use strings with one or more wild cards, represented by an asterisk (*), to allow an instance type, size, or generation. The following are examples: m5.8xlarge, c5*.*, m5a.*, r*, *3*.

For example, if you specify c5*, Amazon EC2 Auto Scaling will allow the entire C5 instance family, which includes all C5a and C5n instance types. If you specify m5a.*, Amazon EC2 Auto Scaling will allow all the M5a instance types, but not the M5n instance types.

If you specify AllowedInstanceTypes, you can't specify ExcludedInstanceTypes.

Default: All instance types

instanceRequirements_bareMetal :: Lens' InstanceRequirements (Maybe BareMetal) Source #

Indicates whether bare metal instance types are included, excluded, or required.

Default: excluded

instanceRequirements_baselineEbsBandwidthMbps :: Lens' InstanceRequirements (Maybe BaselineEbsBandwidthMbpsRequest) Source #

The minimum and maximum baseline bandwidth performance for an instance type, in Mbps. For more information, see Amazon EBS–optimized instances in the Amazon EC2 User Guide for Linux Instances.

Default: No minimum or maximum limits

instanceRequirements_burstablePerformance :: Lens' InstanceRequirements (Maybe BurstablePerformance) Source #

Indicates whether burstable performance instance types are included, excluded, or required. For more information, see Burstable performance instances in the Amazon EC2 User Guide for Linux Instances.

Default: excluded

instanceRequirements_cpuManufacturers :: Lens' InstanceRequirements (Maybe [CpuManufacturer]) Source #

Lists which specific CPU manufacturers to include.

  • For instance types with Intel CPUs, specify intel.
  • For instance types with AMD CPUs, specify amd.
  • For instance types with Amazon Web Services CPUs, specify amazon-web-services.

Don't confuse the CPU hardware manufacturer with the CPU hardware architecture. Instances will be launched with a compatible CPU architecture based on the Amazon Machine Image (AMI) that you specify in your launch template.

Default: Any manufacturer

instanceRequirements_excludedInstanceTypes :: Lens' InstanceRequirements (Maybe [Text]) Source #

The instance types to exclude. You can use strings with one or more wild cards, represented by an asterisk (*), to exclude an instance family, type, size, or generation. The following are examples: m5.8xlarge, c5*.*, m5a.*, r*, *3*.

For example, if you specify c5*, you are excluding the entire C5 instance family, which includes all C5a and C5n instance types. If you specify m5a.*, Amazon EC2 Auto Scaling will exclude all the M5a instance types, but not the M5n instance types.

If you specify ExcludedInstanceTypes, you can't specify AllowedInstanceTypes.

Default: No excluded instance types

instanceRequirements_instanceGenerations :: Lens' InstanceRequirements (Maybe [InstanceGeneration]) Source #

Indicates whether current or previous generation instance types are included.

  • For current generation instance types, specify current. The current generation includes EC2 instance types currently recommended for use. This typically includes the latest two to three generations in each instance family. For more information, see Instance types in the Amazon EC2 User Guide for Linux Instances.
  • For previous generation instance types, specify previous.

Default: Any current or previous generation

instanceRequirements_localStorage :: Lens' InstanceRequirements (Maybe LocalStorage) Source #

Indicates whether instance types with instance store volumes are included, excluded, or required. For more information, see Amazon EC2 instance store in the Amazon EC2 User Guide for Linux Instances.

Default: included

instanceRequirements_localStorageTypes :: Lens' InstanceRequirements (Maybe [LocalStorageType]) Source #

Indicates the type of local storage that is required.

  • For instance types with hard disk drive (HDD) storage, specify hdd.
  • For instance types with solid state drive (SSD) storage, specify ssd.

Default: Any local storage type

instanceRequirements_memoryGiBPerVCpu :: Lens' InstanceRequirements (Maybe MemoryGiBPerVCpuRequest) Source #

The minimum and maximum amount of memory per vCPU for an instance type, in GiB.

Default: No minimum or maximum limits

instanceRequirements_networkBandwidthGbps :: Lens' InstanceRequirements (Maybe NetworkBandwidthGbpsRequest) Source #

The minimum and maximum amount of network bandwidth, in gigabits per second (Gbps).

Default: No minimum or maximum limits

instanceRequirements_networkInterfaceCount :: Lens' InstanceRequirements (Maybe NetworkInterfaceCountRequest) Source #

The minimum and maximum number of network interfaces for an instance type.

Default: No minimum or maximum limits

instanceRequirements_onDemandMaxPricePercentageOverLowestPrice :: Lens' InstanceRequirements (Maybe Natural) Source #

The price protection threshold for On-Demand Instances. This is the maximum you’ll pay for an On-Demand Instance, expressed as a percentage higher than the least expensive current generation M, C, or R instance type with your specified attributes. When Amazon EC2 Auto Scaling selects instance types with your attributes, we will exclude instance types whose price is higher than your threshold. The parameter accepts an integer, which Amazon EC2 Auto Scaling interprets as a percentage. To turn off price protection, specify a high value, such as 999999.

If you set DesiredCapacityType to vcpu or memory-mib, the price protection threshold is applied based on the per vCPU or per memory price instead of the per instance price.

Default: 20

instanceRequirements_requireHibernateSupport :: Lens' InstanceRequirements (Maybe Bool) Source #

Indicates whether instance types must provide On-Demand Instance hibernation support.

Default: false

instanceRequirements_spotMaxPricePercentageOverLowestPrice :: Lens' InstanceRequirements (Maybe Natural) Source #

The price protection threshold for Spot Instances. This is the maximum you’ll pay for a Spot Instance, expressed as a percentage higher than the least expensive current generation M, C, or R instance type with your specified attributes. When Amazon EC2 Auto Scaling selects instance types with your attributes, we will exclude instance types whose price is higher than your threshold. The parameter accepts an integer, which Amazon EC2 Auto Scaling interprets as a percentage. To turn off price protection, specify a high value, such as 999999.

If you set DesiredCapacityType to vcpu or memory-mib, the price protection threshold is applied based on the per vCPU or per memory price instead of the per instance price.

Default: 100

instanceRequirements_totalLocalStorageGB :: Lens' InstanceRequirements (Maybe TotalLocalStorageGBRequest) Source #

The minimum and maximum total local storage size for an instance type, in GB.

Default: No minimum or maximum limits

instanceRequirements_vCpuCount :: Lens' InstanceRequirements VCpuCountRequest Source #

The minimum and maximum number of vCPUs for an instance type.

instanceRequirements_memoryMiB :: Lens' InstanceRequirements MemoryMiBRequest Source #

The minimum and maximum instance memory size for an instance type, in MiB.

InstanceReusePolicy

instanceReusePolicy_reuseOnScaleIn :: Lens' InstanceReusePolicy (Maybe Bool) Source #

Specifies whether instances in the Auto Scaling group can be returned to the warm pool on scale in.

InstancesDistribution

instancesDistribution_onDemandAllocationStrategy :: Lens' InstancesDistribution (Maybe Text) Source #

The allocation strategy to apply to your On-Demand Instances when they are launched. Possible instance types are determined by the launch template overrides that you specify.

The following lists the valid values:

lowest-price
Uses price to determine which instance types are the highest priority, launching the lowest priced instance types within an Availability Zone first. This is the default value for Auto Scaling groups that specify InstanceRequirements.
prioritized
You set the order of instance types for the launch template overrides from highest to lowest priority (from first to last in the list). Amazon EC2 Auto Scaling launches your highest priority instance types first. If all your On-Demand capacity cannot be fulfilled using your highest priority instance type, then Amazon EC2 Auto Scaling launches the remaining capacity using the second priority instance type, and so on. This is the default value for Auto Scaling groups that don't specify InstanceRequirements and cannot be used for groups that do.

instancesDistribution_onDemandBaseCapacity :: Lens' InstancesDistribution (Maybe Int) Source #

The minimum amount of the Auto Scaling group's capacity that must be fulfilled by On-Demand Instances. This base portion is launched first as your group scales.

This number has the same unit of measurement as the group's desired capacity. If you change the default unit of measurement (number of instances) by specifying weighted capacity values in your launch template overrides list, or by changing the default desired capacity type setting of the group, you must specify this number using the same unit of measurement.

Default: 0

instancesDistribution_onDemandPercentageAboveBaseCapacity :: Lens' InstancesDistribution (Maybe Int) Source #

Controls the percentages of On-Demand Instances and Spot Instances for your additional capacity beyond OnDemandBaseCapacity. Expressed as a number (for example, 20 specifies 20% On-Demand Instances, 80% Spot Instances). If set to 100, only On-Demand Instances are used.

Default: 100

instancesDistribution_spotAllocationStrategy :: Lens' InstancesDistribution (Maybe Text) Source #

The allocation strategy to apply to your Spot Instances when they are launched. Possible instance types are determined by the launch template overrides that you specify.

The following lists the valid values:

capacity-optimized
Requests Spot Instances using pools that are optimally chosen based on the available Spot capacity. This strategy has the lowest risk of interruption. To give certain instance types a higher chance of launching first, use capacity-optimized-prioritized.
capacity-optimized-prioritized
You set the order of instance types for the launch template overrides from highest to lowest priority (from first to last in the list). Amazon EC2 Auto Scaling honors the instance type priorities on a best effort basis but optimizes for capacity first. Note that if the On-Demand allocation strategy is set to prioritized, the same priority is applied when fulfilling On-Demand capacity. This is not a valid value for Auto Scaling groups that specify InstanceRequirements.
lowest-price
Requests Spot Instances using the lowest priced pools within an Availability Zone, across the number of Spot pools that you specify for the SpotInstancePools property. To ensure that your desired capacity is met, you might receive Spot Instances from several pools. This is the default value, but it might lead to high interruption rates because this strategy only considers instance price and not available capacity.
price-capacity-optimized (recommended)
The price and capacity optimized allocation strategy looks at both price and capacity to select the Spot Instance pools that are the least likely to be interrupted and have the lowest possible price.

instancesDistribution_spotInstancePools :: Lens' InstancesDistribution (Maybe Int) Source #

The number of Spot Instance pools across which to allocate your Spot Instances. The Spot pools are determined from the different instance types in the overrides. Valid only when the SpotAllocationStrategy is lowest-price. Value must be in the range of 1–20.

Default: 2

instancesDistribution_spotMaxPrice :: Lens' InstancesDistribution (Maybe Text) Source #

The maximum price per unit hour that you are willing to pay for a Spot Instance. If your maximum price is lower than the Spot price for the instance types that you selected, your Spot Instances are not launched. We do not recommend specifying a maximum price because it can lead to increased interruptions. When Spot Instances launch, you pay the current Spot price. To remove a maximum price that you previously set, include the property but specify an empty string ("") for the value.

If you specify a maximum price, your instances will be interrupted more frequently than if you do not specify one.

Valid Range: Minimum value of 0.001

LaunchConfiguration

launchConfiguration_associatePublicIpAddress :: Lens' LaunchConfiguration (Maybe Bool) Source #

Specifies whether to assign a public IPv4 address to the group's instances. If the instance is launched into a default subnet, the default is to assign a public IPv4 address, unless you disabled the option to assign a public IPv4 address on the subnet. If the instance is launched into a nondefault subnet, the default is not to assign a public IPv4 address, unless you enabled the option to assign a public IPv4 address on the subnet. For more information, see Launching Auto Scaling instances in a VPC in the Amazon EC2 Auto Scaling User Guide.

launchConfiguration_blockDeviceMappings :: Lens' LaunchConfiguration (Maybe [BlockDeviceMapping]) Source #

The block device mapping entries that define the block devices to attach to the instances at launch. By default, the block devices specified in the block device mapping for the AMI are used. For more information, see Block Device Mapping in the Amazon EC2 User Guide for Linux Instances.

launchConfiguration_ebsOptimized :: Lens' LaunchConfiguration (Maybe Bool) Source #

Specifies whether the launch configuration is optimized for EBS I/O (true) or not (false). For more information, see Amazon EBS-Optimized Instances in the Amazon EC2 User Guide for Linux Instances.

launchConfiguration_iamInstanceProfile :: Lens' LaunchConfiguration (Maybe Text) Source #

The name or the Amazon Resource Name (ARN) of the instance profile associated with the IAM role for the instance. The instance profile contains the IAM role. For more information, see IAM role for applications that run on Amazon EC2 instances in the Amazon EC2 Auto Scaling User Guide.

launchConfiguration_instanceMonitoring :: Lens' LaunchConfiguration (Maybe InstanceMonitoring) Source #

Controls whether instances in this group are launched with detailed (true) or basic (false) monitoring.

For more information, see Configure Monitoring for Auto Scaling Instances in the Amazon EC2 Auto Scaling User Guide.

launchConfiguration_kernelId :: Lens' LaunchConfiguration (Maybe Text) Source #

The ID of the kernel associated with the AMI.

launchConfiguration_keyName :: Lens' LaunchConfiguration (Maybe Text) Source #

The name of the key pair.

For more information, see Amazon EC2 Key Pairs in the Amazon EC2 User Guide for Linux Instances.

launchConfiguration_launchConfigurationARN :: Lens' LaunchConfiguration (Maybe Text) Source #

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

launchConfiguration_metadataOptions :: Lens' LaunchConfiguration (Maybe InstanceMetadataOptions) Source #

The metadata options for the instances. For more information, see Configuring the Instance Metadata Options in the Amazon EC2 Auto Scaling User Guide.

launchConfiguration_placementTenancy :: Lens' LaunchConfiguration (Maybe Text) Source #

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

For more information, see Configuring instance tenancy with Amazon EC2 Auto Scaling in the Amazon EC2 Auto Scaling User Guide.

launchConfiguration_ramdiskId :: Lens' LaunchConfiguration (Maybe Text) Source #

The ID of the RAM disk associated with the AMI.

launchConfiguration_securityGroups :: Lens' LaunchConfiguration (Maybe [Text]) Source #

A list that contains the security groups to assign to the instances in the Auto Scaling group. For more information, see Security Groups for Your VPC in the Amazon Virtual Private Cloud User Guide.

launchConfiguration_spotPrice :: Lens' LaunchConfiguration (Maybe Text) Source #

The maximum hourly price to be paid for any Spot Instance launched to fulfill the request. Spot Instances are launched when the price you specify exceeds the current Spot price. For more information, see Requesting Spot Instances in the Amazon EC2 Auto Scaling User Guide.

launchConfiguration_userData :: Lens' LaunchConfiguration (Maybe Text) Source #

The user data to make available to the launched EC2 instances. For more information, see Instance metadata and user data (Linux) and Instance metadata and user data (Windows). If you are using a command line tool, base64-encoding is performed for you, and you can load the text from a file. Otherwise, you must provide base64-encoded text. User data is limited to 16 KB.

launchConfiguration_imageId :: Lens' LaunchConfiguration Text Source #

The ID of the Amazon Machine Image (AMI) to use to launch your EC2 instances. For more information, see Find a Linux AMI in the Amazon EC2 User Guide for Linux Instances.

launchConfiguration_instanceType :: Lens' LaunchConfiguration Text Source #

The instance type for the instances. For information about available instance types, see Available instance types in the Amazon EC2 User Guide for Linux Instances.

launchConfiguration_createdTime :: Lens' LaunchConfiguration UTCTime Source #

The creation date and time for the launch configuration.

LaunchTemplate

launchTemplate_overrides :: Lens' LaunchTemplate (Maybe [LaunchTemplateOverrides]) Source #

Any properties that you specify override the same properties in the launch template.

LaunchTemplateOverrides

launchTemplateOverrides_instanceRequirements :: Lens' LaunchTemplateOverrides (Maybe InstanceRequirements) Source #

The instance requirements. Amazon EC2 Auto Scaling uses your specified requirements to identify instance types. Then, it uses your On-Demand and Spot allocation strategies to launch instances from these instance types.

You can specify up to four separate sets of instance requirements per Auto Scaling group. This is useful for provisioning instances from different Amazon Machine Images (AMIs) in the same Auto Scaling group. To do this, create the AMIs and create a new launch template for each AMI. Then, create a compatible set of instance requirements for each launch template.

If you specify InstanceRequirements, you can't specify InstanceType.

launchTemplateOverrides_instanceType :: Lens' LaunchTemplateOverrides (Maybe Text) Source #

The instance type, such as m3.xlarge. You must specify an instance type that is supported in your requested Region and Availability Zones. For more information, see Instance types in the Amazon Elastic Compute Cloud User Guide.

You can specify up to 40 instance types per Auto Scaling group.

launchTemplateOverrides_launchTemplateSpecification :: Lens' LaunchTemplateOverrides (Maybe LaunchTemplateSpecification) Source #

Provides a launch template for the specified instance type or set of instance requirements. For example, some instance types might require a launch template with a different AMI. If not provided, Amazon EC2 Auto Scaling uses the launch template that's specified in the LaunchTemplate definition. For more information, see Specifying a different launch template for an instance type in the Amazon EC2 Auto Scaling User Guide.

You can specify up to 20 launch templates per Auto Scaling group. The launch templates specified in the overrides and in the LaunchTemplate definition count towards this limit.

launchTemplateOverrides_weightedCapacity :: Lens' LaunchTemplateOverrides (Maybe Text) Source #

If you provide a list of instance types to use, you can specify the number of capacity units provided by each instance type in terms of virtual CPUs, memory, storage, throughput, or other relative performance characteristic. When a Spot or On-Demand Instance is launched, the capacity units count toward the desired capacity. Amazon EC2 Auto Scaling launches instances until the desired capacity is totally fulfilled, even if this results in an overage. For example, if there are two units remaining to fulfill capacity, and Amazon EC2 Auto Scaling can only launch an instance with a WeightedCapacity of five units, the instance is launched, and the desired capacity is exceeded by three units. For more information, see Configuring instance weighting for Amazon EC2 Auto Scaling in the Amazon EC2 Auto Scaling User Guide. Value must be in the range of 1–999.

If you specify a value for WeightedCapacity for one instance type, you must specify a value for WeightedCapacity for all of them.

Every Auto Scaling group has three size parameters (DesiredCapacity, MaxSize, and MinSize). Usually, you set these sizes based on a specific number of instances. However, if you configure a mixed instances policy that defines weights for the instance types, you must specify these sizes with the same units that you use for weighting instances.

LaunchTemplateSpecification

launchTemplateSpecification_launchTemplateId :: Lens' LaunchTemplateSpecification (Maybe Text) Source #

The ID of the launch template. To get the template ID, use the Amazon EC2 DescribeLaunchTemplates API operation. New launch templates can be created using the Amazon EC2 CreateLaunchTemplate API.

Conditional: You must specify either a LaunchTemplateId or a LaunchTemplateName.

launchTemplateSpecification_launchTemplateName :: Lens' LaunchTemplateSpecification (Maybe Text) Source #

The name of the launch template. To get the template name, use the Amazon EC2 DescribeLaunchTemplates API operation. New launch templates can be created using the Amazon EC2 CreateLaunchTemplate API.

Conditional: You must specify either a LaunchTemplateId or a LaunchTemplateName.

launchTemplateSpecification_version :: Lens' LaunchTemplateSpecification (Maybe Text) Source #

The version number, $Latest, or $Default. To get the version number, use the Amazon EC2 DescribeLaunchTemplateVersions API operation. New launch template versions can be created using the Amazon EC2 CreateLaunchTemplateVersion API. If the value is $Latest, Amazon EC2 Auto Scaling selects the latest version of the launch template when launching instances. If the value is $Default, Amazon EC2 Auto Scaling selects the default version of the launch template when launching instances. The default value is $Default.

LifecycleHook

lifecycleHook_autoScalingGroupName :: Lens' LifecycleHook (Maybe Text) Source #

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

lifecycleHook_defaultResult :: Lens' LifecycleHook (Maybe Text) Source #

The action the Auto Scaling group takes when the lifecycle hook timeout elapses or if an unexpected failure occurs.

Valid values: CONTINUE | ABANDON

lifecycleHook_globalTimeout :: Lens' LifecycleHook (Maybe Int) Source #

The maximum time, in seconds, that an instance can remain in a wait state. The maximum is 172800 seconds (48 hours) or 100 times HeartbeatTimeout, whichever is smaller.

lifecycleHook_heartbeatTimeout :: Lens' LifecycleHook (Maybe Int) Source #

The maximum time, in seconds, that can elapse before the lifecycle hook times out. If the lifecycle hook times out, Amazon EC2 Auto Scaling performs the action that you specified in the DefaultResult property.

lifecycleHook_lifecycleTransition :: Lens' LifecycleHook (Maybe Text) Source #

The lifecycle transition.

Valid values: autoscaling:EC2_INSTANCE_LAUNCHING | autoscaling:EC2_INSTANCE_TERMINATING

lifecycleHook_notificationMetadata :: Lens' LifecycleHook (Maybe Text) Source #

Additional information that is included any time Amazon EC2 Auto Scaling sends a message to the notification target.

lifecycleHook_notificationTargetARN :: Lens' LifecycleHook (Maybe Text) Source #

The ARN of the target that Amazon EC2 Auto Scaling sends notifications to when an instance is in a wait state for the lifecycle hook.

lifecycleHook_roleARN :: Lens' LifecycleHook (Maybe Text) Source #

The ARN of the IAM role that allows the Auto Scaling group to publish to the specified notification target (an Amazon SNS topic or an Amazon SQS queue).

LifecycleHookSpecification

lifecycleHookSpecification_defaultResult :: Lens' LifecycleHookSpecification (Maybe Text) Source #

The action the Auto Scaling group takes when the lifecycle hook timeout elapses or if an unexpected failure occurs. The default value is ABANDON.

Valid values: CONTINUE | ABANDON

lifecycleHookSpecification_heartbeatTimeout :: Lens' LifecycleHookSpecification (Maybe Int) Source #

The maximum time, in seconds, that can elapse before the lifecycle hook times out. The range is from 30 to 7200 seconds. The default value is 3600 seconds (1 hour).

lifecycleHookSpecification_notificationMetadata :: Lens' LifecycleHookSpecification (Maybe Text) Source #

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

lifecycleHookSpecification_notificationTargetARN :: Lens' LifecycleHookSpecification (Maybe Text) Source #

The Amazon Resource Name (ARN) of the notification target that Amazon EC2 Auto Scaling sends notifications to when an instance is in a wait state for the lifecycle hook. You can specify an Amazon SNS topic or an Amazon SQS queue.

lifecycleHookSpecification_roleARN :: Lens' LifecycleHookSpecification (Maybe Text) Source #

The ARN of the IAM role that allows the Auto Scaling group to publish to the specified notification target. For information about creating this role, see Configure a notification target for a lifecycle hook in the Amazon EC2 Auto Scaling User Guide.

Valid only if the notification target is an Amazon SNS topic or an Amazon SQS queue.

lifecycleHookSpecification_lifecycleTransition :: Lens' LifecycleHookSpecification Text Source #

The lifecycle transition. For Auto Scaling groups, there are two major lifecycle transitions.

  • To create a lifecycle hook for scale-out events, specify autoscaling:EC2_INSTANCE_LAUNCHING.
  • To create a lifecycle hook for scale-in events, specify autoscaling:EC2_INSTANCE_TERMINATING.

LoadBalancerState

loadBalancerState_state :: Lens' LoadBalancerState (Maybe Text) Source #

One of the following load balancer states:

  • Adding - The Auto Scaling instances are being registered with the load balancer.
  • Added - All Auto Scaling instances are registered with the load balancer.
  • InService - At least one Auto Scaling instance passed an ELB health check.
  • Removing - The Auto Scaling 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.
  • Removed - All Auto Scaling instances are deregistered from the load balancer.

LoadBalancerTargetGroupState

loadBalancerTargetGroupState_state :: Lens' LoadBalancerTargetGroupState (Maybe Text) Source #

The state of the target group.

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

LoadForecast

loadForecast_timestamps :: Lens' LoadForecast [UTCTime] Source #

The timestamps for the data points, in UTC format.

loadForecast_values :: Lens' LoadForecast [Double] Source #

The values of the data points.

MemoryGiBPerVCpuRequest

MemoryMiBRequest

Metric

metric_dimensions :: Lens' Metric (Maybe [MetricDimension]) Source #

The dimensions for the metric. For the list of available dimensions, see the Amazon Web Services documentation available from the table in Amazon Web Services services that publish CloudWatch metrics in the Amazon CloudWatch User Guide.

Conditional: If you published your metric with dimensions, you must specify the same dimensions in your scaling policy.

metric_namespace :: Lens' Metric Text Source #

The namespace of the metric. For more information, see the table in Amazon Web Services services that publish CloudWatch metrics in the Amazon CloudWatch User Guide.

metric_metricName :: Lens' Metric Text Source #

The name of the metric.

MetricCollectionType

metricCollectionType_metric :: Lens' MetricCollectionType (Maybe Text) Source #

One of the following metrics:

  • GroupMinSize
  • GroupMaxSize
  • GroupDesiredCapacity
  • GroupInServiceInstances
  • GroupPendingInstances
  • GroupStandbyInstances
  • GroupTerminatingInstances
  • GroupTotalInstances
  • GroupInServiceCapacity
  • GroupPendingCapacity
  • GroupStandbyCapacity
  • GroupTerminatingCapacity
  • GroupTotalCapacity
  • WarmPoolDesiredCapacity
  • WarmPoolWarmedCapacity
  • WarmPoolPendingCapacity
  • WarmPoolTerminatingCapacity
  • WarmPoolTotalCapacity
  • GroupAndWarmPoolDesiredCapacity
  • GroupAndWarmPoolTotalCapacity

MetricDataQuery

metricDataQuery_expression :: Lens' MetricDataQuery (Maybe Text) Source #

The math expression to perform on the returned data, if this object is performing a math expression. This expression can use the Id of the other metrics to refer to those metrics, and can also use the Id of other expressions to use the result of those expressions.

Conditional: Within each MetricDataQuery object, you must specify either Expression or MetricStat, but not both.

metricDataQuery_label :: Lens' MetricDataQuery (Maybe Text) Source #

A human-readable label for this metric or expression. This is especially useful if this is a math expression, so that you know what the value represents.

metricDataQuery_metricStat :: Lens' MetricDataQuery (Maybe MetricStat) Source #

Information about the metric data to return.

Conditional: Within each MetricDataQuery object, you must specify either Expression or MetricStat, but not both.

metricDataQuery_returnData :: Lens' MetricDataQuery (Maybe Bool) Source #

Indicates whether to return the timestamps and raw data values of this metric.

If you use any math expressions, specify true for this value for only the final math expression that the metric specification is based on. You must specify false for ReturnData for all the other metrics and expressions used in the metric specification.

If you are only retrieving metrics and not performing any math expressions, do not specify anything for ReturnData. This sets it to its default (true).

metricDataQuery_id :: Lens' MetricDataQuery Text Source #

A short name that identifies the object's results in the response. This name must be unique among all MetricDataQuery objects specified for a single scaling policy. If you are performing math expressions on this set of data, this name represents that data and can serve as a variable in the mathematical expression. The valid characters are letters, numbers, and underscores. The first character must be a lowercase letter.

MetricDimension

metricDimension_name :: Lens' MetricDimension Text Source #

The name of the dimension.

metricDimension_value :: Lens' MetricDimension Text Source #

The value of the dimension.

MetricGranularityType

metricGranularityType_granularity :: Lens' MetricGranularityType (Maybe Text) Source #

The granularity. The only valid value is 1Minute.

MetricStat

metricStat_unit :: Lens' MetricStat (Maybe Text) Source #

The unit to use for the returned data points. For a complete list of the units that CloudWatch supports, see the MetricDatum data type in the Amazon CloudWatch API Reference.

metricStat_metric :: Lens' MetricStat Metric Source #

The CloudWatch metric to return, including the metric name, namespace, and dimensions. To get the exact metric name, namespace, and dimensions, inspect the Metric object that is returned by a call to ListMetrics.

metricStat_stat :: Lens' MetricStat Text Source #

The statistic to return. It can include any CloudWatch statistic or extended statistic. For a list of valid values, see the table in Statistics in the Amazon CloudWatch User Guide.

The most commonly used metrics for predictive scaling are Average and Sum.

MixedInstancesPolicy

mixedInstancesPolicy_launchTemplate :: Lens' MixedInstancesPolicy (Maybe LaunchTemplate) Source #

One or more launch templates and the instance types (overrides) that are used to launch EC2 instances to fulfill On-Demand and Spot capacities.

NetworkBandwidthGbpsRequest

networkBandwidthGbpsRequest_max :: Lens' NetworkBandwidthGbpsRequest (Maybe Double) Source #

The maximum amount of network bandwidth, in gigabits per second (Gbps).

networkBandwidthGbpsRequest_min :: Lens' NetworkBandwidthGbpsRequest (Maybe Double) Source #

The minimum amount of network bandwidth, in gigabits per second (Gbps).

NetworkInterfaceCountRequest

NotificationConfiguration

notificationConfiguration_notificationType :: Lens' NotificationConfiguration (Maybe Text) Source #

One of the following event notification types:

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

notificationConfiguration_topicARN :: Lens' NotificationConfiguration (Maybe Text) Source #

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

PredefinedMetricSpecification

predefinedMetricSpecification_resourceLabel :: Lens' PredefinedMetricSpecification (Maybe Text) Source #

A label that uniquely identifies a specific Application Load Balancer target group from which to determine the average request count served by your Auto Scaling group. You can't specify a resource label unless the target group is attached to the Auto Scaling group.

You create the resource label by appending the final portion of the load balancer ARN and the final portion of the target group ARN into a single value, separated by a forward slash (/). The format of the resource label is:

app/my-alb/778d41231b141a0f/targetgroup/my-alb-target-group/943f017f100becff.

Where:

  • app/<load-balancer-name>/<load-balancer-id> is the final portion of the load balancer ARN
  • targetgroup/<target-group-name>/<target-group-id> is the final portion of the target group ARN.

To find the ARN for an Application Load Balancer, use the DescribeLoadBalancers API operation. To find the ARN for the target group, use the DescribeTargetGroups API operation.

predefinedMetricSpecification_predefinedMetricType :: Lens' PredefinedMetricSpecification MetricType Source #

The metric type. The following predefined metrics are available:

  • ASGAverageCPUUtilization - Average CPU utilization of the Auto Scaling group.
  • ASGAverageNetworkIn - Average number of bytes received on all network interfaces by the Auto Scaling group.
  • ASGAverageNetworkOut - Average number of bytes sent out on all network interfaces by the Auto Scaling group.
  • ALBRequestCountPerTarget - Average Application Load Balancer request count per target for your Auto Scaling group.

PredictiveScalingConfiguration

predictiveScalingConfiguration_maxCapacityBreachBehavior :: Lens' PredictiveScalingConfiguration (Maybe PredictiveScalingMaxCapacityBreachBehavior) Source #

Defines the behavior that should be applied if the forecast capacity approaches or exceeds the maximum capacity of the Auto Scaling group. Defaults to HonorMaxCapacity if not specified.

The following are possible values:

  • HonorMaxCapacity - Amazon EC2 Auto Scaling cannot scale out capacity higher than the maximum capacity. The maximum capacity is enforced as a hard limit.
  • IncreaseMaxCapacity - Amazon EC2 Auto Scaling can scale out capacity higher than the maximum capacity when the forecast capacity is close to or exceeds the maximum capacity. The upper limit is determined by the forecasted capacity and the value for MaxCapacityBuffer.

predictiveScalingConfiguration_maxCapacityBuffer :: Lens' PredictiveScalingConfiguration (Maybe Natural) Source #

The size of the capacity buffer to use when the forecast capacity is close to or exceeds the maximum capacity. The value is specified as a percentage relative to the forecast capacity. For example, if the buffer is 10, this means a 10 percent buffer, such that if the forecast capacity is 50, and the maximum capacity is 40, then the effective maximum capacity is 55.

If set to 0, Amazon EC2 Auto Scaling may scale capacity higher than the maximum capacity to equal but not exceed forecast capacity.

Required if the MaxCapacityBreachBehavior property is set to IncreaseMaxCapacity, and cannot be used otherwise.

predictiveScalingConfiguration_mode :: Lens' PredictiveScalingConfiguration (Maybe PredictiveScalingMode) Source #

The predictive scaling mode. Defaults to ForecastOnly if not specified.

predictiveScalingConfiguration_schedulingBufferTime :: Lens' PredictiveScalingConfiguration (Maybe Natural) Source #

The amount of time, in seconds, by which the instance launch time can be advanced. For example, the forecast says to add capacity at 10:00 AM, and you choose to pre-launch instances by 5 minutes. In that case, the instances will be launched at 9:55 AM. The intention is to give resources time to be provisioned. It can take a few minutes to launch an EC2 instance. The actual amount of time required depends on several factors, such as the size of the instance and whether there are startup scripts to complete.

The value must be less than the forecast interval duration of 3600 seconds (60 minutes). Defaults to 300 seconds if not specified.

predictiveScalingConfiguration_metricSpecifications :: Lens' PredictiveScalingConfiguration [PredictiveScalingMetricSpecification] Source #

This structure includes the metrics and target utilization to use for predictive scaling.

This is an array, but we currently only support a single metric specification. That is, you can specify a target value and a single metric pair, or a target value and one scaling metric and one load metric.

PredictiveScalingCustomizedCapacityMetric

predictiveScalingCustomizedCapacityMetric_metricDataQueries :: Lens' PredictiveScalingCustomizedCapacityMetric [MetricDataQuery] Source #

One or more metric data queries to provide the data points for a capacity metric. Use multiple metric data queries only if you are performing a math expression on returned data.

PredictiveScalingCustomizedLoadMetric

predictiveScalingCustomizedLoadMetric_metricDataQueries :: Lens' PredictiveScalingCustomizedLoadMetric [MetricDataQuery] Source #

One or more metric data queries to provide the data points for a load metric. Use multiple metric data queries only if you are performing a math expression on returned data.

PredictiveScalingCustomizedScalingMetric

predictiveScalingCustomizedScalingMetric_metricDataQueries :: Lens' PredictiveScalingCustomizedScalingMetric [MetricDataQuery] Source #

One or more metric data queries to provide the data points for a scaling metric. Use multiple metric data queries only if you are performing a math expression on returned data.

PredictiveScalingMetricSpecification

predictiveScalingMetricSpecification_predefinedMetricPairSpecification :: Lens' PredictiveScalingMetricSpecification (Maybe PredictiveScalingPredefinedMetricPair) Source #

The predefined metric pair specification from which Amazon EC2 Auto Scaling determines the appropriate scaling metric and load metric to use.

predictiveScalingMetricSpecification_targetValue :: Lens' PredictiveScalingMetricSpecification Double Source #

Specifies the target utilization.

Some metrics are based on a count instead of a percentage, such as the request count for an Application Load Balancer or the number of messages in an SQS queue. If the scaling policy specifies one of these metrics, specify the target utilization as the optimal average request or message count per instance during any one-minute interval.

PredictiveScalingPredefinedLoadMetric

predictiveScalingPredefinedLoadMetric_resourceLabel :: Lens' PredictiveScalingPredefinedLoadMetric (Maybe Text) Source #

A label that uniquely identifies a specific Application Load Balancer target group from which to determine the request count served by your Auto Scaling group. You can't specify a resource label unless the target group is attached to the Auto Scaling group.

You create the resource label by appending the final portion of the load balancer ARN and the final portion of the target group ARN into a single value, separated by a forward slash (/). The format of the resource label is:

app/my-alb/778d41231b141a0f/targetgroup/my-alb-target-group/943f017f100becff.

Where:

  • app/<load-balancer-name>/<load-balancer-id> is the final portion of the load balancer ARN
  • targetgroup/<target-group-name>/<target-group-id> is the final portion of the target group ARN.

To find the ARN for an Application Load Balancer, use the DescribeLoadBalancers API operation. To find the ARN for the target group, use the DescribeTargetGroups API operation.

PredictiveScalingPredefinedMetricPair

predictiveScalingPredefinedMetricPair_resourceLabel :: Lens' PredictiveScalingPredefinedMetricPair (Maybe Text) Source #

A label that uniquely identifies a specific Application Load Balancer target group from which to determine the total and average request count served by your Auto Scaling group. You can't specify a resource label unless the target group is attached to the Auto Scaling group.

You create the resource label by appending the final portion of the load balancer ARN and the final portion of the target group ARN into a single value, separated by a forward slash (/). The format of the resource label is:

app/my-alb/778d41231b141a0f/targetgroup/my-alb-target-group/943f017f100becff.

Where:

  • app/<load-balancer-name>/<load-balancer-id> is the final portion of the load balancer ARN
  • targetgroup/<target-group-name>/<target-group-id> is the final portion of the target group ARN.

To find the ARN for an Application Load Balancer, use the DescribeLoadBalancers API operation. To find the ARN for the target group, use the DescribeTargetGroups API operation.

predictiveScalingPredefinedMetricPair_predefinedMetricType :: Lens' PredictiveScalingPredefinedMetricPair PredefinedMetricPairType Source #

Indicates which metrics to use. There are two different types of metrics for each metric type: one is a load metric and one is a scaling metric. For example, if the metric type is ASGCPUUtilization, the Auto Scaling group's total CPU metric is used as the load metric, and the average CPU metric is used for the scaling metric.

PredictiveScalingPredefinedScalingMetric

predictiveScalingPredefinedScalingMetric_resourceLabel :: Lens' PredictiveScalingPredefinedScalingMetric (Maybe Text) Source #

A label that uniquely identifies a specific Application Load Balancer target group from which to determine the average request count served by your Auto Scaling group. You can't specify a resource label unless the target group is attached to the Auto Scaling group.

You create the resource label by appending the final portion of the load balancer ARN and the final portion of the target group ARN into a single value, separated by a forward slash (/). The format of the resource label is:

app/my-alb/778d41231b141a0f/targetgroup/my-alb-target-group/943f017f100becff.

Where:

  • app/<load-balancer-name>/<load-balancer-id> is the final portion of the load balancer ARN
  • targetgroup/<target-group-name>/<target-group-id> is the final portion of the target group ARN.

To find the ARN for an Application Load Balancer, use the DescribeLoadBalancers API operation. To find the ARN for the target group, use the DescribeTargetGroups API operation.

ProcessType

processType_processName :: Lens' ProcessType Text Source #

One of the following processes:

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

RefreshPreferences

refreshPreferences_checkpointDelay :: Lens' RefreshPreferences (Maybe Natural) Source #

The amount of time, in seconds, to wait after a checkpoint before continuing. This property is optional, but if you specify a value for it, you must also specify a value for CheckpointPercentages. If you specify a value for CheckpointPercentages and not for CheckpointDelay, the CheckpointDelay defaults to 3600 (1 hour).

refreshPreferences_checkpointPercentages :: Lens' RefreshPreferences (Maybe [Natural]) Source #

Threshold values for each checkpoint in ascending order. Each number must be unique. To replace all instances in the Auto Scaling group, the last number in the array must be 100.

For usage examples, see Adding checkpoints to an instance refresh in the Amazon EC2 Auto Scaling User Guide.

refreshPreferences_instanceWarmup :: Lens' RefreshPreferences (Maybe Natural) Source #

Not needed if the default instance warmup is defined for the group.

The duration of the instance warmup, in seconds.

The default is to use the value for the default instance warmup defined for the group. If default instance warmup is null, then InstanceWarmup falls back to the value of the health check grace period.

refreshPreferences_minHealthyPercentage :: Lens' RefreshPreferences (Maybe Natural) Source #

The amount of capacity in the Auto Scaling group that must pass your group's health checks to allow the operation to continue. The value is expressed as a percentage of the desired capacity of the Auto Scaling group (rounded up to the nearest integer). The default is 90.

Setting the minimum healthy percentage to 100 percent limits the rate of replacement to one instance at a time. In contrast, setting it to 0 percent has the effect of replacing all instances at the same time.

refreshPreferences_skipMatching :: Lens' RefreshPreferences (Maybe Bool) Source #

A boolean value that indicates whether skip matching is enabled. If true, then Amazon EC2 Auto Scaling skips replacing instances that match the desired configuration. If no desired configuration is specified, then it skips replacing instances that have the same configuration that is already set on the group. The default is false.

ScalingPolicy

scalingPolicy_adjustmentType :: Lens' ScalingPolicy (Maybe Text) Source #

Specifies how the scaling adjustment is interpreted (for example, an absolute number or a percentage). The valid values are ChangeInCapacity, ExactCapacity, and PercentChangeInCapacity.

scalingPolicy_alarms :: Lens' ScalingPolicy (Maybe [Alarm]) Source #

The CloudWatch alarms related to the policy.

scalingPolicy_autoScalingGroupName :: Lens' ScalingPolicy (Maybe Text) Source #

The name of the Auto Scaling group.

scalingPolicy_cooldown :: Lens' ScalingPolicy (Maybe Int) Source #

The duration of the policy's cooldown period, in seconds.

scalingPolicy_enabled :: Lens' ScalingPolicy (Maybe Bool) Source #

Indicates whether the policy is enabled (true) or disabled (false).

scalingPolicy_estimatedInstanceWarmup :: Lens' ScalingPolicy (Maybe Int) Source #

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

scalingPolicy_metricAggregationType :: Lens' ScalingPolicy (Maybe Text) Source #

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

scalingPolicy_minAdjustmentMagnitude :: Lens' ScalingPolicy (Maybe Int) Source #

The minimum value to scale by when the adjustment type is PercentChangeInCapacity.

scalingPolicy_minAdjustmentStep :: Lens' ScalingPolicy (Maybe Int) Source #

Available for backward compatibility. Use MinAdjustmentMagnitude instead.

scalingPolicy_policyARN :: Lens' ScalingPolicy (Maybe Text) Source #

The Amazon Resource Name (ARN) of the policy.

scalingPolicy_policyName :: Lens' ScalingPolicy (Maybe Text) Source #

The name of the scaling policy.

scalingPolicy_policyType :: Lens' ScalingPolicy (Maybe Text) Source #

One of the following policy types:

  • TargetTrackingScaling
  • StepScaling
  • SimpleScaling (default)
  • PredictiveScaling

For more information, see Target tracking scaling policies and Step and simple scaling policies in the Amazon EC2 Auto Scaling User Guide.

scalingPolicy_scalingAdjustment :: 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.

scalingPolicy_stepAdjustments :: Lens' ScalingPolicy (Maybe [StepAdjustment]) Source #

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

ScalingProcessQuery

scalingProcessQuery_scalingProcesses :: Lens' ScalingProcessQuery (Maybe [Text]) Source #

One or more of the following processes:

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

If you omit this property, all processes are specified.

ScheduledUpdateGroupAction

scheduledUpdateGroupAction_desiredCapacity :: Lens' ScheduledUpdateGroupAction (Maybe Int) Source #

The desired capacity is the initial capacity of the Auto Scaling group after the scheduled action runs and the capacity it attempts to maintain.

scheduledUpdateGroupAction_endTime :: Lens' ScheduledUpdateGroupAction (Maybe UTCTime) Source #

The date and time in UTC for the recurring schedule to end. For example, "2019-06-01T00:00:00Z".

scheduledUpdateGroupAction_maxSize :: Lens' ScheduledUpdateGroupAction (Maybe Int) Source #

The maximum size of the Auto Scaling group.

scheduledUpdateGroupAction_minSize :: Lens' ScheduledUpdateGroupAction (Maybe Int) Source #

The minimum size of the Auto Scaling group.

scheduledUpdateGroupAction_recurrence :: Lens' ScheduledUpdateGroupAction (Maybe Text) Source #

The recurring schedule for the action, in Unix cron syntax format.

When StartTime and EndTime are specified with Recurrence, they form the boundaries of when the recurring action starts and stops.

scheduledUpdateGroupAction_scheduledActionARN :: Lens' ScheduledUpdateGroupAction (Maybe Text) Source #

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

scheduledUpdateGroupAction_startTime :: Lens' ScheduledUpdateGroupAction (Maybe UTCTime) Source #

The date and time in UTC for this action to start. For example, "2019-06-01T00:00:00Z".

ScheduledUpdateGroupActionRequest

scheduledUpdateGroupActionRequest_desiredCapacity :: Lens' ScheduledUpdateGroupActionRequest (Maybe Int) Source #

The desired capacity is the initial capacity of the Auto Scaling group after the scheduled action runs and the capacity it attempts to maintain.

scheduledUpdateGroupActionRequest_endTime :: Lens' ScheduledUpdateGroupActionRequest (Maybe UTCTime) Source #

The date and time for the recurring schedule to end, in UTC.

scheduledUpdateGroupActionRequest_recurrence :: Lens' ScheduledUpdateGroupActionRequest (Maybe Text) Source #

The recurring schedule for the action, in Unix cron syntax format. This format consists of five fields separated by white spaces: [Minute] [Hour] [Day_of_Month] [Month_of_Year] [Day_of_Week]. The value must be in quotes (for example, "30 0 1 1,6,12 *"). For more information about this format, see Crontab.

When StartTime and EndTime are specified with Recurrence, they form the boundaries of when the recurring action starts and stops.

Cron expressions use Universal Coordinated Time (UTC) by default.

scheduledUpdateGroupActionRequest_startTime :: Lens' ScheduledUpdateGroupActionRequest (Maybe UTCTime) Source #

The date and time for the action to start, in YYYY-MM-DDThh:mm:ssZ format in UTC/GMT only and in quotes (for example, "2019-06-01T00:00:00Z").

If you specify Recurrence and StartTime, Amazon EC2 Auto Scaling performs the action at this time, and then performs the action based on the specified recurrence.

If you try to schedule the action in the past, Amazon EC2 Auto Scaling returns an error message.

scheduledUpdateGroupActionRequest_timeZone :: Lens' ScheduledUpdateGroupActionRequest (Maybe Text) Source #

Specifies the time zone for a cron expression. If a time zone is not provided, UTC is used by default.

Valid values are the canonical names of the IANA time zones, derived from the IANA Time Zone Database (such as Etc/GMT+9 or Pacific/Tahiti). For more information, see https://en.wikipedia.org/wiki/List_of_tz_database_time_zones.

StepAdjustment

stepAdjustment_metricIntervalLowerBound :: 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.

stepAdjustment_metricIntervalUpperBound :: 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.

stepAdjustment_scalingAdjustment :: 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.

The amount by which to scale. The adjustment is based on the value that you specified in the AdjustmentType property (either an absolute number or a percentage). A positive value adds to the current capacity and a negative number subtracts from the current capacity.

SuspendedProcess

suspendedProcess_processName :: Lens' SuspendedProcess (Maybe Text) Source #

The name of the suspended process.

suspendedProcess_suspensionReason :: Lens' SuspendedProcess (Maybe Text) Source #

The reason that the process was suspended.

Tag

tag_key :: Lens' Tag Text Source #

The tag key.

tag_resourceId :: Lens' Tag Text Source #

The name of the Auto Scaling group.

tag_resourceType :: Lens' Tag Text Source #

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

tag_propagateAtLaunch :: Lens' Tag Bool Source #

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

tag_value :: Lens' Tag Text Source #

The tag value.

TagDescription

tagDescription_resourceType :: Lens' TagDescription Text Source #

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

tagDescription_propagateAtLaunch :: Lens' TagDescription Bool Source #

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

TargetTrackingConfiguration

targetTrackingConfiguration_customizedMetricSpecification :: Lens' TargetTrackingConfiguration (Maybe CustomizedMetricSpecification) Source #

A customized metric. You must specify either a predefined metric or a customized metric.

targetTrackingConfiguration_disableScaleIn :: Lens' TargetTrackingConfiguration (Maybe Bool) Source #

Indicates whether scaling in by the target tracking scaling policy is disabled. If scaling in is disabled, the target tracking scaling policy doesn't remove instances from the Auto Scaling group. Otherwise, the target tracking scaling policy can remove instances from the Auto Scaling group. The default is false.

targetTrackingConfiguration_predefinedMetricSpecification :: Lens' TargetTrackingConfiguration (Maybe PredefinedMetricSpecification) Source #

A predefined metric. You must specify either a predefined metric or a customized metric.

targetTrackingConfiguration_targetValue :: Lens' TargetTrackingConfiguration Double Source #

The target value for the metric.

Some metrics are based on a count instead of a percentage, such as the request count for an Application Load Balancer or the number of messages in an SQS queue. If the scaling policy specifies one of these metrics, specify the target utilization as the optimal average request or message count per instance during any one-minute interval.

TargetTrackingMetricDataQuery

targetTrackingMetricDataQuery_expression :: Lens' TargetTrackingMetricDataQuery (Maybe Text) Source #

The math expression to perform on the returned data, if this object is performing a math expression. This expression can use the Id of the other metrics to refer to those metrics, and can also use the Id of other expressions to use the result of those expressions.

Conditional: Within each TargetTrackingMetricDataQuery object, you must specify either Expression or MetricStat, but not both.

targetTrackingMetricDataQuery_label :: Lens' TargetTrackingMetricDataQuery (Maybe Text) Source #

A human-readable label for this metric or expression. This is especially useful if this is a math expression, so that you know what the value represents.

targetTrackingMetricDataQuery_metricStat :: Lens' TargetTrackingMetricDataQuery (Maybe TargetTrackingMetricStat) Source #

Information about the metric data to return.

Conditional: Within each TargetTrackingMetricDataQuery object, you must specify either Expression or MetricStat, but not both.

targetTrackingMetricDataQuery_returnData :: Lens' TargetTrackingMetricDataQuery (Maybe Bool) Source #

Indicates whether to return the timestamps and raw data values of this metric.

If you use any math expressions, specify true for this value for only the final math expression that the metric specification is based on. You must specify false for ReturnData for all the other metrics and expressions used in the metric specification.

If you are only retrieving metrics and not performing any math expressions, do not specify anything for ReturnData. This sets it to its default (true).

targetTrackingMetricDataQuery_id :: Lens' TargetTrackingMetricDataQuery Text Source #

A short name that identifies the object's results in the response. This name must be unique among all TargetTrackingMetricDataQuery objects specified for a single scaling policy. If you are performing math expressions on this set of data, this name represents that data and can serve as a variable in the mathematical expression. The valid characters are letters, numbers, and underscores. The first character must be a lowercase letter.

TargetTrackingMetricStat

targetTrackingMetricStat_unit :: Lens' TargetTrackingMetricStat (Maybe Text) Source #

The unit to use for the returned data points. For a complete list of the units that CloudWatch supports, see the MetricDatum data type in the Amazon CloudWatch API Reference.

targetTrackingMetricStat_stat :: Lens' TargetTrackingMetricStat Text Source #

The statistic to return. It can include any CloudWatch statistic or extended statistic. For a list of valid values, see the table in Statistics in the Amazon CloudWatch User Guide.

The most commonly used metrics for scaling is Average

TotalLocalStorageGBRequest

TrafficSourceIdentifier

trafficSourceIdentifier_identifier :: Lens' TrafficSourceIdentifier (Maybe Text) Source #

The unique identifier of the traffic source.

TrafficSourceState

trafficSourceState_state :: Lens' TrafficSourceState (Maybe Text) Source #

The following are the possible states for a VPC Lattice target group:

  • Adding - The Auto Scaling instances are being registered with the target group.
  • Added - All Auto Scaling instances are registered with the target group.
  • InService - At least one Auto Scaling instance passed the VPC_LATTICE health check.
  • Removing - The Auto Scaling instances are being deregistered from the target group. If connection draining is enabled, VPC Lattice waits for in-flight requests to complete before deregistering the instances.
  • Removed - All Auto Scaling instances are deregistered from the target group.

trafficSourceState_trafficSource :: Lens' TrafficSourceState (Maybe Text) Source #

The unique identifier of the traffic source. Currently, this is the Amazon Resource Name (ARN) for a VPC Lattice target group.

VCpuCountRequest

WarmPoolConfiguration

warmPoolConfiguration_maxGroupPreparedCapacity :: Lens' WarmPoolConfiguration (Maybe Int) Source #

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.

warmPoolConfiguration_minSize :: Lens' WarmPoolConfiguration (Maybe Natural) Source #

The minimum number of instances to maintain in the warm pool.

warmPoolConfiguration_poolState :: Lens' WarmPoolConfiguration (Maybe WarmPoolState) Source #

The instance state to transition to after the lifecycle actions are complete.

warmPoolConfiguration_status :: Lens' WarmPoolConfiguration (Maybe WarmPoolStatus) Source #

The status of a warm pool that is marked for deletion.