Class: AWS::AutoScaling::Client

Inherits:
Core::Client show all
Extended by:
Core::QueryClient
Defined in:
lib/aws/auto_scaling/client.rb

Overview

Client class for Auto Scaling.

Constant Summary collapse

API_VERSION = 
'2011-01-01'

Instance Attribute Summary

Attributes inherited from Core::Client

#config, #http_read_timeout

Instance Method Summary collapse

Methods inherited from Core::Client

#initialize, #log_warning, #operations, #with_http_handler, #with_options

Constructor Details

This class inherits a constructor from AWS::Core::Client

Instance Method Details

#create_auto_scaling_group(options = {}) ⇒ Core::Response

Calls the CreateAutoScalingGroup API operation.

Parameters:

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

    • :auto_scaling_group_name - required - (String)

    • :launch_configuration_name - required - (String)

    • :min_size - required - (Integer)

    • :max_size - required - (Integer)

    • :desired_capacity - (Integer)

    • :default_cooldown - (Integer)

    • :availability_zones - required - (Array<String>)

    • :load_balancer_names - (Array<String>)

    • :health_check_type - (String)

    • :health_check_grace_period - (Integer)

    • :placement_group - (String)

    • :vpc_zone_identifier - (String)

    • :tags - (Array<Hash>)

      • :resource_id - (String)

      • :resource_type - (String)

      • :key - required - (String)

      • :value - (String)

      • :propagate_at_launch - (Boolean)

Returns:



64
 
# File 'lib/aws/auto_scaling/client.rb', line 64

define_client_method :create_auto_scaling_group, 'CreateAutoScalingGroup'

#create_launch_configuration(options = {}) ⇒ Core::Response

Calls the CreateLaunchConfiguration API operation.

Parameters:

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

    • :launch_configuration_name - required - (String)

    • :image_id - required - (String)

    • :key_name - (String)

    • :security_groups - (Array<String>)

    • :user_data - (String)

    • :instance_type - required - (String)

    • :kernel_id - (String)

    • :ramdisk_id - (String)

    • :block_device_mappings - (Array<Hash>)

      • :virtual_name - (String)

      • :device_name - required - (String)

      • :ebs - (Hash)

        • :snapshot_id - (String)

        • :volume_size - (Integer)

    • :instance_monitoring - (Hash)

      • :enabled - (Boolean)

    • :spot_price - (String)

    • :iam_instance_profile - (String)

Returns:



88
 
# File 'lib/aws/auto_scaling/client.rb', line 88

define_client_method :create_launch_configuration, 'CreateLaunchConfiguration'

#create_or_update_tags(options = {}) ⇒ Core::Response

Calls the CreateOrUpdateTags API operation.

Parameters:

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

    • :tags - required - (Array<Hash>)

      • :resource_id - (String)

      • :resource_type - (String)

      • :key - required - (String)

      • :value - (String)

      • :propagate_at_launch - (Boolean)

Returns:



100
 
# File 'lib/aws/auto_scaling/client.rb', line 100

define_client_method :create_or_update_tags, 'CreateOrUpdateTags'

#delete_auto_scaling_group(options = {}) ⇒ Core::Response

Calls the DeleteAutoScalingGroup API operation.

Parameters:

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

    • :auto_scaling_group_name - required - (String)

    • :force_delete - (Boolean)

Returns:



108
 
# File 'lib/aws/auto_scaling/client.rb', line 108

define_client_method :delete_auto_scaling_group, 'DeleteAutoScalingGroup'

#delete_launch_configuration(options = {}) ⇒ Core::Response

Calls the DeleteLaunchConfiguration API operation.

Parameters:

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

    • :launch_configuration_name - required - (String)

Returns:



115
 
# File 'lib/aws/auto_scaling/client.rb', line 115

define_client_method :delete_launch_configuration, 'DeleteLaunchConfiguration'

#delete_notification_configuration(options = {}) ⇒ Core::Response

Calls the DeleteNotificationConfiguration API operation.

Parameters:

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

    • :auto_scaling_group_name - required - (String)

    • :topic_arn - required - (String)

Returns:



123
 
# File 'lib/aws/auto_scaling/client.rb', line 123

define_client_method :delete_notification_configuration, 'DeleteNotificationConfiguration'

#delete_policy(options = {}) ⇒ Core::Response

Calls the DeletePolicy API operation.

Parameters:

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

    • :auto_scaling_group_name - (String)

    • :policy_name - required - (String)

