lib/aws-sdk-autoscaling/client.rb in aws-sdk-autoscaling-1.4.0 vs lib/aws-sdk-autoscaling/client.rb in aws-sdk-autoscaling-1.5.0

- old
+ new

@@ -164,11 +164,11 @@ # # # [1]: http://docs.aws.amazon.com/autoscaling/latest/userguide/attach-instance-asg.html # # @option params [Array<String>] :instance_ids - # One or more instance IDs. + # The IDs of the instances. You can specify up to 20 instances. # # @option params [required, String] :auto_scaling_group_name # The name of the Auto Scaling group. # # @return [Struct] Returns an empty {Seahorse::Client::Response response}. @@ -217,11 +217,12 @@ # # @option params [required, String] :auto_scaling_group_name # The name of the Auto Scaling group. # # @option params [required, Array<String>] :target_group_arns - # The Amazon Resource Names (ARN) of the target groups. + # The Amazon Resource Names (ARN) of the target groups. You can specify + # up to 10 target groups. # # @return [Struct] Returns an empty {Seahorse::Client::Response response}. # # # @example Example: To attach a target group to an Auto Scaling group @@ -270,11 +271,12 @@ # # @option params [required, String] :auto_scaling_group_name # The name of the Auto Scaling group. # # @option params [required, Array<String>] :load_balancer_names - # One or more load balancer names. + # The names of the load balancers. You can specify up to 10 load + # balancers. # # @return [Struct] Returns an empty {Seahorse::Client::Response response}. # # # @example Example: To attach a load balancer to an Auto Scaling group @@ -388,20 +390,22 @@ req.send_request(options) end # Creates an Auto Scaling group with the specified name and attributes. # - # If you exceed your maximum limit of Auto Scaling groups, which by - # default is 20 per region, the call fails. For information about - # viewing and updating this limit, see DescribeAccountLimits. + # 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 *Auto Scaling User Guide*. # - # For more information, see [Auto Scaling Groups][1] in the *Auto + # For more information, see [Auto Scaling Groups][2] in the *Auto # Scaling User Guide*. # # # - # [1]: http://docs.aws.amazon.com/autoscaling/latest/userguide/AutoScalingGroup.html + # [1]: http://docs.aws.amazon.com/autoscaling/latest/userguide/as-account-limits.html + # [2]: http://docs.aws.amazon.com/autoscaling/latest/userguide/AutoScalingGroup.html # # @option params [required, String] :auto_scaling_group_name # The name of the Auto Scaling group. This name must be unique within # the scope of your AWS account. # @@ -552,10 +556,16 @@ # # # # [1]: http://docs.aws.amazon.com/autoscaling/latest/userguide/autoscaling-tagging.html # + # @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. By + # default, Auto Scaling uses a service-linked role named + # AWSServiceRoleForAutoScaling, which it creates if it does not exist. + # # @return [Struct] Returns an empty {Seahorse::Client::Response response}. # # # @example Example: To create an Auto Scaling group # @@ -647,10 +657,11 @@ # key: "TagKey", # required # value: "TagValue", # propagate_at_launch: false, # }, # ], + # service_linked_role_arn: "ResourceName", # }) # # @see http://docs.aws.amazon.com/goto/WebAPI/autoscaling-2011-01-01/CreateAutoScalingGroup AWS API Documentation # # @overload create_auto_scaling_group(params = {}) @@ -660,20 +671,22 @@ req.send_request(options) end # Creates a launch configuration. # - # If you exceed your maximum limit of launch configurations, which by - # default is 100 per region, the call fails. For information about - # viewing and updating this limit, see DescribeAccountLimits. + # 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 *Auto Scaling User Guide*. # - # For more information, see [Launch Configurations][1] in the *Auto + # For more information, see [Launch Configurations][2] in the *Auto # Scaling User Guide*. # # # - # [1]: http://docs.aws.amazon.com/autoscaling/latest/userguide/LaunchConfiguration.html + # [1]: http://docs.aws.amazon.com/autoscaling/latest/userguide/as-account-limits.html + # [2]: http://docs.aws.amazon.com/autoscaling/latest/userguide/LaunchConfiguration.html # # @option params [required, String] :launch_configuration_name # The name of the launch configuration. This name must be unique within # the scope of your AWS account. # @@ -842,18 +855,17 @@ # # 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 `true`. If the instance is launched into a nondefault - # subnet, the default is `false`. For more information, see [Supported - # Platforms][2] in the *Amazon Elastic Compute Cloud User Guide*. + # 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. # # # # [1]: http://docs.aws.amazon.com/autoscaling/latest/userguide/asg-in-vpc.html - # [2]: http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-supported-platforms.html # # @option params [String] :placement_tenancy # 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. # @@ -1300,16 +1312,16 @@ end # Describes the current Auto Scaling resource limits for your AWS # account. # - # For information about requesting an increase in these limits, see [AWS - # Service Limits][1] in the *Amazon Web Services General Reference*. + # For information about requesting an increase in these limits, see + # [Auto Scaling Limits][1] in the *Auto Scaling User Guide*. # # # - # [1]: http://docs.aws.amazon.com/general/latest/gr/aws_service_limits.html + # [1]: http://docs.aws.amazon.com/autoscaling/latest/userguide/as-account-limits.html # # @return [Types::DescribeAccountLimitsAnswer] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # # * {Types::DescribeAccountLimitsAnswer#max_number_of_auto_scaling_groups #max_number_of_auto_scaling_groups} => Integer # * {Types::DescribeAccountLimitsAnswer#max_number_of_launch_configurations #max_number_of_launch_configurations} => Integer @@ -1521,10 +1533,11 @@ # resp.auto_scaling_groups[0].tags[0].value #=> String # resp.auto_scaling_groups[0].tags[0].propagate_at_launch #=> Boolean # resp.auto_scaling_groups[0].termination_policies #=> Array # resp.auto_scaling_groups[0].termination_policies[0] #=> String # resp.auto_scaling_groups[0].new_instances_protected_from_scale_in #=> Boolean + # resp.auto_scaling_groups[0].service_linked_role_arn #=> String # resp.next_token #=> String # # @see http://docs.aws.amazon.com/goto/WebAPI/autoscaling-2011-01-01/DescribeAutoScalingGroups AWS API Documentation # # @overload describe_auto_scaling_groups(params = {}) @@ -1541,11 +1554,11 @@ # parameter, all Auto Scaling instances are described. If you specify an # ID that does not exist, it is ignored with no error. # # @option params [Integer] :max_records # The maximum number of items to return with this call. The default - # value is 50 and the maximum value is 100. + # value is 50 and the maximum value is 50. # # @option params [String] :next_token # The token for the next set of items to return. (You received this # token from a previous call.) # @@ -1868,11 +1881,11 @@ # The token for the next set of items to return. (You received this # token from a previous call.) # # @option params [Integer] :max_records # The maximum number of items to return with this call. The default - # value is 50 and the maximum value is 100. + # value is 100 and the maximum value is 100. # # @return [Types::DescribeLoadBalancerTargetGroupsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # # * {Types::DescribeLoadBalancerTargetGroupsResponse#load_balancer_target_groups #load_balancer_target_groups} => Array&lt;Types::LoadBalancerTargetGroupState&gt; # * {Types::DescribeLoadBalancerTargetGroupsResponse#next_token #next_token} => String @@ -1933,11 +1946,11 @@ # The token for the next set of items to return. (You received this # token from a previous call.) # # @option params [Integer] :max_records # The maximum number of items to return with this call. The default - # value is 50 and the maximum value is 100. + # value is 100 and the maximum value is 100. # # @return [Types::DescribeLoadBalancersResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # # * {Types::DescribeLoadBalancersResponse#load_balancers #load_balancers} => Array&lt;Types::LoadBalancerState&gt; # * {Types::DescribeLoadBalancersResponse#next_token #next_token} => String @@ -2255,11 +2268,11 @@ # @option params [String] :auto_scaling_group_name # The name of the Auto Scaling group. # # @option params [Integer] :max_records # The maximum number of items to return with this call. The default - # value is 100. + # value is 100 and the maximum value is 100. # # @option params [String] :next_token # The token for the next set of items to return. (You received this # token from a previous call.) # @@ -2637,18 +2650,18 @@ # # # [1]: http://docs.aws.amazon.com/autoscaling/latest/userguide/detach-instance-asg.html # # @option params [Array<String>] :instance_ids - # One or more instance IDs. + # The IDs of the instances. You can specify up to 20 instances. # # @option params [required, String] :auto_scaling_group_name # The name of the Auto Scaling group. # # @option params [required, Boolean] :should_decrement_desired_capacity - # If `True`, the Auto Scaling group decrements the desired capacity - # value by the number of instances detached. + # Indicates whether the Auto Scaling group decrements the desired + # capacity value by the number of instances detached. # # @return [Types::DetachInstancesAnswer] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # # * {Types::DetachInstancesAnswer#activities #activities} => Array&lt;Types::Activity&gt; # @@ -2717,11 +2730,12 @@ # # @option params [required, String] :auto_scaling_group_name # The name of the Auto Scaling group. # # @option params [required, Array<String>] :target_group_arns - # The Amazon Resource Names (ARN) of the target groups. + # The Amazon Resource Names (ARN) of the target groups. You can specify + # up to 10 target groups. # # @return [Struct] Returns an empty {Seahorse::Client::Response response}. # # # @example Example: To detach a target group from an Auto Scaling group @@ -2765,11 +2779,12 @@ # # @option params [required, String] :auto_scaling_group_name # The name of the Auto Scaling group. # # @option params [required, Array<String>] :load_balancer_names - # One or more load balancer names. + # The names of the load balancers. You can specify up to 10 load + # balancers. # # @return [Struct] Returns an empty {Seahorse::Client::Response response}. # # # @example Example: To detach a load balancer from an Auto Scaling group @@ -2926,21 +2941,18 @@ # # # [1]: http://docs.aws.amazon.com/autoscaling/latest/userguide/as-enter-exit-standby.html # # @option params [Array<String>] :instance_ids - # One or more instances to move into `Standby` mode. You must specify at - # least one instance ID. + # The IDs of the instances. You can specify up to 20 instances. # # @option params [required, String] :auto_scaling_group_name # The name of the Auto Scaling group. # # @option params [required, Boolean] :should_decrement_desired_capacity - # Specifies whether the instances moved to `Standby` mode count as part - # of the Auto Scaling group's desired capacity. If set, the desired - # capacity for the Auto Scaling group decrements by the number of - # instances moved to `Standby` mode. + # Indicates whether to decrement the desired capacity of the Auto + # Scaling group by the number of instances moved to `Standby` mode. # # @return [Types::EnterStandbyAnswer] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # # * {Types::EnterStandbyAnswer#activities #activities} => Array&lt;Types::Activity&gt; # @@ -3011,14 +3023,12 @@ # # @option params [required, String] :policy_name # The name or ARN of the policy. # # @option params [Boolean] :honor_cooldown - # If this parameter is true, Auto Scaling waits for the cooldown period - # to complete before executing the policy. Otherwise, Auto Scaling - # executes the policy without waiting for the cooldown period to - # complete. + # Indicates whether Auto Scaling waits for the cooldown period to + # complete before executing the policy. # # This parameter is not supported if the policy type is `StepScaling`. # # For more information, see [Auto Scaling Cooldowns][1] in the *Auto # Scaling User Guide*. @@ -3086,11 +3096,11 @@ # # # [1]: http://docs.aws.amazon.com/autoscaling/latest/userguide/as-enter-exit-standby.html # # @option params [Array<String>] :instance_ids - # One or more instance IDs. You must specify at least one instance ID. + # The IDs of the instances. You can specify up to 20 instances. # # @option params [required, String] :auto_scaling_group_name # The name of the Auto Scaling group. # # @return [Types::ExitStandbyAnswer] Returns a {Seahorse::Client::Response response} object which responds to the following methods: @@ -3773,15 +3783,14 @@ # @option params [required, Integer] :desired_capacity # The number of EC2 instances that should be running in the Auto Scaling # group. # # @option params [Boolean] :honor_cooldown - # By default, `SetDesiredCapacity` overrides any cooldown period - # associated with the Auto Scaling group. Specify `True` to make Auto - # Scaling to wait for the cool-down period associated with the Auto - # Scaling group to complete before initiating a scaling activity to set - # your Auto Scaling group to its new capacity. + # Indicates whether 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, Auto Scaling does not honor the + # cooldown period during manual scaling activities. # # @return [Struct] Returns an empty {Seahorse::Client::Response response}. # # # @example Example: To set the desired capacity for an Auto Scaling group @@ -4006,12 +4015,12 @@ # # @option params [required, String] :instance_id # The ID of the instance. # # @option params [required, Boolean] :should_decrement_desired_capacity - # If `true`, terminating the instance also decrements the size of the - # Auto Scaling group. + # Indicates whether terminating the instance also decrements the size of + # the Auto Scaling group. # # @return [Types::ActivityType] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # # * {Types::ActivityType#activity #activity} => Types::Activity # @@ -4083,16 +4092,16 @@ # # @option params [required, String] :auto_scaling_group_name # The name of the Auto Scaling group. # # @option params [String] :launch_configuration_name - # The name of the launch configuration. You must specify either a launch - # configuration or a launch template. + # The name of the launch configuration. If you specify a launch + # configuration, you can't specify a launch template. # # @option params [Types::LaunchTemplateSpecification] :launch_template - # The launch template to use to specify the updates. You must specify a - # launch configuration or a launch template. + # The launch template to use to specify the updates. If you specify a + # launch template, you can't specify a launch configuration. # # @option params [Integer] :min_size # The minimum size of the Auto Scaling group. # # @option params [Integer] :max_size @@ -4171,10 +4180,14 @@ # # @option params [Boolean] :new_instances_protected_from_scale_in # Indicates whether newly launched instances are protected from # termination by Auto Scaling when scaling in. # + # @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}. # # # @example Example: To update the launch configuration # @@ -4223,10 +4236,11 @@ # health_check_grace_period: 1, # placement_group: "XmlStringMaxLen255", # vpc_zone_identifier: "XmlStringMaxLen2047", # termination_policies: ["XmlStringMaxLen1600"], # new_instances_protected_from_scale_in: false, + # service_linked_role_arn: "ResourceName", # }) # # @see http://docs.aws.amazon.com/goto/WebAPI/autoscaling-2011-01-01/UpdateAutoScalingGroup AWS API Documentation # # @overload update_auto_scaling_group(params = {}) @@ -4247,10 +4261,10 @@ operation: config.api.operation(operation_name), client: self, params: params, config: config) context[:gem_name] = 'aws-sdk-autoscaling' - context[:gem_version] = '1.4.0' + context[:gem_version] = '1.5.0' Seahorse::Client::Request.new(handlers, context) end # Polls an API operation until a resource enters a desired state. #