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
 
 

Classes

NameDescription
Class Activity Describes scaling activity, which is a long-running process that represents a change to your Auto Scaling group, such as changing its size or replacing an instance.
Class AdjustmentType Describes a policy adjustment type.

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

Class Alarm Describes an alarm.
Class AlreadyExistsException AutoScaling exception
Class AttachInstancesRequest Container for the parameters to the AttachInstances operation. 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.

Class AttachInstancesResponse
Class AttachLoadBalancersRequest Container for the parameters to the AttachLoadBalancers operation. 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.

Class AttachLoadBalancersResponse Configuration for accessing Amazon AttachLoadBalancers service
Class AttachLoadBalancersResult
Class AutoScalingGroup Describes an Auto Scaling group.
Class AutoScalingInstanceDetails Describes an EC2 instance associated with an Auto Scaling group.
Class BlockDeviceMapping Describes a block device mapping.
Class CompleteLifecycleActionRequest Container for the parameters to the CompleteLifecycleAction operation. 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.

Class CompleteLifecycleActionResponse Configuration for accessing Amazon CompleteLifecycleAction service
Class CompleteLifecycleActionResult
Class CreateAutoScalingGroupRequest Container for the parameters to the CreateAutoScalingGroup operation. 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.

Class CreateAutoScalingGroupResponse
Class CreateLaunchConfigurationRequest Container for the parameters to the CreateLaunchConfiguration operation. 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.

Class CreateLaunchConfigurationResponse
Class CreateOrUpdateTagsRequest Container for the parameters to the CreateOrUpdateTags operation. 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.

Class CreateOrUpdateTagsResponse
Class DeleteAutoScalingGroupRequest Container for the parameters to the DeleteAutoScalingGroup operation. 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.

Class DeleteAutoScalingGroupResponse
Class DeleteLaunchConfigurationRequest Container for the parameters to the DeleteLaunchConfiguration operation. 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.

Class DeleteLaunchConfigurationResponse
Class DeleteLifecycleHookRequest Container for the parameters to the DeleteLifecycleHook operation. Deletes the specified lifecycle hook.

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

Class DeleteLifecycleHookResponse Configuration for accessing Amazon DeleteLifecycleHook service
Class DeleteLifecycleHookResult
Class DeleteNotificationConfigurationRequest Container for the parameters to the DeleteNotificationConfiguration operation. Deletes the specified notification.
Class DeleteNotificationConfigurationResponse
Class DeletePolicyRequest Container for the parameters to the DeletePolicy operation. 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.

Class DeletePolicyResponse
Class DeleteScheduledActionRequest Container for the parameters to the DeleteScheduledAction operation. Deletes the specified scheduled action.
Class DeleteScheduledActionResponse
Class DeleteTagsRequest Container for the parameters to the DeleteTags operation. Deletes the specified tags.
Class DeleteTagsResponse
Class DescribeAccountLimitsRequest Container for the parameters to the DescribeAccountLimits operation. 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.

Class DescribeAccountLimitsResponse Configuration for accessing Amazon DescribeAccountLimits service
Class DescribeAccountLimitsResult
Class DescribeAdjustmentTypesRequest Container for the parameters to the DescribeAdjustmentTypes operation. Describes the policy adjustment types for use with PutScalingPolicy.
Class DescribeAdjustmentTypesResponse Configuration for accessing Amazon DescribeAdjustmentTypes service
Class DescribeAdjustmentTypesResult
Class DescribeAutoScalingGroupsRequest Container for the parameters to the DescribeAutoScalingGroups operation. Describes one or more Auto Scaling groups. If a list of names is not provided, the call describes all Auto Scaling groups.
Class DescribeAutoScalingGroupsResponse Configuration for accessing Amazon DescribeAutoScalingGroups service
Class DescribeAutoScalingGroupsResult
Class DescribeAutoScalingInstancesRequest Container for the parameters to the DescribeAutoScalingInstances operation. Describes one or more Auto Scaling instances. If a list is not provided, the call describes all instances.
Class DescribeAutoScalingInstancesResponse Configuration for accessing Amazon DescribeAutoScalingInstances service
Class DescribeAutoScalingInstancesResult
Class DescribeAutoScalingNotificationTypesRequest Container for the parameters to the DescribeAutoScalingNotificationTypes operation. Describes the notification types that are supported by Auto Scaling.
Class DescribeAutoScalingNotificationTypesResponse Configuration for accessing Amazon DescribeAutoScalingNotificationTypes service
Class DescribeAutoScalingNotificationTypesResult
Class DescribeLaunchConfigurationsRequest Container for the parameters to the DescribeLaunchConfigurations operation. Describes one or more launch configurations. If you omit the list of names, then the call describes all launch configurations.
Class DescribeLaunchConfigurationsResponse Configuration for accessing Amazon DescribeLaunchConfigurations service
Class DescribeLaunchConfigurationsResult
Class DescribeLifecycleHooksRequest Container for the parameters to the DescribeLifecycleHooks operation. Describes the lifecycle hooks for the specified Auto Scaling group.
Class DescribeLifecycleHooksResponse Configuration for accessing Amazon DescribeLifecycleHooks service
Class DescribeLifecycleHooksResult
Class DescribeLifecycleHookTypesRequest Container for the parameters to the DescribeLifecycleHookTypes operation. Describes the available types of lifecycle hooks.
Class DescribeLifecycleHookTypesResponse Configuration for accessing Amazon DescribeLifecycleHookTypes service
Class DescribeLifecycleHookTypesResult
Class DescribeLoadBalancersRequest Container for the parameters to the DescribeLoadBalancers operation. Describes the load balancers for the specified Auto Scaling group.
Class DescribeLoadBalancersResponse Configuration for accessing Amazon DescribeLoadBalancers service
Class DescribeLoadBalancersResult
Class DescribeMetricCollectionTypesRequest Container for the parameters to the DescribeMetricCollectionTypes operation. 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.

