@type block_device_mapping() :: [
  device_name: binary(),
  ebs: ebs(),
  no_device: boolean(),
  virtual_name: binary()
]

Describes a block device mapping. See ebs/0

Keys

• device_name (String) - The device name exposed to the EC2 instance (for example, /dev/sdh or xvdh). For more information, see Device Naming on Linux Instances in the Amazon EC2 User Guide for Linux Instances.

• ebs (ebs/0) - The information about the Amazon EBS volume.

• no_device (boolean) - Suppresses a device mapping. If this parameter is true for the root device, the instance might fail the EC2 health check. In that case, Amazon EC2 Auto Scaling launches a replacement instance.

• virtual_name (String) - The name of the virtual device (for example, ephemeral0).

@type complete_life_cycle_action_opts() :: [
  lifecycle_action_token: binary(),
  instance_id: binary()
]

The optional parameters when calling complete_life_cycle_action/4

Members

• lifecycle_action_token (String) - 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.

• instance_id (String) - The ID of the instance.

@type create_auto_scaling_group_opts() :: [
  availability_zones: [binary(), ...],
  default_cool_down: integer(),
  desired_capacity: integer(),
  health_check_grace_period: integer(),
  health_check_type: binary(),
  instance_id: binary(),
  launch_configuration_name: binary(),
  launch_template: launch_template_specification(),
  lifecycle_hook_specification_list: [lifecycle_hook_specification(), ...],
  load_balancer_names: [binary(), ...],
  mixed_instances_policy: mixed_instances_policy(),
  new_instances_protected_from_scale_in: boolean(),
  placement_group: binary(),
  service_linked_role_arn: binary(),
  tags: [tag(), ...],
  target_group_arns: [binary(), ...],
  termination_policies: [binary(), ...],
  vpc_zone_identifier: binary()
]

The optional parameters when calling create_auto_scaling_group/4

Keys

• availability_zones (List) - One or more Availability Zones for the group. This parameter is optional if you specify one or more subnets. Minimum number of 1 item. Maximum number is 255.

• default_cool_down (Integer) - The amount of time, in seconds, after a scaling activity completes before another scaling activity can start. The default value is 300.

• desired_capacity (Integer) - The number of EC2 instances that should be running in the group. 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.

• health_check_grace_period (Integer) - 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. During this time, any health check failures for the instance are ignored. The default value is 0. This parameter is required if you are adding an ELB health check.

• health_check_type (String) - The service to use for the health checks. The valid values are "EC2" and "ELB".

• launch_configuration_name (String) - The name of the launch configuration. This parameter, a launch template, a mixed instances policy, or an EC2 instance must be specified.

• launch_template (launch_template_specification/0) - The launch template to use to launch instances. This parameter, a launch configuration, a mixed instances policy, or an EC2 instance must be specified.

• lifecycle_hook_specification_list (List of lifecycle_hook_specification/0) - One or more lifecycle hooks.

• load_balancer_names (List of String) - One or more Classic Load Balancers. To specify an Application Load Balancer or a Network Load Balancer, use target_group_arns instead.

• mixed_instances_policy (mixed_instances_policy/0) - The mixed instances policy to use to launch instances. This parameter, a launch template, a launch configuration, or an EC2 instance must be specified.

• new_instances_protected_from_scale_in (boolean) - Indicates whether newly launched instances are protected from termination by Auto Scaling when scaling in. For more information about preventing instances from terminating on scale in, see Instance Protection in the Amazon EC2 Auto Scaling User Guide.

• placement_group (String) - The name of the placement group into which to launch your instances, if any. For more information, see Placement Groups in the Amazon EC2 User Guide for Linux Instances.

• service_linked_role_arn (String) - The Amazon Resource Name (ARN) of the service-linked role that the Auto Scaling group uses to call other AWS services 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.

• tags (List of tag/0) - One or more tags

• target_group_arns (List of String) - The Amazon Resource Names (ARN) of the target groups.

• termination_policies (List of String) - One or more termination policies used to select the instance to terminate. These policies are executed in the order that they are listed. For more information, see "Controlling Which Instances Auto Scaling Terminates During Scale In" in the Amazon EC2 Auto Scaling User Guide.

• vpc_zone_identifier (String) - A comma-separated list of subnet identifiers for your virtual private cloud (VPC)

