AWS SDK Version 3 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.

Interface for accessing AutoScaling Amazon EC2 Auto Scaling

Amazon EC2 Auto Scaling is designed to automatically launch or terminate EC2 instances based on user-defined scaling policies, scheduled actions, and health checks. Use this service with AWS Auto Scaling, Amazon CloudWatch, and Elastic Load Balancing.

For more information, including information about granting IAM users required permissions for Amazon EC2 Auto Scaling actions, see the Amazon EC2 Auto Scaling User Guide.

Inheritance Hierarchy

Amazon.AutoScaling.IAmazonAutoScaling

Namespace: Amazon.AutoScaling
Assembly: AWSSDK.AutoScaling.dll
Version: 3.x.y.z

Syntax

C#
public interface IAmazonAutoScaling
         IAmazonService, IDisposable

The IAmazonAutoScaling type exposes the following members

Methods

Note:

Asynchronous operations (methods ending with Async) in the table below are for .NET 4.5 or higher. For .NET 3.5 the SDK follows the standard naming convention of BeginMethodName and EndMethodName to indicate asynchronous operations - these method pairs are not shown in the table below.

NameDescription
Public Method AttachInstances(AttachInstancesRequest)

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

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

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

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

Public Method AttachInstancesAsync(AttachInstancesRequest, CancellationToken)

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

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

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

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

Public Method AttachLoadBalancers(AttachLoadBalancersRequest)

Attaches one or more Classic Load Balancers to the specified Auto Scaling group.

To attach an Application Load Balancer or a Network Load Balancer instead, see AttachLoadBalancerTargetGroups.

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 Attaching a Load Balancer to Your Auto Scaling Group in the Amazon EC2 Auto Scaling User Guide.

Public Method AttachLoadBalancersAsync(AttachLoadBalancersRequest, CancellationToken)

Attaches one or more Classic Load Balancers to the specified Auto Scaling group.

To attach an Application Load Balancer or a Network Load Balancer instead, see AttachLoadBalancerTargetGroups.

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 Attaching a Load Balancer to Your Auto Scaling Group in the Amazon EC2 Auto Scaling User Guide.

Public Method AttachLoadBalancerTargetGroups(AttachLoadBalancerTargetGroupsRequest)

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

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

With Application Load Balancers and Network Load Balancers, instances are registered as targets with a target group. With Classic Load Balancers, instances are registered with the load balancer. For more information, see Attaching a Load Balancer to Your Auto Scaling Group in the Amazon EC2 Auto Scaling User Guide.

Public Method AttachLoadBalancerTargetGroupsAsync(AttachLoadBalancerTargetGroupsRequest, CancellationToken)

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

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

With Application Load Balancers and Network Load Balancers, instances are registered as targets with a target group. With Classic Load Balancers, instances are registered with the load balancer. For more information, see Attaching a Load Balancer to Your Auto Scaling Group in the Amazon EC2 Auto Scaling User Guide.

Public Method BatchDeleteScheduledAction(BatchDeleteScheduledActionRequest)

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

Public Method BatchDeleteScheduledActionAsync(BatchDeleteScheduledActionRequest, CancellationToken)

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

Public Method BatchPutScheduledUpdateGroupAction(BatchPutScheduledUpdateGroupActionRequest)

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

Public Method BatchPutScheduledUpdateGroupActionAsync(BatchPutScheduledUpdateGroupActionRequest, CancellationToken)

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

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 Amazon EC2 Auto Scaling launches or terminates instances.

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

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

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

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

For more information, see Amazon EC2 Auto Scaling Lifecycle Hooks in the Amazon EC2 Auto Scaling User Guide.

Public Method CompleteLifecycleActionAsync(CompleteLifecycleActionRequest, CancellationToken)

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

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

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

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

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

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

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

For more information, see Amazon EC2 Auto Scaling Lifecycle Hooks in the Amazon EC2 Auto Scaling User Guide.

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, the call fails. For information about viewing this limit, see DescribeAccountLimits. For information about updating this limit, see Amazon EC2 Auto Scaling Service Quotas in the Amazon EC2 Auto Scaling User Guide.

Public Method CreateAutoScalingGroupAsync(CreateAutoScalingGroupRequest, CancellationToken)

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