Returns:



131
 
# File 'lib/aws/auto_scaling/client.rb', line 131

define_client_method :delete_policy, 'DeletePolicy'

#delete_scheduled_action(options = {}) ⇒ Core::Response

Calls the DeleteScheduledAction API operation.

Parameters:

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

    • :auto_scaling_group_name - (String)

    • :scheduled_action_name - required - (String)

Returns:



139
 
# File 'lib/aws/auto_scaling/client.rb', line 139

define_client_method :delete_scheduled_action, 'DeleteScheduledAction'

#delete_tags(options = {}) ⇒ Core::Response

Calls the DeleteTags API operation.

Parameters:

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

    • :tags - required - (Array<Hash>)

      • :resource_id - (String)

      • :resource_type - (String)

      • :key - required - (String)

      • :value - (String)

      • :propagate_at_launch - (Boolean)

Returns:



151
 
# File 'lib/aws/auto_scaling/client.rb', line 151

define_client_method :delete_tags, 'DeleteTags'

#describe_adjustment_types(options = {}) ⇒ Core::Response

Calls the DescribeAdjustmentTypes API operation.

Parameters:

  • options (Hash) (defaults to: {})

Returns:

  • (Core::Response) —

    The #data method of the response object returns a hash with the following structure:

    • :adjustment_types - (Array<Hash>)

      • :adjustment_type - (String)



161
 
# File 'lib/aws/auto_scaling/client.rb', line 161

define_client_method :describe_adjustment_types, 'DescribeAdjustmentTypes'

#describe_auto_scaling_groups(options = {}) ⇒ Core::Response

Calls the DescribeAutoScalingGroups API operation.

Parameters:

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

    • :auto_scaling_group_names - (Array<String>)

    • :next_token - (String)

    • :max_records - (Integer)

Returns:

  • (Core::Response) —

    The #data method of the response object returns a hash with the following structure:

    • :auto_scaling_groups - (Array<Hash>)

      • :auto_scaling_group_name - (String)

      • :auto_scaling_group_arn - (String)

      • :launch_configuration_name - (String)

      • :min_size - (Integer)

      • :max_size - (Integer)

      • :desired_capacity - (Integer)

      • :default_cooldown - (Integer)

      • :availability_zones - (Array<String>)

      • :load_balancer_names - (Array<String>)

      • :health_check_type - (String)

      • :health_check_grace_period - (Integer)

      • :instances - (Array<Hash>)

        • :instance_id - (String)

        • :availability_zone - (String)

        • :lifecycle_state - (String)

        • :health_status - (String)

        • :launch_configuration_name - (String)

      • :created_time - (Time)

      • :suspended_processes - (Array<Hash>)

        • :process_name - (String)

        • :suspension_reason - (String)

      • :placement_group - (String)

      • :vpc_zone_identifier - (String)

      • :enabled_metrics - (Array<Hash>)

        • :metric - (String)

        • :granularity - (String)

      • :status - (String)

      • :tags - (Array<Hash>)

        • :resource_id - (String)

        • :resource_type - (String)

        • :key - (String)

        • :value - (String)

        • :propagate_at_launch - (Boolean)

    • :next_token - (String)



207
 
# File 'lib/aws/auto_scaling/client.rb', line 207

define_client_method :describe_auto_scaling_groups, 'DescribeAutoScalingGroups'

#describe_auto_scaling_instances(options = {}) ⇒ Core::Response

Calls the DescribeAutoScalingInstances API operation.

Parameters:

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

    • :instance_ids - (Array<String>)

    • :max_records - (Integer)

    • :next_token - (String)

Returns:

  • (Core::Response) —

    The #data method of the response object returns a hash with the following structure:

    • :auto_scaling_instances - (Array<Hash>)

      • :instance_id - (String)

      • :auto_scaling_group_name - (String)

      • :availability_zone - (String)

      • :lifecycle_state - (String)

      • :health_status - (String)

      • :launch_configuration_name - (String)

    • :next_token - (String)



226
 
# File 'lib/aws/auto_scaling/client.rb', line 226

define_client_method :describe_auto_scaling_instances, 'DescribeAutoScalingInstances'

#describe_auto_scaling_notification_types(options = {}) ⇒ Core::Response

Calls the DescribeAutoScalingNotificationTypes API operation.

Parameters:

  • options (Hash) (defaults to: {})

