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

Public Method AttachInstancesAsync(AttachInstancesRequest, CancellationToken)

Initiates the asynchronous execution of the AttachInstances operation.

Public Method AttachLoadBalancers(AttachLoadBalancersRequest)

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

To attach an Application 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 Attach a Load Balancer to Your Auto Scaling Group in the Auto Scaling User Guide.

Public Method AttachLoadBalancersAsync(AttachLoadBalancersRequest, CancellationToken)

Initiates the asynchronous execution of the AttachLoadBalancers operation.

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.

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

Public Method AttachLoadBalancerTargetGroupsAsync(AttachLoadBalancerTargetGroupsRequest, CancellationToken)

Initiates the asynchronous execution of the AttachLoadBalancerTargetGroups 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 User Guide.

Public Method CompleteLifecycleActionAsync(CompleteLifecycleActionRequest, CancellationToken)

Initiates the asynchronous execution of the CompleteLifecycleAction operation.

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 User Guide.

Public Method CreateAutoScalingGroupAsync(CreateAutoScalingGroupRequest, CancellationToken)

Initiates the asynchronous execution of the CreateAutoScalingGroup operation.

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 User Guide.

Public Method CreateLaunchConfigurationAsync(CreateLaunchConfigurationRequest, CancellationToken)

Initiates the asynchronous execution of the CreateLaunchConfiguration operation.

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 User Guide.

Public Method CreateOrUpdateTagsAsync(CreateOrUpdateTagsRequest, CancellationToken)

Initiates the asynchronous execution of the CreateOrUpdateTags operation.

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 DeleteAutoScalingGroupAsync(DeleteAutoScalingGroupRequest, CancellationToken)

Initiates the asynchronous execution of the DeleteAutoScalingGroup operation.

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)

Initiates the asynchronous execution of the DeleteLaunchConfiguration operation.

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)

Initiates the asynchronous execution of the DeleteLifecycleHook operation.

Public Method DeleteNotificationConfiguration(DeleteNotificationConfigurationRequest)

Deletes the specified notification.

Public Method DeleteNotificationConfigurationAsync(DeleteNotificationConfigurationRequest, CancellationToken)

Initiates the asynchronous execution of the DeleteNotificationConfiguration operation.

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 DeletePolicyAsync(DeletePolicyRequest, CancellationToken)

Initiates the asynchronous execution of the DeletePolicy operation.

Public Method DeleteScheduledAction(DeleteScheduledActionRequest)

Deletes the specified scheduled action.

Public Method DeleteScheduledActionAsync(DeleteScheduledActionRequest, CancellationToken)

Initiates the asynchronous execution of the DeleteScheduledAction operation.

Public Method DeleteTags(DeleteTagsRequest)

Deletes the specified tags.

Public Method DeleteTagsAsync(DeleteTagsRequest, CancellationToken)

Initiates the asynchronous execution of the DeleteTags operation.

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

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 DescribeAccountLimitsAsync(DescribeAccountLimitsRequest, CancellationToken)

Initiates the asynchronous execution of the DescribeAccountLimits operation.

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)

Initiates the asynchronous execution of the DescribeAdjustmentTypes operation.

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)

Initiates the asynchronous execution of the DescribeAutoScalingGroups operation.

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)

Initiates the asynchronous execution of the DescribeAutoScalingInstances operation.

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

Describes the notification types that are supported by Auto Scaling.

Public Method DescribeAutoScalingNotificationTypesAsync(DescribeAutoScalingNotificationTypesRequest, CancellationToken)

Initiates the asynchronous execution of the DescribeAutoScalingNotificationTypes operation.

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)

Initiates the asynchronous execution of the DescribeLaunchConfigurations operation.

Public Method DescribeLifecycleHooks(DescribeLifecycleHooksRequest)

Describes the lifecycle hooks for the specified Auto Scaling group.

Public Method DescribeLifecycleHooksAsync(DescribeLifecycleHooksRequest, CancellationToken)

Initiates the asynchronous execution of the DescribeLifecycleHooks operation.

Public Method DescribeLifecycleHookTypes(DescribeLifecycleHookTypesRequest)

Describes the available types of lifecycle hooks.

Public Method DescribeLifecycleHookTypesAsync(DescribeLifecycleHookTypesRequest, CancellationToken)

Initiates the asynchronous execution of the DescribeLifecycleHookTypes operation.

Public Method DescribeLoadBalancers(DescribeLoadBalancersRequest)

Describes the load balancers for the specified Auto Scaling group.

Note that this operation describes only Classic Load Balancers. If you have Application Load Balancers, use DescribeLoadBalancerTargetGroups instead.

Public Method DescribeLoadBalancersAsync(DescribeLoadBalancersRequest, CancellationToken)

Initiates the asynchronous execution of the DescribeLoadBalancers operation.

Public Method DescribeLoadBalancerTargetGroups(DescribeLoadBalancerTargetGroupsRequest)

Describes the target groups for the specified Auto Scaling group.

Public Method DescribeLoadBalancerTargetGroupsAsync(DescribeLoadBalancerTargetGroupsRequest, CancellationToken)

Initiates the asynchronous execution of the DescribeLoadBalancerTargetGroups operation.

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

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 DescribeMetricCollectionTypesAsync(DescribeMetricCollectionTypesRequest, CancellationToken)

Initiates the asynchronous execution of the DescribeMetricCollectionTypes operation.

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)

Initiates the asynchronous execution of the DescribeNotificationConfigurations operation.

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)

Initiates the asynchronous execution of the DescribePolicies operation.

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)

Initiates the asynchronous execution of the DescribeScalingActivities operation.

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)

Initiates the asynchronous execution of the DescribeScalingProcessTypes operation.

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

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 DescribeScheduledActionsAsync(DescribeScheduledActionsRequest, CancellationToken)

