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.

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.

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, 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.

Class AttachInstancesResponse

This is the response object from the AttachInstances operation.

Class AttachLoadBalancersRequest

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

Class AttachLoadBalancersResponse

This is the response object from the AttachLoadBalancers operation.

Class AttachLoadBalancerTargetGroupsRequest

Container for the parameters to the AttachLoadBalancerTargetGroups operation. 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.

Class AttachLoadBalancerTargetGroupsResponse

This is the response object from the AttachLoadBalancerTargetGroups operation.

Class AutoScalingGroup

Describes an Auto Scaling group.

Class AutoScalingInstanceDetails

Describes an EC2 instance associated with an Auto Scaling group.

Class BatchDeleteScheduledActionRequest

Container for the parameters to the BatchDeleteScheduledAction operation. Deletes one or more scheduled actions for the specified Auto Scaling group.

Class BatchDeleteScheduledActionResponse

This is the response object from the BatchDeleteScheduledAction operation.

Class BatchPutScheduledUpdateGroupActionRequest

Container for the parameters to the BatchPutScheduledUpdateGroupAction operation. 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.

Class BatchPutScheduledUpdateGroupActionResponse

This is the response object from the BatchPutScheduledUpdateGroupAction operation.

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

Class CompleteLifecycleActionResponse

This is the response object from the CompleteLifecycleAction operation.

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, 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.

Class CreateAutoScalingGroupResponse

This is the response object from the CreateAutoScalingGroup operation.

Class CreateLaunchConfigurationRequest

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

Class CreateLaunchConfigurationResponse

This is the response object from the CreateLaunchConfiguration operation.

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

Class CreateOrUpdateTagsResponse

This is the response object from the CreateOrUpdateTags operation.

Class CustomizedMetricSpecification

Represents a CloudWatch metric of your choosing for a target tracking scaling policy to use with Amazon EC2 Auto Scaling.

To create your customized metric specification:

  • Add values for each required parameter from CloudWatch. You can use an existing metric, or a new metric that you create. To use your own metric, you must first publish the metric to CloudWatch. For more information, see Publish Custom Metrics in the Amazon CloudWatch User Guide.

  • Choose a metric that changes proportionally with capacity. The value of the metric should increase or decrease in inverse proportion to the number of capacity units. That is, the value of the metric should decrease when capacity increases.

For more information about CloudWatch, see Amazon CloudWatch Concepts.

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

Class DeleteAutoScalingGroupResponse

This is the response object from the DeleteAutoScalingGroup operation.

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

This is the response object from the DeleteLaunchConfiguration operation.

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

This is the response object from the DeleteLifecycleHook operation.

Class DeleteNotificationConfigurationRequest

Container for the parameters to the DeleteNotificationConfiguration operation. Deletes the specified notification.

Class DeleteNotificationConfigurationResponse

This is the response object from the DeleteNotificationConfiguration operation.

Class DeletePolicyRequest

Container for the parameters to the DeletePolicy operation. 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.

Class DeletePolicyResponse

This is the response object from the DeletePolicy operation.

Class DeleteScheduledActionRequest

Container for the parameters to the DeleteScheduledAction operation. Deletes the specified scheduled action.

Class DeleteScheduledActionResponse

This is the response object from the DeleteScheduledAction operation.

Class DeleteTagsRequest

Container for the parameters to the DeleteTags operation. Deletes the specified tags.

Class DeleteTagsResponse

This is the response object from the DeleteTags operation.

Class DescribeAccountLimitsRequest

Container for the parameters to the DescribeAccountLimits operation. 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.

Class DescribeAccountLimitsResponse

This is the response object from the DescribeAccountLimits operation.

Class DescribeAdjustmentTypesRequest

Container for the parameters to the DescribeAdjustmentTypes operation. Describes the policy adjustment types for use with PutScalingPolicy.

Class DescribeAdjustmentTypesResponse

This is the response object from the DescribeAdjustmentTypes operation.

Class DescribeAutoScalingGroupsRequest

Container for the parameters to the DescribeAutoScalingGroups operation. Describes one or more Auto Scaling groups.

Class DescribeAutoScalingGroupsResponse

This is the response object from the DescribeAutoScalingGroups operation.

Class DescribeAutoScalingInstancesRequest

Container for the parameters to the DescribeAutoScalingInstances operation. Describes one or more Auto Scaling instances.