Returns:

  • (Core::Response) —

    The #data method of the response object returns a hash with the following structure:

    • :auto_scaling_notification_types - (Array<String>)



235
 
# File 'lib/aws/auto_scaling/client.rb', line 235

define_client_method :describe_auto_scaling_notification_types, 'DescribeAutoScalingNotificationTypes'

#describe_launch_configurations(options = {}) ⇒ Core::Response

Calls the DescribeLaunchConfigurations API operation.

Parameters:

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

    • :launch_configuration_names - (Array<String>)

    • :next_token - (String)

    • :max_records - (Integer)

Returns:

  • (Core::Response) —

    The #data method of the response object returns a hash with the following structure:

    • :launch_configurations - (Array<Hash>)

      • :launch_configuration_name - (String)

      • :launch_configuration_arn - (String)

      • :image_id - (String)

      • :key_name - (String)

      • :security_groups - (Array<String>)

      • :user_data - (String)

      • :instance_type - (String)

      • :kernel_id - (String)

      • :ramdisk_id - (String)

      • :block_device_mappings - (Array<Hash>)

        • :virtual_name - (String)

        • :device_name - (String)

        • :ebs - (Hash)

          • :snapshot_id - (String)

          • :volume_size - (Integer)

      • :instance_monitoring - (Hash)

        • :enabled - (Boolean)

      • :spot_price - (String)

      • :iam_instance_profile - (String)

      • :created_time - (Time)

    • :next_token - (String)



268
 
# File 'lib/aws/auto_scaling/client.rb', line 268

define_client_method :describe_launch_configurations, 'DescribeLaunchConfigurations'

#describe_metric_collection_types(options = {}) ⇒ Core::Response

Calls the DescribeMetricCollectionTypes API operation.

Parameters:

  • options (Hash) (defaults to: {})

Returns:

  • (Core::Response) —

    The #data method of the response object returns a hash with the following structure:

    • :metrics - (Array<Hash>)

      • :metric - (String)

    • :granularities - (Array<Hash>)

      • :granularity - (String)



280
 
# File 'lib/aws/auto_scaling/client.rb', line 280

define_client_method :describe_metric_collection_types, 'DescribeMetricCollectionTypes'

#describe_notification_configurations(options = {}) ⇒ Core::Response

Calls the DescribeNotificationConfigurations API operation.

Parameters:

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

    • :auto_scaling_group_names - (Array<String>)

    • :next_token - (String)

    • :max_records - (Integer)

Returns:

  • (Core::Response) —

    The #data method of the response object returns a hash with the following structure:

    • :notification_configurations - (Array<Hash>)

      • :auto_scaling_group_name - (String)

      • :topic_arn - (String)

      • :notification_type - (String)

    • :next_token - (String)



296
 
# File 'lib/aws/auto_scaling/client.rb', line 296

define_client_method :describe_notification_configurations, 'DescribeNotificationConfigurations'

#describe_policies(options = {}) ⇒ Core::Response

Calls the DescribePolicies API operation.

Parameters:

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

    • :auto_scaling_group_name - (String)

    • :policy_names - (Array<String>)

    • :next_token - (String)

    • :max_records - (Integer)

Returns:

  • (Core::Response) —

    The #data method of the response object returns a hash with the following structure:

    • :scaling_policies - (Array<Hash>)

      • :auto_scaling_group_name - (String)

      • :policy_name - (String)

      • :scaling_adjustment - (Integer)

      • :adjustment_type - (String)

      • :cooldown - (Integer)

      • :policy_arn - (String)

      • :alarms - (Array<Hash>)

        • :alarm_name - (String)

        • :alarm_arn - (String)

      • :min_adjustment_step - (Integer)

    • :next_token - (String)



320
 
# File 'lib/aws/auto_scaling/client.rb', line 320

define_client_method :describe_policies, 'DescribePolicies'

#describe_scaling_activities(options = {}) ⇒ Core::Response

Calls the DescribeScalingActivities API operation.

Parameters:

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

    • :activity_ids - (Array<String>)

    • :auto_scaling_group_name - (String)

    • :max_records - (Integer)

    • :next_token - (String)

Returns:

  • (Core::Response) —

    The #data method of the response object returns a hash with the following structure:

    • :activities - (Array<Hash>)

      • :activity_id - (String)

      • :auto_scaling_group_name - (String)

      • :description - (String)

      • :cause - (String)

      • :start_time - (Time)

      • :end_time - (Time)

      • :status_code - (String)

      • :status_message - (String)

      • :progress - (Integer)

      • :details - (String)

    • :next_token - (String)