If you exceed your maximum limit of Auto Scaling groups, the call fails. For information about viewing this limit, see DescribeAccountLimits. For information about updating this limit, see Amazon EC2 Auto Scaling Service Quotas in the Amazon EC2 Auto Scaling User Guide.

Public Method CreateLaunchConfiguration(CreateLaunchConfigurationRequest)

Creates a launch configuration.

If you exceed your maximum limit of launch configurations, the call fails. For information about viewing this limit, see DescribeAccountLimits. For information about updating this limit, see Amazon EC2 Auto Scaling Service Quotas in the Amazon EC2 Auto Scaling User Guide.

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

Public Method CreateLaunchConfigurationAsync(CreateLaunchConfigurationRequest, CancellationToken)

Creates a launch configuration.

If you exceed your maximum limit of launch configurations, the call fails. For information about viewing this limit, see DescribeAccountLimits. For information about updating this limit, see Amazon EC2 Auto Scaling Service Quotas in the Amazon EC2 Auto Scaling User Guide.

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

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 Amazon EC2 Auto Scaling User Guide.

Public Method CreateOrUpdateTagsAsync(CreateOrUpdateTagsRequest, CancellationToken)

Creates or updates tags for the specified Auto Scaling group.

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

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

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. This ensures that Amazon EC2 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 DeleteAutoScalingGroupAsync(DeleteAutoScalingGroupRequest, CancellationToken)

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. This ensures that Amazon EC2 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 DeleteLaunchConfigurationAsync(DeleteLaunchConfigurationRequest, CancellationToken)

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 DeleteLifecycleHookAsync(DeleteLifecycleHookRequest, CancellationToken)

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 DeleteNotificationConfigurationAsync(DeleteNotificationConfigurationRequest, CancellationToken)

Deletes the specified notification.

Public Method DeletePolicy(DeletePolicyRequest)

Deletes the specified scaling policy.

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

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

Public Method DeletePolicyAsync(DeletePolicyRequest, CancellationToken)

Deletes the specified scaling policy.

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

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

Public Method DeleteScheduledAction(DeleteScheduledActionRequest)

Deletes the specified scheduled action.

Public Method DeleteScheduledActionAsync(DeleteScheduledActionRequest, CancellationToken)

Deletes the specified scheduled action.

Public Method DeleteTags(DeleteTagsRequest)

Deletes the specified tags.

Public Method DeleteTagsAsync(DeleteTagsRequest, CancellationToken)

Deletes the specified tags.

Public Method DescribeAccountLimits()

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

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

Public Method DescribeAccountLimits(DescribeAccountLimitsRequest)

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

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

Public Method DescribeAccountLimitsAsync(CancellationToken)

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

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

Public Method DescribeAccountLimitsAsync(DescribeAccountLimitsRequest, CancellationToken)

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

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

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 DescribeAdjustmentTypesAsync(CancellationToken)

Describes the policy adjustment types for use with PutScalingPolicy.

Public Method DescribeAdjustmentTypesAsync(DescribeAdjustmentTypesRequest, CancellationToken)

Describes the policy adjustment types for use with PutScalingPolicy.

Public Method DescribeAutoScalingGroups()

Describes one or more Auto Scaling groups.

Public Method DescribeAutoScalingGroups(DescribeAutoScalingGroupsRequest)

Describes one or more Auto Scaling groups.

Public Method DescribeAutoScalingGroupsAsync(CancellationToken)

Describes one or more Auto Scaling groups.

Public Method DescribeAutoScalingGroupsAsync(DescribeAutoScalingGroupsRequest, CancellationToken)

Describes one or more Auto Scaling groups.

Public Method DescribeAutoScalingInstances()

Describes one or more Auto Scaling instances.

Public Method DescribeAutoScalingInstances(DescribeAutoScalingInstancesRequest)

Describes one or more Auto Scaling instances.

Public Method DescribeAutoScalingInstancesAsync(CancellationToken)

Describes one or more Auto Scaling instances.

Public Method DescribeAutoScalingInstancesAsync(DescribeAutoScalingInstancesRequest, CancellationToken)

Describes one or more Auto Scaling instances.

Public Method DescribeAutoScalingNotificationTypes()

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

Public Method DescribeAutoScalingNotificationTypes(DescribeAutoScalingNotificationTypesRequest)

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

Public Method DescribeAutoScalingNotificationTypesAsync(CancellationToken)

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