Class DescribeAutoScalingInstancesResponse

This is the response object from the DescribeAutoScalingInstances operation.

Class DescribeAutoScalingNotificationTypesRequest

Container for the parameters to the DescribeAutoScalingNotificationTypes operation. Describes the notification types that are supported by Amazon EC2 Auto Scaling.

Class DescribeAutoScalingNotificationTypesResponse

This is the response object from the DescribeAutoScalingNotificationTypes operation.

Class DescribeLaunchConfigurationsRequest

Container for the parameters to the DescribeLaunchConfigurations operation. Describes one or more launch configurations.

Class DescribeLaunchConfigurationsResponse

This is the response object from the DescribeLaunchConfigurations operation.

Class DescribeLifecycleHooksRequest

Container for the parameters to the DescribeLifecycleHooks operation. Describes the lifecycle hooks for the specified Auto Scaling group.

Class DescribeLifecycleHooksResponse

This is the response object from the DescribeLifecycleHooks operation.

Class DescribeLifecycleHookTypesRequest

Container for the parameters to the DescribeLifecycleHookTypes operation. Describes the available types of lifecycle hooks.

The following hook types are supported:

  • autoscaling:EC2_INSTANCE_LAUNCHING

  • autoscaling:EC2_INSTANCE_TERMINATING

Class DescribeLifecycleHookTypesResponse

This is the response object from the DescribeLifecycleHookTypes operation.

Class DescribeLoadBalancersRequest

Container for the parameters to the DescribeLoadBalancers operation. 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.

Class DescribeLoadBalancersResponse

This is the response object from the DescribeLoadBalancers operation.

Class DescribeLoadBalancerTargetGroupsRequest

Container for the parameters to the DescribeLoadBalancerTargetGroups operation. Describes the target groups for the specified Auto Scaling group.

Class DescribeLoadBalancerTargetGroupsResponse

This is the response object from the DescribeLoadBalancerTargetGroups operation.

Class DescribeMetricCollectionTypesRequest

Container for the parameters to the DescribeMetricCollectionTypes operation. 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.

Class DescribeMetricCollectionTypesResponse

This is the response object from the DescribeMetricCollectionTypes operation.

Class DescribeNotificationConfigurationsRequest

Container for the parameters to the DescribeNotificationConfigurations operation. Describes the notification actions associated with the specified Auto Scaling group.

Class DescribeNotificationConfigurationsResponse

This is the response object from the DescribeNotificationConfigurations operation.

Class DescribePoliciesRequest

Container for the parameters to the DescribePolicies operation. Describes the policies for the specified Auto Scaling group.

Class DescribePoliciesResponse

This is the response object from the DescribePolicies operation.

Class DescribeScalingActivitiesRequest

Container for the parameters to the DescribeScalingActivities operation. Describes one or more scaling activities for the specified Auto Scaling group.

Class DescribeScalingActivitiesResponse

This is the response object from the DescribeScalingActivities operation.

Class DescribeScalingProcessTypesRequest

Container for the parameters to the DescribeScalingProcessTypes operation. Describes the scaling process types for use with ResumeProcesses and SuspendProcesses.

Class DescribeScalingProcessTypesResponse

This is the response object from the DescribeScalingProcessTypes operation.

Class DescribeScheduledActionsRequest

Container for the parameters to the DescribeScheduledActions operation. 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.

Class DescribeScheduledActionsResponse

This is the response object from the DescribeScheduledActions operation.

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

This is the response object from the DescribeTags operation.

Class DescribeTerminationPolicyTypesRequest

Container for the parameters to the DescribeTerminationPolicyTypes operation. 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.

Class DescribeTerminationPolicyTypesResponse

This is the response object from the DescribeTerminationPolicyTypes operation.

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

Class DetachInstancesResponse

This is the response object from the DetachInstances operation.

Class DetachLoadBalancersRequest

Container for the parameters to the DetachLoadBalancers operation. 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.

Class DetachLoadBalancersResponse

This is the response object from the DetachLoadBalancers operation.

Class DetachLoadBalancerTargetGroupsRequest

Container for the parameters to the DetachLoadBalancerTargetGroups operation. Detaches one or more target groups from the specified Auto Scaling group.

Class DetachLoadBalancerTargetGroupsResponse

This is the response object from the DetachLoadBalancerTargetGroups operation.