344
 
# File 'lib/aws/auto_scaling/client.rb', line 344

define_client_method :describe_scaling_activities, 'DescribeScalingActivities'

#describe_scaling_process_types(options = {}) ⇒ Core::Response

Calls the DescribeScalingProcessTypes API operation.

Parameters:

  • options (Hash) (defaults to: {})

Returns:

  • (Core::Response) —

    The #data method of the response object returns a hash with the following structure:

    • :processes - (Array<Hash>)

      • :process_name - (String)



354
 
# File 'lib/aws/auto_scaling/client.rb', line 354

define_client_method :describe_scaling_process_types, 'DescribeScalingProcessTypes'

#describe_scheduled_actions(options = {}) ⇒ Core::Response

Calls the DescribeScheduledActions API operation.

Parameters:

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

    • :auto_scaling_group_name - (String)

    • :scheduled_action_names - (Array<String>)

    • :start_time - (String<ISO8601 datetime>)

    • :end_time - (String<ISO8601 datetime>)

    • :next_token - (String)

    • :max_records - (Integer)

Returns:

  • (Core::Response) —

    The #data method of the response object returns a hash with the following structure:

    • :scheduled_update_group_actions - (Array<Hash>)

      • :auto_scaling_group_name - (String)

      • :scheduled_action_name - (String)

      • :scheduled_action_arn - (String)

      • :time - (Time)

      • :start_time - (Time)

      • :end_time - (Time)

      • :recurrence - (String)

      • :min_size - (Integer)

      • :max_size - (Integer)

      • :desired_capacity - (Integer)

    • :next_token - (String)



380
 
# File 'lib/aws/auto_scaling/client.rb', line 380

define_client_method :describe_scheduled_actions, 'DescribeScheduledActions'

#describe_tags(options = {}) ⇒ Core::Response

Calls the DescribeTags API operation.

Parameters:

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

    • :filters - (Array<Hash>)

      • :name - (String)

      • :values - (Array<String>)

    • :next_token - (String)

    • :max_records - (Integer)

Returns:

  • (Core::Response) —

    The #data method of the response object returns a hash with the following structure:

    • :tags - (Array<Hash>)

      • :resource_id - (String)

      • :resource_type - (String)

      • :key - (String)

      • :value - (String)

      • :propagate_at_launch - (Boolean)

    • :next_token - (String)



400
 
# File 'lib/aws/auto_scaling/client.rb', line 400

define_client_method :describe_tags, 'DescribeTags'

#disable_metrics_collection(options = {}) ⇒ Core::Response

Calls the DisableMetricsCollection API operation.

Parameters:

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

    • :auto_scaling_group_name - required - (String)

    • :metrics - (Array<String>)

Returns:



408
 
# File 'lib/aws/auto_scaling/client.rb', line 408

define_client_method :disable_metrics_collection, 'DisableMetricsCollection'

#enable_metrics_collection(options = {}) ⇒ Core::Response

Calls the EnableMetricsCollection API operation.

Parameters:

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

    • :auto_scaling_group_name - required - (String)

    • :metrics - (Array<String>)

    • :granularity - required - (String)

Returns:



417
 
# File 'lib/aws/auto_scaling/client.rb', line 417

define_client_method :enable_metrics_collection, 'EnableMetricsCollection'

#execute_policy(options = {}) ⇒ Core::Response

Calls the ExecutePolicy API operation.

Parameters:

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

    • :auto_scaling_group_name - (String)

    • :policy_name - required - (String)

    • :honor_cooldown - (Boolean)

Returns:



426
 
# File 'lib/aws/auto_scaling/client.rb', line 426

define_client_method :execute_policy, 'ExecutePolicy'

#put_notification_configuration(options = {}) ⇒ Core::Response

Calls the PutNotificationConfiguration API operation.

Parameters:

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

    • :auto_scaling_group_name - required - (String)

    • :topic_arn - required - (String)

    • :notification_types - required - (Array<String>)

Returns:



435
 
# File 'lib/aws/auto_scaling/client.rb', line 435

define_client_method :put_notification_configuration, 'PutNotificationConfiguration'

#put_scaling_policy(options = {}) ⇒ Core::Response

Calls the PutScalingPolicy API operation.

