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

- old
+ new

@@ -167,11 +167,11 @@ # # @option params [Array<String>] :instance_ids # One or more instance IDs. # # @option params [required, String] :auto_scaling_group_name - # The name of the group. + # The name of the Auto Scaling group. # # @return [Struct] Returns an empty {Seahorse::Client::Response response}. # # # @example Example: To attach an instance to an Auto Scaling group @@ -267,11 +267,11 @@ # # # [1]: http://docs.aws.amazon.com/autoscaling/latest/userguide/attach-load-balancer-asg.html # # @option params [required, String] :auto_scaling_group_name - # The name of the group. + # The name of the Auto Scaling group. # # @option params [required, Array<String>] :load_balancer_names # One or more load balancer names. # # @return [Struct] Returns an empty {Seahorse::Client::Response response}. @@ -337,11 +337,11 @@ # # @option params [required, String] :lifecycle_hook_name # The name of the lifecycle hook. # # @option params [required, String] :auto_scaling_group_name - # The name of the group for the lifecycle hook. + # The name of the Auto Scaling group. # # @option params [String] :lifecycle_action_token # A universally unique identifier (UUID) that identifies a specific # lifecycle action associated with an instance. Auto Scaling sends this # token to the notification target you specified when you created the @@ -400,21 +400,27 @@ # # # [1]: http://docs.aws.amazon.com/autoscaling/latest/userguide/AutoScalingGroup.html # # @option params [required, String] :auto_scaling_group_name - # The name of the group. This name must be unique within the scope of - # your AWS account. + # The name of the Auto Scaling group. This name must be unique within + # the scope of your AWS account. # # @option params [String] :launch_configuration_name - # The name of the launch configuration. Alternatively, specify an EC2 - # instance instead of a launch configuration. + # The name of the launch configuration. You must specify one of the + # following: a launch configuration, a launch template, or an EC2 + # instance. # + # @option params [Types::LaunchTemplateSpecification] :launch_template + # The launch template to use to launch instances. You must specify one + # of the following: a launch template, a launch configuration, or an EC2 + # instance. + # # @option params [String] :instance_id # The ID of the instance used to create a launch configuration for the - # group. Alternatively, specify a launch configuration instead of an EC2 - # instance. + # group. You must specify one of the following: an EC2 instance, a + # launch configuration, or a launch template. # # When you specify an ID of an instance, Auto Scaling creates a new # launch configuration and associates it with the group. This launch # configuration derives its attributes from the specified instance, with # the exception of the block device mapping. @@ -602,10 +608,15 @@ # @example Request syntax with placeholder values # # resp = client.create_auto_scaling_group({ # auto_scaling_group_name: "XmlStringMaxLen255", # required # launch_configuration_name: "ResourceName", + # launch_template: { + # launch_template_id: "XmlStringMaxLen255", + # launch_template_name: "LaunchTemplateName", + # version: "XmlStringMaxLen255", + # }, # instance_id: "XmlStringMaxLen19", # min_size: 1, # required # max_size: 1, # required # desired_capacity: 1, # default_cooldown: 1, @@ -619,11 +630,11 @@ # termination_policies: ["XmlStringMaxLen1600"], # new_instances_protected_from_scale_in: false, # lifecycle_hook_specification_list: [ # { # lifecycle_hook_name: "AsciiStringMaxLen255", # required - # lifecycle_transition: "LifecycleTransition", + # lifecycle_transition: "LifecycleTransition", # required # notification_metadata: "XmlStringMaxLen1023", # heartbeat_timeout: 1, # default_result: "LifecycleActionResult", # notification_target_arn: "NotificationTargetResourceName", # role_arn: "ResourceName", @@ -1009,11 +1020,11 @@ # To terminate all instances before deleting the Auto Scaling group, # call UpdateAutoScalingGroup and set the minimum size and desired # capacity of the Auto Scaling group to zero. # # @option params [required, String] :auto_scaling_group_name - # The name of the group to delete. + # The name of the Auto Scaling group. # # @option params [Boolean] :force_delete # Specifies that the group will 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 @@ -1098,11 +1109,11 @@ # # @option params [required, String] :lifecycle_hook_name # The name of the lifecycle hook. # # @option params [required, String] :auto_scaling_group_name - # The name of the Auto Scaling group for the lifecycle hook. + # The name of the Auto Scaling group. # # @return [Struct] Returns an empty {Seahorse::Client::Response response}. # # # @example Example: To delete a lifecycle hook @@ -1381,12 +1392,12 @@ end # Describes one or more Auto Scaling groups. # # @option params [Array<String>] :auto_scaling_group_names - # The group names. If you omit this parameter, all Auto Scaling groups - # are described. + # The names of the Auto Scaling groups. 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.) # @@ -1466,10 +1477,13 @@ # # resp.auto_scaling_groups #=> Array # resp.auto_scaling_groups[0].auto_scaling_group_name #=> String # resp.auto_scaling_groups[0].auto_scaling_group_arn #=> String # resp.auto_scaling_groups[0].launch_configuration_name #=> String + # resp.auto_scaling_groups[0].launch_template.launch_template_id #=> String + # resp.auto_scaling_groups[0].launch_template.launch_template_name #=> String + # resp.auto_scaling_groups[0].launch_template.version #=> String # resp.auto_scaling_groups[0].min_size #=> Integer # resp.auto_scaling_groups[0].max_size #=> Integer # resp.auto_scaling_groups[0].desired_capacity #=> Integer # resp.auto_scaling_groups[0].default_cooldown #=> Integer # resp.auto_scaling_groups[0].availability_zones #=> Array @@ -1484,10 +1498,13 @@ # resp.auto_scaling_groups[0].instances[0].instance_id #=> String # resp.auto_scaling_groups[0].instances[0].availability_zone #=> String # resp.auto_scaling_groups[0].instances[0].lifecycle_state #=> String, one of "Pending", "Pending:Wait", "Pending:Proceed", "Quarantined", "InService", "Terminating", "Terminating:Wait", "Terminating:Proceed", "Terminated", "Detaching", "Detached", "EnteringStandby", "Standby" # resp.auto_scaling_groups[0].instances[0].health_status #=> String # resp.auto_scaling_groups[0].instances[0].launch_configuration_name #=> String + # resp.auto_scaling_groups[0].instances[0].launch_template.launch_template_id #=> String + # resp.auto_scaling_groups[0].instances[0].launch_template.launch_template_name #=> String + # resp.auto_scaling_groups[0].instances[0].launch_template.version #=> String # resp.auto_scaling_groups[0].instances[0].protected_from_scale_in #=> Boolean # resp.auto_scaling_groups[0].created_time #=> Time # resp.auto_scaling_groups[0].suspended_processes #=> Array # resp.auto_scaling_groups[0].suspended_processes[0].process_name #=> String # resp.auto_scaling_groups[0].suspended_processes[0].suspension_reason #=> String @@ -1578,10 +1595,13 @@ # resp.auto_scaling_instances[0].auto_scaling_group_name #=> String # resp.auto_scaling_instances[0].availability_zone #=> String # resp.auto_scaling_instances[0].lifecycle_state #=> String # resp.auto_scaling_instances[0].health_status #=> String # resp.auto_scaling_instances[0].launch_configuration_name #=> String + # resp.auto_scaling_instances[0].launch_template.launch_template_id #=> String + # resp.auto_scaling_instances[0].launch_template.launch_template_name #=> String + # resp.auto_scaling_instances[0].launch_template.version #=> String # resp.auto_scaling_instances[0].protected_from_scale_in #=> Boolean # resp.next_token #=> String # # @see http://docs.aws.amazon.com/goto/WebAPI/autoscaling-2011-01-01/DescribeAutoScalingInstances AWS API Documentation # @@ -1773,11 +1793,11 @@ end # Describes the lifecycle hooks for the specified Auto Scaling group. # # @option params [required, String] :auto_scaling_group_name - # The name of the group. + # The name of the Auto Scaling group. # # @option params [Array<String>] :lifecycle_hook_names # The names of one or more lifecycle hooks. If you omit this parameter, # all lifecycle hooks are described. # @@ -1905,11 +1925,11 @@ # Note that this operation describes only Classic Load Balancers. If you # have Application Load Balancers, use DescribeLoadBalancerTargetGroups # instead. # # @option params [required, String] :auto_scaling_group_name - # The name of the group. + # The name of the Auto Scaling group. # # @option params [String] :next_token # The token for the next set of items to return. (You received this # token from a previous call.) # @@ -2037,11 +2057,11 @@ # Describes the notification actions associated with the specified Auto # Scaling group. # # @option params [Array<String>] :auto_scaling_group_names - # The name of the group. + # The name of the Auto Scaling group. # # @option params [String] :next_token # The token for the next set of items to return. (You received this # token from a previous call.) # @@ -2107,18 +2127,17 @@ end # Describes the policies for the specified Auto Scaling group. # # @option params [String] :auto_scaling_group_name - # The name of the group. + # The name of the Auto Scaling group. # # @option params [Array<String>] :policy_names - # One or more policy names or policy ARNs to be described. If you omit - # this parameter, all policy names are described. If an group name is - # provided, the results are limited to that group. This list is limited - # to 50 items. If you specify an unknown policy name, it is ignored with - # no error. + # The names of one or more policies. If you omit this parameter, all + # policies are described. If an group name is provided, the results are + # limited to that group. This list is limited to 50 items. If you + # specify an unknown policy name, it is ignored with no error. # # @option params [Array<String>] :policy_types # One or more policy types. Valid values are `SimpleScaling` and # `StepScaling`. # @@ -2232,11 +2251,11 @@ # specify an Auto Scaling group, the results are limited to that group. # The list of requested activities cannot contain more than 50 items. If # unknown activities are requested, they are ignored with no error. # # @option params [String] :auto_scaling_group_name - # The name of the group. + # 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. # @@ -2370,11 +2389,11 @@ # Describes the actions scheduled for your Auto Scaling group that # haven't run. To describe the actions that have already run, use # DescribeScalingActivities. # # @option params [String] :auto_scaling_group_name - # The name of the group. + # The name of the Auto Scaling group. # # @option params [Array<String>] :scheduled_action_names # Describes one or more scheduled actions. If you omit this parameter, # all scheduled actions are described. If you specify an unknown # scheduled action, it is ignored with no error. @@ -2621,11 +2640,11 @@ # # @option params [Array<String>] :instance_ids # One or more instance IDs. # # @option params [required, String] :auto_scaling_group_name - # The name of the group. + # 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. # @@ -2781,11 +2800,11 @@ end # Disables group metrics for the specified Auto Scaling group. # # @option params [required, String] :auto_scaling_group_name - # The name or Amazon Resource Name (ARN) of the group. + # The name of the Auto Scaling group. # # @option params [Array<String>] :metrics # One or more of the following metrics. If you omit this parameter, all # metrics are disabled. # @@ -2842,11 +2861,11 @@ # # # [1]: http://docs.aws.amazon.com/autoscaling/latest/userguide/as-instance-monitoring.html # # @option params [required, String] :auto_scaling_group_name - # The name or ARN of the Auto Scaling group. + # The name of the Auto Scaling group. # # @option params [Array<String>] :metrics # One or more of the following metrics. If you omit this parameter, all # metrics are enabled. # @@ -2986,11 +3005,11 @@ end # Executes the specified policy. # # @option params [String] :auto_scaling_group_name - # The name or Amazon Resource Name (ARN) of the Auto Scaling group. + # The name of the Auto Scaling group. # # @option params [required, String] :policy_name # The name or ARN of the policy. # # @option params [Boolean] :honor_cooldown @@ -3179,12 +3198,11 @@ # # @option params [required, String] :lifecycle_hook_name # The name of the lifecycle hook. # # @option params [required, String] :auto_scaling_group_name - # The name of the Auto Scaling group to which you want to assign the - # lifecycle hook. + # The name of the Auto Scaling group. # # @option params [String] :lifecycle_transition # The instance state to which you want to attach the lifecycle hook. For # a list of lifecycle hook types, see DescribeLifecycleHookTypes. # @@ -3339,11 +3357,11 @@ # # # [1]: http://docs.aws.amazon.com/general/latest/gr/aws_service_limits.html # # @option params [required, String] :auto_scaling_group_name - # The name or ARN of the group. + # The name of the Auto Scaling group. # # @option params [required, String] :policy_name # The name of the policy. # # @option params [String] :policy_type @@ -3518,11 +3536,11 @@ # # # [1]: http://docs.aws.amazon.com/autoscaling/latest/userguide/schedule_time.html # # @option params [required, String] :auto_scaling_group_name - # The name or Amazon Resource Name (ARN) of the Auto Scaling group. + # The name of the Auto Scaling group. # # @option params [required, String] :scheduled_action_name # The name of this scaling action. # # @option params [Time,DateTime,Date,Integer,String] :time @@ -3634,11 +3652,11 @@ # # @option params [required, String] :lifecycle_hook_name # The name of the lifecycle hook. # # @option params [required, String] :auto_scaling_group_name - # The name of the Auto Scaling group for the hook. + # The name of the Auto Scaling group. # # @option params [String] :lifecycle_action_token # A token that uniquely identifies a specific lifecycle action # associated with an instance. Auto Scaling sends this token to the # notification target you specified when you created the lifecycle hook. @@ -3686,11 +3704,11 @@ # # # [1]: http://docs.aws.amazon.com/autoscaling/latest/userguide/as-suspend-resume-processes.html # # @option params [required, String] :auto_scaling_group_name - # The name or Amazon Resource Name (ARN) of the Auto Scaling group. + # The name of the Auto Scaling group. # # @option params [Array<String>] :scaling_processes # One or more of the following processes. If you omit this parameter, # all processes are specified. # @@ -3860,11 +3878,11 @@ # # @option params [required, Array<String>] :instance_ids # One or more instance IDs. # # @option params [required, String] :auto_scaling_group_name - # The name of the group. + # The name of the Auto Scaling group. # # @option params [required, Boolean] :protected_from_scale_in # Indicates whether the instance is protected from termination by Auto # Scaling when scaling in. # @@ -3926,11 +3944,11 @@ # # # [1]: http://docs.aws.amazon.com/autoscaling/latest/userguide/as-suspend-resume-processes.html # # @option params [required, String] :auto_scaling_group_name - # The name or Amazon Resource Name (ARN) of the Auto Scaling group. + # The name of the Auto Scaling group. # # @option params [Array<String>] :scaling_processes # One or more of the following processes. If you omit this parameter, # all processes are specified. # @@ -4065,12 +4083,17 @@ # # @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. + # The name of the launch configuration. You must specify either a launch + # configuration or 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. + # # @option params [Integer] :min_size # The minimum size of the Auto Scaling group. # # @option params [Integer] :max_size # The maximum size of the Auto Scaling group. @@ -4184,10 +4207,15 @@ # @example Request syntax with placeholder values # # resp = client.update_auto_scaling_group({ # auto_scaling_group_name: "ResourceName", # required # launch_configuration_name: "ResourceName", + # launch_template: { + # launch_template_id: "XmlStringMaxLen255", + # launch_template_name: "LaunchTemplateName", + # version: "XmlStringMaxLen255", + # }, # min_size: 1, # max_size: 1, # desired_capacity: 1, # default_cooldown: 1, # availability_zones: ["XmlStringMaxLen255"], @@ -4219,10 +4247,10 @@ operation: config.api.operation(operation_name), client: self, params: params, config: config) context[:gem_name] = 'aws-sdk-autoscaling' - context[:gem_version] = '1.3.0' + context[:gem_version] = '1.4.0' Seahorse::Client::Request.new(handlers, context) end # Polls an API operation until a resource enters a desired state. #