Class DescribeMetricCollectionTypesResponse Configuration for accessing Amazon DescribeMetricCollectionTypes service
Class DescribeMetricCollectionTypesResult
Class DescribeNotificationConfigurationsRequest Container for the parameters to the DescribeNotificationConfigurations operation. Describes the notification actions associated with the specified Auto Scaling group.
Class DescribeNotificationConfigurationsResponse Configuration for accessing Amazon DescribeNotificationConfigurations service
Class DescribeNotificationConfigurationsResult
Class DescribePoliciesRequest Container for the parameters to the DescribePolicies operation. Describes the policies for the specified Auto Scaling group.
Class DescribePoliciesResponse Configuration for accessing Amazon DescribePolicies service
Class DescribePoliciesResult
Class DescribeScalingActivitiesRequest Container for the parameters to the DescribeScalingActivities operation. 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.
Class DescribeScalingActivitiesResponse Configuration for accessing Amazon DescribeScalingActivities service
Class DescribeScalingActivitiesResult
Class DescribeScalingProcessTypesRequest Container for the parameters to the DescribeScalingProcessTypes operation. Describes the scaling process types for use with ResumeProcesses and SuspendProcesses.
Class DescribeScalingProcessTypesResponse Configuration for accessing Amazon DescribeScalingProcessTypes service
Class DescribeScalingProcessTypesResult
Class DescribeScheduledActionsRequest Container for the parameters to the DescribeScheduledActions operation. Describes the actions scheduled for your Auto Scaling group that haven't run. To describe the actions that have already run, use DescribeScalingActivities.
Class DescribeScheduledActionsResponse Configuration for accessing Amazon DescribeScheduledActions service
Class DescribeScheduledActionsResult
Class DescribeTagsRequest Container for the parameters to the DescribeTags operation. 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.

Class DescribeTagsResponse Configuration for accessing Amazon DescribeTags service
Class DescribeTagsResult
Class DescribeTerminationPolicyTypesRequest Container for the parameters to the DescribeTerminationPolicyTypes operation. Describes the termination policies supported by Auto Scaling.
Class DescribeTerminationPolicyTypesResponse Configuration for accessing Amazon DescribeTerminationPolicyTypes service
Class DescribeTerminationPolicyTypesResult
Class DetachInstancesRequest Container for the parameters to the DetachInstances operation. 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.

Class DetachInstancesResponse Configuration for accessing Amazon DetachInstances service
Class DetachInstancesResult
Class DetachLoadBalancersRequest Container for the parameters to the DetachLoadBalancers operation. 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.

Class DetachLoadBalancersResponse Configuration for accessing Amazon DetachLoadBalancers service
Class DetachLoadBalancersResult
Class DisableMetricsCollectionRequest Container for the parameters to the DisableMetricsCollection operation. Disables monitoring of the specified metrics for the specified Auto Scaling group.
Class DisableMetricsCollectionResponse
Class Ebs Describes an Amazon EBS volume.
Class EnabledMetric Describes an enabled metric.
Class EnableMetricsCollectionRequest Container for the parameters to the EnableMetricsCollection operation. 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.

Class EnableMetricsCollectionResponse
Class EnterStandbyRequest Container for the parameters to the EnterStandby operation. Moves the specified instances into Standby mode.

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

Class EnterStandbyResponse Configuration for accessing Amazon EnterStandby service
Class EnterStandbyResult
Class ExecutePolicyRequest Container for the parameters to the ExecutePolicy operation. Executes the specified policy.
Class ExecutePolicyResponse
Class ExitStandbyRequest Container for the parameters to the ExitStandby operation. Moves the specified instances out of Standby mode.

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

