AWS SDK Version 2 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

.NET Framework 3.5
 
Interface for accessing AutoScaling Auto Scaling

Auto Scaling is designed to automatically launch or terminate EC2 instances based on user-defined policies, schedules, and health checks. Use this service in conjunction with the Amazon CloudWatch and Elastic Load Balancing services.

Inheritance Hierarchy

Amazon.AutoScaling.IAmazonAutoScaling

Namespace: Amazon.AutoScaling
Assembly: AWSSDK.dll
Version: (assembly version)

Syntax

C#
public interface IAmazonAutoScaling
         IDisposable

The IAmazonAutoScaling type exposes the following members

Methods

NameDescription
Public Method AttachInstances(AttachInstancesRequest) Attaches one or more EC2 instances to the specified Auto Scaling group.

When you attach instances, 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.

For more information, see Attach EC2 Instances to Your Auto Scaling Group in the Auto Scaling Developer Guide.

Public Method AttachLoadBalancers(AttachLoadBalancersRequest) Attaches one or more load balancers to the specified Auto Scaling group.

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

For more information, see Attach a Load Balancer to Your Auto Scaling Group in the Auto Scaling Developer Guide.

Public Method BeginAttachInstances(AttachInstancesRequest, AsyncCallback, object) Initiates the asynchronous execution of the AttachInstances operation.
Public Method BeginAttachLoadBalancers(AttachLoadBalancersRequest, AsyncCallback, object) Initiates the asynchronous execution of the AttachLoadBalancers operation.
Public Method BeginCompleteLifecycleAction(CompleteLifecycleActionRequest, AsyncCallback, object) Initiates the asynchronous execution of the CompleteLifecycleAction operation.
Public Method BeginCreateAutoScalingGroup(CreateAutoScalingGroupRequest, AsyncCallback, object) Initiates the asynchronous execution of the CreateAutoScalingGroup operation.
Public Method BeginCreateLaunchConfiguration(CreateLaunchConfigurationRequest, AsyncCallback, object) Initiates the asynchronous execution of the CreateLaunchConfiguration operation.
Public Method BeginCreateOrUpdateTags(CreateOrUpdateTagsRequest, AsyncCallback, object) Initiates the asynchronous execution of the CreateOrUpdateTags operation.
Public Method BeginDeleteAutoScalingGroup(DeleteAutoScalingGroupRequest, AsyncCallback, object) Initiates the asynchronous execution of the DeleteAutoScalingGroup operation.
Public Method BeginDeleteLaunchConfiguration(DeleteLaunchConfigurationRequest, AsyncCallback, object) Initiates the asynchronous execution of the DeleteLaunchConfiguration operation.
Public Method BeginDeleteLifecycleHook(DeleteLifecycleHookRequest, AsyncCallback, object) Initiates the asynchronous execution of the DeleteLifecycleHook operation.
Public Method BeginDeleteNotificationConfiguration(DeleteNotificationConfigurationRequest, AsyncCallback, object) Initiates the asynchronous execution of the DeleteNotificationConfiguration operation.
Public Method BeginDeletePolicy(DeletePolicyRequest, AsyncCallback, object) Initiates the asynchronous execution of the DeletePolicy operation.
Public Method BeginDeleteScheduledAction(DeleteScheduledActionRequest, AsyncCallback, object) Initiates the asynchronous execution of the DeleteScheduledAction operation.
Public Method BeginDeleteTags(DeleteTagsRequest, AsyncCallback, object) Initiates the asynchronous execution of the DeleteTags operation.
Public Method BeginDescribeAccountLimits(DescribeAccountLimitsRequest, AsyncCallback, object) Initiates the asynchronous execution of the DescribeAccountLimits operation.
Public Method BeginDescribeAdjustmentTypes(DescribeAdjustmentTypesRequest, AsyncCallback, object) Initiates the asynchronous execution of the DescribeAdjustmentTypes operation.
Public Method BeginDescribeAutoScalingGroups(DescribeAutoScalingGroupsRequest, AsyncCallback, object) Initiates the asynchronous execution of the DescribeAutoScalingGroups operation.
Public Method BeginDescribeAutoScalingInstances(DescribeAutoScalingInstancesRequest, AsyncCallback, object) Initiates the asynchronous execution of the DescribeAutoScalingInstances operation.
Public Method BeginDescribeAutoScalingNotificationTypes(DescribeAutoScalingNotificationTypesRequest, AsyncCallback, object) Initiates the asynchronous execution of the DescribeAutoScalingNotificationTypes operation.
Public Method BeginDescribeLaunchConfigurations(DescribeLaunchConfigurationsRequest, AsyncCallback, object) Initiates the asynchronous execution of the DescribeLaunchConfigurations operation.
Public Method BeginDescribeLifecycleHooks(DescribeLifecycleHooksRequest, AsyncCallback, object) Initiates the asynchronous execution of the DescribeLifecycleHooks operation.
Public Method BeginDescribeLifecycleHookTypes(DescribeLifecycleHookTypesRequest, AsyncCallback, object) Initiates the asynchronous execution of the DescribeLifecycleHookTypes operation.
Public Method BeginDescribeLoadBalancers(DescribeLoadBalancersRequest, AsyncCallback, object) Initiates the asynchronous execution of the DescribeLoadBalancers operation.
Public Method BeginDescribeMetricCollectionTypes(DescribeMetricCollectionTypesRequest, AsyncCallback, object) Initiates the asynchronous execution of the DescribeMetricCollectionTypes operation.
Public Method BeginDescribeNotificationConfigurations(DescribeNotificationConfigurationsRequest, AsyncCallback, object) Initiates the asynchronous execution of the DescribeNotificationConfigurations operation.
Public Method BeginDescribePolicies(DescribePoliciesRequest, AsyncCallback, object) Initiates the asynchronous execution of the DescribePolicies operation.
Public Method BeginDescribeScalingActivities(DescribeScalingActivitiesRequest, AsyncCallback, object) Initiates the asynchronous execution of the DescribeScalingActivities operation.
Public Method BeginDescribeScalingProcessTypes(DescribeScalingProcessTypesRequest, AsyncCallback, object) Initiates the asynchronous execution of the DescribeScalingProcessTypes operation.
Public Method BeginDescribeScheduledActions(DescribeScheduledActionsRequest, AsyncCallback, object) Initiates the asynchronous execution of the DescribeScheduledActions operation.
Public Method BeginDescribeTags(DescribeTagsRequest, AsyncCallback, object) Initiates the asynchronous execution of the DescribeTags operation.
Public Method BeginDescribeTerminationPolicyTypes(DescribeTerminationPolicyTypesRequest, AsyncCallback, object) Initiates the asynchronous execution of the DescribeTerminationPolicyTypes operation.
Public Method BeginDetachInstances(DetachInstancesRequest, AsyncCallback, object) Initiates the asynchronous execution of the DetachInstances operation.
Public Method BeginDetachLoadBalancers(DetachLoadBalancersRequest, AsyncCallback, object) Initiates the asynchronous execution of the DetachLoadBalancers operation.
Public Method BeginDisableMetricsCollection(DisableMetricsCollectionRequest, AsyncCallback, object) Initiates the asynchronous execution of the DisableMetricsCollection operation.
Public Method BeginEnableMetricsCollection(EnableMetricsCollectionRequest, AsyncCallback, object) Initiates the asynchronous execution of the EnableMetricsCollection operation.
Public Method BeginEnterStandby(EnterStandbyRequest, AsyncCallback, object) Initiates the asynchronous execution of the EnterStandby operation.
Public Method BeginExecutePolicy(ExecutePolicyRequest, AsyncCallback, object) Initiates the asynchronous execution of the ExecutePolicy operation.
Public Method BeginExitStandby(ExitStandbyRequest, AsyncCallback, object) Initiates the asynchronous execution of the ExitStandby operation.
Public Method BeginPutLifecycleHook(PutLifecycleHookRequest, AsyncCallback, object) Initiates the asynchronous execution of the PutLifecycleHook operation.
Public Method BeginPutNotificationConfiguration(PutNotificationConfigurationRequest, AsyncCallback, object) Initiates the asynchronous execution of the PutNotificationConfiguration operation.
Public Method BeginPutScalingPolicy(PutScalingPolicyRequest, AsyncCallback, object) Initiates the asynchronous execution of the PutScalingPolicy operation.
Public Method BeginPutScheduledUpdateGroupAction(PutScheduledUpdateGroupActionRequest, AsyncCallback, object) Initiates the asynchronous execution of the PutScheduledUpdateGroupAction operation.
Public Method BeginRecordLifecycleActionHeartbeat(RecordLifecycleActionHeartbeatRequest, AsyncCallback, object) Initiates the asynchronous execution of the RecordLifecycleActionHeartbeat operation.
Public Method BeginResumeProcesses(ResumeProcessesRequest, AsyncCallback, object) Initiates the asynchronous execution of the ResumeProcesses operation.
Public Method BeginSetDesiredCapacity(SetDesiredCapacityRequest, AsyncCallback, object) Initiates the asynchronous execution of the SetDesiredCapacity operation.
Public Method BeginSetInstanceHealth(SetInstanceHealthRequest, AsyncCallback, object) Initiates the asynchronous execution of the SetInstanceHealth operation.
Public Method BeginSetInstanceProtection(SetInstanceProtectionRequest, AsyncCallback, object) Initiates the asynchronous execution of the SetInstanceProtection operation.
Public Method BeginSuspendProcesses(SuspendProcessesRequest, AsyncCallback, object) Initiates the asynchronous execution of the SuspendProcesses operation.
Public Method BeginTerminateInstanceInAutoScalingGroup(TerminateInstanceInAutoScalingGroupRequest, AsyncCallback, object) Initiates the asynchronous execution of the TerminateInstanceInAutoScalingGroup operation.
Public Method BeginUpdateAutoScalingGroup(UpdateAutoScalingGroupRequest, AsyncCallback, object) Initiates the asynchronous execution of the UpdateAutoScalingGroup operation.
Public Method CompleteLifecycleAction(CompleteLifecycleActionRequest) 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 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 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 Auto Scaling Developer Guide.