Initiates the asynchronous execution of the DescribeScheduledActions operation.

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 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 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)

Initiates the asynchronous execution of the DescribeTags operation.

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

Describes the termination policies supported by Auto Scaling.

Public Method DescribeTerminationPolicyTypesAsync(DescribeTerminationPolicyTypesRequest, CancellationToken)

Initiates the asynchronous execution of the DescribeTerminationPolicyTypes operation.

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

Public Method DetachInstancesAsync(DetachInstancesRequest, CancellationToken)

Initiates the asynchronous execution of the DetachInstances operation.

Public Method DetachLoadBalancers(DetachLoadBalancersRequest)

Detaches one or more Classic Load Balancers from the specified Auto Scaling group.

Note that this operation detaches only Classic Load Balancers. If you have Application 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. Note that the instances remain running.

Public Method DetachLoadBalancersAsync(DetachLoadBalancersRequest, CancellationToken)

Initiates the asynchronous execution of the DetachLoadBalancers operation.

Public Method DetachLoadBalancerTargetGroups(DetachLoadBalancerTargetGroupsRequest)

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

Public Method DetachLoadBalancerTargetGroupsAsync(DetachLoadBalancerTargetGroupsRequest, CancellationToken)

Initiates the asynchronous execution of the DetachLoadBalancerTargetGroups operation.

Public Method DisableMetricsCollection(DisableMetricsCollectionRequest)

Disables group metrics for the specified Auto Scaling group.

Public Method DisableMetricsCollectionAsync(DisableMetricsCollectionRequest, CancellationToken)

Initiates the asynchronous execution of the DisableMetricsCollection operation.

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

Public Method EnableMetricsCollectionAsync(EnableMetricsCollectionRequest, CancellationToken)

Initiates the asynchronous execution of the EnableMetricsCollection operation.

Public Method EnterStandby(EnterStandbyRequest)

Moves the specified instances into the standby state.

For more information, see Temporarily Removing Instances from Your Auto Scaling Group in the Auto Scaling User Guide.

Public Method EnterStandbyAsync(EnterStandbyRequest, CancellationToken)

Initiates the asynchronous execution of the EnterStandby operation.

Public Method ExecutePolicy(ExecutePolicyRequest)

Executes the specified policy.

Public Method ExecutePolicyAsync(ExecutePolicyRequest, CancellationToken)

Initiates the asynchronous execution of the ExecutePolicy operation.

Public Method ExitStandby(ExitStandbyRequest)

Moves the specified instances out of the standby state.

For more information, see Temporarily Removing Instances from Your Auto Scaling Group in the Auto Scaling User Guide.

Public Method ExitStandbyAsync(ExitStandbyRequest, CancellationToken)

Initiates the asynchronous execution of the ExitStandby operation.

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 Hooks in the 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. For information about updating this limit, see AWS Service Limits in the Amazon Web Services General Reference.

Public Method PutLifecycleHookAsync(PutLifecycleHookRequest, CancellationToken)

Initiates the asynchronous execution of the PutLifecycleHook operation.

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 SNS Notifications When Your Auto Scaling Group Scales in the Auto Scaling User Guide.

Public Method PutNotificationConfigurationAsync(PutNotificationConfigurationRequest, CancellationToken)

Initiates the asynchronous execution of the PutNotificationConfiguration operation.

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 PutScalingPolicyAsync(PutScalingPolicyRequest, CancellationToken)

Initiates the asynchronous execution of the PutScalingPolicy operation.

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.

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

Public Method PutScheduledUpdateGroupActionAsync(PutScheduledUpdateGroupActionRequest, CancellationToken)

Initiates the asynchronous execution of the PutScheduledUpdateGroupAction operation.

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 User Guide.

Public Method RecordLifecycleActionHeartbeatAsync(RecordLifecycleActionHeartbeatRequest, CancellationToken)

Initiates the asynchronous execution of the RecordLifecycleActionHeartbeat operation.

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 User Guide.

Public Method ResumeProcessesAsync(ResumeProcessesRequest, CancellationToken)

Initiates the asynchronous execution of the ResumeProcesses operation.

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 User Guide.

Public Method SetDesiredCapacityAsync(SetDesiredCapacityRequest, CancellationToken)

Initiates the asynchronous execution of the SetDesiredCapacity operation.

Public Method SetInstanceHealth(SetInstanceHealthRequest)

Sets the health status of the specified instance.

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

Public Method SetInstanceHealthAsync(SetInstanceHealthRequest, CancellationToken)

Initiates the asynchronous execution of the SetInstanceHealth operation.

Public Method SetInstanceProtection(SetInstanceProtectionRequest)

Updates the instance protection settings of the specified instances.

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

Public Method SetInstanceProtectionAsync(SetInstanceProtectionRequest, CancellationToken)

Initiates the asynchronous execution of the SetInstanceProtection operation.

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 User Guide.

Public Method SuspendProcessesAsync(SuspendProcessesRequest, CancellationToken)

Initiates the asynchronous execution of the SuspendProcesses operation.

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 TerminateInstanceInAutoScalingGroupAsync(TerminateInstanceInAutoScalingGroupRequest, CancellationToken)

Initiates the asynchronous execution of the TerminateInstanceInAutoScalingGroup operation.

Public Method UpdateAutoScalingGroup(UpdateAutoScalingGroupRequest)

Updates the configuration for the specified Auto Scaling group.

The new settings take effect on any scaling activities after this call returns. Scaling activities that are currently in progress aren't affected.

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.

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.

Public Method UpdateAutoScalingGroupAsync(UpdateAutoScalingGroupRequest, CancellationToken)

Initiates the asynchronous execution of the UpdateAutoScalingGroup operation.

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