Public Method DescribeAutoScalingNotificationTypesAsync(DescribeAutoScalingNotificationTypesRequest, CancellationToken)

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

Public Method DescribeLaunchConfigurations()

Describes one or more launch configurations.

Public Method DescribeLaunchConfigurations(DescribeLaunchConfigurationsRequest)

Describes one or more launch configurations.

Public Method DescribeLaunchConfigurationsAsync(CancellationToken)

Describes one or more launch configurations.

Public Method DescribeLaunchConfigurationsAsync(DescribeLaunchConfigurationsRequest, CancellationToken)

Describes one or more launch configurations.

Public Method DescribeLifecycleHooks(DescribeLifecycleHooksRequest)

Describes the lifecycle hooks for the specified Auto Scaling group.

Public Method DescribeLifecycleHooksAsync(DescribeLifecycleHooksRequest, CancellationToken)

Describes the lifecycle hooks for the specified Auto Scaling group.

Public Method DescribeLifecycleHookTypes(DescribeLifecycleHookTypesRequest)

Describes the available types of lifecycle hooks.

The following hook types are supported:

  • autoscaling:EC2_INSTANCE_LAUNCHING

  • autoscaling:EC2_INSTANCE_TERMINATING

Public Method DescribeLifecycleHookTypesAsync(DescribeLifecycleHookTypesRequest, CancellationToken)

Describes the available types of lifecycle hooks.

The following hook types are supported:

  • autoscaling:EC2_INSTANCE_LAUNCHING

  • autoscaling:EC2_INSTANCE_TERMINATING

Public Method DescribeLoadBalancers(DescribeLoadBalancersRequest)

Describes the load balancers for the specified Auto Scaling group.

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

Public Method DescribeLoadBalancersAsync(DescribeLoadBalancersRequest, CancellationToken)

Describes the load balancers for the specified Auto Scaling group.

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

Public Method DescribeLoadBalancerTargetGroups(DescribeLoadBalancerTargetGroupsRequest)

Describes the target groups for the specified Auto Scaling group.

Public Method DescribeLoadBalancerTargetGroupsAsync(DescribeLoadBalancerTargetGroupsRequest, CancellationToken)

Describes the target groups for the specified Auto Scaling group.

Public Method DescribeMetricCollectionTypes()

Describes the available CloudWatch metrics for Amazon EC2 Auto Scaling.

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

Public Method DescribeMetricCollectionTypes(DescribeMetricCollectionTypesRequest)

Describes the available CloudWatch metrics for Amazon EC2 Auto Scaling.

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

Public Method DescribeMetricCollectionTypesAsync(CancellationToken)

Describes the available CloudWatch metrics for Amazon EC2 Auto Scaling.

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

Public Method DescribeMetricCollectionTypesAsync(DescribeMetricCollectionTypesRequest, CancellationToken)

Describes the available CloudWatch metrics for Amazon EC2 Auto Scaling.

The GroupStandbyInstances metric is not returned by default. You must explicitly request this metric when calling 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 DescribeNotificationConfigurationsAsync(CancellationToken)

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

Public Method DescribeNotificationConfigurationsAsync(DescribeNotificationConfigurationsRequest, CancellationToken)

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 DescribePoliciesAsync(CancellationToken)

Describes the policies for the specified Auto Scaling group.

Public Method DescribePoliciesAsync(DescribePoliciesRequest, CancellationToken)

Describes the policies for the specified Auto Scaling group.

Public Method DescribeScalingActivities()

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

Public Method DescribeScalingActivities(DescribeScalingActivitiesRequest)

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

Public Method DescribeScalingActivitiesAsync(CancellationToken)

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

Public Method DescribeScalingActivitiesAsync(DescribeScalingActivitiesRequest, CancellationToken)

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

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 DescribeScalingProcessTypesAsync(CancellationToken)

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

Public Method DescribeScalingProcessTypesAsync(DescribeScalingProcessTypesRequest, CancellationToken)

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

Public Method DescribeScheduledActions(DescribeScheduledActionsRequest)

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

Public Method DescribeScheduledActions()

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

Public Method DescribeScheduledActionsAsync(CancellationToken)

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

Public Method DescribeScheduledActionsAsync(DescribeScheduledActionsRequest, CancellationToken)