Public Method CreateAutoScalingGroup(CreateAutoScalingGroupRequest) Creates an Auto Scaling group with the specified name and attributes.

If you exceed your maximum limit of Auto Scaling groups, which by default is 20 per region, the call fails. For information about viewing and updating this limit, see DescribeAccountLimits.

For more information, see Auto Scaling Groups in the Auto Scaling Developer Guide.

Public Method CreateLaunchConfiguration(CreateLaunchConfigurationRequest) Creates a launch configuration.

If you exceed your maximum limit of launch configurations, which by default is 100 per region, the call fails. For information about viewing and updating this limit, see DescribeAccountLimits.

For more information, see Launch Configurations in the Auto Scaling Developer Guide.

Public Method CreateOrUpdateTags(CreateOrUpdateTagsRequest) 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 Auto Scaling Developer Guide.

Public Method DeleteAutoScalingGroup(DeleteAutoScalingGroupRequest) 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 DetachInstances with the list of instances and the option to decrement the desired capacity so that Auto Scaling does not launch replacement instances.

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

Public Method DeleteLaunchConfiguration(DeleteLaunchConfigurationRequest) 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.

Public Method DeleteLifecycleHook(DeleteLifecycleHookRequest) Deletes the specified lifecycle hook.

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

Public Method DeleteNotificationConfiguration(DeleteNotificationConfigurationRequest) Deletes the specified notification.
Public Method DeletePolicy(DeletePolicyRequest) Deletes the specified Auto Scaling policy.

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

