Class: Aws::AutoScaling::Client

Inherits:
Seahorse::Client::Base show all
Includes:
ClientStubs
Defined in:
gems/aws-sdk-autoscaling/lib/aws-sdk-autoscaling/client.rb

Overview

An API client for AutoScaling. To construct a client, you need to configure a :region and :credentials.

client = Aws::AutoScaling::Client.new(
  region: region_name,
  credentials: credentials,
  # ...
)

For details on configuring region and credentials see the developer guide.

See #initialize for a full list of supported configuration options.

Instance Attribute Summary

Attributes inherited from Seahorse::Client::Base

#config, #handlers

API Operations collapse

Instance Method Summary collapse

Methods included from ClientStubs

#api_requests, #stub_data, #stub_responses

Methods inherited from Seahorse::Client::Base

add_plugin, api, clear_plugins, define, new, #operation_names, plugins, remove_plugin, set_api, set_plugins

Methods included from Seahorse::Client::HandlerBuilder

#handle, #handle_request, #handle_response

Constructor Details

#initialize(options) ⇒ Client

Returns a new instance of Client.

Parameters:

  • options (Hash)

Options Hash (options):

  • :credentials (required, Aws::CredentialProvider) —

    Your AWS credentials. This can be an instance of any one of the following classes:

    • Aws::Credentials - Used for configuring static, non-refreshing credentials.

    • Aws::SharedCredentials - Used for loading static credentials from a shared file, such as ~/.aws/config.

    • Aws::AssumeRoleCredentials - Used when you need to assume a role.

    • Aws::AssumeRoleWebIdentityCredentials - Used when you need to assume a role after providing credentials via the web.

    • Aws::SSOCredentials - Used for loading credentials from AWS SSO using an access token generated from aws login.

    • Aws::ProcessCredentials - Used for loading credentials from a process that outputs to stdout.

    • Aws::InstanceProfileCredentials - Used for loading credentials from an EC2 IMDS on an EC2 instance.

    • Aws::ECSCredentials - Used for loading credentials from instances running in ECS.

    • Aws::CognitoIdentityCredentials - Used for loading credentials from the Cognito Identity service.

    When :credentials are not configured directly, the following locations will be searched for credentials:

    • Aws.config[:credentials]
    • The :access_key_id, :secret_access_key, and :session_token options.
    • ENV['AWS_ACCESS_KEY_ID'], ENV['AWS_SECRET_ACCESS_KEY']
    • ~/.aws/credentials
    • ~/.aws/config
    • EC2/ECS IMDS instance profile - When used by default, the timeouts are very aggressive. Construct and pass an instance of Aws::InstanceProfileCredentails or Aws::ECSCredentials to enable retries and extended timeouts.
  • :region (required, String) —

    The AWS region to connect to. The configured :region is used to determine the service :endpoint. When not passed, a default :region is searched for in the following locations:

    • Aws.config[:region]
    • ENV['AWS_REGION']
    • ENV['AMAZON_REGION']
    • ENV['AWS_DEFAULT_REGION']
    • ~/.aws/credentials
    • ~/.aws/config
  • :access_key_id (String)
  • :active_endpoint_cache (Boolean) — default: false —

    When set to true, a thread polling for endpoints will be running in the background every 60 secs (default). Defaults to false.

  • :adaptive_retry_wait_to_fill (Boolean) — default: true —

    Used only in adaptive retry mode. When true, the request will sleep until there is sufficent client side capacity to retry the request. When false, the request will raise a RetryCapacityNotAvailableError and will not retry instead of sleeping.

  • :client_side_monitoring (Boolean) — default: false —

    When true, client-side metrics will be collected for all API requests from this client.

  • :client_side_monitoring_client_id (String) — default: "" —

    Allows you to provide an identifier for this client which will be attached to all generated client side metrics. Defaults to an empty string.

  • :client_side_monitoring_host (String) — default: "127.0.0.1" —

    Allows you to specify the DNS hostname or IPv4 or IPv6 address that the client side monitoring agent is running on, where client metrics will be published via UDP.

  • :client_side_monitoring_port (Integer) — default: 31000 —

    Required for publishing client metrics. The port that the client side monitoring agent is running on, where client metrics will be published via UDP.

  • :client_side_monitoring_publisher (Aws::ClientSideMonitoring::Publisher) — default: Aws::ClientSideMonitoring::Publisher —

    Allows you to provide a custom client-side monitoring publisher class. By default, will use the Client Side Monitoring Agent Publisher.

  • :convert_params (Boolean) — default: true —

    When true, an attempt is made to coerce request parameters into the required types.

  • :correct_clock_skew (Boolean) — default: true —

    Used only in standard and adaptive retry modes. Specifies whether to apply a clock skew correction and retry requests with skewed client clocks.

  • :disable_host_prefix_injection (Boolean) — default: false —

    Set to true to disable SDK automatically adding host prefix to default service endpoint when available.

  • :endpoint (String) —

    The client endpoint is normally constructed from the :region option. You should only configure an :endpoint when connecting to test or custom endpoints. This should be a valid HTTP(S) URI.

  • :endpoint_cache_max_entries (Integer) — default: 1000 —

    Used for the maximum size limit of the LRU cache storing endpoints data for endpoint discovery enabled operations. Defaults to 1000.

  • :endpoint_cache_max_threads (Integer) — default: 10 —

    Used for the maximum threads in use for polling endpoints to be cached, defaults to 10.

  • :endpoint_cache_poll_interval (Integer) — default: 60 —

    When :endpoint_discovery and :active_endpoint_cache is enabled, Use this option to config the time interval in seconds for making requests fetching endpoints information. Defaults to 60 sec.

  • :endpoint_discovery (Boolean) — default: false —

    When set to true, endpoint discovery will be enabled for operations when available.

  • :log_formatter (Aws::Log::Formatter) — default: Aws::Log::Formatter.default —

    The log formatter.

  • :log_level (Symbol) — default: :info —

    The log level to send messages to the :logger at.

  • :logger (Logger) —

    The Logger instance to send log messages to. If this option is not set, logging will be disabled.

  • :max_attempts (Integer) — default: 3 —

    An integer representing the maximum number attempts that will be made for a single request, including the initial attempt. For example, setting this value to 5 will result in a request being retried up to 4 times. Used in standard and adaptive retry modes.

  • :profile (String) — default: "default" —

    Used when loading credentials from the shared credentials file at HOME/.aws/credentials. When not specified, 'default' is used.

  • :retry_backoff (Proc) —

    A proc or lambda used for backoff. Defaults to 2**retries * retry_base_delay. This option is only used in the legacy retry mode.

  • :retry_base_delay (Float) — default: 0.3 —

    The base delay in seconds used by the default backoff function. This option is only used in the legacy retry mode.

  • :retry_jitter (Symbol) — default: :none —

    A delay randomiser function used by the default backoff function. Some predefined functions can be referenced by name - :none, :equal, :full, otherwise a Proc that takes and returns a number. This option is only used in the legacy retry mode.

    @see https://www.awsarchitectureblog.com/2015/03/backoff.html

  • :retry_limit (Integer) — default: 3 —

    The maximum number of times to retry failed requests. Only ~ 500 level server errors and certain ~ 400 level client errors are retried. Generally, these are throttling errors, data checksum errors, networking errors, timeout errors, auth errors, endpoint discovery, and errors from expired credentials. This option is only used in the legacy retry mode.

  • :retry_max_delay (Integer) — default: 0 —

    The maximum number of seconds to delay between retries (0 for no limit) used by the default backoff function. This option is only used in the legacy retry mode.

  • :retry_mode (String) — default: "legacy" —

    Specifies which retry algorithm to use. Values are:

    • legacy - The pre-existing retry behavior. This is default value if no retry mode is provided.

    • standard - A standardized set of retry rules across the AWS SDKs. This includes support for retry quotas, which limit the number of unsuccessful retries a client can make.

    • adaptive - An experimental retry mode that includes all the functionality of standard mode along with automatic client side throttling. This is a provisional mode that may change behavior in the future.

  • :secret_access_key (String)
  • :session_token (String)
  • :stub_responses (Boolean) — default: false —

    Causes the client to return stubbed responses. By default fake responses are generated and returned. You can specify the response data to return or errors to raise by calling ClientStubs#stub_responses. See ClientStubs for more information.

    Please note When response stubbing is enabled, no HTTP requests are made, and retries are disabled.

  • :validate_params (Boolean) — default: true —

    When true, request parameters are validated before sending the request.

  • :http_proxy (URI::HTTP, String) —

    A proxy to send requests through. Formatted like 'http://proxy.com:123'.

  • :http_open_timeout (Float) — default: 15 —

    The number of seconds to wait when opening a HTTP session before raising a Timeout::Error.

  • :http_read_timeout (Integer) — default: 60 —

    The default number of seconds to wait for response data. This value can safely be set per-request on the session.

  • :http_idle_timeout (Float) — default: 5 —

    The number of seconds a connection is allowed to sit idle before it is considered stale. Stale connections are closed and removed from the pool before making a request.

  • :http_continue_timeout (Float) — default: 1 —

    The number of seconds to wait for a 100-continue response before sending the request body. This option has no effect unless the request has "Expect" header set to "100-continue". Defaults to nil which disables this behaviour. This value can safely be set per request on the session.

  • :http_wire_trace (Boolean) — default: false —

    When true, HTTP debug output will be sent to the :logger.

  • :ssl_verify_peer (Boolean) — default: true —

    When true, SSL peer certificates are verified when establishing a connection.

  • :ssl_ca_bundle (String) —

    Full path to the SSL certificate authority bundle file that should be used when verifying peer certificates. If you do not pass :ssl_ca_bundle or :ssl_ca_directory the the system default will be used if available.

  • :ssl_ca_directory (String) —

    Full path of the directory that contains the unbundled SSL certificate authority files for verifying peer certificates. If you do not pass :ssl_ca_bundle or :ssl_ca_directory the the system default will be used if available.



324
325
326
 
# File 'gems/aws-sdk-autoscaling/lib/aws-sdk-autoscaling/client.rb', line 324

def initialize(*args)
  super
end

Instance Method Details

#attach_instances(params = {}) ⇒ Struct

Attaches one or more EC2 instances to the specified Auto Scaling group.

When you attach instances, Amazon EC2 Auto Scaling increases the desired capacity of the group by the number of instances being attached. If the number of instances being attached plus the desired capacity of the group exceeds the maximum size of the group, the operation fails.

If there is a Classic Load Balancer attached to your Auto Scaling group, the instances are also registered with the load balancer. If there are target groups attached to your Auto Scaling group, the instances are also registered with the target groups.

For more information, see Attach EC2 instances to your Auto Scaling group in the Amazon EC2 Auto Scaling User Guide.

Examples:

Example: To attach an instance to an Auto Scaling group


# This example attaches the specified instance to the specified Auto Scaling group.

resp = client.attach_instances({
  auto_scaling_group_name: "my-auto-scaling-group", 
  instance_ids: [
    "i-93633f9b", 
  ], 
})

Request syntax with placeholder values