@type create_launch_configuration_opts() :: [
  associate_public_ip_address: boolean(),
  block_device_mappings: [block_device_mapping(), ...],
  classic_link_vpc_id: binary(),
  classic_link_vpc_security_groups: [binary(), ...],
  ebs_optimized: boolean(),
  iam_instance_profile: binary(),
  image_id: binary(),
  instance_id: binary(),
  instance_monitoring: boolean(),
  instance_type: binary(),
  kernel_id: binary(),
  key_name: binary(),
  placement_tenancy: binary(),
  ramdisk_id: binary(),
  security_groups: [binary(), ...],
  spot_price: binary(),
  user_data: binary()
]

The optional parameters when calling create_launch_configuration/2

Keys

• associate_public_ip_address (boolean) - Used for groups that launch instances into a virtual private cloud (VPC). Specifies whether to assign a public IP address to each instance. For more information, see Launching Auto Scaling Instances in a VPC in the Amazon EC2 Auto Scaling User Guide. If you specify this parameter, be sure to specify at least one subnet when you create your group. Default: If the instance is launched into a default subnet, the default is to assign a public IP address. If the instance is launched into a nondefault subnet, the default is not to assign a public IP address.

• block_device_mappings (List of block_device_mapping/0) - One or more mappings that specify how block devices are exposed to the instance. For more information, see Block Device Mapping in the Amazon EC2 User Guide for Linux Instances.

• classic_link_vpc_id (String) - The ID of a ClassicLink-enabled VPC to link your EC2-Classic instances to. This parameter is supported only if you are launching EC2-Classic instances. For more information, see ClassicLink in the Amazon EC2 User Guide for Linux Instances and Linking EC2-Classic Instances to a VPC in the Amazon EC2 Auto Scaling User Guide.

• classic_link_vpc_security_groups (List of String) - The IDs of one or more security groups for the specified ClassicLink-enabled VPC. This parameter is required if you specify a ClassicLink-enabled VPC, and is not supported otherwise. For more information, see ClassicLink in the Amazon EC2 User Guide for Linux Instances and Linking EC2-Classic Instances to a VPC in the Amazon EC2 Auto Scaling User Guide.

• ebs_optimized (boolean) - Indicates whether the instance is optimized for Amazon EBS I/O. By default, the instance is not optimized for EBS I/O. 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 usage charges apply. For more information, see Amazon EBS-Optimized Instances in the Amazon EC2 User Guide for Linux Instances.

• iam_instance_profile (String) - The name or the Amazon Resource Name (ARN) of the instance profile associated with the IAM role for the instance. EC2 instances launched with an IAM role automatically have AWS security credentials available. You can use IAM roles with Amazon EC2 Auto Scaling to automatically enable applications running on your EC2 instances to securely access other AWS resources. For more information, see Use an IAM Role for Applications That Run on Amazon EC2 Instances in the Amazon EC2 Auto Scaling User Guide.

• image_id (String) - The ID of the Amazon Machine Image (AMI) to use to launch your EC2 instances. If you do not specify instance_id, you must specify image_id.

• instance_id (String) - 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. If you do not specify instance_id, you must specify both image_id and instance_type. 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 Create a Launch Configuration Using an EC2 Instance in the Amazon EC2 Auto Scaling User Guide.

• instance_monitoring (boolean) - Enables detailed monitoring (true) or basic monitoring (false) for the Auto Scaling instances. The default value is true.

• instance_type (String) - The instance type of the EC2 instance. If you do not specify instance_id, you must specify instance_type. For information about available instance types, see Available Instance Types in the Amazon EC2 User Guide for Linux Instances.

• kernel_id (String) - The ID of the kernel associated with the AMI.

• key_name (String) - The name of the key pair. For more information, see Amazon EC2 Key Pairs in the Amazon EC2 User Guide for Linux Instances.

• placement_tenancy (String) - The tenancy of the instance. An instance with a tenancy of dedicated runs on 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 parameter to dedicated. If you specify this parameter, be sure to specify at least one subnet when you create your group. For more information, see Launching Auto Scaling Instances in a VPC in the Amazon EC2 Auto Scaling User Guide. Valid values: "default" | "dedicated"

• ramdisk_id (String) - The ID of the RAM disk associated with the AMI.

• security_groups (List of String) - One or more security groups with which to associate the instances. If your instances are launched in EC2-Classic, you can either specify security group names or the security group IDs. For more information, see Amazon EC2 Security Groups in the Amazon EC2 User Guide for Linux Instances. If your instances are launched into a VPC, specify security group IDs. For more information, see Security Groups for Your VPC in the Amazon Virtual Private Cloud User Guide.