Public Method DeleteScheduledAction(DeleteScheduledActionRequest) Deletes the specified scheduled action.
Public Method DeleteTags(DeleteTagsRequest) Deletes the specified tags.
Public Method DescribeAccountLimits() Describes the current Auto Scaling resource limits for your AWS account.

For information about requesting an increase in these limits, see AWS Service Limits in the Amazon Web Services General Reference.

Public Method DescribeAccountLimits(DescribeAccountLimitsRequest) Describes the current Auto Scaling resource limits for your AWS account.

For information about requesting an increase in these limits, see AWS Service Limits in the Amazon Web Services General Reference.

Public Method DescribeAdjustmentTypes() Describes the policy adjustment types for use with PutScalingPolicy.
Public Method DescribeAdjustmentTypes(DescribeAdjustmentTypesRequest) Describes the policy adjustment types for use with PutScalingPolicy.
Public Method DescribeAutoScalingGroups() Describes one or more Auto Scaling groups. If a list of names is not provided, the call describes all Auto Scaling groups.
Public Method DescribeAutoScalingGroups(DescribeAutoScalingGroupsRequest) Describes one or more Auto Scaling groups. If a list of names is not provided, the call describes all Auto Scaling groups.
Public Method DescribeAutoScalingInstances() Describes one or more Auto Scaling instances. If a list is not provided, the call describes all instances.
Public Method DescribeAutoScalingInstances(DescribeAutoScalingInstancesRequest) Describes one or more Auto Scaling instances. If a list is not provided, the call describes all instances.
Public Method DescribeAutoScalingNotificationTypes() Describes the notification types that are supported by Auto Scaling.
Public Method DescribeAutoScalingNotificationTypes(DescribeAutoScalingNotificationTypesRequest) Describes the notification types that are supported by Auto Scaling.
Public Method DescribeLaunchConfigurations() Describes one or more launch configurations. If you omit the list of names, then the call describes all launch configurations.
Public Method DescribeLaunchConfigurations(DescribeLaunchConfigurationsRequest) Describes one or more launch configurations. If you omit the list of names, then the call describes all launch configurations.
Public Method DescribeLifecycleHooks(DescribeLifecycleHooksRequest) Describes the lifecycle hooks for the specified Auto Scaling group.
Public Method DescribeLifecycleHookTypes(DescribeLifecycleHookTypesRequest) Describes the available types of lifecycle hooks.
Public Method DescribeLoadBalancers(DescribeLoadBalancersRequest) Describes the load balancers for the specified Auto Scaling group.
Public Method DescribeMetricCollectionTypes() Describes the available CloudWatch metrics for Auto Scaling.

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