Describes the actions scheduled for your Auto Scaling group that haven't run or that have not reached their end time. To describe the actions that have already run, 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 DescribeTagsAsync(CancellationToken)

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 DescribeTagsAsync(DescribeTagsRequest, CancellationToken)

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 Amazon EC2 Auto Scaling.

For more information, see Controlling Which Auto Scaling Instances Terminate During Scale In in the Amazon EC2 Auto Scaling User Guide.

Public Method DescribeTerminationPolicyTypes(DescribeTerminationPolicyTypesRequest)

Describes the termination policies supported by Amazon EC2 Auto Scaling.

For more information, see Controlling Which Auto Scaling Instances Terminate During Scale In in the Amazon EC2 Auto Scaling User Guide.

Public Method DescribeTerminationPolicyTypesAsync(CancellationToken)

Describes the termination policies supported by Amazon EC2 Auto Scaling.

For more information, see Controlling Which Auto Scaling Instances Terminate During Scale In in the Amazon EC2 Auto Scaling User Guide.

Public Method DescribeTerminationPolicyTypesAsync(DescribeTerminationPolicyTypesRequest, CancellationToken)

Describes the termination policies supported by Amazon EC2 Auto Scaling.

For more information, see Controlling Which Auto Scaling Instances Terminate During Scale In in the Amazon EC2 Auto Scaling User Guide.

Public Method DetachInstances(DetachInstancesRequest)

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

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

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

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

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

Public Method DetachInstancesAsync(DetachInstancesRequest, CancellationToken)

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

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

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

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

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

Public Method DetachLoadBalancers(DetachLoadBalancersRequest)

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

Public Method DetachLoadBalancersAsync(DetachLoadBalancersRequest, CancellationToken)

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

Public Method DetachLoadBalancerTargetGroups(DetachLoadBalancerTargetGroupsRequest)

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

Public Method DetachLoadBalancerTargetGroupsAsync(DetachLoadBalancerTargetGroupsRequest, CancellationToken)

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

Public Method DisableMetricsCollection(DisableMetricsCollectionRequest)

Disables group metrics for the specified Auto Scaling group.

Public Method DisableMetricsCollectionAsync(DisableMetricsCollectionRequest, CancellationToken)

Disables group metrics for the specified Auto Scaling group.

Public Method EnableMetricsCollection(EnableMetricsCollectionRequest)

Enables group metrics for the specified Auto Scaling group. For more information, see Monitoring Your Auto Scaling Groups and Instances in the Amazon EC2 Auto Scaling User Guide.

Public Method EnableMetricsCollectionAsync(EnableMetricsCollectionRequest, CancellationToken)

Enables group metrics for the specified Auto Scaling group. For more information, see Monitoring Your Auto Scaling Groups and Instances in the Amazon EC2 Auto Scaling User Guide.

Public Method EnterStandby(EnterStandbyRequest)

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.

Public Method EnterStandbyAsync(EnterStandbyRequest, CancellationToken)

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.

Public Method ExecutePolicy(ExecutePolicyRequest)

Executes the specified policy.

Public Method ExecutePolicyAsync(ExecutePolicyRequest, CancellationToken)

Executes the specified policy.

Public Method ExitStandby(ExitStandbyRequest)

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.

Public Method ExitStandbyAsync(ExitStandbyRequest, CancellationToken)

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.

Public Method PutLifecycleHook(PutLifecycleHookRequest)

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

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

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

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

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

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

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

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

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 DescribeLifecycleHooks. If you are no longer using a lifecycle hook, you can delete it using DeleteLifecycleHook.

Public Method PutLifecycleHookAsync(PutLifecycleHookRequest, CancellationToken)

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

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

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

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

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

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

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

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

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 DescribeLifecycleHooks. If you are no longer using a lifecycle hook, you can delete it using DeleteLifecycleHook.

Public Method PutNotificationConfiguration(PutNotificationConfigurationRequest)

Configures an Auto Scaling group to send notifications when specified events take place. Subscribers to the specified topic can have messages delivered to an endpoint such as a web server or an email address.

This configuration overwrites any existing configuration.

For more information, see Getting Amazon SNS Notifications When Your Auto Scaling Group Scales in the Amazon EC2 Auto Scaling User Guide.

Public Method PutNotificationConfigurationAsync(PutNotificationConfigurationRequest, CancellationToken)

Configures an Auto Scaling group to send notifications when specified events take place. Subscribers to the specified topic can have messages delivered to an endpoint such as a web server or an email address.

