Class: Aws::AutoScaling::Client
- Inherits:
-
Seahorse::Client::Base
- Object
- Seahorse::Client::Base
- Aws::AutoScaling::Client
- 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
API Operations collapse
-
#attach_instances(params = {}) ⇒ Struct
Attaches one or more EC2 instances to the specified Auto Scaling group.
-
#attach_load_balancer_target_groups(params = {}) ⇒ Struct
This API operation is superseded by AttachTrafficSources, which can attach multiple traffic sources types. -
#attach_load_balancers(params = {}) ⇒ Struct
This API operation is superseded by AttachTrafficSources, which can attach multiple traffic sources types. -
#attach_traffic_sources(params = {}) ⇒ Struct
Attaches one or more traffic sources to the specified Auto Scaling group.
-
#batch_delete_scheduled_action(params = {}) ⇒ Types::BatchDeleteScheduledActionAnswer
Deletes one or more scheduled actions for the specified Auto Scaling group.
-
#batch_put_scheduled_update_group_action(params = {}) ⇒ Types::BatchPutScheduledUpdateGroupActionAnswer
Creates or updates one or more scheduled scaling actions for an Auto Scaling group.
-
#cancel_instance_refresh(params = {}) ⇒ Types::CancelInstanceRefreshAnswer
Cancels an instance refresh or rollback that is in progress.
-
#complete_lifecycle_action(params = {}) ⇒ Struct
Completes the lifecycle action for the specified token or instance with the specified result.
-
#create_auto_scaling_group(params = {}) ⇒ Struct
We strongly recommend using a launch template when calling this operation to ensure full functionality for Amazon EC2 Auto Scaling and Amazon EC2..
-
#create_launch_configuration(params = {}) ⇒ Struct
Creates a launch configuration.
-
#create_or_update_tags(params = {}) ⇒ Struct
Creates or updates tags for the specified Auto Scaling group.
-
#delete_auto_scaling_group(params = {}) ⇒ Struct
Deletes the specified Auto Scaling group.
-
#delete_launch_configuration(params = {}) ⇒ Struct
Deletes the specified launch configuration.
-
#delete_lifecycle_hook(params = {}) ⇒ Struct
Deletes the specified lifecycle hook.
-
#delete_notification_configuration(params = {}) ⇒ Struct
Deletes the specified notification.
-
#delete_policy(params = {}) ⇒ Struct
Deletes the specified scaling policy.
-
#delete_scheduled_action(params = {}) ⇒ Struct
Deletes the specified scheduled action.
-
#delete_tags(params = {}) ⇒ Struct
Deletes the specified tags.
-
#delete_warm_pool(params = {}) ⇒ Struct
Deletes the warm pool for the specified Auto Scaling group.
-
#describe_account_limits(params = {}) ⇒ Types::DescribeAccountLimitsAnswer
Describes the current Amazon EC2 Auto Scaling resource quotas for your account.
-
#describe_adjustment_types(params = {}) ⇒ Types::DescribeAdjustmentTypesAnswer
Describes the available adjustment types for step scaling and simple scaling policies.
-
#describe_auto_scaling_groups(params = {}) ⇒ Types::AutoScalingGroupsType
Gets information about the Auto Scaling groups in the account and Region.
-
#describe_auto_scaling_instances(params = {}) ⇒ Types::AutoScalingInstancesType
Gets information about the Auto Scaling instances in the account and Region.
-
#describe_auto_scaling_notification_types(params = {}) ⇒ Types::DescribeAutoScalingNotificationTypesAnswer
Describes the notification types that are supported by Amazon EC2 Auto Scaling.
-
#describe_instance_refreshes(params = {}) ⇒ Types::DescribeInstanceRefreshesAnswer
Gets information about the instance refreshes for the specified Auto Scaling group from the previous six weeks.
-
#describe_launch_configurations(params = {}) ⇒ Types::LaunchConfigurationsType
Gets information about the launch configurations in the account and Region.
-
#describe_lifecycle_hook_types(params = {}) ⇒ Types::DescribeLifecycleHookTypesAnswer
Describes the available types of lifecycle hooks.
-
#describe_lifecycle_hooks(params = {}) ⇒ Types::DescribeLifecycleHooksAnswer
Gets information about the lifecycle hooks for the specified Auto Scaling group.
-
#describe_load_balancer_target_groups(params = {}) ⇒ Types::DescribeLoadBalancerTargetGroupsResponse
This API operation is superseded by DescribeTrafficSources, which can describe multiple traffic sources types. -
#describe_load_balancers(params = {}) ⇒ Types::DescribeLoadBalancersResponse
This API operation is superseded by DescribeTrafficSources, which can describe multiple traffic sources types. -
#describe_metric_collection_types(params = {}) ⇒ Types::DescribeMetricCollectionTypesAnswer
Describes the available CloudWatch metrics for Amazon EC2 Auto Scaling.
-
#describe_notification_configurations(params = {}) ⇒ Types::DescribeNotificationConfigurationsAnswer
Gets information about the Amazon SNS notifications that are configured for one or more Auto Scaling groups.
-
#describe_policies(params = {}) ⇒ Types::PoliciesType
Gets information about the scaling policies in the account and Region.
-
#describe_scaling_activities(params = {}) ⇒ Types::ActivitiesType
Gets information about the scaling activities in the account and Region.
-
#describe_scaling_process_types(params = {}) ⇒ Types::ProcessesType
Describes the scaling process types for use with the ResumeProcesses and SuspendProcesses APIs.
-
#describe_scheduled_actions(params = {}) ⇒ Types::ScheduledActionsType
Gets information about the scheduled actions that haven't run or that have not reached their end time.
-
#describe_tags(params = {}) ⇒ Types::TagsType
Describes the specified tags.
-
#describe_termination_policy_types(params = {}) ⇒ Types::DescribeTerminationPolicyTypesAnswer
Describes the termination policies supported by Amazon EC2 Auto Scaling.
-
#describe_traffic_sources(params = {}) ⇒ Types::DescribeTrafficSourcesResponse
Gets information about the traffic sources for the specified Auto Scaling group.
-
#describe_warm_pool(params = {}) ⇒ Types::DescribeWarmPoolAnswer
Gets information about a warm pool and its instances.
-
#detach_instances(params = {}) ⇒ Types::DetachInstancesAnswer
Removes one or more instances from the specified Auto Scaling group.
-
#detach_load_balancer_target_groups(params = {}) ⇒ Struct
This API operation is superseded by DetachTrafficSources, which can detach multiple traffic sources types. -
#detach_load_balancers(params = {}) ⇒ Struct
This API operation is superseded by DetachTrafficSources, which can detach multiple traffic sources types. -
#detach_traffic_sources(params = {}) ⇒ Struct
Detaches one or more traffic sources from the specified Auto Scaling group.
-
#disable_metrics_collection(params = {}) ⇒ Struct
Disables group metrics collection for the specified Auto Scaling group.
-
#enable_metrics_collection(params = {}) ⇒ Struct
Enables group metrics collection for the specified Auto Scaling group.
-
#enter_standby(params = {}) ⇒ Types::EnterStandbyAnswer
Moves the specified instances into the standby state.
-
#execute_policy(params = {}) ⇒ Struct
Executes the specified policy.
-
#exit_standby(params = {}) ⇒ Types::ExitStandbyAnswer
Moves the specified instances out of the standby state.
-
#get_predictive_scaling_forecast(params = {}) ⇒ Types::GetPredictiveScalingForecastAnswer
Retrieves the forecast data for a predictive scaling policy.
-
#put_lifecycle_hook(params = {}) ⇒ Struct
Creates or updates a lifecycle hook for the specified Auto Scaling group.
-
#put_notification_configuration(params = {}) ⇒ Struct
Configures an Auto Scaling group to send notifications when specified events take place.
-
#put_scaling_policy(params = {}) ⇒ Types::PolicyARNType
Creates or updates a scaling policy for an Auto Scaling group.
-
#put_scheduled_update_group_action(params = {}) ⇒ Struct
Creates or updates a scheduled scaling action for an Auto Scaling group.
-
#put_warm_pool(params = {}) ⇒ Struct
Creates or updates a warm pool for the specified Auto Scaling group.
-
#record_lifecycle_action_heartbeat(params = {}) ⇒ Struct
Records a heartbeat for the lifecycle action associated with the specified token or instance.
-
#resume_processes(params = {}) ⇒ Struct
Resumes the specified suspended auto scaling processes, or all suspended process, for the specified Auto Scaling group.
-
#rollback_instance_refresh(params = {}) ⇒ Types::RollbackInstanceRefreshAnswer
Cancels an instance refresh that is in progress and rolls back any changes that it made.
-
#set_desired_capacity(params = {}) ⇒ Struct
Sets the size of the specified Auto Scaling group.
-
#set_instance_health(params = {}) ⇒ Struct
Sets the health status of the specified instance.
-
#set_instance_protection(params = {}) ⇒ Struct
Updates the instance protection settings of the specified instances.
-
#start_instance_refresh(params = {}) ⇒ Types::StartInstanceRefreshAnswer
Starts an instance refresh.
-
#suspend_processes(params = {}) ⇒ Struct
Suspends the specified auto scaling processes, or all processes, for the specified Auto Scaling group.
-
#terminate_instance_in_auto_scaling_group(params = {}) ⇒ Types::ActivityType
Terminates the specified instance and optionally adjusts the desired group size.
-
#update_auto_scaling_group(params = {}) ⇒ Struct
We strongly recommend that all Auto Scaling groups use launch templates to ensure full functionality for Amazon EC2 Auto Scaling and Amazon EC2..
Instance Method Summary collapse
-
#initialize(options) ⇒ Client
constructor
A new instance of Client.
-
#wait_until(waiter_name, params = {}, options = {}) {|w.waiter| ... } ⇒ Boolean
Polls an API operation until a resource enters a desired state.
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.
422 423 424 |
# File 'gems/aws-sdk-autoscaling/lib/aws-sdk-autoscaling/client.rb', line 422 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 Detach or attach instances in the Amazon EC2 Auto Scaling User Guide.
480 481 482 483 |
# File 'gems/aws-sdk-autoscaling/lib/aws-sdk-autoscaling/client.rb', line 480 def attach_instances(params = {}, = {}) req = build_request(:attach_instances, params) req.send_request() end |
#attach_load_balancer_target_groups(params = {}) ⇒ Struct
AttachTrafficSources
to simplify how you manage traffic sources.
However, we continue to support AttachLoadBalancerTargetGroups
. You
can use both the original AttachLoadBalancerTargetGroups
API
operation and AttachTrafficSources
on the same Auto Scaling group.
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.
This operation is additive and does not detach existing target groups or Classic Load Balancers from the Auto Scaling group.
For more information, see Use Elastic Load Balancing to distribute traffic across the instances in your Auto Scaling group in the Amazon EC2 Auto Scaling User Guide.
559 560 561 562 |
# File 'gems/aws-sdk-autoscaling/lib/aws-sdk-autoscaling/client.rb', line 559 def attach_load_balancer_target_groups(params = {}, = {}) req = build_request(:attach_load_balancer_target_groups, params) req.send_request() end |
#attach_load_balancers(params = {}) ⇒ Struct
AttachTrafficSources
to simplify how you manage traffic sources.
However, we continue to support AttachLoadBalancers
. You can use
both the original AttachLoadBalancers
API operation and
AttachTrafficSources
on the same Auto Scaling group.
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 a load balancer from the Auto Scaling group, call the DetachLoadBalancers API.
This operation is additive and does not detach existing Classic Load Balancers or target groups from the Auto Scaling group.
For more information, see Use Elastic Load Balancing to distribute traffic across the instances in your Auto Scaling group in the Amazon EC2 Auto Scaling User Guide.
624 625 626 627 |
# File 'gems/aws-sdk-autoscaling/lib/aws-sdk-autoscaling/client.rb', line 624 def attach_load_balancers(params = {}, = {}) req = build_request(:attach_load_balancers, params) req.send_request() end |
#attach_traffic_sources(params = {}) ⇒ Struct
Attaches one or more traffic sources to the specified Auto Scaling group.
You can use any of the following as traffic sources for an Auto Scaling group:
Application Load Balancer
Classic Load Balancer
Gateway Load Balancer
Network Load Balancer
VPC Lattice
This operation is additive and does not detach existing traffic sources from the Auto Scaling group.
After the operation completes, use the DescribeTrafficSources API to return details about the state of the attachments between traffic sources and your Auto Scaling group. To detach a traffic source from the Auto Scaling group, call the DetachTrafficSources API.
696 697 698 699 |
# File 'gems/aws-sdk-autoscaling/lib/aws-sdk-autoscaling/client.rb', line 696 def attach_traffic_sources(params = {}, = {}) req = build_request(:attach_traffic_sources, params) req.send_request() end |
#batch_delete_scheduled_action(params = {}) ⇒ Types::BatchDeleteScheduledActionAnswer
Deletes one or more scheduled actions for the specified Auto Scaling group.
733 734 735 736 |
# File 'gems/aws-sdk-autoscaling/lib/aws-sdk-autoscaling/client.rb', line 733 def batch_delete_scheduled_action(params = {}, = {}) req = build_request(:batch_delete_scheduled_action, params) req.send_request() end |
#batch_put_scheduled_update_group_action(params = {}) ⇒ Types::BatchPutScheduledUpdateGroupActionAnswer
Creates or updates one or more scheduled scaling actions for an Auto Scaling group.
780 781 782 783 |
# File 'gems/aws-sdk-autoscaling/lib/aws-sdk-autoscaling/client.rb', line 780 def batch_put_scheduled_update_group_action(params = {}, = {}) req = build_request(:batch_put_scheduled_update_group_action, params) req.send_request() end |
#cancel_instance_refresh(params = {}) ⇒ Types::CancelInstanceRefreshAnswer
Cancels an instance refresh or rollback that is in progress. If an
instance refresh or rollback is not in progress, an
ActiveInstanceRefreshNotFound
error occurs.
This operation is part of the instance refresh feature in Amazon EC2 Auto Scaling, which helps you update instances in your Auto Scaling group after you make configuration changes.
When you cancel an instance refresh, this does not roll back any changes that it made. Use the RollbackInstanceRefresh API to roll back instead.
836 837 838 839 |
# File 'gems/aws-sdk-autoscaling/lib/aws-sdk-autoscaling/client.rb', line 836 def cancel_instance_refresh(params = {}, = {}) req = build_request(:cancel_instance_refresh, params) req.send_request() 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:
(Optional) Create a launch template or launch configuration with a user data script that runs while an instance is in a wait state due to a lifecycle hook.
(Optional) Create a Lambda function and a rule that allows Amazon EventBridge to invoke your Lambda function when an instance is put into a wait state due to a lifecycle hook.
(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.
Create the lifecycle hook. Specify whether the hook is used when the instances launch or terminate.
If you need more time, record the lifecycle action heartbeat to keep the instance in a wait state.
If you finish before the timeout period ends, send a callback by using the CompleteLifecycleAction API call.
For more information, see Complete a lifecycle action in the Amazon EC2 Auto Scaling User Guide.
924 925 926 927 |
# File 'gems/aws-sdk-autoscaling/lib/aws-sdk-autoscaling/client.rb', line 924 def complete_lifecycle_action(params = {}, = {}) req = build_request(:complete_lifecycle_action, params) req.send_request() end |
#create_auto_scaling_group(params = {}) ⇒ Struct
We strongly recommend using a launch template when calling this operation to ensure full functionality for Amazon EC2 Auto Scaling and Amazon EC2.
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 Quotas for Amazon EC2 Auto Scaling in the Amazon EC2 Auto Scaling User Guide.
If you're new to Amazon EC2 Auto Scaling, see the introductory tutorials in Get started with Amazon EC2 Auto Scaling in the Amazon EC2 Auto Scaling User Guide.
Every Auto Scaling group has three size properties (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.
1545 1546 1547 1548 |
# File 'gems/aws-sdk-autoscaling/lib/aws-sdk-autoscaling/client.rb', line 1545 def create_auto_scaling_group(params = {}, = {}) req = build_request(:create_auto_scaling_group, params) req.send_request() 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 Quotas for Amazon EC2 Auto Scaling in the Amazon EC2 Auto Scaling User Guide.
For more information, see Launch configurations in the Amazon EC2 Auto Scaling User Guide.
1865 1866 1867 1868 |
# File 'gems/aws-sdk-autoscaling/lib/aws-sdk-autoscaling/client.rb', line 1865 def create_launch_configuration(params = {}, = {}) req = build_request(:create_launch_configuration, params) req.send_request() 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 Tag Auto Scaling groups and instances in the Amazon EC2 Auto Scaling User Guide.
1930 1931 1932 1933 |
# File 'gems/aws-sdk-autoscaling/lib/aws-sdk-autoscaling/client.rb', line 1930 def (params = {}, = {}) req = build_request(:create_or_update_tags, params) req.send_request() 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. The force delete operation will also terminate the EC2 instances. If the group has a warm pool, the force delete option also deletes the warm pool.
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.
If the group has scaling policies, deleting the group deletes the policies, the underlying alarm actions, and any alarm that no longer has an associated action.
For more information, see Delete your Auto Scaling infrastructure in the Amazon EC2 Auto Scaling User Guide.
2003 2004 2005 2006 |
# File 'gems/aws-sdk-autoscaling/lib/aws-sdk-autoscaling/client.rb', line 2003 def delete_auto_scaling_group(params = {}, = {}) req = build_request(:delete_auto_scaling_group, params) req.send_request() 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.
2038 2039 2040 2041 |
# File 'gems/aws-sdk-autoscaling/lib/aws-sdk-autoscaling/client.rb', line 2038 def delete_launch_configuration(params = {}, = {}) req = build_request(:delete_launch_configuration, params) req.send_request() 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).
2078 2079 2080 2081 |
# File 'gems/aws-sdk-autoscaling/lib/aws-sdk-autoscaling/client.rb', line 2078 def delete_lifecycle_hook(params = {}, = {}) req = build_request(:delete_lifecycle_hook, params) req.send_request() end |
#delete_notification_configuration(params = {}) ⇒ Struct
Deletes the specified notification.
2114 2115 2116 2117 |
# File 'gems/aws-sdk-autoscaling/lib/aws-sdk-autoscaling/client.rb', line 2114 def delete_notification_configuration(params = {}, = {}) req = build_request(:delete_notification_configuration, params) req.send_request() 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 Delete a scaling policy in the Amazon EC2 Auto Scaling User Guide.
2161 2162 2163 2164 |
# File 'gems/aws-sdk-autoscaling/lib/aws-sdk-autoscaling/client.rb', line 2161 def delete_policy(params = {}, = {}) req = build_request(:delete_policy, params) req.send_request() end |
#delete_scheduled_action(params = {}) ⇒ Struct
Deletes the specified scheduled action.
2197 2198 2199 2200 |
# File 'gems/aws-sdk-autoscaling/lib/aws-sdk-autoscaling/client.rb', line 2197 def delete_scheduled_action(params = {}, = {}) req = build_request(:delete_scheduled_action, params) req.send_request() end |
#delete_tags(params = {}) ⇒ Struct
Deletes the specified tags.
2243 2244 2245 2246 |
# File 'gems/aws-sdk-autoscaling/lib/aws-sdk-autoscaling/client.rb', line 2243 def (params = {}, = {}) req = build_request(:delete_tags, params) req.send_request() end |
#delete_warm_pool(params = {}) ⇒ Struct
Deletes the warm pool for the specified Auto Scaling group.
For more information, see Warm pools for Amazon EC2 Auto Scaling in the Amazon EC2 Auto Scaling User Guide.
2279 2280 2281 2282 |
# File 'gems/aws-sdk-autoscaling/lib/aws-sdk-autoscaling/client.rb', line 2279 def delete_warm_pool(params = {}, = {}) req = build_request(:delete_warm_pool, params) req.send_request() end |
#describe_account_limits(params = {}) ⇒ Types::DescribeAccountLimitsAnswer
Describes the current Amazon EC2 Auto Scaling resource quotas for your account.
When you establish an Amazon Web Services account, the account has initial quotas on the maximum number of Auto Scaling groups and launch configurations that you can create in a given Region. For more information, see Quotas for Amazon EC2 Auto Scaling in the Amazon EC2 Auto Scaling User Guide.
2331 2332 2333 2334 |
# File 'gems/aws-sdk-autoscaling/lib/aws-sdk-autoscaling/client.rb', line 2331 def describe_account_limits(params = {}, = {}) req = build_request(:describe_account_limits, params) req.send_request() end |
#describe_adjustment_types(params = {}) ⇒ Types::DescribeAdjustmentTypesAnswer
Describes the available adjustment types for step scaling and simple scaling policies.
The following adjustment types are supported:
ChangeInCapacity
ExactCapacity
PercentChangeInCapacity
2383 2384 2385 2386 |
# File 'gems/aws-sdk-autoscaling/lib/aws-sdk-autoscaling/client.rb', line 2383 def describe_adjustment_types(params = {}, = {}) req = build_request(:describe_adjustment_types, params) req.send_request() end |
#describe_auto_scaling_groups(params = {}) ⇒ Types::AutoScalingGroupsType
Gets information about the Auto Scaling groups in the account and Region.
If you specify Auto Scaling group names, the output includes information for only the specified Auto Scaling groups. If you specify filters, the output includes information for only those Auto Scaling groups that meet the filter criteria. If you do not specify group names or filters, the output includes information for all Auto Scaling groups.
This operation also returns information about instances in Auto Scaling groups. To retrieve information about the instances in a warm pool, you must call the DescribeWarmPool API.
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
2652 2653 2654 2655 |
# File 'gems/aws-sdk-autoscaling/lib/aws-sdk-autoscaling/client.rb', line 2652 def describe_auto_scaling_groups(params = {}, = {}) req = build_request(:describe_auto_scaling_groups, params) req.send_request() end |
#describe_auto_scaling_instances(params = {}) ⇒ Types::AutoScalingInstancesType
Gets information about the Auto Scaling instances in the account and Region.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
2738 2739 2740 2741 |
# File 'gems/aws-sdk-autoscaling/lib/aws-sdk-autoscaling/client.rb', line 2738 def describe_auto_scaling_instances(params = {}, = {}) req = build_request(:describe_auto_scaling_instances, params) req.send_request() end |
#describe_auto_scaling_notification_types(params = {}) ⇒ Types::DescribeAutoScalingNotificationTypesAnswer
Describes the notification types that are supported by Amazon EC2 Auto Scaling.
2778 2779 2780 2781 |
# File 'gems/aws-sdk-autoscaling/lib/aws-sdk-autoscaling/client.rb', line 2778 def describe_auto_scaling_notification_types(params = {}, = {}) req = build_request(:describe_auto_scaling_notification_types, params) req.send_request() end |
#describe_instance_refreshes(params = {}) ⇒ Types::DescribeInstanceRefreshesAnswer
Gets information about the instance refreshes for the specified Auto Scaling group from the previous six weeks.
This operation is part of the instance refresh feature in Amazon EC2 Auto Scaling, which helps you update instances in your Auto Scaling group after you make configuration changes.
To help you determine the status of an instance refresh, Amazon EC2 Auto Scaling returns information about the instance refreshes you previously initiated, including their status, start time, end time, the percentage of the instance refresh that is complete, and the number of instances remaining to update before the instance refresh is complete. If a rollback is initiated while an instance refresh is in progress, Amazon EC2 Auto Scaling also returns information about the rollback of the instance refresh.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
2994 2995 2996 2997 |
# File 'gems/aws-sdk-autoscaling/lib/aws-sdk-autoscaling/client.rb', line 2994 def describe_instance_refreshes(params = {}, = {}) req = build_request(:describe_instance_refreshes, params) req.send_request() end |
#describe_launch_configurations(params = {}) ⇒ Types::LaunchConfigurationsType
Gets information about the launch configurations in the account and Region.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
3108 3109 3110 3111 |
# File 'gems/aws-sdk-autoscaling/lib/aws-sdk-autoscaling/client.rb', line 3108 def describe_launch_configurations(params = {}, = {}) req = build_request(:describe_launch_configurations, params) req.send_request() 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
3150 3151 3152 3153 |
# File 'gems/aws-sdk-autoscaling/lib/aws-sdk-autoscaling/client.rb', line 3150 def describe_lifecycle_hook_types(params = {}, = {}) req = build_request(:describe_lifecycle_hook_types, params) req.send_request() end |
#describe_lifecycle_hooks(params = {}) ⇒ Types::DescribeLifecycleHooksAnswer
Gets information about the lifecycle hooks for the specified Auto Scaling group.
3218 3219 3220 3221 |
# File 'gems/aws-sdk-autoscaling/lib/aws-sdk-autoscaling/client.rb', line 3218 def describe_lifecycle_hooks(params = {}, = {}) req = build_request(:describe_lifecycle_hooks, params) req.send_request() end |
#describe_load_balancer_target_groups(params = {}) ⇒ Types::DescribeLoadBalancerTargetGroupsResponse
DetachTrafficSources
to simplify how you manage traffic sources.
However, we continue to support DescribeLoadBalancerTargetGroups
.
You can use both the original DescribeLoadBalancerTargetGroups
API
operation and DescribeTrafficSources
on the same Auto Scaling group.
Gets information about the Elastic Load Balancing target groups for the specified Auto Scaling group.
To determine the attachment status of the target group, use the
State
element in the response. When you attach a target group to an
Auto Scaling group, the initial State
value is Adding
. The state
transitions to Added
after all Auto Scaling instances are registered
with the target group. If Elastic Load Balancing health checks are
enabled for the Auto Scaling group, the state transitions to
InService
after at least one Auto Scaling instance passes the health
check. When the target group is in the InService
state, Amazon EC2
Auto Scaling can terminate and replace any instances that are reported
as unhealthy. If no registered instances pass the health checks, the
target group doesn't enter the InService
state.
Target groups also have an InService
state if you attach them in the
CreateAutoScalingGroup API call. If your target group state is
InService
, but it is not working properly, check the scaling
activities by calling DescribeScalingActivities and take any
corrective actions necessary.
For help with failed health checks, see Troubleshooting Amazon EC2 Auto Scaling: Health checks in the Amazon EC2 Auto Scaling User Guide. For more information, see Use Elastic Load Balancing to distribute traffic across the instances in your Auto Scaling group in the Amazon EC2 Auto Scaling User Guide.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
3326 3327 3328 3329 |
# File 'gems/aws-sdk-autoscaling/lib/aws-sdk-autoscaling/client.rb', line 3326 def describe_load_balancer_target_groups(params = {}, = {}) req = build_request(:describe_load_balancer_target_groups, params) req.send_request() end |
#describe_load_balancers(params = {}) ⇒ Types::DescribeLoadBalancersResponse
DescribeTrafficSources
to simplify how you manage traffic sources.
However, we continue to support DescribeLoadBalancers
. You can use
both the original DescribeLoadBalancers
API operation and
DescribeTrafficSources
on the same Auto Scaling group.
Gets information about 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.
To determine the attachment status of the load balancer, use the
State
element in the response. When you attach a load balancer to an
Auto Scaling group, the initial State
value is Adding
. The state
transitions to Added
after all Auto Scaling instances are registered
with the load balancer. If Elastic Load Balancing health checks are
enabled for the Auto Scaling group, the state transitions to
InService
after at least one Auto Scaling instance passes the health
check. When the load balancer is in the InService
state, Amazon EC2
Auto Scaling can terminate and replace any instances that are reported
as unhealthy. If no registered instances pass the health checks, the
load balancer doesn't enter the InService
state.
Load balancers also have an InService
state if you attach them in
the CreateAutoScalingGroup API call. If your load balancer state is
InService
, but it is not working properly, check the scaling
activities by calling DescribeScalingActivities and take any
corrective actions necessary.
For help with failed health checks, see Troubleshooting Amazon EC2 Auto Scaling: Health checks in the Amazon EC2 Auto Scaling User Guide. For more information, see Use Elastic Load Balancing to distribute traffic across the instances in your Auto Scaling group in the Amazon EC2 Auto Scaling User Guide.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
3432 3433 3434 3435 |
# File 'gems/aws-sdk-autoscaling/lib/aws-sdk-autoscaling/client.rb', line 3432 def describe_load_balancers(params = {}, = {}) req = build_request(:describe_load_balancers, params) req.send_request() end |
#describe_metric_collection_types(params = {}) ⇒ Types::DescribeMetricCollectionTypesAnswer
Describes the available CloudWatch metrics for Amazon EC2 Auto Scaling.
3499 3500 3501 3502 |
# File 'gems/aws-sdk-autoscaling/lib/aws-sdk-autoscaling/client.rb', line 3499 def describe_metric_collection_types(params = {}, = {}) req = build_request(:describe_metric_collection_types, params) req.send_request() end |
#describe_notification_configurations(params = {}) ⇒ Types::DescribeNotificationConfigurationsAnswer
Gets information about the Amazon SNS notifications that are configured for one or more Auto Scaling groups.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
3572 3573 3574 3575 |
# File 'gems/aws-sdk-autoscaling/lib/aws-sdk-autoscaling/client.rb', line 3572 def describe_notification_configurations(params = {}, = {}) req = build_request(:describe_notification_configurations, params) req.send_request() end |
#describe_policies(params = {}) ⇒ Types::PoliciesType
Gets information about the scaling policies in the account and Region.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
3753 3754 3755 3756 |
# File 'gems/aws-sdk-autoscaling/lib/aws-sdk-autoscaling/client.rb', line 3753 def describe_policies(params = {}, = {}) req = build_request(:describe_policies, params) req.send_request() end |
#describe_scaling_activities(params = {}) ⇒ Types::ActivitiesType
Gets information about the scaling activities in the account and Region.
When scaling events occur, you see a record of the scaling activity in the scaling activities. For more information, see Verify a scaling activity for an Auto Scaling group in the Amazon EC2 Auto Scaling User Guide.
If the scaling event succeeds, the value of the StatusCode
element
in the response is Successful
. If an attempt to launch instances
failed, the StatusCode
value is Failed
or Cancelled
and the
StatusMessage
element in the response indicates the cause of the
failure. For help interpreting the StatusMessage
, see
Troubleshooting Amazon EC2 Auto Scaling in the Amazon EC2 Auto
Scaling User Guide.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
3868 3869 3870 3871 |
# File 'gems/aws-sdk-autoscaling/lib/aws-sdk-autoscaling/client.rb', line 3868 def describe_scaling_activities(params = {}, = {}) req = build_request(:describe_scaling_activities, params) req.send_request() end |
#describe_scaling_process_types(params = {}) ⇒ Types::ProcessesType
Describes the scaling process types for use with the ResumeProcesses and SuspendProcesses APIs.
3927 3928 3929 3930 |
# File 'gems/aws-sdk-autoscaling/lib/aws-sdk-autoscaling/client.rb', line 3927 def describe_scaling_process_types(params = {}, = {}) req = build_request(:describe_scaling_process_types, params) req.send_request() end |
#describe_scheduled_actions(params = {}) ⇒ Types::ScheduledActionsType
Gets information about the scheduled actions that haven't run or that have not reached their end time.
To describe the scaling activities for scheduled 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.
4028 4029 4030 4031 |
# File 'gems/aws-sdk-autoscaling/lib/aws-sdk-autoscaling/client.rb', line 4028 def describe_scheduled_actions(params = {}, = {}) req = build_request(:describe_scheduled_actions, params) req.send_request() 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 Tag 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.
4133 4134 4135 4136 |
# File 'gems/aws-sdk-autoscaling/lib/aws-sdk-autoscaling/client.rb', line 4133 def (params = {}, = {}) req = build_request(:describe_tags, params) req.send_request() end |
#describe_termination_policy_types(params = {}) ⇒ Types::DescribeTerminationPolicyTypesAnswer
Describes the termination policies supported by Amazon EC2 Auto Scaling.
For more information, see Configure termination policies for Amazon EC2 Auto Scaling in the Amazon EC2 Auto Scaling User Guide.
4180 4181 4182 4183 |
# File 'gems/aws-sdk-autoscaling/lib/aws-sdk-autoscaling/client.rb', line 4180 def describe_termination_policy_types(params = {}, = {}) req = build_request(:describe_termination_policy_types, params) req.send_request() end |
#describe_traffic_sources(params = {}) ⇒ Types::DescribeTrafficSourcesResponse
Gets information about the traffic sources for the specified Auto Scaling group.
You can optionally provide a traffic source type. If you provide a traffic source type, then the results only include that traffic source type.
If you do not provide a traffic source type, then the results include all the traffic sources for the specified Auto Scaling group.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
4268 4269 4270 4271 |
# File 'gems/aws-sdk-autoscaling/lib/aws-sdk-autoscaling/client.rb', line 4268 def describe_traffic_sources(params = {}, = {}) req = build_request(:describe_traffic_sources, params) req.send_request() end |
#describe_warm_pool(params = {}) ⇒ Types::DescribeWarmPoolAnswer
Gets information about a warm pool and its instances.
For more information, see Warm pools for Amazon EC2 Auto Scaling in the Amazon EC2 Auto Scaling User Guide.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
4334 4335 4336 4337 |
# File 'gems/aws-sdk-autoscaling/lib/aws-sdk-autoscaling/client.rb', line 4334 def describe_warm_pool(params = {}, = {}) req = build_request(:describe_warm_pool, params) req.send_request() 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 or attach instances in the Amazon EC2 Auto Scaling User Guide.
4431 4432 4433 4434 |
# File 'gems/aws-sdk-autoscaling/lib/aws-sdk-autoscaling/client.rb', line 4431 def detach_instances(params = {}, = {}) req = build_request(:detach_instances, params) req.send_request() end |
#detach_load_balancer_target_groups(params = {}) ⇒ Struct
DetachTrafficSources
to simplify how you manage traffic sources.
However, we continue to support DetachLoadBalancerTargetGroups
. You
can use both the original DetachLoadBalancerTargetGroups
API
operation and DetachTrafficSources
on the same Auto Scaling group.
Detaches one or more target groups from the specified Auto Scaling group.
When you detach a target group, it enters the Removing
state while
deregistering the instances in the group. When all instances are
deregistered, then you can no longer describe the target group using
the DescribeLoadBalancerTargetGroups API call. The instances remain
running.
4492 4493 4494 4495 |
# File 'gems/aws-sdk-autoscaling/lib/aws-sdk-autoscaling/client.rb', line 4492 def detach_load_balancer_target_groups(params = {}, = {}) req = build_request(:detach_load_balancer_target_groups, params) req.send_request() end |
#detach_load_balancers(params = {}) ⇒ Struct
DetachTrafficSources
to simplify how you manage traffic sources.
However, we continue to support DetachLoadBalancers
. You can use
both the original DetachLoadBalancers
API operation and
DetachTrafficSources
on the same Auto Scaling group.
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.
4550 4551 4552 4553 |
# File 'gems/aws-sdk-autoscaling/lib/aws-sdk-autoscaling/client.rb', line 4550 def detach_load_balancers(params = {}, = {}) req = build_request(:detach_load_balancers, params) req.send_request() end |
#detach_traffic_sources(params = {}) ⇒ Struct
Detaches one or more traffic sources from the specified Auto Scaling group.
When you detach a traffic source, it enters the Removing
state while
deregistering the instances in the group. When all instances are
deregistered, then you can no longer describe the traffic source using
the DescribeTrafficSources API call. The instances continue to run.
4606 4607 4608 4609 |
# File 'gems/aws-sdk-autoscaling/lib/aws-sdk-autoscaling/client.rb', line 4606 def detach_traffic_sources(params = {}, = {}) req = build_request(:detach_traffic_sources, params) req.send_request() end |
#disable_metrics_collection(params = {}) ⇒ Struct
Disables group metrics collection for the specified Auto Scaling group.
4696 4697 4698 4699 |
# File 'gems/aws-sdk-autoscaling/lib/aws-sdk-autoscaling/client.rb', line 4696 def disable_metrics_collection(params = {}, = {}) req = build_request(:disable_metrics_collection, params) req.send_request() end |
#enable_metrics_collection(params = {}) ⇒ Struct
Enables group metrics collection for the specified Auto Scaling group.
You can use these metrics to track changes in an Auto Scaling group and to set alarms on threshold values. You can view group metrics using the Amazon EC2 Auto Scaling console or the CloudWatch console. For more information, see Monitor CloudWatch metrics for your Auto Scaling groups and instances in the Amazon EC2 Auto Scaling User Guide.
4800 4801 4802 4803 |
# File 'gems/aws-sdk-autoscaling/lib/aws-sdk-autoscaling/client.rb', line 4800 def enable_metrics_collection(params = {}, = {}) req = build_request(:enable_metrics_collection, params) req.send_request() 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.
4894 4895 4896 4897 |
# File 'gems/aws-sdk-autoscaling/lib/aws-sdk-autoscaling/client.rb', line 4894 def enter_standby(params = {}, = {}) req = build_request(:enter_standby, params) req.send_request() end |
#execute_policy(params = {}) ⇒ Struct
Executes the specified policy. This can be useful for testing the design of your scaling policy.
4967 4968 4969 4970 |
# File 'gems/aws-sdk-autoscaling/lib/aws-sdk-autoscaling/client.rb', line 4967 def execute_policy(params = {}, = {}) req = build_request(:execute_policy, params) req.send_request() 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.
5049 5050 5051 5052 |
# File 'gems/aws-sdk-autoscaling/lib/aws-sdk-autoscaling/client.rb', line 5049 def exit_standby(params = {}, = {}) req = build_request(:exit_standby, params) req.send_request() end |
#get_predictive_scaling_forecast(params = {}) ⇒ Types::GetPredictiveScalingForecastAnswer
Retrieves the forecast data for a predictive scaling policy.
Load forecasts are predictions of the hourly load values using historical load data from CloudWatch and an analysis of historical trends. Capacity forecasts are represented as predicted values for the minimum capacity that is needed on an hourly basis, based on the hourly load forecast.
A minimum of 24 hours of data is required to create the initial forecasts. However, having a full 14 days of historical data results in more accurate forecasts.
For more information, see Predictive scaling for Amazon EC2 Auto Scaling in the Amazon EC2 Auto Scaling User Guide.
5168 5169 5170 5171 |
# File 'gems/aws-sdk-autoscaling/lib/aws-sdk-autoscaling/client.rb', line 5168 def get_predictive_scaling_forecast(params = {}, = {}) req = build_request(:get_predictive_scaling_forecast, params) req.send_request() end |
#put_lifecycle_hook(params = {}) ⇒ Struct
Creates or updates a lifecycle hook for the specified Auto Scaling group.
Lifecycle hooks let you create solutions that are aware of events in the Auto Scaling instance lifecycle, and then perform a custom action on instances when the corresponding lifecycle event occurs.
This step is a part of the procedure for adding a lifecycle hook to an Auto Scaling group:
(Optional) Create a launch template or launch configuration with a user data script that runs while an instance is in a wait state due to a lifecycle hook.
(Optional) Create a Lambda function and a rule that allows Amazon EventBridge to invoke your Lambda function when an instance is put into a wait state due to a lifecycle hook.
(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.
Create the lifecycle hook. Specify whether the hook is used when the instances launch or terminate.
If you need more time, record the lifecycle action heartbeat to keep the instance in a wait state using the RecordLifecycleActionHeartbeat API call.
If you finish before the timeout period ends, send a callback by 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.
5312 5313 5314 5315 |
# File 'gems/aws-sdk-autoscaling/lib/aws-sdk-autoscaling/client.rb', line 5312 def put_lifecycle_hook(params = {}, = {}) req = build_request(:put_lifecycle_hook, params) req.send_request() 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 Amazon SNS notification options for Amazon EC2 Auto Scaling 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.
5372 5373 5374 5375 |
# File 'gems/aws-sdk-autoscaling/lib/aws-sdk-autoscaling/client.rb', line 5372 def put_notification_configuration(params = {}, = {}) req = build_request(:put_notification_configuration, params) req.send_request() end |
#put_scaling_policy(params = {}) ⇒ Types::PolicyARNType
Creates or updates a scaling policy for an Auto Scaling group. Scaling policies are used to scale an Auto Scaling group based on configurable metrics. If no policies are defined, the dynamic scaling and predictive scaling features are not used.
For more information about using dynamic scaling, see Target tracking scaling policies and Step and simple scaling policies in the Amazon EC2 Auto Scaling User Guide.
For more information about using predictive scaling, see Predictive scaling for Amazon EC2 Auto Scaling in the Amazon EC2 Auto Scaling User Guide.
You can view the scaling policies for an Auto Scaling group using the DescribePolicies API call. If you are no longer using a scaling policy, you can delete it by calling the DeletePolicy API.
5775 5776 5777 5778 |
# File 'gems/aws-sdk-autoscaling/lib/aws-sdk-autoscaling/client.rb', line 5775 def put_scaling_policy(params = {}, = {}) req = build_request(:put_scaling_policy, params) req.send_request() end |
#put_scheduled_update_group_action(params = {}) ⇒ Struct
Creates or updates a scheduled scaling action for an Auto Scaling group.
For more information, see Scheduled scaling in the Amazon EC2 Auto Scaling User Guide.
You can view the scheduled actions for an Auto Scaling group using the DescribeScheduledActions API call. If you are no longer using a scheduled action, you can delete it by calling the DeleteScheduledAction API.
If you try to schedule your action in the past, Amazon EC2 Auto Scaling returns an error message.
5902 5903 5904 5905 |
# File 'gems/aws-sdk-autoscaling/lib/aws-sdk-autoscaling/client.rb', line 5902 def put_scheduled_update_group_action(params = {}, = {}) req = build_request(:put_scheduled_update_group_action, params) req.send_request() end |
#put_warm_pool(params = {}) ⇒ Struct
Creates or updates a warm pool for the specified Auto Scaling group. A warm pool is a pool of pre-initialized EC2 instances that sits alongside the Auto Scaling group. Whenever your application needs to scale out, the Auto Scaling group can draw on the warm pool to meet its new desired capacity.
This operation must be called from the Region in which the Auto Scaling group was created.
You can view the instances in the warm pool using the DescribeWarmPool API call. If you are no longer using a warm pool, you can delete it by calling the DeleteWarmPool API.
For more information, see Warm pools for Amazon EC2 Auto Scaling in the Amazon EC2 Auto Scaling User Guide.
6000 6001 6002 6003 |
# File 'gems/aws-sdk-autoscaling/lib/aws-sdk-autoscaling/client.rb', line 6000 def put_warm_pool(params = {}, = {}) req = build_request(:put_warm_pool, params) req.send_request() 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:
(Optional) Create a launch template or launch configuration with a user data script that runs while an instance is in a wait state due to a lifecycle hook.
(Optional) Create a Lambda function and a rule that allows Amazon EventBridge to invoke your Lambda function when an instance is put into a wait state due to a lifecycle hook.
(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.
Create the lifecycle hook. Specify whether the hook is used when the instances launch or terminate.
If you need more time, record the lifecycle action heartbeat to keep the instance in a wait state.
If you finish before the timeout period ends, send a callback by using the CompleteLifecycleAction API call.
For more information, see Amazon EC2 Auto Scaling lifecycle hooks in the Amazon EC2 Auto Scaling User Guide.
6082 6083 6084 6085 |
# File 'gems/aws-sdk-autoscaling/lib/aws-sdk-autoscaling/client.rb', line 6082 def record_lifecycle_action_heartbeat(params = {}, = {}) req = build_request(:record_lifecycle_action_heartbeat, params) req.send_request() 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 Suspend and resume Amazon EC2 Auto Scaling processes in the Amazon EC2 Auto Scaling User Guide.
6148 6149 6150 6151 |
# File 'gems/aws-sdk-autoscaling/lib/aws-sdk-autoscaling/client.rb', line 6148 def resume_processes(params = {}, = {}) req = build_request(:resume_processes, params) req.send_request() end |
#rollback_instance_refresh(params = {}) ⇒ Types::RollbackInstanceRefreshAnswer
Cancels an instance refresh that is in progress and rolls back any changes that it made. Amazon EC2 Auto Scaling replaces any instances that were replaced during the instance refresh. This restores your Auto Scaling group to the configuration that it was using before the start of the instance refresh.
This operation is part of the instance refresh feature in Amazon EC2 Auto Scaling, which helps you update instances in your Auto Scaling group after you make configuration changes.
A rollback is not supported in the following situations:
There is no desired configuration specified for the instance refresh.
The Auto Scaling group has a launch template that uses an Amazon Web Services Systems Manager parameter instead of an AMI ID for the
ImageId
property.The Auto Scaling group uses the launch template's
$Latest
or$Default
version.
When you receive a successful response from this operation, Amazon EC2 Auto Scaling immediately begins replacing instances. You can check the status of this operation through the DescribeInstanceRefreshes API operation.
6205 6206 6207 6208 |
# File 'gems/aws-sdk-autoscaling/lib/aws-sdk-autoscaling/client.rb', line 6205 def rollback_instance_refresh(params = {}, = {}) req = build_request(:rollback_instance_refresh, params) req.send_request() 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.
6264 6265 6266 6267 |
# File 'gems/aws-sdk-autoscaling/lib/aws-sdk-autoscaling/client.rb', line 6264 def set_desired_capacity(params = {}, = {}) req = build_request(:set_desired_capacity, params) req.send_request() end |
#set_instance_health(params = {}) ⇒ Struct
Sets the health status of the specified instance.
For more information, see Set up a custom health check for your Auto Scaling group in the Amazon EC2 Auto Scaling User Guide.
6325 6326 6327 6328 |
# File 'gems/aws-sdk-autoscaling/lib/aws-sdk-autoscaling/client.rb', line 6325 def set_instance_health(params = {}, = {}) req = build_request(:set_instance_health, params) req.send_request() end |
#set_instance_protection(params = {}) ⇒ Struct
Updates the instance protection settings of the specified instances. This operation cannot be called on instances in a warm pool.
For more information, see Use 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.
6392 6393 6394 6395 |
# File 'gems/aws-sdk-autoscaling/lib/aws-sdk-autoscaling/client.rb', line 6392 def set_instance_protection(params = {}, = {}) req = build_request(:set_instance_protection, params) req.send_request() end |
#start_instance_refresh(params = {}) ⇒ Types::StartInstanceRefreshAnswer
Starts an instance refresh.
This operation is part of the instance refresh feature in Amazon EC2 Auto Scaling, which helps you update instances in your Auto Scaling group. This feature is helpful, for example, when you have a new AMI or a new user data script. You just need to create a new launch template that specifies the new AMI or user data script. Then start an instance refresh to immediately begin the process of updating instances in the group.
If successful, the request's response contains a unique ID that you can use to track the progress of the instance refresh. 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 that is in progress, use the CancelInstanceRefresh API.
An instance refresh might fail for several reasons, such as EC2 launch
failures, misconfigured health checks, or not ignoring or allowing the
termination of instances that are in Standby
state or protected from
scale in. You can monitor for failed EC2 launches using the scaling
activities. To find the scaling activities, call the
DescribeScalingActivities API.
If you enable auto rollback, your Auto Scaling group will be rolled
back automatically when the instance refresh fails. You can enable
this feature before starting an instance refresh by specifying the
AutoRollback
property in the instance refresh preferences.
Otherwise, to roll back an instance refresh before it finishes, use
the RollbackInstanceRefresh API.
6625 6626 6627 6628 |
# File 'gems/aws-sdk-autoscaling/lib/aws-sdk-autoscaling/client.rb', line 6625 def start_instance_refresh(params = {}, = {}) req = build_request(:start_instance_refresh, params) req.send_request() 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 Suspend and resume Amazon EC2 Auto Scaling
processes in the Amazon EC2 Auto Scaling User Guide.
To resume processes that have been suspended, call the ResumeProcesses API.
6696 6697 6698 6699 |
# File 'gems/aws-sdk-autoscaling/lib/aws-sdk-autoscaling/client.rb', line 6696 def suspend_processes(params = {}, = {}) req = build_request(:suspend_processes, params) req.send_request() end |
#terminate_instance_in_auto_scaling_group(params = {}) ⇒ Types::ActivityType
Terminates the specified instance and optionally adjusts the desired group size. This operation cannot be called on instances in a warm pool.
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 Manual scaling in the Amazon EC2 Auto Scaling User Guide.
6773 6774 6775 6776 |
# File 'gems/aws-sdk-autoscaling/lib/aws-sdk-autoscaling/client.rb', line 6773 def terminate_instance_in_auto_scaling_group(params = {}, = {}) req = build_request(:terminate_instance_in_auto_scaling_group, params) req.send_request() end |
#update_auto_scaling_group(params = {}) ⇒ Struct
We strongly recommend that all Auto Scaling groups use launch templates to ensure full functionality for Amazon EC2 Auto Scaling and Amazon EC2.
Updates the configuration for the specified Auto Scaling group.
To update an Auto Scaling group, specify the name of the group and the property that you want to change. Any properties 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 forDesiredCapacity
, and the newMinSize
is larger than the current size of the group, this sets the group'sDesiredCapacity
to the newMinSize
value.If you specify a new value for
MaxSize
without specifying a value forDesiredCapacity
, and the newMaxSize
is smaller than the current size of the group, this sets the group'sDesiredCapacity
to the newMaxSize
value.
To see which properties 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.
7180 7181 7182 7183 |
# File 'gems/aws-sdk-autoscaling/lib/aws-sdk-autoscaling/client.rb', line 7180 def update_auto_scaling_group(params = {}, = {}) req = build_request(:update_auto_scaling_group, params) req.send_request() 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 |
7292 7293 7294 7295 7296 |
# File 'gems/aws-sdk-autoscaling/lib/aws-sdk-autoscaling/client.rb', line 7292 def wait_until(waiter_name, params = {}, = {}) w = waiter(waiter_name, ) yield(w.waiter) if block_given? # deprecated w.wait(params) end |