Public Method DescribeMetricCollectionTypes(DescribeMetricCollectionTypesRequest) Describes the available CloudWatch metrics for Auto Scaling.

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

Public Method DescribeNotificationConfigurations() Describes the notification actions associated with the specified Auto Scaling group.
Public Method DescribeNotificationConfigurations(DescribeNotificationConfigurationsRequest) Describes the notification actions associated with the specified Auto Scaling group.
Public Method DescribePolicies() Describes the policies for the specified Auto Scaling group.
Public Method DescribePolicies(DescribePoliciesRequest) Describes the policies for the specified Auto Scaling group.
Public Method DescribeScalingActivities(DescribeScalingActivitiesRequest) Describes one or more scaling activities for the specified Auto Scaling group. If you omit the ActivityIds, the call returns all activities from the past six weeks. Activities are sorted by the start time. Activities still in progress appear first on the list.
Public Method DescribeScalingActivities() Describes one or more scaling activities for the specified Auto Scaling group. If you omit the ActivityIds, the call returns all activities from the past six weeks. Activities are sorted by the start time. Activities still in progress appear first on the list.
Public Method DescribeScalingProcessTypes() Describes the scaling process types for use with ResumeProcesses and SuspendProcesses.
Public Method DescribeScalingProcessTypes(DescribeScalingProcessTypesRequest) Describes the scaling process types for use with ResumeProcesses and SuspendProcesses.
Public Method DescribeScheduledActions() Describes the actions scheduled for your Auto Scaling group that haven't run. To describe the actions that have already run, use DescribeScalingActivities.
Public Method DescribeScheduledActions(DescribeScheduledActionsRequest) Describes the actions scheduled for your Auto Scaling group that haven't run. To describe the actions that have already run, use DescribeScalingActivities.
Public Method DescribeTags() 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.

Public Method DescribeTags(DescribeTagsRequest) 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.

Public Method DescribeTerminationPolicyTypes() Describes the termination policies supported by Auto Scaling.
Public Method DescribeTerminationPolicyTypes(DescribeTerminationPolicyTypesRequest) Describes the termination policies supported by Auto Scaling.
Public Method DetachInstances(DetachInstancesRequest) Removes one or more instances from the specified Auto Scaling group.