This configuration overwrites any existing configuration.

For more information, see Getting Amazon SNS Notifications When Your Auto Scaling Group Scales in the Amazon EC2 Auto Scaling User Guide.

Public Method PutScalingPolicy(PutScalingPolicyRequest)

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

For more information about using scaling policies to scale your Auto Scaling group automatically, see Dynamic Scaling in the Amazon EC2 Auto Scaling User Guide.

Public Method PutScalingPolicyAsync(PutScalingPolicyRequest, CancellationToken)

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

For more information about using scaling policies to scale your Auto Scaling group automatically, see Dynamic Scaling in the Amazon EC2 Auto Scaling User Guide.

Public Method PutScheduledUpdateGroupAction(PutScheduledUpdateGroupActionRequest)

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

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

Public Method PutScheduledUpdateGroupActionAsync(PutScheduledUpdateGroupActionRequest, CancellationToken)

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

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

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 Amazon EC2 Auto Scaling launches or terminates instances.

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

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

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

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

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

Public Method RecordLifecycleActionHeartbeatAsync(RecordLifecycleActionHeartbeatRequest, CancellationToken)

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 Amazon EC2 Auto Scaling launches or terminates instances.

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

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

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

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

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

Public Method ResumeProcesses(ResumeProcessesRequest)

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

For more information, see Suspending and Resuming Scaling Processes in the Amazon EC2 Auto Scaling User Guide.

Public Method ResumeProcessesAsync(ResumeProcessesRequest, CancellationToken)

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

For more information, see Suspending and Resuming Scaling Processes in the Amazon EC2 Auto Scaling User Guide.

Public Method SetDesiredCapacity(SetDesiredCapacityRequest)

Sets the size of the specified Auto Scaling group.

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

Public Method SetDesiredCapacityAsync(SetDesiredCapacityRequest, CancellationToken)

Sets the size of the specified Auto Scaling group.

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

Public Method SetInstanceHealth(SetInstanceHealthRequest)

Sets the health status of the specified instance.

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

Public Method SetInstanceHealthAsync(SetInstanceHealthRequest, CancellationToken)

Sets the health status of the specified instance.

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

Public Method SetInstanceProtection(SetInstanceProtectionRequest)

Updates the instance protection settings of the specified instances.

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

Public Method SetInstanceProtectionAsync(SetInstanceProtectionRequest, CancellationToken)

Updates the instance protection settings of the specified instances.

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

Public Method SuspendProcesses(SuspendProcessesRequest)

Suspends the specified automatic 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.

To resume processes that have been suspended, use ResumeProcesses.

For more information, see Suspending and Resuming Scaling Processes in the Amazon EC2 Auto Scaling User Guide.

Public Method SuspendProcessesAsync(SuspendProcessesRequest, CancellationToken)

Suspends the specified automatic 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.

To resume processes that have been suspended, use ResumeProcesses.

For more information, see Suspending and Resuming Scaling Processes in the Amazon EC2 Auto Scaling User 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. When an instance is terminated, the instance status changes to terminated. You can't connect to or start an instance after you've terminated it.

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

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

Public Method TerminateInstanceInAutoScalingGroupAsync(TerminateInstanceInAutoScalingGroupRequest, CancellationToken)

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

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

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

Public Method UpdateAutoScalingGroup(UpdateAutoScalingGroupRequest)

Updates the configuration for the specified Auto Scaling group.

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

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

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

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

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

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

To see which parameters have been set, use DescribeAutoScalingGroups. You can also view the scaling policies for an Auto Scaling group using DescribePolicies. If the group has scaling policies, you can update them using PutScalingPolicy.

Public Method UpdateAutoScalingGroupAsync(UpdateAutoScalingGroupRequest, CancellationToken)

Updates the configuration for the specified Auto Scaling group.

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

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

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

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

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

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

To see which parameters have been set, use DescribeAutoScalingGroups. You can also view the scaling policies for an Auto Scaling group using DescribePolicies. If the group has scaling policies, you can update them using PutScalingPolicy.

Version Information

.NET Standard:
Supported in: 1.3

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

Portable Class Library:
Supported in: Windows Store Apps
Supported in: Windows Phone 8.1
Supported in: Xamarin Android
Supported in: Xamarin iOS (Unified)
Supported in: Xamarin.Forms