• spot_price (String) - 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 market price. For more information, see Launching Spot Instances in Your Auto Scaling Group in the Amazon EC2 Auto Scaling User Guide.

• user_data (String) - The user data to make available to the launched EC2 instances. For more information, see Instance Metadata and User Data in the Amazon EC2 User Guide for Linux Instances. This value will be base64 encoded automatically. Do not base64 encode this value prior to performing the operation.

@type customized_metric_specification() :: [
  dimensions: [metric_dimension(), ...],
  metric_name: binary(),
  namespace: binary(),
  statistic: binary(),
  unit: binary()
]

A customized metric. You can specify either a predefined metric or a customized metric

@type delete_auto_scaling_group_opts() :: [{:force_delete, boolean()}]

The optional parameters when calling delete_auto_scaling_group/2

Keys

• force_delete (boolean) - 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 parameter also deletes any lifecycle actions associated with the group.

@type delete_policy_opts() :: [{:auto_scaling_group_name, binary()}]

The optional parameters when calling delete_policy/2

Keys

• auto_scaling_group_name (String) - The name of the Auto Scaling group

@type describe_auto_scaling_groups_opts() :: [
  auto_scaling_group_names: [binary(), ...],
  max_records: integer(),
  next_token: binary()
]

The optional parameters when calling describe_auto_scaling_groups/1

Keys

• auto_scaling_group_names (List of String) - The names of the Auto Scaling groups. Each name can be a maximum of 1600 characters. By default, you can only specify up to 50 names. You can optionally increase this limit using the MaxRecords parameter. If you omit this parameter, all Auto Scaling groups are described.

• max_records (Integer) - The maximum number of items to return with this call. The default value is 50 and the maximum value is 100.

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

@type describe_auto_scaling_instances_opts() :: [
  instance_ids: [binary(), ...],
  max_records: integer(),
  next_token: binary()
]

The optional parameters when calling describe_auto_scaling_instances/1

Keys

• instance_ids (List of String) - The IDs of the instances. You can specify up to max_records IDs. If you omit this parameter, all Auto Scaling instances are described. If you specify an ID that does not exist, it is ignored with no error.

• max_records (Integer) - The maximum number of items to return with this call. The default value is 50 and the maximum value is 50.

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

@type describe_launch_configurations_opts() :: [
  launch_configuration_names: [binary(), ...],
  max_records: integer(),
  next_token: binary()
]

The optional parameters when calling describe_launch_configurations/1

Keys

• launch_configuration_names (List of String) - The launch configuration names. If you omit this parameter, all launch configurations are described.

• max_records (Integer) - The maximum number of items to return with this call. The default value is 50 and the maximum value is 100.

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

@type describe_lifecycle_hooks_opts() :: [{:lifecycle_hook_names, [binary(), ...]}]

The optional parameters when calling describe_lifecycle_hooks/2

Keys

• lifecycle_hook_names (List of String) - The names of one or more lifecycle hooks. If you omit this parameter, all lifecycle hooks are described.

@type describe_notification_configurations_opts() :: [
  auto_scaling_group_names: [binary(), ...],
  max_records: integer(),
  next_token: binary()
]

The optional parameters when calling describe_notification_configurations/1

Keys

• auto_scaling_group_names (List of String) - The name of the Auto Scaling group

• max_records (Integer) - The maximum number of items to return with this call. The default value is 50 and the maximum value is 100.

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

@type describe_policies_opts() :: [
  auto_scaling_group_name: binary(),
  max_records: integer(),
  next_token: binary()
]

The optional parameters when calling describe_policies/1

Keys

• auto_scaling_group_name (String) - The name of the Auto Scaling group

• max_records (Integer) - The maximum number of items to return with this call. The default value is 50 and the maximum value is 100.

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

@type describe_scaling_activities_opts() :: [
  auto_scaling_group_name: binary(),
  max_records: integer(),
  next_token: binary()
]

The optional parameters when calling describe_scaling_activities/1

Keys

• auto_scaling_group_name (String) - The name of the Auto Scaling group

• max_records (Integer) - The maximum number of items to return with this call. The default value is 50 and the maximum value is 100.

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

@type describe_scheduled_actions_opts() :: [
  auto_scaling_group_name: binary(),
  end_time: binary(),
  max_records: integer(),
  next_token: binary(),
  scheduled_action_names: [binary(), ...],
  start_time: binary()
]

The optional parameters when calling describe_scheduled_actions/1

Keys

• auto_scaling_group_name (String) - The name of the Auto Scaling group