After the instances are detached, you can manage them independently from the rest of the Auto Scaling group.

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

For more information, see Detach EC2 Instances from Your Auto Scaling Group in the Auto Scaling Developer Guide.

Public Method DetachLoadBalancers(DetachLoadBalancersRequest) Removes one or more load balancers from the specified Auto Scaling group.

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 DescribeLoadBalancers. Note that the instances remain running.

Public Method DisableMetricsCollection(DisableMetricsCollectionRequest) Disables monitoring of the specified metrics for the specified Auto Scaling group.
Public Method EnableMetricsCollection(EnableMetricsCollectionRequest) Enables monitoring of the specified metrics for the specified Auto Scaling group.

You can only enable metrics collection if InstanceMonitoring in the launch configuration for the group is set to True.

Public Method EndAttachInstances(IAsyncResult) Finishes the asynchronous execution of the AttachInstances operation.
Public Method EndAttachLoadBalancers(IAsyncResult) Finishes the asynchronous execution of the AttachLoadBalancers operation.
Public Method EndCompleteLifecycleAction(IAsyncResult) Finishes the asynchronous execution of the CompleteLifecycleAction operation.
Public Method EndCreateAutoScalingGroup(IAsyncResult) Finishes the asynchronous execution of the CreateAutoScalingGroup operation.
Public Method EndCreateLaunchConfiguration(IAsyncResult) Finishes the asynchronous execution of the CreateLaunchConfiguration operation.
Public Method EndCreateOrUpdateTags(IAsyncResult) Finishes the asynchronous execution of the CreateOrUpdateTags operation.
Public Method EndDeleteAutoScalingGroup(IAsyncResult) Finishes the asynchronous execution of the DeleteAutoScalingGroup operation.
Public Method EndDeleteLaunchConfiguration(IAsyncResult) Finishes the asynchronous execution of the DeleteLaunchConfiguration operation.
Public Method EndDeleteLifecycleHook(IAsyncResult) Finishes the asynchronous execution of the DeleteLifecycleHook operation.
Public Method EndDeleteNotificationConfiguration(IAsyncResult) Finishes the asynchronous execution of the DeleteNotificationConfiguration operation.
Public Method EndDeletePolicy(IAsyncResult) Finishes the asynchronous execution of the DeletePolicy operation.
Public Method EndDeleteScheduledAction(IAsyncResult) Finishes the asynchronous execution of the DeleteScheduledAction operation.
Public Method EndDeleteTags(IAsyncResult) Finishes the asynchronous execution of the DeleteTags operation.
Public Method EndDescribeAccountLimits(IAsyncResult) Finishes the asynchronous execution of the DescribeAccountLimits operation.
Public Method EndDescribeAdjustmentTypes(IAsyncResult) Finishes the asynchronous execution of the DescribeAdjustmentTypes operation.
Public Method EndDescribeAutoScalingGroups(IAsyncResult) Finishes the asynchronous execution of the DescribeAutoScalingGroups operation.
Public Method EndDescribeAutoScalingInstances(IAsyncResult) Finishes the asynchronous execution of the DescribeAutoScalingInstances operation.
Public Method EndDescribeAutoScalingNotificationTypes(IAsyncResult) Finishes the asynchronous execution of the DescribeAutoScalingNotificationTypes operation.
Public Method EndDescribeLaunchConfigurations(IAsyncResult) Finishes the asynchronous execution of the DescribeLaunchConfigurations operation.
Public Method EndDescribeLifecycleHooks(IAsyncResult) Finishes the asynchronous execution of the DescribeLifecycleHooks operation.
Public Method EndDescribeLifecycleHookTypes(IAsyncResult) Finishes the asynchronous execution of the DescribeLifecycleHookTypes operation.
Public Method EndDescribeLoadBalancers(IAsyncResult) Finishes the asynchronous execution of the DescribeLoadBalancers operation.
Public Method EndDescribeMetricCollectionTypes(IAsyncResult) Finishes the asynchronous execution of the DescribeMetricCollectionTypes operation.
Public Method EndDescribeNotificationConfigurations(IAsyncResult) Finishes the asynchronous execution of the DescribeNotificationConfigurations operation.
Public Method EndDescribePolicies(IAsyncResult) Finishes the asynchronous execution of the DescribePolicies operation.
Public Method EndDescribeScalingActivities(IAsyncResult) Finishes the asynchronous execution of the DescribeScalingActivities operation.
Public Method EndDescribeScalingProcessTypes(IAsyncResult) Finishes the asynchronous execution of the DescribeScalingProcessTypes operation.
Public Method EndDescribeScheduledActions(IAsyncResult) Finishes the asynchronous execution of the DescribeScheduledActions operation.
Public Method EndDescribeTags(IAsyncResult) Finishes the asynchronous execution of the DescribeTags operation.
Public Method EndDescribeTerminationPolicyTypes(IAsyncResult) Finishes the asynchronous execution of the DescribeTerminationPolicyTypes operation.
Public Method EndDetachInstances(IAsyncResult) Finishes the asynchronous execution of the DetachInstances operation.
Public Method EndDetachLoadBalancers(IAsyncResult) Finishes the asynchronous execution of the DetachLoadBalancers operation.
Public Method EndDisableMetricsCollection(IAsyncResult) Finishes the asynchronous execution of the DisableMetricsCollection operation.
Public Method EndEnableMetricsCollection(IAsyncResult) Finishes the asynchronous execution of the EnableMetricsCollection operation.
Public Method EndEnterStandby(IAsyncResult) Finishes the asynchronous execution of the EnterStandby operation.
Public Method EndExecutePolicy(IAsyncResult) Finishes the asynchronous execution of the ExecutePolicy operation.
Public Method EndExitStandby(IAsyncResult) Finishes the asynchronous execution of the ExitStandby operation.
Public Method EndPutLifecycleHook(IAsyncResult) Finishes the asynchronous execution of the PutLifecycleHook operation.
Public Method EndPutNotificationConfiguration(IAsyncResult) Finishes the asynchronous execution of the PutNotificationConfiguration operation.
Public Method EndPutScalingPolicy(IAsyncResult) Finishes the asynchronous execution of the PutScalingPolicy operation.
Public Method EndPutScheduledUpdateGroupAction(IAsyncResult) Finishes the asynchronous execution of the PutScheduledUpdateGroupAction operation.
Public Method EndRecordLifecycleActionHeartbeat(IAsyncResult) Finishes the asynchronous execution of the RecordLifecycleActionHeartbeat operation.
Public Method EndResumeProcesses(IAsyncResult) Finishes the asynchronous execution of the ResumeProcesses operation.
Public Method EndSetDesiredCapacity(IAsyncResult) Finishes the asynchronous execution of the SetDesiredCapacity operation.
Public Method EndSetInstanceHealth(IAsyncResult) Finishes the asynchronous execution of the SetInstanceHealth operation.
Public Method EndSetInstanceProtection(IAsyncResult) Finishes the asynchronous execution of the SetInstanceProtection operation.
Public Method EndSuspendProcesses(IAsyncResult) Finishes the asynchronous execution of the SuspendProcesses operation.
Public Method EndTerminateInstanceInAutoScalingGroup(IAsyncResult) Finishes the asynchronous execution of the TerminateInstanceInAutoScalingGroup operation.
Public Method EndUpdateAutoScalingGroup(IAsyncResult) Finishes the asynchronous execution of the UpdateAutoScalingGroup operation.
Public Method EnterStandby(EnterStandbyRequest) Moves the specified instances into Standby mode.