Parameters:

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

    • :auto_scaling_group_name - required - (String)

    • :policy_name - required - (String)

    • :scaling_adjustment - required - (Integer)

    • :adjustment_type - required - (String)

    • :cooldown - (Integer)

    • :min_adjustment_step - (Integer)

Returns:

  • (Core::Response) —

    The #data method of the response object returns a hash with the following structure:

    • :policy_arn - (String)



450
 
# File 'lib/aws/auto_scaling/client.rb', line 450

define_client_method :put_scaling_policy, 'PutScalingPolicy'

#put_scheduled_update_group_action(options = {}) ⇒ Core::Response

Calls the PutScheduledUpdateGroupAction API operation.

Parameters:

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

    • :auto_scaling_group_name - required - (String)

    • :scheduled_action_name - required - (String)

    • :time - (String<ISO8601 datetime>)

    • :start_time - (String<ISO8601 datetime>)

    • :end_time - (String<ISO8601 datetime>)

    • :recurrence - (String)

    • :min_size - (Integer)

    • :max_size - (Integer)

    • :desired_capacity - (Integer)

Returns:



465
 
# File 'lib/aws/auto_scaling/client.rb', line 465

define_client_method :put_scheduled_update_group_action, 'PutScheduledUpdateGroupAction'

#resume_processes(options = {}) ⇒ Core::Response

Calls the ResumeProcesses API operation.

Parameters:

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

    • :auto_scaling_group_name - required - (String)

    • :scaling_processes - (Array<String>)

Returns:



473
 
# File 'lib/aws/auto_scaling/client.rb', line 473

define_client_method :resume_processes, 'ResumeProcesses'

#set_desired_capacity(options = {}) ⇒ Core::Response

Calls the SetDesiredCapacity API operation.

Parameters:

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

    • :auto_scaling_group_name - required - (String)

    • :desired_capacity - required - (Integer)

    • :honor_cooldown - (Boolean)

Returns:



482
 
# File 'lib/aws/auto_scaling/client.rb', line 482

define_client_method :set_desired_capacity, 'SetDesiredCapacity'

#set_instance_health(options = {}) ⇒ Core::Response

Calls the SetInstanceHealth API operation.

Parameters:

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

    • :instance_id - required - (String)

    • :health_status - required - (String)

    • :should_respect_grace_period - (Boolean)

Returns:



491
 
# File 'lib/aws/auto_scaling/client.rb', line 491

define_client_method :set_instance_health, 'SetInstanceHealth'

#suspend_processes(options = {}) ⇒ Core::Response

Calls the SuspendProcesses API operation.

Parameters:

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

    • :auto_scaling_group_name - required - (String)

    • :scaling_processes - (Array<String>)

Returns:



499
 
# File 'lib/aws/auto_scaling/client.rb', line 499

define_client_method :suspend_processes, 'SuspendProcesses'

#terminate_instance_in_auto_scaling_group(options = {}) ⇒ Core::Response

Calls the TerminateInstanceInAutoScalingGroup API operation.

Parameters:

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

    • :instance_id - required - (String)

    • :should_decrement_desired_capacity - required - (Boolean)

Returns:

  • (Core::Response) —

    The #data method of the response object returns a hash with the following structure:

    • :activity - (Hash)

      • :activity_id - (String)

      • :auto_scaling_group_name - (String)

      • :description - (String)

      • :cause - (String)

      • :start_time - (Time)

      • :end_time - (Time)

      • :status_code - (String)

      • :status_message - (String)

      • :progress - (Integer)

      • :details - (String)



520
 
# File 'lib/aws/auto_scaling/client.rb', line 520

define_client_method :terminate_instance_in_auto_scaling_group, 'TerminateInstanceInAutoScalingGroup'

#update_auto_scaling_group(options = {}) ⇒ Core::Response

Calls the UpdateAutoScalingGroup API operation.

Parameters:

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

    • :auto_scaling_group_name - required - (String)

    • :launch_configuration_name - (String)

    • :min_size - (Integer)

    • :max_size - (Integer)

    • :desired_capacity - (Integer)

    • :default_cooldown - (Integer)

    • :availability_zones - (Array<String>)

    • :health_check_type - (String)

    • :health_check_grace_period - (Integer)

    • :placement_group - (String)

    • :vpc_zone_identifier - (String)

Returns:



537
 
# File 'lib/aws/auto_scaling/client.rb', line 537

define_client_method :update_auto_scaling_group, 'UpdateAutoScalingGroup'