• end_time (String) - The latest scheduled start time to return. If scheduled action names are provided, this parameter is ignored.

• max_records (Integer) - The maximum number of items to return with this call. The default value is 50 and the maximum value is 100.

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

• scheduled_action_names (List of String) - The names of one or more scheduled actions. You can specify up to 50 actions. If you omit this parameter, all scheduled actions are described. If you specify an unknown scheduled action, it is ignored with no error.

• start_time (String) - The earliest scheduled start time to return. If scheduled action names are provided, this parameter is ignored.

@type describe_tags_opts() :: [
  filters: [filter(), ...],
  max_records: integer(),
  next_token: binary(),
  scheduled_action_names: [binary(), ...],
  start_time: binary()
]

The optional parameters when calling describe_tags/1

Keys

• filters (List of filter/0) - 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.

• max_records (Integer) - The maximum number of items to return with this call. The default value is 50 and the maximum value is 100.

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

@type ebs() :: [
  delete_on_termination: boolean(),
  encrypted: boolean(),
  iops: integer(),
  snapshot_id: binary(),
  volume_size: integer(),
  volume_type: binary()
]

Describes an Amazon EBS volume. Used in combination with block_device_mapping/0

Keys

• delete_on_termination (boolean) - Indicates whether the volume is deleted on instance termination. The default value is true.

• encrypted (boolean) - Specifies whether the volume should be encrypted. Encrypted EBS volumes must be attached to instances that support Amazon EBS encryption. Volumes that are created from encrypted snapshots are automatically encrypted. There is no way to create an encrypted volume from an unencrypted snapshot or an unencrypted volume from an encrypted snapshot. If your AMI uses encrypted volumes, you can only launch it on supported instance types. For more information, see Amazon EBS Encryption in the Amazon EC2 User Guide for Linux Instances.

• iops (Integer) - The number of I/O operations per second (IOPS) to provision for the volume. For more information, see Amazon EBS Volume Types in the Amazon EC2 User Guide for Linux Instances. Constraint: Required when the volume type is io1. (Not used with standard, gp2, st1, or sc1 volumes.) Valid Range: Minimum value of 100. Maximum value of 20000.

• snapshot_id (String) - The ID of the snapshot. This parameter is optional if you specify a volume size.

• volume_size (Integer) - The volume size, in GiB. Constraints: 1-1,024 for standard, 4-16,384 for io1, 1-16,384 for gp2, and 500-16,384 for st1 and sc1. If you specify a snapshot, the volume size must be equal to or larger than the snapshot size. Default: If you create a volume from a snapshot and you don't specify a volume size, the default is the snapshot size. Valid Range: Minimum value of 1. Maximum value of 16384.

• volume_type (String) - The volume type, which can be "standard" for Magnetic, "io1" for Provisioned IOPS SSD, "gp2" for General Purpose SSD, "st1" for Throughput Optimized HDD, or "sc1" for Cold HDD. For more information, see Amazon EBS Volume Types in the Amazon EC2 User Guide for Linux Instances.

@type execute_policy_opts() :: [
  breach_threshold: binary(),
  honor_cooldown: boolean(),
  metric_value: binary()
]

The optional parameters when calling execute_policy/3

Keys

• breach_threshold (Float) - The breach threshold for the alarm. This parameter is required if the policy type is StepScaling and not supported otherwise.

• honor_cooldown (boolean) - Indicates whether Amazon EC2 Auto Scaling waits for the cooldown period to complete before executing the policy. This parameter is not supported if the policy type is StepScaling.

• metric_value (Float) - 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. This parameter is required if the policy type is StepScaling and not supported otherwise.

@type filter() :: [name: binary(), values: [binary(), ...]]

Describes a filter.

Parameters

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

• values (List of String) - The value of the filter.

@type instances_distribution() :: [
  on_demand_allocation_strategy: binary(),
  on_demand_base_capacity: integer(),
  on_demand_percentage_above_base_capacity: integer(),
  spot_allocation_strategy: binary(),
  spot_instance_pools: integer(),
  spot_max_price: binary()
]

Describes an instances distribution for an Auto Scaling group with mixed_instances_policy.

Keys

• on_demand_allocation_strategy (String) - Indicates how to allocate instance types to fulfill On-Demand capacity. The only valid value is "prioritized", which is also the default value. This strategy uses the order of instance type overrides for the launch_template to define the launch priority of each instance type. The first instance type in the array is prioritized higher than the last. If all your On-Demand capacity cannot be fulfilled using your highest priority instance, then the Auto Scaling groups launches the remaining capacity using the second priority instance type, and so on.