Class ExitStandbyResponse Configuration for accessing Amazon ExitStandby service
Class ExitStandbyResult
Class Filter Describes a filter.
Class Instance Describes an EC2 instance.
Class InstanceMonitoring Describes whether instance monitoring is enabled.
Class InvalidNextTokenException AutoScaling exception
Class LaunchConfiguration Describes a launch configuration.
Class LifecycleHook Describes a lifecycle hook, which tells Auto Scaling that you want to perform an action when an instance launches or terminates. When you have a lifecycle hook in place, the Auto Scaling group will either:
  • Pause the instance after it launches, but before it is put into service
  • Pause the instance as it terminates, but before it is fully terminated

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

Class LimitExceededException AutoScaling exception
Class LoadBalancerState Describes the state of a load balancer.
Class MetricCollectionType Describes a metric.
Class MetricGranularityType Describes a granularity of a metric.
Class NotificationConfiguration Describes a notification.
Class ProcessType Describes a process type.

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

Class PutLifecycleHookRequest Container for the parameters to the PutLifecycleHook operation. 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.

Class PutLifecycleHookResponse Configuration for accessing Amazon PutLifecycleHook service
Class PutLifecycleHookResult
Class PutNotificationConfigurationRequest Container for the parameters to the PutNotificationConfiguration operation. 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.

Class PutNotificationConfigurationResponse
Class PutScalingPolicyRequest Container for the parameters to the PutScalingPolicy operation. 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.

Class PutScalingPolicyResponse Configuration for accessing Amazon PutScalingPolicy service
Class PutScalingPolicyResult
Class PutScheduledUpdateGroupActionRequest Container for the parameters to the PutScheduledUpdateGroupAction operation. 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.

Class PutScheduledUpdateGroupActionResponse
Class RecordLifecycleActionHeartbeatRequest Container for the parameters to the RecordLifecycleActionHeartbeat operation. 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.

Class RecordLifecycleActionHeartbeatResponse Configuration for accessing Amazon RecordLifecycleActionHeartbeat service
Class RecordLifecycleActionHeartbeatResult
Class ResourceContentionException AutoScaling exception
Class ResourceInUseException AutoScaling exception
Class ResumeProcessesRequest Container for the parameters to the ResumeProcesses operation. 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.

Class ResumeProcessesResponse
Class ScalingActivityInProgressException AutoScaling exception
Class ScalingPolicy Describes a scaling policy.
Class ScheduledUpdateGroupAction Describes a scheduled update to an Auto Scaling group.
Class SetDesiredCapacityRequest Container for the parameters to the SetDesiredCapacity operation. 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.

Class SetDesiredCapacityResponse
Class SetInstanceHealthRequest Container for the parameters to the SetInstanceHealth operation. Sets the health status of the specified instance.

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

Class SetInstanceHealthResponse
Class SetInstanceProtectionRequest Container for the parameters to the SetInstanceProtection operation. Updates the instance protection settings of the specified instances.

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

Class SetInstanceProtectionResponse Configuration for accessing Amazon SetInstanceProtection service
Class SetInstanceProtectionResult
Class StepAdjustment Describes an adjustment based on the difference between the value of the aggregated CloudWatch metric and the breach threshold that you've defined for the alarm.

For the following examples, suppose that you have an alarm with a breach threshold of 50:

  • If you want the adjustment to be triggered when the metric is greater than or equal to 50 and less than 60, specify a lower bound of 0 and an upper bound of 10.

  • If you want the adjustment to be triggered when the metric is greater than 40 and less than or equal to 50, specify a lower bound of -10 and an upper bound of 0.

There are a few rules for the step adjustments for your step policy:

  • The ranges of your step adjustments can't overlap or have a gap.

  • At most one step adjustment can have a null lower bound. If one step adjustment has a negative lower bound, then there must be a step adjustment with a null lower bound.

  • At most one step adjustment can have a null upper bound. If one step adjustment has a positive upper bound, then there must be a step adjustment with a null upper bound.

  • The upper and lower bound can't be null in the same step adjustment.

Class SuspendedProcess Describes an Auto Scaling process that has been suspended. For more information, see ProcessType.
Class SuspendProcessesRequest Container for the parameters to the SuspendProcesses operation. 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.

Class SuspendProcessesResponse
Class Tag Describes a tag for an Auto Scaling group.
Class TagDescription Describes a tag for an Auto Scaling group.
Class TerminateInstanceInAutoScalingGroupRequest Container for the parameters to the TerminateInstanceInAutoScalingGroup operation. Terminates the specified instance and optionally adjusts the desired group size.

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

Class TerminateInstanceInAutoScalingGroupResponse Configuration for accessing Amazon TerminateInstanceInAutoScalingGroup service
Class TerminateInstanceInAutoScalingGroupResult
Class UpdateAutoScalingGroupRequest Container for the parameters to the UpdateAutoScalingGroup operation. 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.

Class UpdateAutoScalingGroupResponse