resp = client.attach_instances({
  instance_ids: ["XmlStringMaxLen19"],
  auto_scaling_group_name: "ResourceName", # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :instance_ids (Array<String>) —

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

  • :auto_scaling_group_name (required, String) —

    The name of the Auto Scaling group.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



382
383
384
385
 
# File 'gems/aws-sdk-autoscaling/lib/aws-sdk-autoscaling/client.rb', line 382

def attach_instances(params = {}, options = {})
  req = build_request(:attach_instances, params)
  req.send_request(options)
end

#attach_load_balancer_target_groups(params = {}) ⇒ Struct

Attaches one or more target groups to the specified Auto Scaling group.

This operation is used with the following load balancer types:

  • Application Load Balancer - Operates at the application layer (layer 7) and supports HTTP and HTTPS.

  • Network Load Balancer - Operates at the transport layer (layer 4) and supports TCP, TLS, and UDP.

  • Gateway Load Balancer - Operates at the network layer (layer 3).

To describe the target groups for an Auto Scaling group, call the DescribeLoadBalancerTargetGroups API. To detach the target group from the Auto Scaling group, call the DetachLoadBalancerTargetGroups API.

For more information, see Elastic Load Balancing and Amazon EC2 Auto Scaling in the Amazon EC2 Auto Scaling User Guide.

Examples:

Example: To attach a target group to an Auto Scaling group


# This example attaches the specified target group to the specified Auto Scaling group.

resp = client.attach_load_balancer_target_groups({
  auto_scaling_group_name: "my-auto-scaling-group", 
  target_group_arns: [
    "arn:aws:elasticloadbalancing:us-west-2:123456789012:targetgroup/my-targets/73e2d6bc24d8a067", 
  ], 
})

Request syntax with placeholder values


resp = client.attach_load_balancer_target_groups({
  auto_scaling_group_name: "ResourceName", # required
  target_group_arns: ["XmlStringMaxLen511"], # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :auto_scaling_group_name (required, String) —

    The name of the Auto Scaling group.

  • :target_group_arns (required, Array<String>) —

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

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



448
449
450
451
 
# File 'gems/aws-sdk-autoscaling/lib/aws-sdk-autoscaling/client.rb', line 448

def attach_load_balancer_target_groups(params = {}, options = {})
  req = build_request(:attach_load_balancer_target_groups, params)
  req.send_request(options)
end

#attach_load_balancers(params = {}) ⇒ Struct

To attach an Application Load Balancer, Network Load Balancer, or Gateway Load Balancer, use the AttachLoadBalancerTargetGroups API operation instead.

Attaches one or more Classic Load Balancers to the specified Auto Scaling group. Amazon EC2 Auto Scaling registers the running instances with these Classic Load Balancers.

To describe the load balancers for an Auto Scaling group, call the DescribeLoadBalancers API. To detach the load balancer from the Auto Scaling group, call the DetachLoadBalancers API.

For more information, see Elastic Load Balancing and Amazon EC2 Auto Scaling in the Amazon EC2 Auto Scaling User Guide.

Examples:

Example: To attach a load balancer to an Auto Scaling group


# This example attaches the specified load balancer to the specified Auto Scaling group.

resp = client.attach_load_balancers({
  auto_scaling_group_name: "my-auto-scaling-group", 
  load_balancer_names: [
    "my-load-balancer", 
  ], 
})

Request syntax with placeholder values


resp = client.attach_load_balancers({
  auto_scaling_group_name: "ResourceName", # required
  load_balancer_names: ["XmlStringMaxLen255"], # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :auto_scaling_group_name (required, String) —

    The name of the Auto Scaling group.

  • :load_balancer_names (required, Array<String>) —

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

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



506
507
508
509
 
# File 'gems/aws-sdk-autoscaling/lib/aws-sdk-autoscaling/client.rb', line 506

def attach_load_balancers(params = {}, options = {})
  req = build_request(:attach_load_balancers, params)
  req.send_request(options)
end

#batch_delete_scheduled_action(params = {}) ⇒ Types::BatchDeleteScheduledActionAnswer

Deletes one or more scheduled actions for the specified Auto Scaling group.

Examples:

Request syntax with placeholder values


resp = client.batch_delete_scheduled_action({
  auto_scaling_group_name: "ResourceName", # required
  scheduled_action_names: ["ResourceName"], # required
})

Response structure


resp.failed_scheduled_actions #=> Array
resp.failed_scheduled_actions[0].scheduled_action_name #=> String
resp.failed_scheduled_actions[0].error_code #=> String
resp.failed_scheduled_actions[0].error_message #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :auto_scaling_group_name (required, String) —

    The name of the Auto Scaling group.

  • :scheduled_action_names (required, Array<String>) —

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

Returns:

See Also:



543
544
545
546
 
# File 'gems/aws-sdk-autoscaling/lib/aws-sdk-autoscaling/client.rb', line 543

def batch_delete_scheduled_action(params = {}, options = {})
  req = build_request(:batch_delete_scheduled_action, params)
  req.send_request(options)
end

#batch_put_scheduled_update_group_action(params = {}) ⇒ Types::BatchPutScheduledUpdateGroupActionAnswer

Creates or updates one or more scheduled scaling actions for an Auto Scaling group. If you leave a parameter unspecified when updating a scheduled scaling action, the corresponding value remains unchanged.

Examples:

Request syntax with placeholder values


resp = client.batch_put_scheduled_update_group_action({
  auto_scaling_group_name: "ResourceName", # required
  scheduled_update_group_actions: [ # required
    {
      scheduled_action_name: "XmlStringMaxLen255", # required
      start_time: Time.now,
      end_time: Time.now,
      recurrence: "XmlStringMaxLen255",
      min_size: 1,
      max_size: 1,
      desired_capacity: 1,
    },
  ],
})

Response structure


resp.failed_scheduled_update_group_actions #=> Array
resp.failed_scheduled_update_group_actions[0].scheduled_action_name #=> String
resp.failed_scheduled_update_group_actions[0].error_code #=> String
resp.failed_scheduled_update_group_actions[0].error_message #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :auto_scaling_group_name (required, String) —

    The name of the Auto Scaling group.

  • :scheduled_update_group_actions (required, Array<Types::ScheduledUpdateGroupActionRequest>) —

    One or more scheduled actions. The maximum number allowed is 50.

Returns:

See Also:



590
591
592
593
 
# File 'gems/aws-sdk-autoscaling/lib/aws-sdk-autoscaling/client.rb', line 590

def batch_put_scheduled_update_group_action(params = {}, options = {})
  req = build_request(:batch_put_scheduled_update_group_action, params)
  req.send_request(options)
end

#cancel_instance_refresh(params = {}) ⇒ Types::CancelInstanceRefreshAnswer

Cancels an instance refresh operation in progress. Cancellation does not roll back any replacements that have already been completed, but it prevents new replacements from being started.

For more information, see Replacing Auto Scaling Instances Based on an Instance Refresh.

Examples:

Example: To cancel an instance refresh


# This example cancels an instance refresh operation in progress.

resp = client.cancel_instance_refresh({
  auto_scaling_group_name: "my-auto-scaling-group", 
})

resp.to_h outputs the following:
{
  instance_refresh_id: "08b91cf7-8fa6-48af-b6a6-d227f40f1b9b", 
}

Request syntax with placeholder values


resp = client.cancel_instance_refresh({
  auto_scaling_group_name: "XmlStringMaxLen255", # required
})

Response structure


resp.instance_refresh_id #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :auto_scaling_group_name (required, String) —

    The name of the Auto Scaling group.

Returns:

See Also:



641
642
643
644
 
# File 'gems/aws-sdk-autoscaling/lib/aws-sdk-autoscaling/client.rb', line 641

def cancel_instance_refresh(params = {}, options = {})
  req = build_request(:cancel_instance_refresh, params)
  req.send_request(options)
end

#complete_lifecycle_action(params = {}) ⇒ Struct

Completes the lifecycle action for the specified token or instance with the specified result.

This step is a part of the procedure for adding a lifecycle hook to an Auto Scaling group:

  1. (Optional) Create a Lambda function and a rule that allows CloudWatch Events to invoke your Lambda function when Amazon EC2 Auto Scaling launches or terminates instances.

  2. (Optional) Create a notification target and an IAM role. The target can be either an Amazon SQS queue or an Amazon SNS topic. The role allows Amazon EC2 Auto Scaling to publish lifecycle notifications to the target.

  3. Create the lifecycle hook. Specify whether the hook is used when the instances launch or terminate.

  4. If you need more time, record the lifecycle action heartbeat to keep the instance in a pending state.

  5. If you finish before the timeout period ends, complete the lifecycle action.

For more information, see Amazon EC2 Auto Scaling lifecycle hooks in the Amazon EC2 Auto Scaling User Guide.

Examples:

Example: To complete the lifecycle action


# This example notifies Auto Scaling that the specified lifecycle action is complete so that it can finish launching or
# terminating the instance.

resp = client.complete_lifecycle_action({
  auto_scaling_group_name: "my-auto-scaling-group", 
  lifecycle_action_result: "CONTINUE", 
  lifecycle_action_token: "bcd2f1b8-9a78-44d3-8a7a-4dd07d7cf635", 
  lifecycle_hook_name: "my-lifecycle-hook", 
})

Request syntax with placeholder values


resp = client.complete_lifecycle_action({
  lifecycle_hook_name: "AsciiStringMaxLen255", # required
  auto_scaling_group_name: "ResourceName", # required
  lifecycle_action_token: "LifecycleActionToken",
  lifecycle_action_result: "LifecycleActionResult", # required
  instance_id: "XmlStringMaxLen19",
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :lifecycle_hook_name (required, String) —

    The name of the lifecycle hook.

  • :auto_scaling_group_name (required, String) —

    The name of the Auto Scaling group.

  • :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.

  • :lifecycle_action_result (required, String) —

    The action for the group to take. This parameter can be either CONTINUE or ABANDON.

  • :instance_id (String) —

    The ID of the instance.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



725
726
727
728
 
# File 'gems/aws-sdk-autoscaling/lib/aws-sdk-autoscaling/client.rb', line 725

def complete_lifecycle_action(params = {}, options = {})
  req = build_request(:complete_lifecycle_action, params)
  req.send_request(options)
end

#create_auto_scaling_group(params = {}) ⇒ Struct

Creates an Auto Scaling group with the specified name and attributes.

If you exceed your maximum limit of Auto Scaling groups, the call fails. To query this limit, call the DescribeAccountLimits API. For information about updating this limit, see Amazon EC2 Auto Scaling service quotas in the Amazon EC2 Auto Scaling User Guide.

For introductory exercises for creating an Auto Scaling group, see Getting started with Amazon EC2 Auto Scaling and Tutorial: Set up a scaled and load-balanced application in the Amazon EC2 Auto Scaling User Guide. For more information, see Auto Scaling groups in the Amazon EC2 Auto Scaling User Guide.

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

Examples:

Example: To create an Auto Scaling group


# This example creates an Auto Scaling group.

resp = client.create_auto_scaling_group({
  auto_scaling_group_name: "my-auto-scaling-group", 
  launch_template: {
    launch_template_id: "lt-0a20c965061f64abc", 
    version: "$Latest", 
  }, 
  max_instance_lifetime: 2592000, 
  max_size: 3, 
  min_size: 1, 
  vpc_zone_identifier: "subnet-057fa0918fEXAMPLE", 
})

Example: To create an Auto Scaling group with an attached target group


# This example creates an Auto Scaling group and attaches the specified target group.

resp = client.create_auto_scaling_group({
  auto_scaling_group_name: "my-auto-scaling-group", 
  health_check_grace_period: 120, 
  health_check_type: "ELB", 
  launch_configuration_name: "my-launch-config", 
  max_size: 3, 
  min_size: 1, 
  target_group_arns: [
    "arn:aws:elasticloadbalancing:us-west-2:123456789012:targetgroup/my-targets/73e2d6bc24d8a067", 
  ], 
  vpc_zone_identifier: "subnet-057fa0918fEXAMPLE, subnet-610acd08EXAMPLE", 
})

Example: To create an Auto Scaling group with an attached load balancer


# This example creates an Auto Scaling group and attaches the specified Classic Load Balancer.

resp = client.create_auto_scaling_group({
  auto_scaling_group_name: "my-auto-scaling-group", 
  availability_zones: [
    "us-west-2c", 
  ], 
  health_check_grace_period: 120, 
  health_check_type: "ELB", 
  launch_configuration_name: "my-launch-config", 
  load_balancer_names: [
    "my-load-balancer", 
  ], 
  max_size: 3, 
  min_size: 1, 
})

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",
  },
  mixed_instances_policy: {
    launch_template: {
      launch_template_specification: {
        launch_template_id: "XmlStringMaxLen255",
        launch_template_name: "LaunchTemplateName",
        version: "XmlStringMaxLen255",
      },
      overrides: [
        {
          instance_type: "XmlStringMaxLen255",
          weighted_capacity: "XmlStringMaxLen32",
          launch_template_specification: {
            launch_template_id: "XmlStringMaxLen255",
            launch_template_name: "LaunchTemplateName",
            version: "XmlStringMaxLen255",
          },
        },
      ],
    },
    instances_distribution: {
      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: "MixedInstanceSpotPrice",
    },
  },
  instance_id: "XmlStringMaxLen19",
  min_size: 1, # required
  max_size: 1, # required
  desired_capacity: 1,
  default_cooldown: 1,
  availability_zones: ["XmlStringMaxLen255"],
  load_balancer_names: ["XmlStringMaxLen255"],
  target_group_arns: ["XmlStringMaxLen511"],
  health_check_type: "XmlStringMaxLen32",
  health_check_grace_period: 1,
  placement_group: "XmlStringMaxLen255",
  vpc_zone_identifier: "XmlStringMaxLen2047",
  termination_policies: ["XmlStringMaxLen1600"],
  new_instances_protected_from_scale_in: false,
  capacity_rebalance: false,
  lifecycle_hook_specification_list: [
    {
      lifecycle_hook_name: "AsciiStringMaxLen255", # required
      lifecycle_transition: "LifecycleTransition", # required
      notification_metadata: "XmlStringMaxLen1023",
      heartbeat_timeout: 1,
      default_result: "LifecycleActionResult",
      notification_target_arn: "NotificationTargetResourceName",
      role_arn: "ResourceName",
    },
  ],
  tags: [
    {
      resource_id: "XmlString",
      resource_type: "XmlString",
      key: "TagKey", # required
      value: "TagValue",
      propagate_at_launch: false,
    },
  ],
  service_linked_role_arn: "ResourceName",
  max_instance_lifetime: 1,
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :auto_scaling_group_name (required, String) —

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

  • :launch_configuration_name (String) —

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

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

  • :launch_template (Types::LaunchTemplateSpecification) —

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

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

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

  • :mixed_instances_policy (Types::MixedInstancesPolicy) —

    An embedded object that specifies a mixed instances policy. The required parameters must be specified. If optional parameters are unspecified, their default values are used.

    The policy includes parameters that not only define the distribution of On-Demand Instances and Spot Instances, the maximum price to pay for Spot Instances, and how the Auto Scaling group allocates instance types to fulfill On-Demand and Spot capacities, but also the parameters that specify the instance configuration information—the launch template and instance types. The policy can also include a weight for each instance type and different launch templates for individual instance types. For more information, see Auto Scaling groups with multiple instance types and purchase options in the Amazon EC2 Auto Scaling User Guide.

  • :instance_id (String) —

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

  • :min_size (required, Integer) —

    The minimum size of the group.

  • :max_size (required, Integer) —

    The maximum size of the group.

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

  • :desired_capacity (Integer) —

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

  • :default_cooldown (Integer) —

    The amount of time, in seconds, after a scaling activity completes before another scaling activity can start. The default value is 300. This setting applies when using simple scaling policies, but not when using other scaling policies or scheduled scaling. For more information, see Scaling cooldowns for Amazon EC2 Auto Scaling in the Amazon EC2 Auto Scaling User Guide.

  • :availability_zones (Array<String>) —

    A list of Availability Zones where instances in the Auto Scaling group can be created. This parameter is optional if you specify one or more subnets for VPCZoneIdentifier.

    Conditional: If your account supports EC2-Classic and VPC, this parameter is required to launch instances into EC2-Classic.

  • :load_balancer_names (Array<String>) —

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

  • :target_group_arns (Array<String>) —

    The Amazon Resource Names (ARN) of the target groups to associate with the Auto Scaling group. Instances are registered as targets in a target group, and traffic is routed to the target group. For more information, see Elastic Load Balancing and Amazon EC2 Auto Scaling in the Amazon EC2 Auto Scaling User Guide.

  • :health_check_type (String) —

    The service to use for the health checks. The valid values are EC2 (default) and ELB. If you configure an Auto Scaling group to use load balancer (ELB) health checks, it considers the instance unhealthy if it fails either the EC2 status checks or the load balancer health checks. For more information, see Health checks for Auto Scaling instances in the Amazon EC2 Auto Scaling User Guide.

  • :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. For more information, see Health check grace period in the Amazon EC2 Auto Scaling User Guide.

    Conditional: Required if you are adding an ELB health check.

  • :placement_group (String) —

    The name of an existing placement group into which to launch your instances, if any. A placement group is a logical grouping of instances within a single Availability Zone. You cannot specify multiple Availability Zones and a placement group. For more information, see Placement Groups in the Amazon EC2 User Guide for Linux Instances.

  • :vpc_zone_identifier (String) —

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

    Conditional: If your account supports EC2-Classic and VPC, this parameter is required to launch instances into a VPC.

  • :termination_policies (Array<String>) —

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

  • :new_instances_protected_from_scale_in (Boolean) —

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

  • :capacity_rebalance (Boolean) —

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

  • :lifecycle_hook_specification_list (Array<Types::LifecycleHookSpecification>) —

    One or more lifecycle hooks for the group, which specify actions to perform when Amazon EC2 Auto Scaling launches or terminates instances.

  • :tags (Array<Types::Tag>) —

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

  • :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.

  • :max_instance_lifetime (Integer) —

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

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



1143
1144
1145
1146
 
# File 'gems/aws-sdk-autoscaling/lib/aws-sdk-autoscaling/client.rb', line 1143

def create_auto_scaling_group(params = {}, options = {})
  req = build_request(:create_auto_scaling_group, params)
  req.send_request(options)
end

#create_launch_configuration(params = {}) ⇒ Struct

Creates a launch configuration.

If you exceed your maximum limit of launch configurations, the call fails. To query this limit, call the DescribeAccountLimits API. For information about updating this limit, see Amazon EC2 Auto Scaling service quotas in the Amazon EC2 Auto Scaling User Guide.

For more information, see Launch configurations in the Amazon EC2 Auto Scaling User Guide.

Examples:

Example: To create a launch configuration


# This example creates a launch configuration.

resp = client.create_launch_configuration({
  iam_instance_profile: "my-iam-role", 
  image_id: "ami-12345678", 
  instance_type: "m3.medium", 
  launch_configuration_name: "my-launch-config", 
  security_groups: [
    "sg-eb2af88e", 
  ], 
})

Request syntax with placeholder values


resp = client.create_launch_configuration({
  launch_configuration_name: "XmlStringMaxLen255", # required
  image_id: "XmlStringMaxLen255",
  key_name: "XmlStringMaxLen255",
  security_groups: ["XmlString"],
  classic_link_vpc_id: "XmlStringMaxLen255",
  classic_link_vpc_security_groups: ["XmlStringMaxLen255"],
  user_data: "XmlStringUserData",
  instance_id: "XmlStringMaxLen19",
  instance_type: "XmlStringMaxLen255",
  kernel_id: "XmlStringMaxLen255",
  ramdisk_id: "XmlStringMaxLen255",
  block_device_mappings: [
    {
      virtual_name: "XmlStringMaxLen255",
      device_name: "XmlStringMaxLen255", # required
      ebs: {
        snapshot_id: "XmlStringMaxLen255",
        volume_size: 1,
        volume_type: "BlockDeviceEbsVolumeType",
        delete_on_termination: false,
        iops: 1,
        encrypted: false,
      },
      no_device: false,
    },
  ],
  instance_monitoring: {
    enabled: false,
  },
  spot_price: "SpotPrice",
  iam_instance_profile: "XmlStringMaxLen1600",
  ebs_optimized: false,
  associate_public_ip_address: false,
  placement_tenancy: "XmlStringMaxLen64",
  metadata_options: {
    http_tokens: "optional", # accepts optional, required
    http_put_response_hop_limit: 1,
    http_endpoint: "disabled", # accepts disabled, enabled
  },
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :launch_configuration_name (required, String) —

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

  • :image_id (String) —

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

    If you do not specify InstanceId, you must specify ImageId.

  • :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.

  • :security_groups (Array<String>) —

    A list that contains the security groups to assign to the instances in the Auto Scaling group.

    [EC2-VPC] Specify the security group IDs. For more information, see Security Groups for Your VPC in the Amazon Virtual Private Cloud User Guide.

    [EC2-Classic] Specify either the 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.

  • :classic_link_vpc_id (String) —

    The ID of a ClassicLink-enabled VPC to link your EC2-Classic instances to. 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.

    This parameter can only be used if you are launching EC2-Classic instances.

  • :classic_link_vpc_security_groups (Array<String>) —

    The IDs of one or more security groups for the specified ClassicLink-enabled VPC. 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.

    If you specify the ClassicLinkVPCId parameter, you must specify this parameter.

  • :user_data (String) —

    The Base64-encoded 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.

  • :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.

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

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

    If you do not specify InstanceId, you must specify both ImageId and InstanceType.

  • :instance_type (String) —

    Specifies the instance type of the EC2 instance.

    For information about available instance types, see Available Instance Types in the Amazon EC2 User Guide for Linux Instances.

    If you do not specify InstanceId, you must specify InstanceType.

  • :kernel_id (String) —

    The ID of the kernel associated with the AMI.

  • :ramdisk_id (String) —

    The ID of the RAM disk to select.

  • :block_device_mappings (Array<Types::BlockDeviceMapping>) —

    A block device mapping, which specifies the block devices for the instance. You can specify virtual devices and EBS volumes. For more information, see Block Device Mapping in the Amazon EC2 User Guide for Linux Instances.

  • :instance_monitoring (Types::InstanceMonitoring) —

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

    The default value is true (enabled).

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

  • :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 price. For more information, see Requesting Spot Instances in the Amazon EC2 Auto Scaling User Guide.

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

  • :iam_instance_profile (String) —

    The name or the Amazon Resource Name (ARN) of the instance profile associated with the IAM role for the instance. The instance profile contains the IAM role.

    For more information, see IAM role for applications that run on Amazon EC2 instances in the Amazon EC2 Auto Scaling User Guide.

  • :ebs_optimized (Boolean) —

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

    The default value is false.

  • :associate_public_ip_address (Boolean) —

    For Auto Scaling groups that are running in a virtual private cloud (VPC), specifies whether to assign a public IP address to the group's instances. If you specify true, each instance in the Auto Scaling group receives a unique public IP address. For more information, see Launching Auto Scaling instances in a VPC in the Amazon EC2 Auto Scaling User Guide.

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

    If the instance is launched into a default subnet, the default is to assign a public IP address, unless you disabled the option to assign a public IP address on the subnet. If the instance is launched into a nondefault subnet, the default is not to assign a public IP address, unless you enabled the option to assign a public IP address on the subnet.

  • :placement_tenancy (String) —

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

    To launch dedicated instances into a shared tenancy VPC (a VPC with the instance placement tenancy attribute set to default), you must set the value of this parameter to dedicated.

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

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

    Valid Values: default | dedicated

  • :metadata_options (Types::InstanceMetadataOptions) —

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

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



1469
1470
1471
1472
 
# File 'gems/aws-sdk-autoscaling/lib/aws-sdk-autoscaling/client.rb', line 1469

def create_launch_configuration(params = {}, options = {})
  req = build_request(:create_launch_configuration, params)
  req.send_request(options)
end

#create_or_update_tags(params = {}) ⇒ Struct

Creates or updates tags for the specified Auto Scaling group.

When you specify a tag with a key that already exists, the operation overwrites the previous tag definition, and you do not get an error message.

For more information, see Tagging Auto Scaling groups and instances in the Amazon EC2 Auto Scaling User Guide.

Examples:

Example: To create or update tags for an Auto Scaling group


# This example adds two tags to the specified Auto Scaling group.

resp = client.create_or_update_tags({
  tags: [
    {
      key: "Role", 
      propagate_at_launch: true, 
      resource_id: "my-auto-scaling-group", 
      resource_type: "auto-scaling-group", 
      value: "WebServer", 
    }, 
    {
      key: "Dept", 
      propagate_at_launch: true, 
      resource_id: "my-auto-scaling-group", 
      resource_type: "auto-scaling-group", 
      value: "Research", 
    }, 
  ], 
})

Request syntax with placeholder values


resp = client.create_or_update_tags({
  tags: [ # required
    {
      resource_id: "XmlString",
      resource_type: "XmlString",
      key: "TagKey", # required
      value: "TagValue",
      propagate_at_launch: false,
    },
  ],
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :tags (required, Array<Types::Tag>) —

    One or more tags.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



1534
1535
1536
1537
 
# File 'gems/aws-sdk-autoscaling/lib/aws-sdk-autoscaling/client.rb', line 1534

def create_or_update_tags(params = {}, options = {})
  req = build_request(:create_or_update_tags, params)
  req.send_request(options)
end

#delete_auto_scaling_group(params = {}) ⇒ Struct

Deletes the specified Auto Scaling group.

If the group has instances or scaling activities in progress, you must specify the option to force the deletion in order for it to succeed.

If the group has policies, deleting the group deletes the policies, the underlying alarm actions, and any alarm that no longer has an associated action.

To remove instances from the Auto Scaling group before deleting it, call the DetachInstances API with the list of instances and the option to decrement the desired capacity. This ensures that Amazon EC2 Auto Scaling does not launch replacement instances.

To terminate all instances before deleting the Auto Scaling group, call the UpdateAutoScalingGroup API and set the minimum size and desired capacity of the Auto Scaling group to zero.

Examples:

Example: To delete an Auto Scaling group


# This example deletes the specified Auto Scaling group.

resp = client.delete_auto_scaling_group({
  auto_scaling_group_name: "my-auto-scaling-group", 
})

Example: To delete an Auto Scaling group and all its instances


# This example deletes the specified Auto Scaling group and all its instances.

resp = client.delete_auto_scaling_group({
  auto_scaling_group_name: "my-auto-scaling-group", 
  force_delete: true, 
})

Request syntax with placeholder values


resp = client.delete_auto_scaling_group({
  auto_scaling_group_name: "ResourceName", # required
  force_delete: false,
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :auto_scaling_group_name (required, String) —

    The name of the Auto Scaling group.

  • :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.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



1597
1598
1599
1600
 
# File 'gems/aws-sdk-autoscaling/lib/aws-sdk-autoscaling/client.rb', line 1597

def delete_auto_scaling_group(params = {}, options = {})
  req = build_request(:delete_auto_scaling_group, params)
  req.send_request(options)
end

#delete_launch_configuration(params = {}) ⇒ Struct

Deletes the specified launch configuration.

The launch configuration must not be attached to an Auto Scaling group. When this call completes, the launch configuration is no longer available for use.

Examples:

Example: To delete a launch configuration


# This example deletes the specified launch configuration.

resp = client.delete_launch_configuration({
  launch_configuration_name: "my-launch-config", 
})

Request syntax with placeholder values


resp = client.delete_launch_configuration({
  launch_configuration_name: "ResourceName", # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :launch_configuration_name (required, String) —

    The name of the launch configuration.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



1632
1633
1634
1635
 
# File 'gems/aws-sdk-autoscaling/lib/aws-sdk-autoscaling/client.rb', line 1632

def delete_launch_configuration(params = {}, options = {})
  req = build_request(:delete_launch_configuration, params)
  req.send_request(options)
end

#delete_lifecycle_hook(params = {}) ⇒ Struct

Deletes the specified lifecycle hook.

If there are any outstanding lifecycle actions, they are completed first (ABANDON for launching instances, CONTINUE for terminating instances).

Examples:

Example: To delete a lifecycle hook


# This example deletes the specified lifecycle hook.

resp = client.delete_lifecycle_hook({
  auto_scaling_group_name: "my-auto-scaling-group", 
  lifecycle_hook_name: "my-lifecycle-hook", 
})

Request syntax with placeholder values


resp = client.delete_lifecycle_hook({
  lifecycle_hook_name: "AsciiStringMaxLen255", # required
  auto_scaling_group_name: "ResourceName", # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :lifecycle_hook_name (required, String) —

    The name of the lifecycle hook.

  • :auto_scaling_group_name (required, String) —

    The name of the Auto Scaling group.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



1672
1673
1674
1675
 
# File 'gems/aws-sdk-autoscaling/lib/aws-sdk-autoscaling/client.rb', line 1672

def delete_lifecycle_hook(params = {}, options = {})
  req = build_request(:delete_lifecycle_hook, params)
  req.send_request(options)
end

#delete_notification_configuration(params = {}) ⇒ Struct

Deletes the specified notification.

Examples:

Example: To delete an Auto Scaling notification


# This example deletes the specified notification from the specified Auto Scaling group.

resp = client.delete_notification_configuration({
  auto_scaling_group_name: "my-auto-scaling-group", 
  topic_arn: "arn:aws:sns:us-west-2:123456789012:my-sns-topic", 
})

Request syntax with placeholder values


resp = client.delete_notification_configuration({
  auto_scaling_group_name: "ResourceName", # required
  topic_arn: "ResourceName", # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :auto_scaling_group_name (required, String) —

    The name of the Auto Scaling group.

  • :topic_arn (required, String) —

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

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



1709
1710
1711
1712
 
# File 'gems/aws-sdk-autoscaling/lib/aws-sdk-autoscaling/client.rb', line 1709

def delete_notification_configuration(params = {}, options = {})
  req = build_request(:delete_notification_configuration, params)
  req.send_request(options)
end

#delete_policy(params = {}) ⇒ Struct

Deletes the specified scaling policy.

Deleting either a step scaling policy or a simple scaling policy deletes the underlying alarm action, but does not delete the alarm, even if it no longer has an associated action.

For more information, see Deleting a scaling policy in the Amazon EC2 Auto Scaling User Guide.

Examples:

Example: To delete an Auto Scaling policy


# This example deletes the specified Auto Scaling policy.

resp = client.delete_policy({
  auto_scaling_group_name: "my-auto-scaling-group", 
  policy_name: "my-step-scale-out-policy", 
})

Request syntax with placeholder values


resp = client.delete_policy({
  auto_scaling_group_name: "ResourceName",
  policy_name: "ResourceName", # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :auto_scaling_group_name (String) —

    The name of the Auto Scaling group.

  • :policy_name (required, String) —

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

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



1756
1757
1758
1759
 
# File 'gems/aws-sdk-autoscaling/lib/aws-sdk-autoscaling/client.rb', line 1756

def delete_policy(params = {}, options = {})
  req = build_request(:delete_policy, params)
  req.send_request(options)
end

#delete_scheduled_action(params = {}) ⇒ Struct

Deletes the specified scheduled action.

Examples:

Example: To delete a scheduled action from an Auto Scaling group


# This example deletes the specified scheduled action from the specified Auto Scaling group.

resp = client.delete_scheduled_action({
  auto_scaling_group_name: "my-auto-scaling-group", 
  scheduled_action_name: "my-scheduled-action", 
})

Request syntax with placeholder values


resp = client.delete_scheduled_action({
  auto_scaling_group_name: "ResourceName", # required
  scheduled_action_name: "ResourceName", # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :auto_scaling_group_name (required, String) —

    The name of the Auto Scaling group.

  • :scheduled_action_name (required, String) —

    The name of the action to delete.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



1792
1793
1794
1795
 
# File 'gems/aws-sdk-autoscaling/lib/aws-sdk-autoscaling/client.rb', line 1792

def delete_scheduled_action(params = {}, options = {})
  req = build_request(:delete_scheduled_action, params)
  req.send_request(options)
end

#delete_tags(params = {}) ⇒ Struct

Deletes the specified tags.

Examples:

Example: To delete a tag from an Auto Scaling group


# This example deletes the specified tag from the specified Auto Scaling group.

resp = client.delete_tags({
  tags: [
    {
      key: "Dept", 
      resource_id: "my-auto-scaling-group", 
      resource_type: "auto-scaling-group", 
      value: "Research", 
    }, 
  ], 
})

Request syntax with placeholder values


resp = client.delete_tags({
  tags: [ # required
    {
      resource_id: "XmlString",
      resource_type: "XmlString",
      key: "TagKey", # required
      value: "TagValue",
      propagate_at_launch: false,
    },
  ],
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :tags (required, Array<Types::Tag>) —

    One or more tags.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



1838
1839
1840
1841
 
# File 'gems/aws-sdk-autoscaling/lib/aws-sdk-autoscaling/client.rb', line 1838

def delete_tags(params = {}, options = {})
  req = build_request(:delete_tags, params)
  req.send_request(options)
end

#describe_account_limits(params = {}) ⇒ Types::DescribeAccountLimitsAnswer

Describes the current Amazon EC2 Auto Scaling resource quotas for your AWS account.

For information about requesting an increase, see Amazon EC2 Auto Scaling service quotas in the Amazon EC2 Auto Scaling User Guide.

Examples:

Example: To describe your Auto Scaling account limits


# This example describes the Auto Scaling limits for your AWS account.

resp = client.({
})

resp.to_h outputs the following:
{
  max_number_of_auto_scaling_groups: 20, 
  max_number_of_launch_configurations: 100, 
  number_of_auto_scaling_groups: 3, 
  number_of_launch_configurations: 5, 
}

Response structure


resp.max_number_of_auto_scaling_groups #=> Integer
resp.max_number_of_launch_configurations #=> Integer
resp.number_of_auto_scaling_groups #=> Integer
resp.number_of_launch_configurations #=> Integer

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Returns:

See Also:



1888
1889
1890
1891
 
# File 'gems/aws-sdk-autoscaling/lib/aws-sdk-autoscaling/client.rb', line 1888

def (params = {}, options = {})
  req = build_request(:describe_account_limits, params)
  req.send_request(options)
end

#describe_adjustment_types(params = {}) ⇒ Types::DescribeAdjustmentTypesAnswer

Describes the available adjustment types for Amazon EC2 Auto Scaling scaling policies. These settings apply to step scaling policies and simple scaling policies; they do not apply to target tracking scaling policies.

The following adjustment types are supported:

  • ChangeInCapacity

  • ExactCapacity

  • PercentChangeInCapacity

Examples:

Example: To describe the Amazon EC2 Auto Scaling adjustment types


# This example describes the available adjustment types.

resp = client.describe_adjustment_types({
})

resp.to_h outputs the following:
{
  adjustment_types: [
    {
      adjustment_type: "ChangeInCapacity", 
    }, 
    {
      adjustment_type: "ExactCapcity", 
    }, 
    {
      adjustment_type: "PercentChangeInCapacity", 
    }, 
  ], 
}

Response structure


resp.adjustment_types #=> Array
resp.adjustment_types[0].adjustment_type #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Returns:

See Also:



1942
1943
1944
1945
 
# File 'gems/aws-sdk-autoscaling/lib/aws-sdk-autoscaling/client.rb', line 1942

def describe_adjustment_types(params = {}, options = {})
  req = build_request(:describe_adjustment_types, params)
  req.send_request(options)
end

#describe_auto_scaling_groups(params = {}) ⇒ Types::AutoScalingGroupsType

Describes one or more Auto Scaling groups.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

The following waiters are defined for this operation (see #wait_until for detailed usage):

  • group_exists
  • group_in_service
  • group_not_exists

Examples:

Example: To describe an Auto Scaling group


# This example describes the specified Auto Scaling group.

resp = client.describe_auto_scaling_groups({
  auto_scaling_group_names: [
    "my-auto-scaling-group", 
  ], 
})

resp.to_h outputs the following:
{
  auto_scaling_groups: [
    {
      auto_scaling_group_arn: "arn:aws:autoscaling:us-west-2:123456789012:autoScalingGroup:930d940e-891e-4781-a11a-7b0acd480f03:autoScalingGroupName/my-auto-scaling-group", 
      auto_scaling_group_name: "my-auto-scaling-group", 
      availability_zones: [
        "us-west-2c", 
      ], 
      created_time: Time.parse("2013-08-19T20:53:25.584Z"), 
      default_cooldown: 300, 
      desired_capacity: 1, 
      enabled_metrics: [
      ], 
      health_check_grace_period: 300, 
      health_check_type: "EC2", 
      instances: [
        {
          availability_zone: "us-west-2c", 
          health_status: "Healthy", 
          instance_id: "i-4ba0837f", 
          launch_configuration_name: "my-launch-config", 
          lifecycle_state: "InService", 
          protected_from_scale_in: false, 
        }, 
      ], 
      launch_configuration_name: "my-launch-config", 
      load_balancer_names: [
      ], 
      max_size: 1, 
      min_size: 0, 
      new_instances_protected_from_scale_in: false, 
      suspended_processes: [
      ], 
      tags: [
      ], 
      termination_policies: [
        "Default", 
      ], 
      vpc_zone_identifier: "subnet-12345678", 
    }, 
  ], 
}

Request syntax with placeholder values


resp = client.describe_auto_scaling_groups({
  auto_scaling_group_names: ["ResourceName"],
  next_token: "XmlString",
  max_records: 1,
})

Response structure


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].mixed_instances_policy.launch_template.launch_template_specification.launch_template_id #=> String
resp.auto_scaling_groups[0].mixed_instances_policy.launch_template.launch_template_specification.launch_template_name #=> String
resp.auto_scaling_groups[0].mixed_instances_policy.launch_template.launch_template_specification.version #=> String
resp.auto_scaling_groups[0].mixed_instances_policy.launch_template.overrides #=> Array
resp.auto_scaling_groups[0].mixed_instances_policy.launch_template.overrides[0].instance_type #=> String
resp.auto_scaling_groups[0].mixed_instances_policy.launch_template.overrides[0].weighted_capacity #=> String
resp.auto_scaling_groups[0].mixed_instances_policy.launch_template.overrides[0].launch_template_specification.launch_template_id #=> String
resp.auto_scaling_groups[0].mixed_instances_policy.launch_template.overrides[0].launch_template_specification.launch_template_name #=> String
resp.auto_scaling_groups[0].mixed_instances_policy.launch_template.overrides[0].launch_template_specification.version #=> String
resp.auto_scaling_groups[0].mixed_instances_policy.instances_distribution.on_demand_allocation_strategy #=> String
resp.auto_scaling_groups[0].mixed_instances_policy.instances_distribution.on_demand_base_capacity #=> Integer
resp.auto_scaling_groups[0].mixed_instances_policy.instances_distribution.on_demand_percentage_above_base_capacity #=> Integer
resp.auto_scaling_groups[0].mixed_instances_policy.instances_distribution.spot_allocation_strategy #=> String
resp.auto_scaling_groups[0].mixed_instances_policy.instances_distribution.spot_instance_pools #=> Integer
resp.auto_scaling_groups[0].mixed_instances_policy.instances_distribution.spot_max_price #=> 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
resp.auto_scaling_groups[0].availability_zones[0] #=> String
resp.auto_scaling_groups[0].load_balancer_names #=> Array
resp.auto_scaling_groups[0].load_balancer_names[0] #=> String
resp.auto_scaling_groups[0].target_group_arns #=> Array
resp.auto_scaling_groups[0].target_group_arns[0] #=> String
resp.auto_scaling_groups[0].health_check_type #=> String
resp.auto_scaling_groups[0].health_check_grace_period #=> Integer
resp.auto_scaling_groups[0].instances #=> Array
resp.auto_scaling_groups[0].instances[0].instance_id #=> String
resp.auto_scaling_groups[0].instances[0].instance_type #=> 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].instances[0].weighted_capacity #=> String
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
resp.auto_scaling_groups[0].placement_group #=> String
resp.auto_scaling_groups[0].vpc_zone_identifier #=> String
resp.auto_scaling_groups[0].enabled_metrics #=> Array
resp.auto_scaling_groups[0].enabled_metrics[0].metric #=> String
resp.auto_scaling_groups[0].enabled_metrics[0].granularity #=> String
resp.auto_scaling_groups[0].status #=> String
resp.auto_scaling_groups[0].tags #=> Array
resp.auto_scaling_groups[0].tags[0].resource_id #=> String
resp.auto_scaling_groups[0].tags[0].resource_type #=> String
resp.auto_scaling_groups[0].tags[0].key #=> String
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.auto_scaling_groups[0].max_instance_lifetime #=> Integer
resp.auto_scaling_groups[0].capacity_rebalance #=> Boolean
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :auto_scaling_group_names (Array<String>) —

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

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

  • :next_token (String) —

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

  • :max_records (Integer) —

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

Returns:

See Also:



2117
2118
2119
2120
 
# File 'gems/aws-sdk-autoscaling/lib/aws-sdk-autoscaling/client.rb', line 2117

def describe_auto_scaling_groups(params = {}, options = {})
  req = build_request(:describe_auto_scaling_groups, params)
  req.send_request(options)
end

#describe_auto_scaling_instances(params = {}) ⇒ Types::AutoScalingInstancesType

Describes one or more Auto Scaling instances.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Example: To describe one or more Auto Scaling instances


# This example describes the specified Auto Scaling instance.

resp = client.describe_auto_scaling_instances({
  instance_ids: [
    "i-4ba0837f", 
  ], 
})

resp.to_h outputs the following:
{
  auto_scaling_instances: [
    {
      auto_scaling_group_name: "my-auto-scaling-group", 
      availability_zone: "us-west-2c", 
      health_status: "HEALTHY", 
      instance_id: "i-4ba0837f", 
      launch_configuration_name: "my-launch-config", 
      lifecycle_state: "InService", 
      protected_from_scale_in: false, 
    }, 
  ], 
}

Request syntax with placeholder values


resp = client.describe_auto_scaling_instances({
  instance_ids: ["XmlStringMaxLen19"],
  max_records: 1,
  next_token: "XmlString",
})

Response structure


resp.auto_scaling_instances #=> Array
resp.auto_scaling_instances[0].instance_id #=> String
resp.auto_scaling_instances[0].instance_type #=> String
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.auto_scaling_instances[0].weighted_capacity #=> String
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :instance_ids (Array<String>) —

    The IDs of the instances. You can specify up to MaxRecords 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.)

Returns:

See Also:



2199
2200
2201
2202
 
# File 'gems/aws-sdk-autoscaling/lib/aws-sdk-autoscaling/client.rb', line 2199

def describe_auto_scaling_instances(params = {}, options = {})
  req = build_request(:describe_auto_scaling_instances, params)
  req.send_request(options)
end

#describe_auto_scaling_notification_types(params = {}) ⇒ Types::DescribeAutoScalingNotificationTypesAnswer

Describes the notification types that are supported by Amazon EC2 Auto Scaling.

Examples:

Example: To describe the Auto Scaling notification types


# This example describes the available notification types.

resp = client.describe_auto_scaling_notification_types({
})

resp.to_h outputs the following:
{
  auto_scaling_notification_types: [
    "autoscaling:EC2_INSTANCE_LAUNCH", 
    "autoscaling:EC2_INSTANCE_LAUNCH_ERROR", 
    "autoscaling:EC2_INSTANCE_TERMINATE", 
    "autoscaling:EC2_INSTANCE_TERMINATE_ERROR", 
    "autoscaling:TEST_NOTIFICATION", 
  ], 
}

Response structure


resp.auto_scaling_notification_types #=> Array
resp.auto_scaling_notification_types[0] #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Returns:

See Also:



2239
2240
2241
2242
 
# File 'gems/aws-sdk-autoscaling/lib/aws-sdk-autoscaling/client.rb', line 2239

def describe_auto_scaling_notification_types(params = {}, options = {})
  req = build_request(:describe_auto_scaling_notification_types, params)
  req.send_request(options)
end

#describe_instance_refreshes(params = {}) ⇒ Types::DescribeInstanceRefreshesAnswer

Describes one or more instance refreshes.

You can determine the status of a request by looking at the Status parameter. The following are the possible statuses:

  • Pending - The request was created, but the operation has not started.

  • InProgress - The operation is in progress.

  • Successful - The operation completed successfully.

  • Failed - The operation failed to complete. You can troubleshoot using the status reason and the scaling activities.

  • Cancelling - An ongoing operation is being cancelled. Cancellation does not roll back any replacements that have already been completed, but it prevents new replacements from being started.

  • Cancelled - The operation is cancelled.

For more information, see Replacing Auto Scaling Instances Based on an Instance Refresh.

Examples:

Example: To list instance refreshes


# This example describes the instance refreshes for the specified Auto Scaling group.

resp = client.describe_instance_refreshes({
  auto_scaling_group_name: "my-auto-scaling-group", 
})

resp.to_h outputs the following:
{
  instance_refreshes: [
    {
      auto_scaling_group_name: "my-auto-scaling-group", 
      instance_refresh_id: "08b91cf7-8fa6-48af-b6a6-d227f40f1b9b", 
      instances_to_update: 5, 
      percentage_complete: 0, 
      start_time: Time.parse("2020-06-02T18:11:27Z"), 
      status: "InProgress", 
    }, 
    {
      auto_scaling_group_name: "my-auto-scaling-group", 
      end_time: Time.parse("2020-06-02T16:53:37Z"), 
      instance_refresh_id: "dd7728d0-5bc4-4575-96a3-1b2c52bf8bb1", 
      instances_to_update: 0, 
      percentage_complete: 100, 
      start_time: Time.parse("2020-06-02T16:43:19Z"), 
      status: "Successful", 
    }, 
  ], 
}

Request syntax with placeholder values


resp = client.describe_instance_refreshes({
  auto_scaling_group_name: "XmlStringMaxLen255", # required
  instance_refresh_ids: ["XmlStringMaxLen255"],
  next_token: "XmlString",
  max_records: 1,
})

Response structure


resp.instance_refreshes #=> Array
resp.instance_refreshes[0].instance_refresh_id #=> String
resp.instance_refreshes[0].auto_scaling_group_name #=> String
resp.instance_refreshes[0].status #=> String, one of "Pending", "InProgress", "Successful", "Failed", "Cancelling", "Cancelled"
resp.instance_refreshes[0].status_reason #=> String
resp.instance_refreshes[0].start_time #=> Time
resp.instance_refreshes[0].end_time #=> Time
resp.instance_refreshes[0].percentage_complete #=> Integer
resp.instance_refreshes[0].instances_to_update #=> Integer
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :auto_scaling_group_name (required, String) —

    The name of the Auto Scaling group.

  • :instance_refresh_ids (Array<String>) —

    One or more instance refresh IDs.

  • :next_token (String) —

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

  • :max_records (Integer) —

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

Returns:

See Also:



2349
2350
2351
2352
 
# File 'gems/aws-sdk-autoscaling/lib/aws-sdk-autoscaling/client.rb', line 2349

def describe_instance_refreshes(params = {}, options = {})
  req = build_request(:describe_instance_refreshes, params)
  req.send_request(options)
end

#describe_launch_configurations(params = {}) ⇒ Types::LaunchConfigurationsType

Describes one or more launch configurations.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Example: To describe Auto Scaling launch configurations


# This example describes the specified launch configuration.

resp = client.describe_launch_configurations({
  launch_configuration_names: [
    "my-launch-config", 
  ], 
})

resp.to_h outputs the following:
{
  launch_configurations: [
    {
      associate_public_ip_address: true, 
      block_device_mappings: [
      ], 
      created_time: Time.parse("2014-05-07T17:39:28.599Z"), 
      ebs_optimized: false, 
      image_id: "ami-043a5034", 
      instance_monitoring: {
        enabled: true, 
      }, 
      instance_type: "t1.micro", 
      launch_configuration_arn: "arn:aws:autoscaling:us-west-2:123456789012:launchConfiguration:98d3b196-4cf9-4e88-8ca1-8547c24ced8b:launchConfigurationName/my-launch-config", 
      launch_configuration_name: "my-launch-config", 
      security_groups: [
        "sg-67ef0308", 
      ], 
    }, 
  ], 
}

Request syntax with placeholder values


resp = client.describe_launch_configurations({
  launch_configuration_names: ["ResourceName"],
  next_token: "XmlString",
  max_records: 1,
})

Response structure


resp.launch_configurations #=> Array
resp.launch_configurations[0].launch_configuration_name #=> String
resp.launch_configurations[0].launch_configuration_arn #=> String
resp.launch_configurations[0].image_id #=> String
resp.launch_configurations[0].key_name #=> String
resp.launch_configurations[0].security_groups #=> Array
resp.launch_configurations[0].security_groups[0] #=> String
resp.launch_configurations[0].classic_link_vpc_id #=> String
resp.launch_configurations[0].classic_link_vpc_security_groups #=> Array
resp.launch_configurations[0].classic_link_vpc_security_groups[0] #=> String
resp.launch_configurations[0].user_data #=> String
resp.launch_configurations[0].instance_type #=> String
resp.launch_configurations[0].kernel_id #=> String
resp.launch_configurations[0].ramdisk_id #=> String
resp.launch_configurations[0].block_device_mappings #=> Array
resp.launch_configurations[0].block_device_mappings[0].virtual_name #=> String
resp.launch_configurations[0].block_device_mappings[0].device_name #=> String
resp.launch_configurations[0].block_device_mappings[0].ebs.snapshot_id #=> String
resp.launch_configurations[0].block_device_mappings[0].ebs.volume_size #=> Integer
resp.launch_configurations[0].block_device_mappings[0].ebs.volume_type #=> String
resp.launch_configurations[0].block_device_mappings[0].ebs.delete_on_termination #=> Boolean
resp.launch_configurations[0].block_device_mappings[0].ebs.iops #=> Integer
resp.launch_configurations[0].block_device_mappings[0].ebs.encrypted #=> Boolean
resp.launch_configurations[0].block_device_mappings[0].no_device #=> Boolean
resp.launch_configurations[0].instance_monitoring.enabled #=> Boolean
resp.launch_configurations[0].spot_price #=> String
resp.launch_configurations[0].iam_instance_profile #=> String
resp.launch_configurations[0].created_time #=> Time
resp.launch_configurations[0].ebs_optimized #=> Boolean
resp.launch_configurations[0].associate_public_ip_address #=> Boolean
resp.launch_configurations[0].placement_tenancy #=> String
resp.launch_configurations[0].metadata_options.http_tokens #=> String, one of "optional", "required"
resp.launch_configurations[0].metadata_options.http_put_response_hop_limit #=> Integer
resp.launch_configurations[0].metadata_options.http_endpoint #=> String, one of "disabled", "enabled"
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :launch_configuration_names (Array<String>) —

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

  • :next_token (String) —

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

  • :max_records (Integer) —

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

Returns:

See Also:



2459
2460
2461
2462
 
# File 'gems/aws-sdk-autoscaling/lib/aws-sdk-autoscaling/client.rb', line 2459

def describe_launch_configurations(params = {}, options = {})
  req = build_request(:describe_launch_configurations, params)
  req.send_request(options)
end

#describe_lifecycle_hook_types(params = {}) ⇒ Types::DescribeLifecycleHookTypesAnswer

Describes the available types of lifecycle hooks.

The following hook types are supported:

  • autoscaling:EC2_INSTANCE_LAUNCHING

  • autoscaling:EC2_INSTANCE_TERMINATING

Examples:

Example: To describe the available types of lifecycle hooks


# This example describes the available lifecycle hook types.

resp = client.describe_lifecycle_hook_types({
})

resp.to_h outputs the following:
{
  lifecycle_hook_types: [
    "autoscaling:EC2_INSTANCE_LAUNCHING", 
    "autoscaling:EC2_INSTANCE_TERMINATING", 
  ], 
}

Response structure


resp.lifecycle_hook_types #=> Array
resp.lifecycle_hook_types[0] #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Returns:

See Also:



2501
2502
2503
2504
 
# File 'gems/aws-sdk-autoscaling/lib/aws-sdk-autoscaling/client.rb', line 2501

def describe_lifecycle_hook_types(params = {}, options = {})
  req = build_request(:describe_lifecycle_hook_types, params)
  req.send_request(options)
end

#describe_lifecycle_hooks(params = {}) ⇒ Types::DescribeLifecycleHooksAnswer

Describes the lifecycle hooks for the specified Auto Scaling group.

Examples:

Example: To describe your lifecycle hooks


# This example describes the lifecycle hooks for the specified Auto Scaling group.

resp = client.describe_lifecycle_hooks({
  auto_scaling_group_name: "my-auto-scaling-group", 
})

resp.to_h outputs the following:
{
  lifecycle_hooks: [
    {
      auto_scaling_group_name: "my-auto-scaling-group", 
      default_result: "ABANDON", 
      global_timeout: 172800, 
      heartbeat_timeout: 3600, 
      lifecycle_hook_name: "my-lifecycle-hook", 
      lifecycle_transition: "autoscaling:EC2_INSTANCE_LAUNCHING", 
      notification_target_arn: "arn:aws:sns:us-west-2:123456789012:my-sns-topic", 
      role_arn: "arn:aws:iam::123456789012:role/my-auto-scaling-role", 
    }, 
  ], 
}

Request syntax with placeholder values


resp = client.describe_lifecycle_hooks({
  auto_scaling_group_name: "ResourceName", # required
  lifecycle_hook_names: ["AsciiStringMaxLen255"],
})

Response structure


resp.lifecycle_hooks #=> Array
resp.lifecycle_hooks[0].lifecycle_hook_name #=> String
resp.lifecycle_hooks[0].auto_scaling_group_name #=> String
resp.lifecycle_hooks[0].lifecycle_transition #=> String
resp.lifecycle_hooks[0].notification_target_arn #=> String
resp.lifecycle_hooks[0].role_arn #=> String
resp.lifecycle_hooks[0].notification_metadata #=> String
resp.lifecycle_hooks[0].heartbeat_timeout #=> Integer
resp.lifecycle_hooks[0].global_timeout #=> Integer
resp.lifecycle_hooks[0].default_result #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :auto_scaling_group_name (required, String) —

    The name of the Auto Scaling group.

  • :lifecycle_hook_names (Array<String>) —

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

Returns:

See Also:



2568
2569
2570
2571
 
# File 'gems/aws-sdk-autoscaling/lib/aws-sdk-autoscaling/client.rb', line 2568

def describe_lifecycle_hooks(params = {}, options = {})
  req = build_request(:describe_lifecycle_hooks, params)
  req.send_request(options)
end

#describe_load_balancer_target_groups(params = {}) ⇒ Types::DescribeLoadBalancerTargetGroupsResponse

Describes the target groups for the specified Auto Scaling group.

Examples:

Example: To describe the target groups for an Auto Scaling group


# This example describes the target groups attached to the specified Auto Scaling group.

resp = client.describe_load_balancer_target_groups({
  auto_scaling_group_name: "my-auto-scaling-group", 
})

resp.to_h outputs the following:
{
  load_balancer_target_groups: [
    {
      load_balancer_target_group_arn: "arn:aws:elasticloadbalancing:us-west-2:123456789012:targetgroup/my-targets/73e2d6bc24d8a067", 
      state: "Added", 
    }, 
  ], 
}

Request syntax with placeholder values


resp = client.describe_load_balancer_target_groups({
  auto_scaling_group_name: "ResourceName", # required
  next_token: "XmlString",
  max_records: 1,
})

Response structure


resp.load_balancer_target_groups #=> Array
resp.load_balancer_target_groups[0].load_balancer_target_group_arn #=> String
resp.load_balancer_target_groups[0].state #=> String
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :auto_scaling_group_name (required, String) —

    The name of the Auto Scaling group.

  • :next_token (String) —

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

  • :max_records (Integer) —

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

Returns:

See Also:



2629
2630
2631
2632
 
# File 'gems/aws-sdk-autoscaling/lib/aws-sdk-autoscaling/client.rb', line 2629

def describe_load_balancer_target_groups(params = {}, options = {})
  req = build_request(:describe_load_balancer_target_groups, params)
  req.send_request(options)
end

#describe_load_balancers(params = {}) ⇒ Types::DescribeLoadBalancersResponse

Describes the load balancers for the specified Auto Scaling group.

This operation describes only Classic Load Balancers. If you have Application Load Balancers, Network Load Balancers, or Gateway Load Balancers, use the DescribeLoadBalancerTargetGroups API instead.

Examples:

Example: To describe the load balancers for an Auto Scaling group


# This example describes the load balancers attached to the specified Auto Scaling group.

resp = client.describe_load_balancers({
  auto_scaling_group_name: "my-auto-scaling-group", 
})

resp.to_h outputs the following:
{
  load_balancers: [
    {
      load_balancer_name: "my-load-balancer", 
      state: "Added", 
    }, 
  ], 
}

Request syntax with placeholder values


resp = client.describe_load_balancers({
  auto_scaling_group_name: "ResourceName", # required
  next_token: "XmlString",
  max_records: 1,
})

Response structure


resp.load_balancers #=> Array
resp.load_balancers[0].load_balancer_name #=> String
resp.load_balancers[0].state #=> String
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :auto_scaling_group_name (required, String) —

    The name of the Auto Scaling group.

  • :next_token (String) —

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

  • :max_records (Integer) —

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

Returns:

See Also:



2694
2695
2696
2697
 
# File 'gems/aws-sdk-autoscaling/lib/aws-sdk-autoscaling/client.rb', line 2694

def describe_load_balancers(params = {}, options = {})
  req = build_request(:describe_load_balancers, params)
  req.send_request(options)
end

#describe_metric_collection_types(params = {}) ⇒ Types::DescribeMetricCollectionTypesAnswer

Describes the available CloudWatch metrics for Amazon EC2 Auto Scaling.

The GroupStandbyInstances metric is not returned by default. You must explicitly request this metric when calling the EnableMetricsCollection API.

Examples:

Example: To describe the Auto Scaling metric collection types


# This example describes the available metric collection types.

resp = client.describe_metric_collection_types({
})

resp.to_h outputs the following:
{
  granularities: [
    {
      granularity: "1Minute", 
    }, 
  ], 
  metrics: [
    {
      metric: "GroupMinSize", 
    }, 
    {
      metric: "GroupMaxSize", 
    }, 
    {
      metric: "GroupDesiredCapacity", 
    }, 
    {
      metric: "GroupInServiceInstances", 
    }, 
    {
      metric: "GroupPendingInstances", 
    }, 
    {
      metric: "GroupTerminatingInstances", 
    }, 
    {
      metric: "GroupStandbyInstances", 
    }, 
    {
      metric: "GroupTotalInstances", 
    }, 
  ], 
}

Response structure


resp.metrics #=> Array
resp.metrics[0].metric #=> String
resp.granularities #=> Array
resp.granularities[0].granularity #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Returns:

See Also:



2765
2766
2767
2768
 
# File 'gems/aws-sdk-autoscaling/lib/aws-sdk-autoscaling/client.rb', line 2765

def describe_metric_collection_types(params = {}, options = {})
  req = build_request(:describe_metric_collection_types, params)
  req.send_request(options)
end

#describe_notification_configurations(params = {}) ⇒ Types::DescribeNotificationConfigurationsAnswer

Describes the notification actions associated with the specified Auto Scaling group.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Example: To describe Auto Scaling notification configurations


# This example describes the notification configurations for the specified Auto Scaling group.

resp = client.describe_notification_configurations({
  auto_scaling_group_names: [
    "my-auto-scaling-group", 
  ], 
})

resp.to_h outputs the following:
{
  notification_configurations: [
    {
      auto_scaling_group_name: "my-auto-scaling-group", 
      notification_type: "autoscaling:TEST_NOTIFICATION", 
      topic_arn: "arn:aws:sns:us-west-2:123456789012:my-sns-topic-2", 
    }, 
    {
      auto_scaling_group_name: "my-auto-scaling-group", 
      notification_type: "autoscaling:TEST_NOTIFICATION", 
      topic_arn: "arn:aws:sns:us-west-2:123456789012:my-sns-topic", 
    }, 
  ], 
}

Request syntax with placeholder values


resp = client.describe_notification_configurations({
  auto_scaling_group_names: ["ResourceName"],
  next_token: "XmlString",
  max_records: 1,
})

Response structure


resp.notification_configurations #=> Array
resp.notification_configurations[0].auto_scaling_group_name #=> String
resp.notification_configurations[0].topic_arn #=> String
resp.notification_configurations[0].notification_type #=> String
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :auto_scaling_group_names (Array<String>) —

    The name of the Auto Scaling group.

  • :next_token (String) —

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

  • :max_records (Integer) —

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

Returns:

See Also:



2838
2839
2840
2841
 
# File 'gems/aws-sdk-autoscaling/lib/aws-sdk-autoscaling/client.rb', line 2838

def describe_notification_configurations(params = {}, options = {})
  req = build_request(:describe_notification_configurations, params)
  req.send_request(options)
end

#describe_policies(params = {}) ⇒ Types::PoliciesType

Describes the policies for the specified Auto Scaling group.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Example: To describe scaling policies


# This example describes the policies for the specified Auto Scaling group.

resp = client.describe_policies({
  auto_scaling_group_name: "my-auto-scaling-group", 
})

resp.to_h outputs the following:
{
  scaling_policies: [
    {
      adjustment_type: "ChangeInCapacity", 
      alarms: [
      ], 
      auto_scaling_group_name: "my-auto-scaling-group", 
      policy_arn: "arn:aws:autoscaling:us-west-2:123456789012:scalingPolicy:2233f3d7-6290-403b-b632-93c553560106:autoScalingGroupName/my-auto-scaling-group:policyName/ScaleIn", 
      policy_name: "ScaleIn", 
      scaling_adjustment: -1, 
    }, 
    {
      adjustment_type: "PercentChangeInCapacity", 
      alarms: [
      ], 
      auto_scaling_group_name: "my-auto-scaling-group", 
      cooldown: 60, 
      min_adjustment_step: 2, 
      policy_arn: "arn:aws:autoscaling:us-west-2:123456789012:scalingPolicy:2b435159-cf77-4e89-8c0e-d63b497baad7:autoScalingGroupName/my-auto-scaling-group:policyName/ScalePercentChange", 
      policy_name: "ScalePercentChange", 
      scaling_adjustment: 25, 
    }, 
  ], 
}

Request syntax with placeholder values


resp = client.describe_policies({
  auto_scaling_group_name: "ResourceName",
  policy_names: ["ResourceName"],
  policy_types: ["XmlStringMaxLen64"],
  next_token: "XmlString",
  max_records: 1,
})

Response structure


resp.scaling_policies #=> Array
resp.scaling_policies[0].auto_scaling_group_name #=> String
resp.scaling_policies[0].policy_name #=> String
resp.scaling_policies[0].policy_arn #=> String
resp.scaling_policies[0].policy_type #=> String
resp.scaling_policies[0].adjustment_type #=> String
resp.scaling_policies[0].min_adjustment_step #=> Integer
resp.scaling_policies[0].min_adjustment_magnitude #=> Integer
resp.scaling_policies[0].scaling_adjustment #=> Integer
resp.scaling_policies[0].cooldown #=> Integer
resp.scaling_policies[0].step_adjustments #=> Array
resp.scaling_policies[0].step_adjustments[0].metric_interval_lower_bound #=> Float
resp.scaling_policies[0].step_adjustments[0].metric_interval_upper_bound #=> Float
resp.scaling_policies[0].step_adjustments[0].scaling_adjustment #=> Integer
resp.scaling_policies[0].metric_aggregation_type #=> String
resp.scaling_policies[0].estimated_instance_warmup #=> Integer
resp.scaling_policies[0].alarms #=> Array
resp.scaling_policies[0].alarms[0].alarm_name #=> String
resp.scaling_policies[0].alarms[0].alarm_arn #=> String
resp.scaling_policies[0].target_tracking_configuration.predefined_metric_specification.predefined_metric_type #=> String, one of "ASGAverageCPUUtilization", "ASGAverageNetworkIn", "ASGAverageNetworkOut", "ALBRequestCountPerTarget"
resp.scaling_policies[0].target_tracking_configuration.predefined_metric_specification.resource_label #=> String
resp.scaling_policies[0].target_tracking_configuration.customized_metric_specification.metric_name #=> String
resp.scaling_policies[0].target_tracking_configuration.customized_metric_specification.namespace #=> String
resp.scaling_policies[0].target_tracking_configuration.customized_metric_specification.dimensions #=> Array
resp.scaling_policies[0].target_tracking_configuration.customized_metric_specification.dimensions[0].name #=> String
resp.scaling_policies[0].target_tracking_configuration.customized_metric_specification.dimensions[0].value #=> String
resp.scaling_policies[0].target_tracking_configuration.customized_metric_specification.statistic #=> String, one of "Average", "Minimum", "Maximum", "SampleCount", "Sum"
resp.scaling_policies[0].target_tracking_configuration.customized_metric_specification.unit #=> String
resp.scaling_policies[0].target_tracking_configuration.target_value #=> Float
resp.scaling_policies[0].target_tracking_configuration.disable_scale_in #=> Boolean
resp.scaling_policies[0].enabled #=> Boolean
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :auto_scaling_group_name (String) —

    The name of the Auto Scaling group.

  • :policy_names (Array<String>) —

    The names of one or more policies. If you omit this parameter, all policies are described. If a 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.

  • :policy_types (Array<String>) —

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

  • :next_token (String) —

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

  • :max_records (Integer) —

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

Returns:

See Also:



2957
2958
2959
2960
 
# File 'gems/aws-sdk-autoscaling/lib/aws-sdk-autoscaling/client.rb', line 2957

def describe_policies(params = {}, options = {})
  req = build_request(:describe_policies, params)
  req.send_request(options)
end

#describe_scaling_activities(params = {}) ⇒ Types::ActivitiesType

Describes one or more scaling activities for the specified Auto Scaling group.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Example: To describe the scaling activities for an Auto Scaling group


# This example describes the scaling activities for the specified Auto Scaling group.

resp = client.describe_scaling_activities({
  auto_scaling_group_name: "my-auto-scaling-group", 
})

resp.to_h outputs the following:
{
  activities: [
    {
      activity_id: "f9f2d65b-f1f2-43e7-b46d-d86756459699", 
      auto_scaling_group_name: "my-auto-scaling-group", 
      cause: "At 2013-08-19T20:53:25Z a user request created an AutoScalingGroup changing the desired capacity from 0 to 1.  At 2013-08-19T20:53:29Z an instance was started in response to a difference between desired and actual capacity, increasing the capacity from 0 to 1.", 
      description: "Launching a new EC2 instance: i-4ba0837f", 
      details: "details", 
      end_time: Time.parse("2013-08-19T20:54:02Z"), 
      progress: 100, 
      start_time: Time.parse("2013-08-19T20:53:29.930Z"), 
      status_code: "Successful", 
    }, 
  ], 
}

Request syntax with placeholder values


resp = client.describe_scaling_activities({
  activity_ids: ["XmlString"],
  auto_scaling_group_name: "ResourceName",
  max_records: 1,
  next_token: "XmlString",
})

Response structure


resp.activities #=> Array
resp.activities[0].activity_id #=> String
resp.activities[0].auto_scaling_group_name #=> String
resp.activities[0].description #=> String
resp.activities[0].cause #=> String
resp.activities[0].start_time #=> Time
resp.activities[0].end_time #=> Time
resp.activities[0].status_code #=> String, one of "PendingSpotBidPlacement", "WaitingForSpotInstanceRequestId", "WaitingForSpotInstanceId", "WaitingForInstanceId", "PreInService", "InProgress", "WaitingForELBConnectionDraining", "MidLifecycleAction", "WaitingForInstanceWarmup", "Successful", "Failed", "Cancelled"
resp.activities[0].status_message #=> String
resp.activities[0].progress #=> Integer
resp.activities[0].details #=> String
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :activity_ids (Array<String>) —

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

  • :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 100 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.)

Returns:

See Also:



3044
3045
3046
3047
 
# File 'gems/aws-sdk-autoscaling/lib/aws-sdk-autoscaling/client.rb', line 3044

def describe_scaling_activities(params = {}, options = {})
  req = build_request(:describe_scaling_activities, params)
  req.send_request(options)
end

#describe_scaling_process_types(params = {}) ⇒ Types::ProcessesType

Describes the scaling process types for use with the ResumeProcesses and SuspendProcesses APIs.

Examples:

Example: To describe the Auto Scaling process types


# This example describes the Auto Scaling process types.

resp = client.describe_scaling_process_types({
})

resp.to_h outputs the following:
{
  processes: [
    {
      process_name: "AZRebalance", 
    }, 
    {
      process_name: "AddToLoadBalancer", 
    }, 
    {
      process_name: "AlarmNotification", 
    }, 
    {
      process_name: "HealthCheck", 
    }, 
    {
      process_name: "Launch", 
    }, 
    {
      process_name: "ReplaceUnhealthy", 
    }, 
    {
      process_name: "ScheduledActions", 
    }, 
    {
      process_name: "Terminate", 
    }, 
  ], 
}

Response structure


resp.processes #=> Array
resp.processes[0].process_name #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Returns:

See Also:



3103
3104
3105
3106
 
# File 'gems/aws-sdk-autoscaling/lib/aws-sdk-autoscaling/client.rb', line 3103

def describe_scaling_process_types(params = {}, options = {})
  req = build_request(:describe_scaling_process_types, params)
  req.send_request(options)
end

#describe_scheduled_actions(params = {}) ⇒ Types::ScheduledActionsType

Describes the actions scheduled for your Auto Scaling group that haven't run or that have not reached their end time. To describe the actions that have already run, call the DescribeScalingActivities API.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Example: To describe scheduled actions


# This example describes the scheduled actions for the specified Auto Scaling group.

resp = client.describe_scheduled_actions({
  auto_scaling_group_name: "my-auto-scaling-group", 
})

resp.to_h outputs the following:
{
  scheduled_update_group_actions: [
    {
      auto_scaling_group_name: "my-auto-scaling-group", 
      desired_capacity: 4, 
      max_size: 6, 
      min_size: 2, 
      recurrence: "30 0 1 12 0", 
      scheduled_action_arn: "arn:aws:autoscaling:us-west-2:123456789012:scheduledUpdateGroupAction:8e86b655-b2e6-4410-8f29-b4f094d6871c:autoScalingGroupName/my-auto-scaling-group:scheduledActionName/my-scheduled-action", 
      scheduled_action_name: "my-scheduled-action", 
      start_time: Time.parse("2016-12-01T00:30:00Z"), 
      time: Time.parse("2016-12-01T00:30:00Z"), 
    }, 
  ], 
}

Request syntax with placeholder values


resp = client.describe_scheduled_actions({
  auto_scaling_group_name: "ResourceName",
  scheduled_action_names: ["ResourceName"],
  start_time: Time.now,
  end_time: Time.now,
  next_token: "XmlString",
  max_records: 1,
})

Response structure


resp.scheduled_update_group_actions #=> Array
resp.scheduled_update_group_actions[0].auto_scaling_group_name #=> String
resp.scheduled_update_group_actions[0].scheduled_action_name #=> String
resp.scheduled_update_group_actions[0].scheduled_action_arn #=> String
resp.scheduled_update_group_actions[0].time #=> Time
resp.scheduled_update_group_actions[0].start_time #=> Time
resp.scheduled_update_group_actions[0].end_time #=> Time
resp.scheduled_update_group_actions[0].recurrence #=> String
resp.scheduled_update_group_actions[0].min_size #=> Integer
resp.scheduled_update_group_actions[0].max_size #=> Integer
resp.scheduled_update_group_actions[0].desired_capacity #=> Integer
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :auto_scaling_group_name (String) —

    The name of the Auto Scaling group.

  • :scheduled_action_names (Array<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 (Time, DateTime, Date, Integer, String) —

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

  • :end_time (Time, DateTime, Date, Integer, String) —

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

  • :next_token (String) —

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

  • :max_records (Integer) —

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

Returns:

See Also:



3200
3201
3202
3203
 
# File 'gems/aws-sdk-autoscaling/lib/aws-sdk-autoscaling/client.rb', line 3200

def describe_scheduled_actions(params = {}, options = {})
  req = build_request(:describe_scheduled_actions, params)
  req.send_request(options)
end

#describe_tags(params = {}) ⇒ Types::TagsType

Describes the specified tags.

You can use filters to limit the results. For example, you can query for the tags for a specific Auto Scaling group. You can specify multiple values for a filter. A tag must match at least one of the specified values for it to be included in the results.

You can also specify multiple filters. The result includes information for a particular tag only if it matches all the filters. If there's no match, no special message is returned.

For more information, see Tagging Auto Scaling groups and instances in the Amazon EC2 Auto Scaling User Guide.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Example: To describe tags


# This example describes the tags for the specified Auto Scaling group.

resp = client.describe_tags({
  filters: [
    {
      name: "auto-scaling-group", 
      values: [
        "my-auto-scaling-group", 
      ], 
    }, 
  ], 
})

resp.to_h outputs the following:
{
  tags: [
    {
      key: "Dept", 
      propagate_at_launch: true, 
      resource_id: "my-auto-scaling-group", 
      resource_type: "auto-scaling-group", 
      value: "Research", 
    }, 
    {
      key: "Role", 
      propagate_at_launch: true, 
      resource_id: "my-auto-scaling-group", 
      resource_type: "auto-scaling-group", 
      value: "WebServer", 
    }, 
  ], 
}

Request syntax with placeholder values


resp = client.describe_tags({
  filters: [
    {
      name: "XmlString",
      values: ["XmlString"],
    },
  ],
  next_token: "XmlString",
  max_records: 1,
})

Response structure


resp.tags #=> Array
resp.tags[0].resource_id #=> String
resp.tags[0].resource_type #=> String
resp.tags[0].key #=> String
resp.tags[0].value #=> String
resp.tags[0].propagate_at_launch #=> Boolean
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :filters (Array<Types::Filter>) —

    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.

  • :next_token (String) —

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

  • :max_records (Integer) —

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

Returns:

See Also:



3305
3306
3307
3308
 
# File 'gems/aws-sdk-autoscaling/lib/aws-sdk-autoscaling/client.rb', line 3305

def describe_tags(params = {}, options = {})
  req = build_request(:describe_tags, params)
  req.send_request(options)
end

#describe_termination_policy_types(params = {}) ⇒ Types::DescribeTerminationPolicyTypesAnswer

Describes the termination policies supported by Amazon EC2 Auto Scaling.

For more information, see Controlling which Auto Scaling instances terminate during scale in in the Amazon EC2 Auto Scaling User Guide.

Examples:

Example: To describe termination policy types


# This example describes the available termination policy types.

resp = client.describe_termination_policy_types({
})

resp.to_h outputs the following:
{
  termination_policy_types: [
    "ClosestToNextInstanceHour", 
    "Default", 
    "NewestInstance", 
    "OldestInstance", 
    "OldestLaunchConfiguration", 
  ], 
}

Response structure


resp.termination_policy_types #=> Array
resp.termination_policy_types[0] #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Returns:

See Also:



3353
3354
3355
3356
 
# File 'gems/aws-sdk-autoscaling/lib/aws-sdk-autoscaling/client.rb', line 3353

def describe_termination_policy_types(params = {}, options = {})
  req = build_request(:describe_termination_policy_types, params)
  req.send_request(options)
end

#detach_instances(params = {}) ⇒ Types::DetachInstancesAnswer

Removes one or more instances from the specified Auto Scaling group.

After the instances are detached, you can manage them independent of the Auto Scaling group.

If you do not specify the option to decrement the desired capacity, Amazon EC2 Auto Scaling launches instances to replace the ones that are detached.

If there is a Classic Load Balancer attached to the Auto Scaling group, the instances are deregistered from the load balancer. If there are target groups attached to the Auto Scaling group, the instances are deregistered from the target groups.

For more information, see Detach EC2 instances from your Auto Scaling group in the Amazon EC2 Auto Scaling User Guide.

Examples:

Example: To detach an instance from an Auto Scaling group


# This example detaches the specified instance from the specified Auto Scaling group.

resp = client.detach_instances({
  auto_scaling_group_name: "my-auto-scaling-group", 
  instance_ids: [
    "i-93633f9b", 
  ], 
  should_decrement_desired_capacity: true, 
})

resp.to_h outputs the following:
{
  activities: [
    {
      activity_id: "5091cb52-547a-47ce-a236-c9ccbc2cb2c9", 
      auto_scaling_group_name: "my-auto-scaling-group", 
      cause: "At 2015-04-12T15:02:16Z instance i-93633f9b was detached in response to a user request, shrinking the capacity from 2 to 1.", 
      description: "Detaching EC2 instance: i-93633f9b", 
      details: "details", 
      progress: 50, 
      start_time: Time.parse("2015-04-12T15:02:16.179Z"), 
      status_code: "InProgress", 
    }, 
  ], 
}

Request syntax with placeholder values


resp = client.detach_instances({
  instance_ids: ["XmlStringMaxLen19"],
  auto_scaling_group_name: "ResourceName", # required
  should_decrement_desired_capacity: false, # required
})

Response structure


resp.activities #=> Array
resp.activities[0].activity_id #=> String
resp.activities[0].auto_scaling_group_name #=> String
resp.activities[0].description #=> String
resp.activities[0].cause #=> String
resp.activities[0].start_time #=> Time
resp.activities[0].end_time #=> Time
resp.activities[0].status_code #=> String, one of "PendingSpotBidPlacement", "WaitingForSpotInstanceRequestId", "WaitingForSpotInstanceId", "WaitingForInstanceId", "PreInService", "InProgress", "WaitingForELBConnectionDraining", "MidLifecycleAction", "WaitingForInstanceWarmup", "Successful", "Failed", "Cancelled"
resp.activities[0].status_message #=> String
resp.activities[0].progress #=> Integer
resp.activities[0].details #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :instance_ids (Array<String>) —

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

  • :auto_scaling_group_name (required, String) —

    The name of the Auto Scaling group.

  • :should_decrement_desired_capacity (required, Boolean) —

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

Returns:

See Also:



3448
3449
3450
3451
 
# File 'gems/aws-sdk-autoscaling/lib/aws-sdk-autoscaling/client.rb', line 3448

def detach_instances(params = {}, options = {})
  req = build_request(:detach_instances, params)
  req.send_request(options)
end

#detach_load_balancer_target_groups(params = {}) ⇒ Struct

Detaches one or more target groups from the specified Auto Scaling group.

Examples:

Example: To detach a target group from an Auto Scaling group


# This example detaches the specified target group from the specified Auto Scaling group

resp = client.detach_load_balancer_target_groups({
  auto_scaling_group_name: "my-auto-scaling-group", 
  target_group_arns: [
    "arn:aws:elasticloadbalancing:us-west-2:123456789012:targetgroup/my-targets/73e2d6bc24d8a067", 
  ], 
})

Request syntax with placeholder values


resp = client.detach_load_balancer_target_groups({
  auto_scaling_group_name: "ResourceName", # required
  target_group_arns: ["XmlStringMaxLen511"], # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :auto_scaling_group_name (required, String) —

    The name of the Auto Scaling group.

  • :target_group_arns (required, Array<String>) —

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

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



3488
3489
3490
3491
 
# File 'gems/aws-sdk-autoscaling/lib/aws-sdk-autoscaling/client.rb', line 3488

def detach_load_balancer_target_groups(params = {}, options = {})
  req = build_request(:detach_load_balancer_target_groups, params)
  req.send_request(options)
end

#detach_load_balancers(params = {}) ⇒ Struct

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, Network Load Balancers, or Gateway Load Balancers, use the DetachLoadBalancerTargetGroups API 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 the DescribeLoadBalancers API call. The instances remain running.

Examples:

Example: To detach a load balancer from an Auto Scaling group


# This example detaches the specified load balancer from the specified Auto Scaling group.

resp = client.detach_load_balancers({
  auto_scaling_group_name: "my-auto-scaling-group", 
  load_balancer_names: [
    "my-load-balancer", 
  ], 
})

Request syntax with placeholder values


resp = client.detach_load_balancers({
  auto_scaling_group_name: "ResourceName", # required
  load_balancer_names: ["XmlStringMaxLen255"], # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :auto_scaling_group_name (required, String) —

    The name of the Auto Scaling group.

  • :load_balancer_names (required, Array<String>) —

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

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



3537
3538
3539
3540
 
# File 'gems/aws-sdk-autoscaling/lib/aws-sdk-autoscaling/client.rb', line 3537

def detach_load_balancers(params = {}, options = {})
  req = build_request(:detach_load_balancers, params)
  req.send_request(options)
end

#disable_metrics_collection(params = {}) ⇒ Struct

Disables group metrics for the specified Auto Scaling group.

Examples:

Example: To disable metrics collection for an Auto Scaling group


# This example disables collecting data for the GroupDesiredCapacity metric for the specified Auto Scaling group.

resp = client.disable_metrics_collection({
  auto_scaling_group_name: "my-auto-scaling-group", 
  metrics: [
    "GroupDesiredCapacity", 
  ], 
})

Request syntax with placeholder values


resp = client.disable_metrics_collection({
  auto_scaling_group_name: "ResourceName", # required
  metrics: ["XmlStringMaxLen255"],
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :auto_scaling_group_name (required, String) —

    The name of the Auto Scaling group.

  • :metrics (Array<String>) —

    Specifies one or more of the following metrics:

    • GroupMinSize

    • GroupMaxSize

    • GroupDesiredCapacity

    • GroupInServiceInstances

    • GroupPendingInstances

    • GroupStandbyInstances

    • GroupTerminatingInstances

    • GroupTotalInstances

    • GroupInServiceCapacity

    • GroupPendingCapacity

    • GroupStandbyCapacity

    • GroupTerminatingCapacity

    • GroupTotalCapacity

    If you omit this parameter, all metrics are disabled.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



3603
3604
3605
3606
 
# File 'gems/aws-sdk-autoscaling/lib/aws-sdk-autoscaling/client.rb', line 3603

def disable_metrics_collection(params = {}, options = {})
  req = build_request(:disable_metrics_collection, params)
  req.send_request(options)
end

#enable_metrics_collection(params = {}) ⇒ Struct

Enables group metrics for the specified Auto Scaling group. For more information, see Monitoring CloudWatch metrics for your Auto Scaling groups and instances in the Amazon EC2 Auto Scaling User Guide.

Examples:

Example: To enable metrics collection for an Auto Scaling group


# This example enables data collection for the specified Auto Scaling group.

resp = client.enable_metrics_collection({
  auto_scaling_group_name: "my-auto-scaling-group", 
  granularity: "1Minute", 
})

Request syntax with placeholder values


resp = client.enable_metrics_collection({
  auto_scaling_group_name: "ResourceName", # required
  metrics: ["XmlStringMaxLen255"],
  granularity: "XmlStringMaxLen255", # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :auto_scaling_group_name (required, String) —

    The name of the Auto Scaling group.

  • :metrics (Array<String>) —

    Specifies which group-level metrics to start collecting. You can specify one or more of the following metrics:

    • GroupMinSize

    • GroupMaxSize

    • GroupDesiredCapacity

    • GroupInServiceInstances

    • GroupPendingInstances

    • GroupStandbyInstances

    • GroupTerminatingInstances

    • GroupTotalInstances

    The instance weighting feature supports the following additional metrics:

    • GroupInServiceCapacity

    • GroupPendingCapacity

    • GroupStandbyCapacity

    • GroupTerminatingCapacity

    • GroupTotalCapacity

    If you omit this parameter, all metrics are enabled.

  • :granularity (required, String) —

    The granularity to associate with the metrics to collect. The only valid value is 1Minute.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



3682
3683
3684
3685
 
# File 'gems/aws-sdk-autoscaling/lib/aws-sdk-autoscaling/client.rb', line 3682

def enable_metrics_collection(params = {}, options = {})
  req = build_request(:enable_metrics_collection, params)
  req.send_request(options)
end

#enter_standby(params = {}) ⇒ Types::EnterStandbyAnswer

Moves the specified instances into the standby state.

If you choose to decrement the desired capacity of the Auto Scaling group, the instances can enter standby as long as the desired capacity of the Auto Scaling group after the instances are placed into standby is equal to or greater than the minimum capacity of the group.

If you choose not to decrement the desired capacity of the Auto Scaling group, the Auto Scaling group launches new instances to replace the instances on standby.

For more information, see Temporarily removing instances from your Auto Scaling group in the Amazon EC2 Auto Scaling User Guide.

Examples:

Example: To move instances into standby mode


# This example puts the specified instance into standby mode.

resp = client.enter_standby({
  auto_scaling_group_name: "my-auto-scaling-group", 
  instance_ids: [
    "i-93633f9b", 
  ], 
  should_decrement_desired_capacity: true, 
})

resp.to_h outputs the following:
{
  activities: [
    {
      activity_id: "ffa056b4-6ed3-41ba-ae7c-249dfae6eba1", 
      auto_scaling_group_name: "my-auto-scaling-group", 
      cause: "At 2015-04-12T15:10:23Z instance i-93633f9b was moved to standby in response to a user request, shrinking the capacity from 2 to 1.", 
      description: "Moving EC2 instance to Standby: i-93633f9b", 
      details: "details", 
      progress: 50, 
      start_time: Time.parse("2015-04-12T15:10:23.640Z"), 
      status_code: "InProgress", 
    }, 
  ], 
}

Request syntax with placeholder values


resp = client.enter_standby({
  instance_ids: ["XmlStringMaxLen19"],
  auto_scaling_group_name: "ResourceName", # required
  should_decrement_desired_capacity: false, # required
})

Response structure


resp.activities #=> Array
resp.activities[0].activity_id #=> String
resp.activities[0].auto_scaling_group_name #=> String
resp.activities[0].description #=> String
resp.activities[0].cause #=> String
resp.activities[0].start_time #=> Time
resp.activities[0].end_time #=> Time
resp.activities[0].status_code #=> String, one of "PendingSpotBidPlacement", "WaitingForSpotInstanceRequestId", "WaitingForSpotInstanceId", "WaitingForInstanceId", "PreInService", "InProgress", "WaitingForELBConnectionDraining", "MidLifecycleAction", "WaitingForInstanceWarmup", "Successful", "Failed", "Cancelled"
resp.activities[0].status_message #=> String
resp.activities[0].progress #=> Integer
resp.activities[0].details #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :instance_ids (Array<String>) —

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

  • :auto_scaling_group_name (required, String) —

    The name of the Auto Scaling group.

  • :should_decrement_desired_capacity (required, Boolean) —

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

Returns:

See Also:



3774
3775
3776
3777
 
# File 'gems/aws-sdk-autoscaling/lib/aws-sdk-autoscaling/client.rb', line 3774

def enter_standby(params = {}, options = {})
  req = build_request(:enter_standby, params)
  req.send_request(options)
end

#execute_policy(params = {}) ⇒ Struct

Executes the specified policy. This can be useful for testing the design of your scaling policy.

Examples:

Example: To execute a scaling policy


# This example executes the specified policy.

resp = client.execute_policy({
  auto_scaling_group_name: "my-auto-scaling-group", 
  breach_threshold: 50.0, 
  metric_value: 59.0, 
  policy_name: "my-step-scale-out-policy", 
})

Request syntax with placeholder values


resp = client.execute_policy({
  auto_scaling_group_name: "ResourceName",
  policy_name: "ResourceName", # required
  honor_cooldown: false,
  metric_value: 1.0,
  breach_threshold: 1.0,
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :auto_scaling_group_name (String) —

    The name of the Auto Scaling group.

  • :policy_name (required, String) —

    The name or ARN of the policy.

  • :honor_cooldown (Boolean) —

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

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

  • :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.

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

  • :breach_threshold (Float) —

    The breach threshold for the alarm.

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

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



3847
3848
3849
3850
 
# File 'gems/aws-sdk-autoscaling/lib/aws-sdk-autoscaling/client.rb', line 3847

def execute_policy(params = {}, options = {})
  req = build_request(:execute_policy, params)
  req.send_request(options)
end

#exit_standby(params = {}) ⇒ Types::ExitStandbyAnswer

Moves the specified instances out of the standby state.

After you put the instances back in service, the desired capacity is incremented.

For more information, see Temporarily removing instances from your Auto Scaling group in the Amazon EC2 Auto Scaling User Guide.

Examples:

Example: To move instances out of standby mode


# This example moves the specified instance out of standby mode.

resp = client.exit_standby({
  auto_scaling_group_name: "my-auto-scaling-group", 
  instance_ids: [
    "i-93633f9b", 
  ], 
})

resp.to_h outputs the following:
{
  activities: [
    {
      activity_id: "142928e1-a2dc-453a-9b24-b85ad6735928", 
      auto_scaling_group_name: "my-auto-scaling-group", 
      cause: "At 2015-04-12T15:14:29Z instance i-93633f9b was moved out of standby in response to a user request, increasing the capacity from 1 to 2.", 
      description: "Moving EC2 instance out of Standby: i-93633f9b", 
      details: "details", 
      progress: 30, 
      start_time: Time.parse("2015-04-12T15:14:29.886Z"), 
      status_code: "PreInService", 
    }, 
  ], 
}

Request syntax with placeholder values


resp = client.exit_standby({
  instance_ids: ["XmlStringMaxLen19"],
  auto_scaling_group_name: "ResourceName", # required
})

Response structure


resp.activities #=> Array
resp.activities[0].activity_id #=> String
resp.activities[0].auto_scaling_group_name #=> String
resp.activities[0].description #=> String
resp.activities[0].cause #=> String
resp.activities[0].start_time #=> Time
resp.activities[0].end_time #=> Time
resp.activities[0].status_code #=> String, one of "PendingSpotBidPlacement", "WaitingForSpotInstanceRequestId", "WaitingForSpotInstanceId", "WaitingForInstanceId", "PreInService", "InProgress", "WaitingForELBConnectionDraining", "MidLifecycleAction", "WaitingForInstanceWarmup", "Successful", "Failed", "Cancelled"
resp.activities[0].status_message #=> String
resp.activities[0].progress #=> Integer
resp.activities[0].details #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :instance_ids (Array<String>) —

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

  • :auto_scaling_group_name (required, String) —

    The name of the Auto Scaling group.

Returns:

See Also:



3927
3928
3929
3930
 
# File 'gems/aws-sdk-autoscaling/lib/aws-sdk-autoscaling/client.rb', line 3927

def exit_standby(params = {}, options = {})
  req = build_request(:exit_standby, params)
  req.send_request(options)
end

#put_lifecycle_hook(params = {}) ⇒ Struct

Creates or updates a lifecycle hook for the specified Auto Scaling group.

A lifecycle hook tells Amazon EC2 Auto Scaling to perform an action on an instance when the instance launches (before it is put into service) or as the instance terminates (before it is fully terminated).

This step is a part of the procedure for adding a lifecycle hook to an Auto Scaling group:

  1. (Optional) Create a Lambda function and a rule that allows CloudWatch Events to invoke your Lambda function when Amazon EC2 Auto Scaling launches or terminates instances.

  2. (Optional) Create a notification target and an IAM role. The target can be either an Amazon SQS queue or an Amazon SNS topic. The role allows Amazon EC2 Auto Scaling to publish lifecycle notifications to the target.

  3. Create the lifecycle hook. Specify whether the hook is used when the instances launch or terminate.

  4. If you need more time, record the lifecycle action heartbeat to keep the instance in a pending state using the RecordLifecycleActionHeartbeat API call.

  5. If you finish before the timeout period ends, complete the lifecycle action using the CompleteLifecycleAction API call.

For more information, see Amazon EC2 Auto Scaling lifecycle hooks 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.

You can view the lifecycle hooks for an Auto Scaling group using the DescribeLifecycleHooks API call. If you are no longer using a lifecycle hook, you can delete it by calling the DeleteLifecycleHook API.

Examples:

Example: To create a lifecycle hook


# This example creates a lifecycle hook.

resp = client.put_lifecycle_hook({
  auto_scaling_group_name: "my-auto-scaling-group", 
  lifecycle_hook_name: "my-lifecycle-hook", 
  lifecycle_transition: "autoscaling:EC2_INSTANCE_LAUNCHING", 
  notification_target_arn: "arn:aws:sns:us-west-2:123456789012:my-sns-topic --role-arn", 
  role_arn: "arn:aws:iam::123456789012:role/my-auto-scaling-role", 
})

Request syntax with placeholder values


resp = client.put_lifecycle_hook({
  lifecycle_hook_name: "AsciiStringMaxLen255", # required
  auto_scaling_group_name: "ResourceName", # required
  lifecycle_transition: "LifecycleTransition",
  role_arn: "ResourceName",
  notification_target_arn: "NotificationTargetResourceName",
  notification_metadata: "XmlStringMaxLen1023",
  heartbeat_timeout: 1,
  default_result: "LifecycleActionResult",
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :lifecycle_hook_name (required, String) —

    The name of the lifecycle hook.

  • :auto_scaling_group_name (required, String) —

    The name of the Auto Scaling group.

  • :lifecycle_transition (String) —

    The instance state to which you want to attach the lifecycle hook. The valid values are:

    • autoscaling:EC2_INSTANCE_LAUNCHING

    • autoscaling:EC2_INSTANCE_TERMINATING

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

  • :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.

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

  • :notification_target_arn (String) —

    The ARN of the notification target that Amazon EC2 Auto Scaling uses to notify you when an instance is in the transition state for the lifecycle hook. This target can be either an SQS queue or an SNS topic.

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

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

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

  • :notification_metadata (String) —

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

  • :heartbeat_timeout (Integer) —

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

    If the lifecycle hook times out, Amazon EC2 Auto Scaling performs the action that you specified in the DefaultResult parameter. You can prevent the lifecycle hook from timing out by calling the RecordLifecycleActionHeartbeat API.

  • :default_result (String) —

    Defines the action the Auto Scaling group should take when the lifecycle hook timeout elapses or if an unexpected failure occurs. This parameter can be either CONTINUE or ABANDON. The default value is ABANDON.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



4069
4070
4071
4072
 
# File 'gems/aws-sdk-autoscaling/lib/aws-sdk-autoscaling/client.rb', line 4069

def put_lifecycle_hook(params = {}, options = {})
  req = build_request(:put_lifecycle_hook, params)
  req.send_request(options)
end

#put_notification_configuration(params = {}) ⇒ Struct

Configures an Auto Scaling group to send notifications when specified events take place. Subscribers to the specified topic can have 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 Amazon SNS notifications when your Auto Scaling group scales in the Amazon EC2 Auto Scaling User Guide.

If you exceed your maximum limit of SNS topics, which is 10 per Auto Scaling group, the call fails.

Examples:

Example: To add an Auto Scaling notification


# This example adds the specified notification to the specified Auto Scaling group.

resp = client.put_notification_configuration({
  auto_scaling_group_name: "my-auto-scaling-group", 
  notification_types: [
    "autoscaling:TEST_NOTIFICATION", 
  ], 
  topic_arn: "arn:aws:sns:us-west-2:123456789012:my-sns-topic", 
})

Request syntax with placeholder values


resp = client.put_notification_configuration({
  auto_scaling_group_name: "ResourceName", # required
  topic_arn: "ResourceName", # required
  notification_types: ["XmlStringMaxLen255"], # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :auto_scaling_group_name (required, String) —

    The name of the Auto Scaling group.

  • :topic_arn (required, String) —

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

  • :notification_types (required, Array<String>) —

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

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



4131
4132
4133
4134
 
# File 'gems/aws-sdk-autoscaling/lib/aws-sdk-autoscaling/client.rb', line 4131

def put_notification_configuration(params = {}, options = {})
  req = build_request(:put_notification_configuration, params)
  req.send_request(options)
end

#put_scaling_policy(params = {}) ⇒ Types::PolicyARNType

Creates or updates a scaling policy for an Auto Scaling group.

For more information about using scaling policies to scale your Auto Scaling group, see Target tracking scaling policies and Step and simple scaling policies in the Amazon EC2 Auto Scaling User Guide.

Examples:

Example: To add a scaling policy to an Auto Scaling group


# This example adds the specified policy to the specified Auto Scaling group.

resp = client.put_scaling_policy({
  auto_scaling_group_name: "my-auto-scaling-group", 
  policy_name: "alb1000-target-tracking-scaling-policy", 
  policy_type: "TargetTrackingScaling", 
  target_tracking_configuration: {
    predefined_metric_specification: {
      predefined_metric_type: "ALBRequestCountPerTarget", 
      resource_label: "app/EC2Co-EcsEl-1TKLTMITMM0EO/f37c06a68c1748aa/targetgroup/EC2Co-Defau-LDNM7Q3ZH1ZN/6d4ea56ca2d6a18d", 
    }, 
    target_value: 1000.0, 
  }, 
})

resp.to_h outputs the following:
{
  alarms: [
    {
      alarm_arn: "arn:aws:cloudwatch:us-west-2:123456789012:alarm:TargetTracking-my-asg-AlarmHigh-fc0e4183-23ac-497e-9992-691c9980c38e", 
      alarm_name: "TargetTracking-my-asg-AlarmHigh-fc0e4183-23ac-497e-9992-691c9980c38e", 
    }, 
    {
      alarm_arn: "arn:aws:cloudwatch:us-west-2:123456789012:alarm:TargetTracking-my-asg-AlarmLow-61a39305-ed0c-47af-bd9e-471a352ee1a2", 
      alarm_name: "TargetTracking-my-asg-AlarmLow-61a39305-ed0c-47af-bd9e-471a352ee1a2", 
    }, 
  ], 
  policy_arn: "arn:aws:autoscaling:us-west-2:123456789012:scalingPolicy:228f02c2-c665-4bfd-aaac-8b04080bea3c:autoScalingGroupName/my-auto-scaling-group:policyName/alb1000-target-tracking-scaling-policy", 
}

Request syntax with placeholder values


resp = client.put_scaling_policy({
  auto_scaling_group_name: "ResourceName", # required
  policy_name: "XmlStringMaxLen255", # required
  policy_type: "XmlStringMaxLen64",
  adjustment_type: "XmlStringMaxLen255",
  min_adjustment_step: 1,
  min_adjustment_magnitude: 1,
  scaling_adjustment: 1,
  cooldown: 1,
  metric_aggregation_type: "XmlStringMaxLen32",
  step_adjustments: [
    {
      metric_interval_lower_bound: 1.0,
      metric_interval_upper_bound: 1.0,
      scaling_adjustment: 1, # required
    },
  ],
  estimated_instance_warmup: 1,
  target_tracking_configuration: {
    predefined_metric_specification: {
      predefined_metric_type: "ASGAverageCPUUtilization", # required, accepts ASGAverageCPUUtilization, ASGAverageNetworkIn, ASGAverageNetworkOut, ALBRequestCountPerTarget
      resource_label: "XmlStringMaxLen1023",
    },
    customized_metric_specification: {
      metric_name: "MetricName", # required
      namespace: "MetricNamespace", # required
      dimensions: [
        {
          name: "MetricDimensionName", # required
          value: "MetricDimensionValue", # required
        },
      ],
      statistic: "Average", # required, accepts Average, Minimum, Maximum, SampleCount, Sum
      unit: "MetricUnit",
    },
    target_value: 1.0, # required
    disable_scale_in: false,
  },
  enabled: false,
})

Response structure


resp.policy_arn #=> String
resp.alarms #=> Array
resp.alarms[0].alarm_name #=> String
resp.alarms[0].alarm_arn #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :auto_scaling_group_name (required, String) —

    The name of the Auto Scaling group.

  • :policy_name (required, String) —

    The name of the policy.

  • :policy_type (String) —

    One of the following policy types:

    • TargetTrackingScaling

    • StepScaling

    • SimpleScaling (default)

  • :adjustment_type (String) —

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

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

  • :min_adjustment_step (Integer) —

    Available for backward compatibility. Use MinAdjustmentMagnitude instead.

  • :min_adjustment_magnitude (Integer) —

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

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

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

  • :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. For exact capacity, you must specify a positive value.

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

  • :cooldown (Integer) —

    The duration of the policy's cooldown period, in seconds. When a cooldown period is specified here, it overrides the default cooldown period defined for the Auto Scaling group.

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

  • :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.

    Valid only if the policy type is StepScaling.

  • :step_adjustments (Array<Types::StepAdjustment>) —

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

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

  • :estimated_instance_warmup (Integer) —

    The estimated time, in seconds, until a newly launched instance can contribute to the CloudWatch metrics. If not provided, the default is to use the value from the default cooldown period for the Auto Scaling group.

    Valid only if the policy type is TargetTrackingScaling or StepScaling.

  • :target_tracking_configuration (Types::TargetTrackingConfiguration) —

    A target tracking scaling policy. Includes support for predefined or customized metrics.

    The following predefined metrics are available:

    • ASGAverageCPUUtilization

    • ASGAverageNetworkIn

    • ASGAverageNetworkOut

    • ALBRequestCountPerTarget

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

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

    Required if the policy type is TargetTrackingScaling.

  • :enabled (Boolean) —

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

Returns:

See Also:



4377
4378
4379
4380
 
# File 'gems/aws-sdk-autoscaling/lib/aws-sdk-autoscaling/client.rb', line 4377

def put_scaling_policy(params = {}, options = {})
  req = build_request(:put_scaling_policy, params)
  req.send_request(options)
end

#put_scheduled_update_group_action(params = {}) ⇒ Struct

Creates or updates a scheduled scaling action for an Auto Scaling group. If you leave a parameter unspecified when updating a scheduled scaling action, the corresponding value remains unchanged.

For more information, see Scheduled scaling in the Amazon EC2 Auto Scaling User Guide.

Examples:

Example: To add a scheduled action to an Auto Scaling group


# This example adds the specified scheduled action to the specified Auto Scaling group.

resp = client.put_scheduled_update_group_action({
  auto_scaling_group_name: "my-auto-scaling-group", 
  desired_capacity: 4, 
  end_time: Time.parse("2014-05-12T08:00:00Z"), 
  max_size: 6, 
  min_size: 2, 
  scheduled_action_name: "my-scheduled-action", 
  start_time: Time.parse("2014-05-12T08:00:00Z"), 
})

Request syntax with placeholder values


resp = client.put_scheduled_update_group_action({
  auto_scaling_group_name: "ResourceName", # required
  scheduled_action_name: "XmlStringMaxLen255", # required
  time: Time.now,
  start_time: Time.now,
  end_time: Time.now,
  recurrence: "XmlStringMaxLen255",
  min_size: 1,
  max_size: 1,
  desired_capacity: 1,
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :auto_scaling_group_name (required, String) —

    The name of the Auto Scaling group.

  • :scheduled_action_name (required, String) —

    The name of this scaling action.

  • :time (Time, DateTime, Date, Integer, String) —

    This parameter is no longer used.

  • :start_time (Time, DateTime, Date, Integer, String) —

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

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

    If you try to schedule your action in the past, Amazon EC2 Auto Scaling returns an error message.

  • :end_time (Time, DateTime, Date, Integer, String) —

    The date and time for the recurring schedule to end. Amazon EC2 Auto Scaling does not perform the action after this time.

  • :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.

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

  • :min_size (Integer) —

    The minimum size of the Auto Scaling group.

  • :max_size (Integer) —

    The maximum size of the Auto Scaling group.

  • :desired_capacity (Integer) —

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

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



4479
4480
4481
4482
 
# File 'gems/aws-sdk-autoscaling/lib/aws-sdk-autoscaling/client.rb', line 4479

def put_scheduled_update_group_action(params = {}, options = {})
  req = build_request(:put_scheduled_update_group_action, params)
  req.send_request(options)
end

#record_lifecycle_action_heartbeat(params = {}) ⇒ Struct

Records a heartbeat for the lifecycle action associated with the specified token or instance. This extends the timeout by the length of time defined using the PutLifecycleHook API call.

This step is a part of the procedure for adding a lifecycle hook to an Auto Scaling group:

  1. (Optional) Create a Lambda function and a rule that allows CloudWatch Events to invoke your Lambda function when Amazon EC2 Auto Scaling launches or terminates instances.

  2. (Optional) Create a notification target and an IAM role. The target can be either an Amazon SQS queue or an Amazon SNS topic. The role allows Amazon EC2 Auto Scaling to publish lifecycle notifications to the target.

  3. Create the lifecycle hook. Specify whether the hook is used when the instances launch or terminate.

  4. If you need more time, record the lifecycle action heartbeat to 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 in the Amazon EC2 Auto Scaling User Guide.

Examples:

Example: To record a lifecycle action heartbeat


# This example records a lifecycle action heartbeat to keep the instance in a pending state.

resp = client.record_lifecycle_action_heartbeat({
  auto_scaling_group_name: "my-auto-scaling-group", 
  lifecycle_action_token: "bcd2f1b8-9a78-44d3-8a7a-4dd07d7cf635", 
  lifecycle_hook_name: "my-lifecycle-hook", 
})

Request syntax with placeholder values


resp = client.record_lifecycle_action_heartbeat({
  lifecycle_hook_name: "AsciiStringMaxLen255", # required
  auto_scaling_group_name: "ResourceName", # required
  lifecycle_action_token: "LifecycleActionToken",
  instance_id: "XmlStringMaxLen19",
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :lifecycle_hook_name (required, String) —

    The name of the lifecycle hook.

  • :auto_scaling_group_name (required, String) —

    The name of the Auto Scaling group.

  • :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.

  • :instance_id (String) —

    The ID of the instance.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



4557
4558
4559
4560
 
# File 'gems/aws-sdk-autoscaling/lib/aws-sdk-autoscaling/client.rb', line 4557

def record_lifecycle_action_heartbeat(params = {}, options = {})
  req = build_request(:record_lifecycle_action_heartbeat, params)
  req.send_request(options)
end

#resume_processes(params = {}) ⇒ Struct

Resumes the specified suspended auto scaling processes, or all suspended process, for the specified Auto Scaling group.

For more information, see Suspending and resuming scaling processes in the Amazon EC2 Auto Scaling User Guide.

Examples:

Example: To resume Auto Scaling processes


# This example resumes the specified suspended scaling process for the specified Auto Scaling group.

resp = client.resume_processes({
  auto_scaling_group_name: "my-auto-scaling-group", 
  scaling_processes: [
    "AlarmNotification", 
  ], 
})

Request syntax with placeholder values


resp = client.resume_processes({
  auto_scaling_group_name: "ResourceName", # required
  scaling_processes: ["XmlStringMaxLen255"],
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :auto_scaling_group_name (required, String) —

    The name of the Auto Scaling group.

  • :scaling_processes (Array<String>) —

    One or more of the following processes:

    • Launch

    • Terminate

    • AddToLoadBalancer

    • AlarmNotification

    • AZRebalance

    • HealthCheck

    • InstanceRefresh

    • ReplaceUnhealthy

    • ScheduledActions

    If you omit this parameter, all processes are specified.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



4623
4624
4625
4626
 
# File 'gems/aws-sdk-autoscaling/lib/aws-sdk-autoscaling/client.rb', line 4623

def resume_processes(params = {}, options = {})
  req = build_request(:resume_processes, params)
  req.send_request(options)
end

#set_desired_capacity(params = {}) ⇒ Struct

Sets the size of the specified Auto Scaling group.

If a scale-in activity occurs as a result of a new DesiredCapacity value that is lower than the current size of the group, the Auto Scaling group uses its termination policy to determine which instances to terminate.

For more information, see Manual scaling in the Amazon EC2 Auto Scaling User Guide.

Examples:

Example: To set the desired capacity for an Auto Scaling group


# This example sets the desired capacity for the specified Auto Scaling group.

resp = client.set_desired_capacity({
  auto_scaling_group_name: "my-auto-scaling-group", 
  desired_capacity: 2, 
  honor_cooldown: true, 
})

Request syntax with placeholder values


resp = client.set_desired_capacity({
  auto_scaling_group_name: "ResourceName", # required
  desired_capacity: 1, # required
  honor_cooldown: false,
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :auto_scaling_group_name (required, String) —

    The name of the Auto Scaling group.

  • :desired_capacity (required, Integer) —

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

  • :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.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



4682
4683
4684
4685
 
# File 'gems/aws-sdk-autoscaling/lib/aws-sdk-autoscaling/client.rb', line 4682

def set_desired_capacity(params = {}, options = {})
  req = build_request(:set_desired_capacity, params)
  req.send_request(options)
end

#set_instance_health(params = {}) ⇒ Struct

Sets the health status of the specified instance.

For more information, see Health checks for Auto Scaling instances in the Amazon EC2 Auto Scaling User Guide.

Examples:

Example: To set the health status of an instance


# This example sets the health status of the specified instance to Unhealthy.

resp = client.set_instance_health({
  health_status: "Unhealthy", 
  instance_id: "i-93633f9b", 
})

Request syntax with placeholder values


resp = client.set_instance_health({
  instance_id: "XmlStringMaxLen19", # required
  health_status: "XmlStringMaxLen32", # required
  should_respect_grace_period: false,
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :instance_id (required, String) —

    The ID of the instance.

  • :health_status (required, String) —

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

  • :should_respect_grace_period (Boolean) —

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

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

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



4743
4744
4745
4746
 
# File 'gems/aws-sdk-autoscaling/lib/aws-sdk-autoscaling/client.rb', line 4743

def set_instance_health(params = {}, options = {})
  req = build_request(:set_instance_health, params)
  req.send_request(options)
end

#set_instance_protection(params = {}) ⇒ Struct

Updates the instance protection settings of the specified instances.

For more information about preventing instances that are part of an Auto Scaling group from terminating on scale in, see Instance scale-in protection in the Amazon EC2 Auto Scaling User Guide.

If you exceed your maximum limit of instance IDs, which is 50 per Auto Scaling group, the call fails.

Examples:

Example: To enable instance protection for an instance


# This example enables instance protection for the specified instance.

resp = client.set_instance_protection({
  auto_scaling_group_name: "my-auto-scaling-group", 
  instance_ids: [
    "i-93633f9b", 
  ], 
  protected_from_scale_in: true, 
})

Example: To disable instance protection for an instance


# This example disables instance protection for the specified instance.

resp = client.set_instance_protection({
  auto_scaling_group_name: "my-auto-scaling-group", 
  instance_ids: [
    "i-93633f9b", 
  ], 
  protected_from_scale_in: false, 
})

Request syntax with placeholder values


resp = client.set_instance_protection({
  instance_ids: ["XmlStringMaxLen19"], # required
  auto_scaling_group_name: "ResourceName", # required
  protected_from_scale_in: false, # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :instance_ids (required, Array<String>) —

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

  • :auto_scaling_group_name (required, String) —

    The name of the Auto Scaling group.

  • :protected_from_scale_in (required, Boolean) —

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

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



4810
4811
4812
4813
 
# File 'gems/aws-sdk-autoscaling/lib/aws-sdk-autoscaling/client.rb', line 4810

def set_instance_protection(params = {}, options = {})
  req = build_request(:set_instance_protection, params)
  req.send_request(options)
end

#start_instance_refresh(params = {}) ⇒ Types::StartInstanceRefreshAnswer

Starts a new instance refresh operation, which triggers a rolling replacement of all previously launched instances in the Auto Scaling group with a new group of instances.

If successful, this call creates a new instance refresh request with a unique ID that you can use to track its progress. To query its status, call the DescribeInstanceRefreshes API. To describe the instance refreshes that have already run, call the DescribeInstanceRefreshes API. To cancel an instance refresh operation in progress, use the CancelInstanceRefresh API.

For more information, see Replacing Auto Scaling Instances Based on an Instance Refresh.

Examples:

Example: To start an instance refresh


# This example starts an instance refresh for the specified Auto Scaling group.

resp = client.start_instance_refresh({
  auto_scaling_group_name: "my-auto-scaling-group", 
  preferences: {
    instance_warmup: 400, 
    min_healthy_percentage: 50, 
  }, 
})

resp.to_h outputs the following:
{
  instance_refresh_id: "08b91cf7-8fa6-48af-b6a6-d227f40f1b9b", 
}

Request syntax with placeholder values


resp = client.start_instance_refresh({
  auto_scaling_group_name: "XmlStringMaxLen255", # required
  strategy: "Rolling", # accepts Rolling
  preferences: {
    min_healthy_percentage: 1,
    instance_warmup: 1,
  },
})

Response structure


resp.instance_refresh_id #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :auto_scaling_group_name (required, String) —

    The name of the Auto Scaling group.

  • :strategy (String) —

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

    A rolling update is an update that is applied to all instances in an Auto Scaling group until all instances have been updated. A rolling update can fail due to failed health checks or if instances are on standby or are protected from scale in. If the rolling update process fails, any instances that were already replaced are not rolled back to their previous configuration.

  • :preferences (Types::RefreshPreferences) —

    Set of preferences associated with the instance refresh request.

    If not provided, the default values are used. For MinHealthyPercentage, the default value is 90. For InstanceWarmup, the default is to use the value specified for the health check grace period for the Auto Scaling group.

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

Returns:

See Also:



4903
4904
4905
4906
 
# File 'gems/aws-sdk-autoscaling/lib/aws-sdk-autoscaling/client.rb', line 4903

def start_instance_refresh(params = {}, options = {})
  req = build_request(:start_instance_refresh, params)
  req.send_request(options)
end

#suspend_processes(params = {}) ⇒ Struct

Suspends the specified auto scaling processes, or all processes, for the specified Auto Scaling group.

If you suspend either the Launch or Terminate process types, it can prevent other process types from functioning properly. For more information, see Suspending and resuming scaling processes in the Amazon EC2 Auto Scaling User Guide.

To resume processes that have been suspended, call the ResumeProcesses API.

Examples:

Example: To suspend Auto Scaling processes


# This example suspends the specified scaling process for the specified Auto Scaling group.

resp = client.suspend_processes({
  auto_scaling_group_name: "my-auto-scaling-group", 
  scaling_processes: [
    "AlarmNotification", 
  ], 
})

Request syntax with placeholder values


resp = client.suspend_processes({
  auto_scaling_group_name: "ResourceName", # required
  scaling_processes: ["XmlStringMaxLen255"],
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :auto_scaling_group_name (required, String) —

    The name of the Auto Scaling group.

  • :scaling_processes (Array<String>) —

    One or more of the following processes:

    • Launch

    • Terminate

    • AddToLoadBalancer

    • AlarmNotification

    • AZRebalance

    • HealthCheck

    • InstanceRefresh

    • ReplaceUnhealthy

    • ScheduledActions

    If you omit this parameter, all processes are specified.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



4974
4975
4976
4977
 
# File 'gems/aws-sdk-autoscaling/lib/aws-sdk-autoscaling/client.rb', line 4974

def suspend_processes(params = {}, options = {})
  req = build_request(:suspend_processes, params)
  req.send_request(options)
end

#terminate_instance_in_auto_scaling_group(params = {}) ⇒ Types::ActivityType

Terminates the specified instance and optionally adjusts the desired group size.

This call simply makes a termination request. The instance is not terminated immediately. When an instance is terminated, the instance status changes to terminated. You can't connect to or start an instance after you've terminated it.

If you do not specify the option to decrement the desired capacity, Amazon EC2 Auto Scaling launches instances to replace the ones that are terminated.

By default, Amazon EC2 Auto Scaling balances instances across all Availability Zones. If you decrement the desired capacity, your Auto Scaling group can become unbalanced between Availability Zones. Amazon EC2 Auto Scaling tries to rebalance the group, and rebalancing might terminate instances in other zones. For more information, see Rebalancing activities in the Amazon EC2 Auto Scaling User Guide.

Examples:

Example: To terminate an instance in an Auto Scaling group


# This example terminates the specified instance from the specified Auto Scaling group without updating the size of the
# group. Auto Scaling launches a replacement instance after the specified instance terminates.

resp = client.terminate_instance_in_auto_scaling_group({
  instance_id: "i-93633f9b", 
  should_decrement_desired_capacity: false, 
})

Request syntax with placeholder values


resp = client.terminate_instance_in_auto_scaling_group({
  instance_id: "XmlStringMaxLen19", # required
  should_decrement_desired_capacity: false, # required
})

Response structure


resp.activity.activity_id #=> String
resp.activity.auto_scaling_group_name #=> String
resp.activity.description #=> String
resp.activity.cause #=> String
resp.activity.start_time #=> Time
resp.activity.end_time #=> Time
resp.activity.status_code #=> String, one of "PendingSpotBidPlacement", "WaitingForSpotInstanceRequestId", "WaitingForSpotInstanceId", "WaitingForInstanceId", "PreInService", "InProgress", "WaitingForELBConnectionDraining", "MidLifecycleAction", "WaitingForInstanceWarmup", "Successful", "Failed", "Cancelled"
resp.activity.status_message #=> String
resp.activity.progress #=> Integer
resp.activity.details #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :instance_id (required, String) —

    The ID of the instance.

  • :should_decrement_desired_capacity (required, Boolean) —

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

Returns:

See Also:



5049
5050
5051
5052
 
# File 'gems/aws-sdk-autoscaling/lib/aws-sdk-autoscaling/client.rb', line 5049

def terminate_instance_in_auto_scaling_group(params = {}, options = {})
  req = build_request(:terminate_instance_in_auto_scaling_group, params)
  req.send_request(options)
end

#update_auto_scaling_group(params = {}) ⇒ Struct

Updates the configuration for the specified Auto Scaling group.

To update an Auto Scaling group, specify the name of the group and the parameter that you want to change. Any parameters that you don't specify are not changed by this update request. The new settings take effect on any scaling activities after this call returns.

If you associate a new launch configuration or template with an Auto Scaling group, all new instances will get the updated configuration. Existing instances continue to run with the configuration that they were originally launched with. When you update a group to specify a mixed instances policy instead of a launch configuration or template, existing instances may be replaced to match the new purchasing options that you specified in the policy. For example, if the group currently has 100% On-Demand capacity and the policy specifies 50% Spot capacity, this means that half of your instances will be gradually terminated and relaunched as Spot Instances. When replacing instances, Amazon EC2 Auto Scaling launches new instances before terminating the old ones, so that updating your group does not compromise the performance or availability of your application.

Note the following about changing DesiredCapacity, MaxSize, or MinSize:

  • If a scale-in activity occurs as a result of a new DesiredCapacity value that is lower than the current size of the group, the Auto Scaling group uses its termination policy to determine which instances to terminate.

  • If you specify a new value for MinSize without specifying a value for DesiredCapacity, and the new MinSize is larger than the current size of the group, this sets the group's DesiredCapacity to the new MinSize value.

  • If you specify a new value for MaxSize without specifying a value for DesiredCapacity, and the new MaxSize is smaller than the current size of the group, this sets the group's DesiredCapacity to the new MaxSize value.

To see which parameters have been set, call the DescribeAutoScalingGroups API. To view the scaling policies for an Auto Scaling group, call the DescribePolicies API. If the group has scaling policies, you can update them by calling the PutScalingPolicy API.

Examples:

Example: To update the launch configuration


# This example updates the launch configuration of the specified Auto Scaling group.

resp = client.update_auto_scaling_group({
  auto_scaling_group_name: "my-auto-scaling-group", 
  launch_configuration_name: "new-launch-config", 
})

Example: To update the minimum and maximum size


# This example updates the minimum size and maximum size of the specified Auto Scaling group.

resp = client.update_auto_scaling_group({
  auto_scaling_group_name: "my-auto-scaling-group", 
  max_size: 3, 
  min_size: 1, 
})

Example: To enable instance protection


# This example enables instance protection for the specified Auto Scaling group.

resp = client.update_auto_scaling_group({
  auto_scaling_group_name: "my-auto-scaling-group", 
  new_instances_protected_from_scale_in: true, 
})

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",
  },
  mixed_instances_policy: {
    launch_template: {
      launch_template_specification: {
        launch_template_id: "XmlStringMaxLen255",
        launch_template_name: "LaunchTemplateName",
        version: "XmlStringMaxLen255",
      },
      overrides: [
        {
          instance_type: "XmlStringMaxLen255",
          weighted_capacity: "XmlStringMaxLen32",
          launch_template_specification: {
            launch_template_id: "XmlStringMaxLen255",
            launch_template_name: "LaunchTemplateName",
            version: "XmlStringMaxLen255",
          },
        },
      ],
    },
    instances_distribution: {
      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: "MixedInstanceSpotPrice",
    },
  },
  min_size: 1,
  max_size: 1,
  desired_capacity: 1,
  default_cooldown: 1,
  availability_zones: ["XmlStringMaxLen255"],
  health_check_type: "XmlStringMaxLen32",
  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",
  max_instance_lifetime: 1,
  capacity_rebalance: false,
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :auto_scaling_group_name (required, String) —

    The name of the Auto Scaling group.

  • :launch_configuration_name (String) —

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

  • :launch_template (Types::LaunchTemplateSpecification) —

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

  • :mixed_instances_policy (Types::MixedInstancesPolicy) —

    An embedded object that specifies a mixed instances policy. When you make changes to an existing policy, all optional parameters are left unchanged if not specified. For more information, see Auto Scaling groups with multiple instance types and purchase options in the Amazon EC2 Auto Scaling User Guide.

  • :min_size (Integer) —

    The minimum size of the Auto Scaling group.

  • :max_size (Integer) —

    The maximum size of the Auto Scaling group.

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

  • :desired_capacity (Integer) —

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

  • :default_cooldown (Integer) —

    The amount of time, in seconds, after a scaling activity completes before another scaling activity can start. The default value is 300. This setting applies when using simple scaling policies, but not when using other scaling policies or scheduled scaling. For more information, see Scaling cooldowns for Amazon EC2 Auto Scaling in the Amazon EC2 Auto Scaling User Guide.

  • :availability_zones (Array<String>) —

    One or more Availability Zones for the group.

  • :health_check_type (String) —

    The service to use for the health checks. The valid values are EC2 and ELB. If you configure an Auto Scaling group to use ELB health checks, it considers the instance unhealthy if it fails either the EC2 status checks or the load balancer health checks.

  • :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. The default value is 0. For more information, see Health check grace period in the Amazon EC2 Auto Scaling User Guide.

    Conditional: Required if you are adding an ELB health check.

  • :placement_group (String) —

    The name of an existing placement group into which to launch your instances, if any. A placement group is a logical grouping of instances within a single Availability Zone. You cannot specify multiple Availability Zones and a placement group. For more information, see Placement Groups in the Amazon EC2 User Guide for Linux Instances.

  • :vpc_zone_identifier (String) —

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

  • :termination_policies (Array<String>) —

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

  • :new_instances_protected_from_scale_in (Boolean) —

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

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

  • :max_instance_lifetime (Integer) —

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

  • :capacity_rebalance (Boolean) —

    Enables or disables Capacity Rebalancing. For more information, see Amazon EC2 Auto Scaling Capacity Rebalancing in the Amazon EC2 Auto Scaling User Guide.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



5339
5340
5341
5342
 
# File 'gems/aws-sdk-autoscaling/lib/aws-sdk-autoscaling/client.rb', line 5339

def update_auto_scaling_group(params = {}, options = {})
  req = build_request(:update_auto_scaling_group, params)
  req.send_request(options)
end

#wait_until(waiter_name, params = {}, options = {}) {|w.waiter| ... } ⇒ Boolean

Polls an API operation until a resource enters a desired state.

Basic Usage

A waiter will call an API operation until:

  • It is successful
  • It enters a terminal state
  • It makes the maximum number of attempts

In between attempts, the waiter will sleep.

# polls in a loop, sleeping between attempts
client.wait_until(waiter_name, params)

Configuration

You can configure the maximum number of polling attempts, and the delay (in seconds) between each polling attempt. You can pass configuration as the final arguments hash.

# poll for ~25 seconds
client.wait_until(waiter_name, params, {
  max_attempts: 5,
  delay: 5,
})

Callbacks

You can be notified before each polling attempt and before each delay. If you throw :success or :failure from these callbacks, it will terminate the waiter.

started_at = Time.now
client.wait_until(waiter_name, params, {

  # disable max attempts
  max_attempts: nil,

  # poll for 1 hour, instead of a number of attempts
  before_wait: -> (attempts, response) do
    throw :failure if Time.now - started_at > 3600
  end
})

Handling Errors

When a waiter is unsuccessful, it will raise an error. All of the failure errors extend from Waiters::Errors::WaiterFailed.

begin
  client.wait_until(...)
rescue Aws::Waiters::Errors::WaiterFailed
  # resource did not enter the desired state in time
end

Valid Waiters

The following table lists the valid waiter names, the operations they call, and the default :delay and :max_attempts values.

waiter_name params :delay :max_attempts
group_exists #describe_auto_scaling_groups 5 10
group_in_service #describe_auto_scaling_groups 15 40
group_not_exists #describe_auto_scaling_groups 15 40

Parameters:

  • waiter_name (Symbol)
  • params (Hash) (defaults to: {}) —

    ({})

  • options (Hash) (defaults to: {}) —

    ({})

Options Hash (options):

  • :max_attempts (Integer)
  • :delay (Integer)
  • :before_attempt (Proc)
  • :before_wait (Proc)

Yields:

  • (w.waiter)

Returns:

  • (Boolean) —

    Returns true if the waiter was successful.

Raises:

  • (Errors::FailureStateError) —

    Raised when the waiter terminates because the waiter has entered a state that it will not transition out of, preventing success.

  • (Errors::TooManyAttemptsError) —

    Raised when the configured maximum number of attempts have been made, and the waiter is not yet successful.

  • (Errors::UnexpectedError) —

    Raised when an error is encounted while polling for a resource that is not expected.

  • (Errors::NoSuchWaiterError) —

    Raised when you request to wait for an unknown state.



5451
5452
5453
5454
5455
 
# File 'gems/aws-sdk-autoscaling/lib/aws-sdk-autoscaling/client.rb', line 5451

def wait_until(waiter_name, params = {}, options = {})
  w = waiter(waiter_name, options)
  yield(w.waiter) if block_given? # deprecated
  w.wait(params)
end