Class DisableMetricsCollectionRequest

Container for the parameters to the DisableMetricsCollection operation. Disables group metrics for the specified Auto Scaling group.

Class DisableMetricsCollectionResponse

This is the response object from the DisableMetricsCollection operation.

Class Ebs

Describes an Amazon EBS volume. Used in combination with BlockDeviceMapping.

Class EnabledMetric

Describes an enabled metric.

Class EnableMetricsCollectionRequest

Container for the parameters to the EnableMetricsCollection operation. 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.

Class EnableMetricsCollectionResponse

This is the response object from the EnableMetricsCollection operation.

Class EnterStandbyRequest

Container for the parameters to the EnterStandby operation. 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.

Class EnterStandbyResponse

This is the response object from the EnterStandby operation.

Class ExecutePolicyRequest

Container for the parameters to the ExecutePolicy operation. Executes the specified policy.

Class ExecutePolicyResponse

This is the response object from the ExecutePolicy operation.

Class ExitStandbyRequest

Container for the parameters to the ExitStandby operation. 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.

Class ExitStandbyResponse

This is the response object from the ExitStandby operation.

Class FailedScheduledUpdateGroupActionRequest

Describes a scheduled action that could not be created, updated, or deleted.

Class Filter

Describes a filter.

Class Instance

Describes an EC2 instance.

Class InstanceMonitoring

Describes whether detailed monitoring is enabled for the Auto Scaling instances.

Class InstancesDistribution

Describes an instances distribution for an Auto Scaling group with MixedInstancesPolicy.

The instances distribution specifies the distribution of On-Demand Instances and Spot Instances, the maximum price to pay for Spot Instances, and how the Auto Scaling group allocates instance types to fulfill On-Demand and Spot capacity.

When you update SpotAllocationStrategy, SpotInstancePools, or SpotMaxPrice, this update action does not deploy any changes across the running Amazon EC2 instances in the group. Your existing Spot Instances continue to run as long as the maximum price for those instances is higher than the current Spot price. When scale out occurs, Amazon EC2 Auto Scaling launches instances based on the new settings. When scale in occurs, Amazon EC2 Auto Scaling terminates instances according to the group's termination policies.

Class InvalidNextTokenException

AutoScaling exception

Class LaunchConfiguration

Describes a launch configuration.

Class LaunchTemplate

Describes a launch template and overrides.

The overrides are used to override the instance type specified by the launch template with multiple instance types that can be used to launch On-Demand Instances and Spot Instances.

When you update the launch template or overrides, existing Amazon EC2 instances continue to run. When scale out occurs, Amazon EC2 Auto Scaling launches instances to match the new settings. When scale in occurs, Amazon EC2 Auto Scaling terminates instances according to the group's termination policies.

Class LaunchTemplateOverrides

Describes an override for a launch template.

Class LaunchTemplateSpecification

Describes a launch template and the launch template version.

The launch template that is specified must be configured for use with an Auto Scaling group. For more information, see Creating a Launch Template for an Auto Scaling Group in the Amazon EC2 Auto Scaling User Guide.

Class LifecycleHook

Describes a lifecycle hook, which tells Amazon EC2 Auto Scaling that you want to perform an action whenever it launches instances or terminates instances. Used in response to DescribeLifecycleHooks.

Class LifecycleHookSpecification

Describes a lifecycle hook. Used in combination with CreateAutoScalingGroup.

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 creating a lifecycle hook for 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.

You can view the lifecycle hooks for an Auto Scaling group using DescribeLifecycleHooks. You can modify an existing lifecycle hook or create new lifecycle hooks using PutLifecycleHook. If you are no longer using a lifecycle hook, you can delete it using DeleteLifecycleHook.

Class LimitExceededException

AutoScaling exception

Class LoadBalancerState

Describes the state of a Classic Load Balancer.

If you specify a load balancer when creating the Auto Scaling group, the state of the load balancer is InService.

If you attach a load balancer to an existing Auto Scaling group, the initial state is Adding. The state transitions to Added after all instances in the group are registered with the load balancer. If Elastic Load Balancing health checks are enabled for the load balancer, the state transitions to InService after at least one instance in the group passes the health check. If EC2 health checks are enabled instead, the load balancer remains in the Added state.

Class LoadBalancerTargetGroupState

Describes the state of a target group.