• on_demand_base_capacity (Integer) - The minimum amount of the Auto Scaling group's capacity that must be fulfilled by On-Demand Instances. This base portion is provisioned first as your group scales. The default value is 0. If you leave this parameter set to 0, On-Demand Instances are launched as a percentage of the Auto Scaling group's desired capacity, per the on_demand_percentage_above_base_capacity setting.

• on_demand_percentage_above_base_capacity (Integer) - Controls the percentages of On-Demand Instances and Spot Instances for your additional capacity beyond on_demand_base_capacity. The range is 0–100. The default value is 100. If you leave this parameter set to 100, the percentages are 100% for On-Demand Instances and 0% for Spot Instances.

• spot_allocation_strategy (String) - Indicates how to allocate Spot capacity across Spot pools. The only valid value is "lowest-price", which is also the default value. The Auto Scaling group selects the cheapest Spot pools and evenly allocates your Spot capacity across the number of Spot pools that you specify.

• spot_instance_pools (Integer) - The number of Spot pools to use to allocate your Spot capacity. The Spot pools are determined from the different instance types in the Overrides array of launch_template. The range is 1–20 and the default is 2.

• spot_max_price (String) - The maximum price per unit hour that you are willing to pay for a Spot Instance. If you leave the value of this parameter blank (which is the default), the maximum Spot price is set at the On-Demand price. To remove a value that you previously set, include the parameter but leave the value blank.

@type instances_opts() :: [{:instance_ids, [binary(), ...]}]

The optional parameters when calling detach_instances/3, enter_standby/3, attach_instances/2

Keys

• instance_ids (List of String) - The IDs of the instances. You can specify up to 20 instances.

@type launch_template() :: [
  launch_template_specification: launch_template_specification(),
  overrides: [launch_template_overrides(), ...]
]

Describes a launch template and overrides

The overrides are used to override the instance type specified by the launch template with multiple instance types that can be used to launch On-Demand Instances and Spot Instances.

Keys