For more information, see Auto Scaling Lifecycle in the Auto Scaling Developer Guide.

Public Method ExecutePolicy(ExecutePolicyRequest) Executes the specified policy.
Public Method ExitStandby(ExitStandbyRequest) Moves the specified instances out of Standby mode.

For more information, see Auto Scaling Lifecycle in the Auto Scaling Developer Guide.

Public Method PutLifecycleHook(PutLifecycleHookRequest) Creates or updates a lifecycle hook for the specified Auto Scaling Group.

A lifecycle hook tells Auto Scaling that you want to perform an action on an instance that is not actively in service; for example, either when the instance launches or before the instance terminates.

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 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 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 Auto Scaling Developer Guide.

If you exceed your maximum limit of lifecycle hooks, which by default is 50 per region, the call fails. For information about updating this limit, see AWS Service Limits in the Amazon Web Services General Reference.

Public Method PutNotificationConfiguration(PutNotificationConfigurationRequest) Configures an Auto Scaling group to send notifications when specified events take place. Subscribers to this topic can have messages for events delivered to an endpoint such as a web server or email address.

For more information see Getting Notifications When Your Auto Scaling Group Changes in the Auto Scaling Developer Guide.

This configuration overwrites an existing configuration.

Public Method PutScalingPolicy(PutScalingPolicyRequest) Creates or updates a policy for an Auto Scaling group. To update an existing policy, use the existing policy name and set the parameters you want to change. Any existing parameter not changed in an update to an existing policy is not changed in this update request.