If you attach a target group to an existing Auto Scaling group, the initial state is Adding. The state transitions to Added after all Auto Scaling instances are registered with the target group. If Elastic Load Balancing health checks are enabled, the state transitions to InService after at least one Auto Scaling instance passes the health check. If EC2 health checks are enabled instead, the target group remains in the Added state.

Class MetricCollectionType

Describes a metric.

Class MetricDimension

Describes the dimension of a metric.

Class MetricGranularityType

Describes a granularity of a metric.

Class MixedInstancesPolicy

Describes a mixed instances policy for an Auto Scaling group. With mixed instances, your Auto Scaling group can provision a combination of On-Demand Instances and Spot Instances across multiple instance types. For more information, see Auto Scaling Groups with Multiple Instance Types and Purchase Options in the Amazon EC2 Auto Scaling User Guide.

You can create a mixed instances policy for a new Auto Scaling group, or you can create it for an existing group by updating the group to specify MixedInstancesPolicy as the top-level parameter instead of a launch configuration or template. For more information, see CreateAutoScalingGroup and UpdateAutoScalingGroup.

Class NotificationConfiguration

Describes a notification.

Class PredefinedMetricSpecification

Represents a predefined metric for a target tracking scaling policy to use with Amazon EC2 Auto Scaling.

Class ProcessType

Describes a process type.

For more information, see Scaling Processes in the Amazon EC2 Auto Scaling User 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 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.

Class PutLifecycleHookResponse

This is the response object from the PutLifecycleHook operation.

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

Class PutNotificationConfigurationResponse

This is the response object from the PutNotificationConfiguration operation.

Class PutScalingPolicyRequest

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

Class PutScalingPolicyResponse

Contains the output of PutScalingPolicy.

Class PutScheduledUpdateGroupActionRequest

Container for the parameters to the PutScheduledUpdateGroupAction operation. 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.

Class PutScheduledUpdateGroupActionResponse

This is the response object from the PutScheduledUpdateGroupAction operation.

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

Class RecordLifecycleActionHeartbeatResponse

This is the response object from the RecordLifecycleActionHeartbeat operation.

Class ResourceContentionException

AutoScaling exception

Class ResourceInUseException

AutoScaling exception

Class ResumeProcessesRequest

Container for the parameters to the ResumeProcesses operation. 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.

Class ResumeProcessesResponse

This is the response object from the ResumeProcesses operation.

Class ScalingActivityInProgressException

AutoScaling exception

Class ScalingPolicy

Describes a scaling policy.

Class ScheduledUpdateGroupAction

Describes a scheduled scaling action. Used in response to DescribeScheduledActions.

Class ScheduledUpdateGroupActionRequest

Describes one or more scheduled scaling action updates for a specified Auto Scaling group. Used in combination with BatchPutScheduledUpdateGroupAction.

When updating a scheduled scaling action, all optional parameters are left unchanged if not specified.

Class ServiceLinkedRoleFailureException

AutoScaling exception

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

Class SetDesiredCapacityResponse

This is the response object from the SetDesiredCapacity operation.

Class SetInstanceHealthRequest

Container for the parameters to the SetInstanceHealth operation. 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.

Class SetInstanceHealthResponse

This is the response object from the SetInstanceHealth operation.

Class SetInstanceProtectionRequest

Container for the parameters to the SetInstanceProtection operation. 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.

Class SetInstanceProtectionResponse

This is the response object from the SetInstanceProtection operation.

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. Used in combination with PutScalingPolicy.

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

  • To trigger the adjustment 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.

  • To trigger the adjustment 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 automatic scaling process that has been suspended. For more information, see ProcessType.

Class SuspendProcessesRequest

Container for the parameters to the SuspendProcesses operation. 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.

Class SuspendProcessesResponse

This is the response object from the SuspendProcesses operation.

Class Tag

Describes a tag for an Auto Scaling group.

Class TagDescription

Describes a tag for an Auto Scaling group.

Class TargetTrackingConfiguration

Represents a target tracking scaling policy configuration to use with Amazon EC2 Auto Scaling.

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

Class TerminateInstanceInAutoScalingGroupResponse

This is the response object from the TerminateInstanceInAutoScalingGroup operation.

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, 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.

Class UpdateAutoScalingGroupResponse

This is the response object from the UpdateAutoScalingGroup operation.