lib/aws-sdk-autoscaling/client.rb in aws-sdk-autoscaling-1.13.0 vs lib/aws-sdk-autoscaling/client.rb in aws-sdk-autoscaling-1.14.0
- old
+ new
@@ -267,11 +267,14 @@
#
# To describe the target groups for an Auto Scaling group, use
# DescribeLoadBalancerTargetGroups. To detach the target group from the
# Auto Scaling group, use DetachLoadBalancerTargetGroups.
#
- # For more information, see [Attach a Load Balancer to Your Auto Scaling
+ # With Application Load Balancers and Network Load Balancers, instances
+ # are registered as targets with a target group. With Classic Load
+ # Balancers, instances are registered with the load balancer. For more
+ # information, see [Attaching a Load Balancer to Your Auto Scaling
# Group][1] in the *Amazon EC2 Auto Scaling User Guide*.
#
#
#
# [1]: http://docs.aws.amazon.com/autoscaling/ec2/userguide/attach-load-balancer-asg.html
@@ -314,19 +317,19 @@
end
# Attaches one or more Classic Load Balancers to the specified Auto
# Scaling group.
#
- # To attach an Application Load Balancer instead, see
- # AttachLoadBalancerTargetGroups.
+ # To attach an Application Load Balancer or a Network Load Balancer
+ # instead, see AttachLoadBalancerTargetGroups.
#
# To describe the load balancers for an Auto Scaling group, use
# DescribeLoadBalancers. To detach the load balancer from the Auto
# Scaling group, use DetachLoadBalancers.
#
- # For more information, see [Attach a Load Balancer to Your Auto Scaling
- # Group][1] in the *Amazon EC2 Auto Scaling User Guide*.
+ # For more information, see [Attaching a Load Balancer to Your Auto
+ # Scaling Group][1] in the *Amazon EC2 Auto Scaling User Guide*.
#
#
#
# [1]: http://docs.aws.amazon.com/autoscaling/ec2/userguide/attach-load-balancer-asg.html
#
@@ -538,11 +541,12 @@
# Creates an Auto Scaling group with the specified name and attributes.
#
# If you exceed your maximum limit of Auto Scaling groups, the call
# fails. For information about viewing this limit, see
# DescribeAccountLimits. For information about updating this limit, see
- # [Auto Scaling Limits][1] in the *Amazon EC2 Auto Scaling User Guide*.
+ # [Amazon EC2 Auto Scaling Limits][1] in the *Amazon EC2 Auto Scaling
+ # User Guide*.
#
# For more information, see [Auto Scaling Groups][2] in the *Amazon EC2
# Auto Scaling User Guide*.
#
#
@@ -614,18 +618,18 @@
# One or more Availability Zones for the group. This parameter is
# optional if you specify one or more subnets.
#
# @option params [Array<String>] :load_balancer_names
# One or more Classic Load Balancers. To specify an Application Load
- # Balancer, use `TargetGroupARNs` instead.
+ # Balancer or a Network Load Balancer, use `TargetGroupARNs` instead.
#
# For more information, see [Using a Load Balancer With an Auto Scaling
# Group][1] in the *Amazon EC2 Auto Scaling User Guide*.
#
#
#
- # [1]: http://docs.aws.amazon.com/autoscaling/ec2/userguide/create-asg-from-instance.html
+ # [1]: http://docs.aws.amazon.com/autoscaling/ec2/userguide/autoscaling-load-balancer.html
#
# @option params [Array<String>] :target_group_arns
# The Amazon Resource Names (ARN) of the target groups.
#
# @option params [String] :health_check_type
@@ -656,11 +660,11 @@
# [1]: http://docs.aws.amazon.com/autoscaling/ec2/userguide/healthcheck.html
#
# @option params [String] :placement_group
# The name of the placement group into which to launch your instances,
# if any. For more information, see [Placement Groups][1] in the *Amazon
- # Elastic Compute Cloud User Guide*.
+ # EC2 User Guide for Linux Instances*.
#
#
#
# [1]: http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/placement-groups.html
#
@@ -683,20 +687,29 @@
# 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][1] in the *Auto Scaling User Guide*.
+ # Terminates During Scale In][1] in the *Amazon EC2 Auto Scaling User
+ # Guide*.
#
#
#
# [1]: http://docs.aws.amazon.com/autoscaling/ec2/userguide/as-instance-termination.html
#
# @option params [Boolean] :new_instances_protected_from_scale_in
# 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][1] in the *Amazon EC2 Auto Scaling
+ # User Guide*.
+ #
+ #
+ #
+ # [1]: http://docs.aws.amazon.com/autoscaling/ec2/userguide/as-instance-termination.html#instance-protection
+ #
# @option params [Array<Types::LifecycleHookSpecification>] :lifecycle_hook_specification_list
# One or more lifecycle hooks.
#
# @option params [Array<Types::Tag>] :tags
# One or more tags.
@@ -792,11 +805,11 @@
# on_demand_allocation_strategy: "XmlString",
# on_demand_base_capacity: 1,
# on_demand_percentage_above_base_capacity: 1,
# spot_allocation_strategy: "XmlString",
# spot_instance_pools: 1,
- # spot_max_price: "SpotPrice",
+ # spot_max_price: "MixedInstanceSpotPrice",
# },
# },
# instance_id: "XmlStringMaxLen19",
# min_size: 1, # required
# max_size: 1, # required
@@ -846,11 +859,12 @@
# Creates a launch configuration.
#
# If you exceed your maximum limit of launch configurations, the call
# fails. For information about viewing this limit, see
# DescribeAccountLimits. For information about updating this limit, see
- # [Auto Scaling Limits][1] in the *Amazon EC2 Auto Scaling User Guide*.
+ # [Amazon EC2 Auto Scaling Limits][1] in the *Amazon EC2 Auto Scaling
+ # User Guide*.
#
# For more information, see [Launch Configurations][2] in the *Amazon
# EC2 Auto Scaling User Guide*.
#
#
@@ -866,32 +880,32 @@
# The ID of the Amazon Machine Image (AMI) to use to launch your EC2
# instances.
#
# If you do not specify `InstanceId`, you must specify `ImageId`.
#
- # For more information, see [Finding an AMI][1] in the *Amazon Elastic
- # Compute Cloud User Guide*.
+ # For more information, see [Finding an AMI][1] in the *Amazon EC2 User
+ # Guide for Linux Instances*.
#
#
#
# [1]: http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/finding-an-ami.html
#
# @option params [String] :key_name
# The name of the key pair. For more information, see [Amazon EC2 Key
- # Pairs][1] in the *Amazon Elastic Compute Cloud User Guide*.
+ # Pairs][1] in the *Amazon EC2 User Guide for Linux Instances*.
#
#
#
# [1]: http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-key-pairs.html
#
# @option params [Array<String>] :security_groups
# 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][1] in the *Amazon Elastic Compute
- # Cloud User Guide*.
+ # see [Amazon EC2 Security Groups][1] 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][2] in the
# *Amazon Virtual Private Cloud User Guide*.
#
@@ -902,31 +916,35 @@
#
# @option params [String] :classic_link_vpc_id
# 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][1] in the *Amazon
- # Elastic Compute Cloud User Guide*.
+ # EC2 User Guide for Linux Instances* and [Linking EC2-Classic Instances
+ # to a VPC][2] in the *Amazon EC2 Auto Scaling User Guide*.
#
#
#
# [1]: http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/vpc-classiclink.html
+ # [2]: http://docs.aws.amazon.com/autoscaling/ec2/userguide/asg-in-vpc.html#as-ClassicLink
#
# @option params [Array<String>] :classic_link_vpc_security_groups
# 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][1] in the *Amazon Elastic Compute Cloud
- # User Guide*.
+ # information, see [ClassicLink][1] in the *Amazon EC2 User Guide for
+ # Linux Instances* and [Linking EC2-Classic Instances to a VPC][2] in
+ # the *Amazon EC2 Auto Scaling User Guide*.
#
#
#
# [1]: http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/vpc-classiclink.html
+ # [2]: http://docs.aws.amazon.com/autoscaling/ec2/userguide/asg-in-vpc.html#as-ClassicLink
#
# @option params [String] :user_data
# The user data to make available to the launched EC2 instances. For
# more information, see [Instance Metadata and User Data][1] in the
- # *Amazon Elastic Compute Cloud User Guide*.
+ # *Amazon EC2 User Guide for Linux Instances*.
#
#
#
# [1]: http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-instance-metadata.html
#
@@ -953,11 +971,11 @@
# The instance type of the EC2 instance.
#
# If you do not specify `InstanceId`, you must specify `InstanceType`.
#
# For information about available instance types, see [Available
- # Instance Types][1] in the *Amazon Elastic Compute Cloud User Guide.*
+ # Instance Types][1] in the *Amazon EC2 User Guide for Linux Instances.*
#
#
#
# [1]: http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-types.html#AvailableInstanceTypes
#
@@ -968,11 +986,11 @@
# The ID of the RAM disk associated with the AMI.
#
# @option params [Array<Types::BlockDeviceMapping>] :block_device_mappings
# One or more mappings that specify how block devices are exposed to the
# instance. For more information, see [Block Device Mapping][1] in the
- # *Amazon Elastic Compute Cloud User Guide*.
+ # *Amazon EC2 User Guide for Linux Instances*.
#
#
#
# [1]: http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/block-device-mapping-concepts.html
#
@@ -997,12 +1015,12 @@
#
# 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 [Launch Auto Scaling Instances with an IAM Role][1]
- # in the *Amazon EC2 Auto Scaling User Guide*.
+ # information, see [Use an IAM Role for Applications That Run on Amazon
+ # EC2 Instances][1] in the *Amazon EC2 Auto Scaling User Guide*.
#
#
#
# [1]: http://docs.aws.amazon.com/autoscaling/ec2/userguide/us-iam-role.html
#
@@ -1011,11 +1029,11 @@
# 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][1] in the *Amazon Elastic Compute Cloud User Guide*.
+ # Instances][1] in the *Amazon EC2 User Guide for Linux Instances*.
#
#
#
# [1]: http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSOptimized.html
#
@@ -1485,11 +1503,12 @@
# Describes the current Auto Scaling resource limits for your AWS
# account.
#
# For information about requesting an increase in these limits, see
- # [Auto Scaling Limits][1] in the *Amazon EC2 Auto Scaling User Guide*.
+ # [Amazon EC2 Auto Scaling Limits][1] in the *Amazon EC2 Auto Scaling
+ # User Guide*.
#
#
#
# [1]: http://docs.aws.amazon.com/autoscaling/ec2/userguide/as-account-limits.html
#
@@ -1576,14 +1595,16 @@
end
# Describes one or more Auto Scaling groups.
#
# @option params [Array<String>] :auto_scaling_group_names
- # The names of the Auto Scaling groups. You can specify up to
- # `MaxRecords` names. If you omit this parameter, all Auto Scaling
- # groups are described.
+ # 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.
+ #
# @option params [String] :next_token
# The token for the next set of items to return. (You received this
# token from a previous call.)
#
# @option params [Integer] :max_records
@@ -2125,12 +2146,12 @@
end
# Describes the load balancers for the specified Auto Scaling group.
#
# This operation describes only Classic Load Balancers. If you have
- # Application Load Balancers, use DescribeLoadBalancerTargetGroups
- # instead.
+ # Application Load Balancers or Network Load Balancers, use
+ # DescribeLoadBalancerTargetGroups instead.
#
# @option params [required, String] :auto_scaling_group_name
# The name of the Auto Scaling group.
#
# @option params [String] :next_token
@@ -2967,12 +2988,12 @@
# Detaches one or more Classic Load Balancers from the specified Auto
# Scaling group.
#
# This operation detaches only Classic Load Balancers. If you have
- # Application Load Balancers, use DetachLoadBalancerTargetGroups
- # instead.
+ # Application Load Balancers or Network Load Balancers, use
+ # DetachLoadBalancerTargetGroups instead.
#
# When you detach a load balancer, it enters the `Removing` state while
# deregistering the instances in the group. When all instances are
# deregistered, then you can no longer describe the load balancer using
# DescribeLoadBalancers. The instances remain running.
@@ -3391,22 +3412,19 @@
# keep the instance in a pending state.
#
# 5. If you finish before the timeout period ends, complete the
# lifecycle action.
#
- # For more information, see [Auto Scaling Lifecycle Hooks][1] in the
- # *Amazon EC2 Auto Scaling User Guide*.
+ # For more information, see [Amazon EC2 Auto Scaling Lifecycle Hooks][1]
+ # in the *Amazon EC2 Auto Scaling User Guide*.
#
# If you exceed your maximum limit of lifecycle hooks, which by default
- # is 50 per Auto Scaling group, the call fails. For information about
- # updating this limit, see [AWS Service Limits][2] in the *Amazon Web
- # Services General Reference*.
+ # is 50 per Auto Scaling group, the call fails.
#
#
#
# [1]: http://docs.aws.amazon.com/autoscaling/ec2/userguide/lifecycle-hooks.html
- # [2]: http://docs.aws.amazon.com/general/latest/gr/aws_service_limits.html
#
# @option params [required, String] :lifecycle_hook_name
# The name of the lifecycle hook.
#
# @option params [required, String] :auto_scaling_group_name
@@ -3505,12 +3523,13 @@
# messages delivered to an endpoint such as a web server or an email
# address.
#
# This configuration overwrites any existing configuration.
#
- # For more information, see [Getting SNS Notifications When Your Auto
- # Scaling Group Scales][1] in the *Auto Scaling User Guide*.
+ # For more information, see [Getting Amazon SNS Notifications When Your
+ # Auto Scaling Group Scales][1] in the *Amazon EC2 Auto Scaling User
+ # Guide*.
#
#
#
# [1]: http://docs.aws.amazon.com/autoscaling/ec2/userguide/ASGettingNotifications.html
#
@@ -3561,19 +3580,10 @@
# Creates or updates a policy for an Auto Scaling group. To update an
# existing policy, use the existing policy name and set the parameters
# to change. Any existing parameter not changed in an update to an
# existing policy is not changed in this update request.
#
- # If you exceed your maximum limit of step adjustments, which by default
- # is 20 per region, the call fails. For information about updating this
- # limit, see [AWS Service Limits][1] in the *Amazon Web Services General
- # Reference*.
- #
- #
- #
- # [1]: http://docs.aws.amazon.com/general/latest/gr/aws_service_limits.html
- #
# @option params [required, String] :auto_scaling_group_name
# The name of the Auto Scaling group.
#
# @option params [required, String] :policy_name
# The name of the policy.
@@ -3775,11 +3785,14 @@
# The time for the recurring schedule to end. Amazon EC2 Auto Scaling
# does not perform the action after this time.
#
# @option params [String] :recurrence
# The recurring schedule for this action, in Unix cron syntax format.
- # For more information about this format, see [Crontab][1].
+ # This format consists of five fields separated by white spaces:
+ # \[Minute\] \[Hour\] \[Day\_of\_Month\] \[Month\_of\_Year\]
+ # \[Day\_of\_Week\]. For more information about this format, see
+ # [Crontab][1].
#
#
#
# [1]: http://crontab.org
#
@@ -3978,11 +3991,11 @@
# For more information about desired capacity, see [What Is Amazon EC2
# Auto Scaling?][1] in the *Amazon EC2 Auto Scaling User Guide*.
#
#
#
- # [1]: http://docs.aws.amazon.com/autoscaling/ec2/userguide/WhatIsAutoScaling.html
+ # [1]: http://docs.aws.amazon.com/autoscaling/ec2/userguide/what-is-amazon-ec2-auto-scaling.html
#
# @option params [required, String] :auto_scaling_group_name
# The name of the Auto Scaling group.
#
# @option params [required, Integer] :desired_capacity
@@ -4082,12 +4095,13 @@
req.send_request(options)
end
# Updates the instance protection settings of the specified instances.
#
- # For more information, see [Instance Protection][1] in the *Amazon EC2
- # Auto Scaling User Guide*.
+ # For more information about preventing instances that are part of an
+ # Auto Scaling group from terminating on scale in, see [Instance
+ # Protection][1] in the *Amazon EC2 Auto Scaling User Guide*.
#
#
#
# [1]: http://docs.aws.amazon.com/autoscaling/ec2/userguide/as-instance-termination.html#instance-protection
#
@@ -4355,11 +4369,11 @@
# [1]: http://docs.aws.amazon.com/autoscaling/ec2/userguide/healthcheck.html
#
# @option params [String] :placement_group
# The name of the placement group into which to launch your instances,
# if any. For more information, see [Placement Groups][1] in the *Amazon
- # Elastic Compute Cloud User Guide*.
+ # EC2 User Guide for Linux Instances*.
#
#
#
# [1]: http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/placement-groups.html
#
@@ -4382,20 +4396,29 @@
# A standalone termination policy or a list of termination policies used
# to select the instance to terminate. The policies are executed in the
# order that they are listed.
#
# For more information, see [Controlling Which Instances Auto Scaling
- # Terminates During Scale In][1] in the *Auto Scaling User Guide*.
+ # Terminates During Scale In][1] in the *Amazon EC2 Auto Scaling User
+ # Guide*.
#
#
#
# [1]: http://docs.aws.amazon.com/autoscaling/ec2/userguide/as-instance-termination.html
#
# @option params [Boolean] :new_instances_protected_from_scale_in
# 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][1] in the *Amazon EC2 Auto Scaling
+ # User Guide*.
+ #
+ #
+ #
+ # [1]: http://docs.aws.amazon.com/autoscaling/ec2/userguide/as-instance-termination.html#instance-protection
+ #
# @option params [String] :service_linked_role_arn
# The Amazon Resource Name (ARN) of the service-linked role that the
# Auto Scaling group uses to call other AWS services on your behalf.
#
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
@@ -4456,11 +4479,11 @@
# on_demand_allocation_strategy: "XmlString",
# on_demand_base_capacity: 1,
# on_demand_percentage_above_base_capacity: 1,
# spot_allocation_strategy: "XmlString",
# spot_instance_pools: 1,
- # spot_max_price: "SpotPrice",
+ # spot_max_price: "MixedInstanceSpotPrice",
# },
# },
# min_size: 1,
# max_size: 1,
# desired_capacity: 1,
@@ -4495,10 +4518,10 @@
operation: config.api.operation(operation_name),
client: self,
params: params,
config: config)
context[:gem_name] = 'aws-sdk-autoscaling'
- context[:gem_version] = '1.13.0'
+ context[:gem_version] = '1.14.0'
Seahorse::Client::Request.new(handlers, context)
end
# Polls an API operation until a resource enters a desired state.
#