If you exceed your maximum limit of step adjustments, which by default is 20 per region, the call fails. For information about updating this limit, see AWS Service Limits in the Amazon Web Services General Reference.

Public Method PutScheduledUpdateGroupAction(PutScheduledUpdateGroupActionRequest) Creates or updates a scheduled scaling action for an Auto Scaling group. When updating a scheduled scaling action, if you leave a parameter unspecified, the corresponding value remains unchanged in the affected Auto Scaling group.

For more information, see Scheduled Scaling in the Auto Scaling Developer Guide.

Public Method RecordLifecycleActionHeartbeat(RecordLifecycleActionHeartbeatRequest) 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 PutLifecycleHook.

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 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 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 Auto Scaling Developer Guide.

Public Method ResumeProcesses(ResumeProcessesRequest) Resumes the specified suspended Auto Scaling processes, or all suspended process, for the specified Auto Scaling group.

For more information, see Suspending and Resuming Auto Scaling Processes in the Auto Scaling Developer Guide.

Public Method SetDesiredCapacity(SetDesiredCapacityRequest) Sets the size of the specified Auto Scaling group.

For more information about desired capacity, see What Is Auto Scaling? in the Auto Scaling Developer Guide.

Public Method SetInstanceHealth(SetInstanceHealthRequest) Sets the health status of the specified instance.

For more information, see Health Checks in the Auto Scaling Developer Guide.

Public Method SetInstanceProtection(SetInstanceProtectionRequest) Updates the instance protection settings of the specified instances.

For more information, see Instance Protection in the Auto Scaling Developer Guide.

Public Method SuspendProcesses(SuspendProcessesRequest) Suspends the specified Auto Scaling processes, or all processes, for the specified Auto Scaling group.

Note that if you suspend either the Launch or Terminate process types, it can prevent other process types from functioning properly.

To resume processes that have been suspended, use ResumeProcesses.

For more information, see Suspending and Resuming Auto Scaling Processes in the Auto Scaling Developer Guide.

Public Method TerminateInstanceInAutoScalingGroup(TerminateInstanceInAutoScalingGroupRequest) Terminates the specified instance and optionally adjusts the desired group size.

This call simply makes a termination request. The instance is not terminated immediately.

Public Method UpdateAutoScalingGroup(UpdateAutoScalingGroupRequest) Updates the configuration for the specified Auto Scaling group.

To update an Auto Scaling group with a launch configuration with InstanceMonitoring set to False, you must first disable the collection of group metrics. Otherwise, you will get an error. If you have previously enabled the collection of group metrics, you can disable it using DisableMetricsCollection.

The new settings are registered upon the completion of this call. Any launch configuration settings take effect on any triggers after this call returns. Scaling activities that are currently in progress aren't affected.

Note the following:

  • 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, we implicitly call SetDesiredCapacity to set the size of the group to the new value of MinSize.

  • 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, we implicitly call SetDesiredCapacity to set the size of the group to the new value of MaxSize.

  • All other optional parameters are left unchanged if not specified.

Version Information

.NET Framework:
Supported in: 4.5, 4.0, 3.5

.NET for Windows Store apps:
Supported in: Windows 8.1, Windows 8

.NET for Windows Phone:
Supported in: Windows Phone 8.1, Windows Phone 8