• launch_template_specification (launch_template_specification/0 - The launch template to use. You must specify either the launch template ID or launch template name in the request.

• overrides (List of launch_template_overrides/0 - Any parameters that you specify override the same parameters in the launch template. Currently, the only supported override is instance type

@type launch_template_overrides() :: [{:instance_type, binary()}]

Describes an override for a launch template

instance_type (String - The instance type. For information about available instance types, see Available Instance Types in the Amazon Elastic Compute Cloud User Guide.

@type launch_template_specification() :: [
  launch_template_id: binary(),
  launch_template_name: binary(),
  version: binary()
]

Describes a launch template and the launch template version

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.

Keys

• launch_template_id (String) - The ID of the launch template. You must specify either a template ID or a template name.

• launch_template_name (String) - The name of the launch template. You must specify either a template name or a template ID.

• version (String) - The version number, "$Latest", or "$Default". 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".

@type lifecycle_hook_specification() :: [
  default_result: binary(),
  heartbeat_timeout: integer(),
  lifecycle_hook_name: binary(),
  lifecycle_transition: binary(),
  notification_target_arn: binary(),
  role_arn: binary()
]

Describes a lifecycle hook, which tells Amazon EC2 Auto Scaling that you want to perform an action whenever it launches instances or whenever it terminates instances.

Used in combination with create_auto_scaling_group/3. For more information, see Amazon EC2 Auto Scaling Lifecycle Hooks in the Amazon EC2 Auto Scaling User Guide.

Keys

• default_result (String) - Defines the action the Auto Scaling group should take when the lifecycle hook timeout elapses or if an unexpected failure occurs. The valid values are "CONTINUE" and "ABANDON".

• heartbeat_timeout (Integer) - 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 default_result parameter. You can prevent the lifecycle hook from timing out by calling record_lifecycle_action_heartbeat/2.

• lifecycle_hook_name (String) - The name of the lifecycle hook.

• lifecycle_transition (String) - The state of the EC2 instance to which you want to attach the lifecycle hook. The possible values are: "autoscaling:EC2_INSTANCE_LAUNCHING" | "autoscaling:EC2_INSTANCE_TERMINATING"

• notification_target_arn (String) - The ARN of the target that Amazon EC2 Auto Scaling sends notifications to when an instance is in the transition state for the lifecycle hook. The notification target can be either an SQS queue or an SNS topic.

• role_arn (String) - The ARN of the IAM role that allows the Auto Scaling group to publish to the specified notification target, for example, an Amazon SNS topic or an Amazon SQS queue

@type metric_dimension() :: [name: binary(), value: binary()]

Describes the dimension of a metric

@type metrics_collection_opts() :: [{:metrics, [binary(), ...]}]

The optional parameters when calling disable_metrics_collection/2 or enable_metrics_collection/3

Keys

• metrics (List of String) - One or more of the following metrics. If you omit this parameter, all metrics are disabled.

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

@type mixed_instances_policy() :: [
  instances_distribution: instances_distribution(),
  launch_template: launch_template()
]

Describes a mixed instances policy for an Auto Scaling group

With mixed instances, your Auto Scaling group can provision a combination of On-Demand Instances and Spot Instances across multiple instance types. For more information, see Using Multiple Instance Types and Purchase Options in the Amazon EC2 Auto Scaling User Guide.

When you create your Auto Scaling group, you can specify a launch configuration or template as a parameter for the top-level object, or you can specify a mixed instances policy, but not both at the same time.

Keys

• instances_distribution (instances_distribution/0) - The instances distribution to use. If you leave this parameter unspecified when creating the group, the default values are used.

• launch_template (launch_template/0) - The launch template and overrides. This parameter is required when creating an Auto Scaling group with a mixed instances policy, but is not required when updating the group.

@type paging_opts() :: [max_records: integer(), next_token: binary()]

The optional parameters when calling describe_load_balancers/2

Keys

• max_records (Integer) - The maximum number of items to return with this call. The default value is 50 and the maximum value is 100.

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

@type predefined_metric_specification() :: [
  predefined_metric_type: binary(),
  resource_label: binary()
]

Represents a predefined metric for a target tracking scaling policy to use with Amazon EC2 Auto Scaling.

Keys

• predefined_metric_type (String) - The metric type. Valid Values: "ASGAverageCPUUtilization", "ASGAverageNetworkIn", "ASGAverageNetworkOut", "ALBRequestCountPerTarget"

• resource_label (String) - Identifies the resource associated with 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" - Number of requests completed per target in an Application Load Balancer or a Network Load Balancer target group.

  For predefined metric types ASGAverageCPUUtilization, ASGAverageNetworkIn, and ASGAverageNetworkOut, the parameter must not be specified as the resource associated with the metric type is the Auto Scaling group. For predefined metric type ALBRequestCountPerTarget, the parameter must be specified in the format: app/load-balancer-name/load-balancer-id/targetgroup/target-group-name/target-group-id, where app/load-balancer-name/load-balancer-id is the final portion of the load balancer ARN, and targetgroup/target-group-name/target-group-id is the final portion of the target group ARN. The target group must be attached to the Auto Scaling group.

@type put_lifecycle_hook_opts() :: [
  default_result: binary(),
  heartbeat_timeout: integer(),
  lifecycle_transition: binary(),
  notification_metadata: binary(),
  notification_target_arn: binary(),
  role_arn: binary()
]

Optional parmeters to put_lifecycle_hook/3

Keys

• default_result (String) - Defines the action the Auto Scaling group should take when the lifecycle hook timeout elapses or if an unexpected failure occurs. The valid values are "CONTINUE" and "ABANDON".

• heartbeat_timeout (Integer) - 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 default_result parameter. You can prevent the lifecycle hook from timing out by calling record_lifecycle_action_heartbeat/2.

• notification_metadata (String) - Contains additional information that you want to include any time Amazon EC2 Auto Scaling sends a message to the notification target.

• lifecycle_transition (String) - The state of the EC2 instance to which you want to attach the lifecycle hook. The possible values are: "autoscaling:EC2_INSTANCE_LAUNCHING" | "autoscaling:EC2_INSTANCE_TERMINATING"

• notification_target_arn (String) - The ARN of the target that Amazon EC2 Auto Scaling sends notifications to when an instance is in the transition state for the lifecycle hook. The notification target can be either an SQS queue or an SNS topic.

• role_arn (String) - The ARN of the IAM role that allows the Auto Scaling group to publish to the specified notification target, for example, an Amazon SNS topic or an Amazon SQS queue

@type put_scaling_policy_opts() :: [
  adjustment_type: binary(),
  cooldown: integer(),
  estimated_instance_warmup: integer(),
  metric_aggregation_type: binary(),
  min_adjustment_magnitude: integer(),
  min_adjustment_step: integer(),
  policy_type: binary(),
  scaling_adjustment: integer(),
  step_adjustments: [step_adjustment(), ...],
  target_tracking_configuration: target_tracking_configuration()
]

Optional parameters to put_scaling_policy/3

Keys

• adjustment_type (String) - The adjustment type. The valid values are "ChangeInCapacity", "ExactCapacity", and "PercentChangeInCapacity". This parameter is supported if the policy type is SimpleScaling or StepScaling. For more information, see Dynamic Scaling in the Amazon EC2 Auto Scaling User Guide.

• cooldown (Integer) - The amount of time, in seconds, after a scaling activity completes and before the next scaling activity can start. If this parameter is not specified, the default cooldown period for the group applies. This parameter is supported if the policy type is SimpleScaling. For more information, see Scaling Cooldowns in the Amazon EC2 Auto Scaling User Guide.

• estimated_instance_warmup (Integer) - The estimated time, in seconds, until a newly launched instance can contribute to the CloudWatch metrics. The default is to use the value specified for the default cooldown period for the group. This parameter is supported if the policy type is StepScaling or TargetTrackingScaling.

• metric_aggregation_type (String) - 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". This parameter is supported if the policy type is StepScaling.

• min_adjustment_magnitude (Integer) - The minimum number of instances to scale. If the value of AdjustmentType is PercentChangeInCapacity, the scaling policy changes the DesiredCapacity of the Auto Scaling group by at least this many instances. Otherwise, the error is ValidationError. This parameter is supported if the policy type is SimpleScaling or StepScaling.

• min_adjustment_step (Integer) - This parameter has been deprecated. Available for backward compatibility. Use min_adjustment_magnitude instead.

• policy_type (String) - The policy type. The valid values are "SimpleScaling", "StepScaling", and "TargetTrackingScaling". If the policy type is null, the value is treated as "SimpleScaling".

• scaling_adjustment (Integer) - 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. This parameter is required if the policy type is SimpleScaling and not supported otherwise.

• target_tracking_configuration (target_tracking_configuration/0) -

@type put_scheduled_update_group_action_opts() :: [
  desired_capacity: integer(),
  end_time: binary(),
  max_size: integer(),
  min_size: integer(),
  recurrence: binary(),
  start_time: binary()
]

Optional parameters to put_scheduled_update_group_action/3

Keys

• desired_capacity (Integer) - The number of EC2 instances that should be running in the group.

• end_time (String) - The time for the recurring schedule to end. Amazon EC2 Auto Scaling does not perform the action after this time.

• max_size (Integer) - The maximum size for the Auto Scaling group.

• min_size (Integer) - The minimum size for the Auto Scaling group.

• recurrence (String) - The recurring schedule for this 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.

@type record_lifecycle_action_heartbeat_opts() :: [
  instance_id: binary(),
  lifecycle_action_token: binary()
]

Optional parameters to record_lifecycle_action_heartbeat/3

Keys

• instance_id (String) - The ID of the instance

• lifecycle_action_token (String) - 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.

@type resume_processes_opts() :: [{:scaling_processes, [binary(), ...]}]

Optional parameters to resume_processes/2

Keys

• scaling_processes (List of String) - One or more of the following processes. If you omit this parameter, all processes are specified.

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

@type scheduled_update_group_action_request() :: [
  desired_capacity: integer(),
  end_time: binary(),
  max_size: integer(),
  min_size: integer(),
  recurrence: binary(),
  start_time: binary(),
  scheduled_action_name: binary()
]

Describes one or more scheduled scaling action updates for a specified Auto Scaling group. Used in combination with batch_put_scheduled_update_group_action/2.

Keys

• desired_capacity (Integer) - The number of EC2 instances that should be running in the group.

• end_time (String) - The time for the recurring schedule to end. Amazon EC2 Auto Scaling does not perform the action after this time.

• max_size (Integer) - The maximum size of the group.

• min_size (Integer) - The minimum size of the group.

• recurrence (String) - 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.

• start_time (String) - The 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 start_time, 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.

• scheduled_action_name (String) - The name of the scaling action.

@type set_desired_capacity_opts() :: [{:honor_cooldown, boolean()}]

Optional parameters when calling set_desired_capacity/3

Keys

• honor_cooldown (boolean) - 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.

@type set_instance_health_opts() :: [{:should_respect_grace_period, boolean()}]

Optional parameters when calling set_instance_health/3

Keys

• should_respect_grace_period (boolean) - If the Auto Scaling group of the specified instance has a health_check_grace_period 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 create_auto_scaling_group/4.

@type step_adjustment() :: [
  metric_interval_lower_bound: float(),
  metric_interval_upper_bound: float(),
  scaling_adjustment: integer()
]

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

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

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

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

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

Keys

• metric_interval_lower_bound (Float) - 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.

• metric_interval_upper_bound (Float) - 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.

• scaling_adjustment (Integer) - 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.

@type tag() :: [
  key: binary(),
  propogate_at_launch: boolean(),
  resource_id: binary(),
  resource_type: binary(),
  value: binary()
]

Describes a tag for an Auto Scaling group.

Keys

• key (String) - The tag key. Length Constraints: Minimum length of 1. Maximum length of 128. Required.

• propagate_at_launch (boolean) - Determines whether the tag is added to new instances as they are launched in the group.

• resource_id (String) - The name of the group.

• resource_type (String) - The type of resource. The only supported value is "auto-scaling-group".

• value (String) - The tag value. Length Constraints: Minimum length of 0. Maximum length of 256.

@type target_tracking_configuration() :: [
  customized_metric_specification: customized_metric_specification(),
  disable_scale_in: boolean(),
  predefined_metric_specification: predefined_metric_specification(),
  target_value: float()
]

A target tracking scaling policy.

Keys

• customized_metric_specification (customized_metric_specification/0) - A customized metric. You can specify either a predefined metric or a customized metric.

• disable_scale_in (boolean) - 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 disabled.

• predefined_metric_specification (predefined_metric_specification/0) - A predefined metric. You can specify either a predefined metric or a customized metric.

• target_value (Float) - The target value for the metric.

@type update_auto_scaling_group_opts() :: [
  availability_zones: [binary(), ...],
  default_cool_down: integer(),
  desired_capacity: integer(),
  health_check_grace_period: integer(),
  health_check_type: binary(),
  instance_id: binary(),
  launch_configuration_name: binary(),
  launch_template: launch_template_specification(),
  lifecycle_hook_specification_list: [lifecycle_hook_specification(), ...],
  max_size: integer(),
  min_size: integer(),
  mixed_instances_policy: mixed_instances_policy(),
  new_instances_protected_from_scale_in: boolean(),
  placement_group: binary(),
  service_linked_role_arn: binary(),
  termination_policies: [binary(), ...],
  vpc_zone_identifier: binary()
]

The optional parameters when calling update_auto_scaling_group/2

Keys

• availability_zones (List) - One or more Availability Zones for the group. This parameter is optional if you specify one or more subnets. Minimum number of 1 item. Maximum number is 255.

• default_cool_down (Integer) - The amount of time, in seconds, after a scaling activity completes before another scaling activity can start. The default value is 300.

• desired_capacity (Integer) - The number of EC2 instances that should be running in the group. 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.

• health_check_grace_period (Integer) - 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. During this time, any health check failures for the instance are ignored. The default value is 0. This parameter is required if you are adding an ELB health check.

• health_check_type (String) - The service to use for the health checks. The valid values are "EC2" and "ELB".

• launch_configuration_name (String) - The name of the launch configuration. If you specify this parameter, you can't specify a launch template or a mixed instances policy.

• launch_template (launch_template_specification/0) - The launch template and version to use to specify the updates. If you specify this parameter, you can't specify a launch configuration or a mixed instances policy

• max_size (Integer) - The maximum size of the Auto Scaling group.

• min_size (Integer) - The minimum size of the Auto Scaling group.

• mixed_instances_policy - The mixed instances policy to use to launch instances. This parameter, a launch template, a launch configuration, or an EC2 instance must be specified.

• new_instances_protected_from_scale_in (boolean) - Indicates whether newly launched instances are protected from termination by Auto Scaling when scaling in. For more information about preventing instances from terminating on scale in, see Instance Protection in the Amazon EC2 Auto Scaling User Guide.

• placement_group (String) - The name of the placement group into which to launch your instances, if any. For more information, see Placement Groups in the Amazon EC2 User Guide for Linux Instances.

• service_linked_role_arn (String) - The Amazon Resource Name (ARN) of the service-linked role that the Auto Scaling group uses to call other AWS services 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.

• termination_policies (List of String) - One or more termination policies used to select the instance to terminate. These policies are executed in the order that they are listed. For more information, see "Controlling Which Instances Auto Scaling Terminates During Scale In" in the Amazon EC2 Auto Scaling User Guide.

• vpc_zone_identifier (String) - A comma-separated list of subnet identifiers for your virtual private cloud (VPC)