AWS SDK for .NET Documentation
Amazon.AutoScaling.Model Namespace
AmazonAmazon.AutoScaling.Model Did this page help you?   Yes   No    Tell us about it...
 
Declaration Syntax
C#
namespace Amazon.AutoScaling.Model
Types
All TypesClasses
IconTypeDescription
Activity

A scaling Activity is a long-running process that represents a change to your AutoScalingGroup, such as changing the size of the group. It can also be a process to replace an instance, or a process to perform any other long-running operations supported by the API.


AdjustmentType

Specifies whether the PutScalingPolicy ScalingAdjustment parameter is an absolute number or a percentage of the current capacity.


Alarm

The Alarm data type.


AlreadyExistsException
AmazonAutoScaling exception

AttachInstancesRequest
Container for the parameters to the AttachInstances operation.

Attaches one or more Amazon EC2 instances to an existing Auto Scaling group. After the instance(s) is attached, it becomes a part of the Auto Scaling group.

For more information, see Attach Amazon EC2 Instance(s) to Your Existing Auto Scaling Group in the Auto Scaling Developer Guide .


AttachInstancesResponse
Returns information about the AttachInstances response metadata. The AttachInstances operation has a void result type.

AutoScalingGroup

The AutoScalingGroup data type.


AutoScalingInstanceDetails

The AutoScalingInstanceDetails data type.


BlockDeviceMapping

The BlockDeviceMapping data type.


CreateAutoScalingGroupRequest
Container for the parameters to the CreateAutoScalingGroup operation.

Creates a new Auto Scaling group with the specified name and other attributes. When the creation request is completed, the Auto Scaling group is ready to be used in other calls.

NOTE: The Auto Scaling group name must be unique within the scope of your AWS account.


CreateAutoScalingGroupResponse
Returns information about the CreateAutoScalingGroup response metadata. The CreateAutoScalingGroup operation has a void result type.

CreateLaunchConfigurationRequest
Container for the parameters to the CreateLaunchConfiguration operation.

Creates a new launch configuration. The launch configuration name must be unique within the scope of the client's AWS account. The maximum limit of launch configurations, which by default is 100, must not yet have been met; otherwise, the call will fail. When created, the new launch configuration is available for immediate use.


CreateLaunchConfigurationResponse
Returns information about the CreateLaunchConfiguration response metadata. The CreateLaunchConfiguration operation has a void result type.

CreateOrUpdateTagsRequest
Container for the parameters to the CreateOrUpdateTags operation.

Creates new tags or updates existing tags for an Auto Scaling group.

NOTE: A tag's definition is composed of a resource ID, resource type, key and value, and the propagate flag. Value and the propagate flag are optional parameters. See the Request Parameters for more information.

For information on creating tags for your Auto Scaling group, see Tag Your Auto Scaling Groups and Amazon EC2 Instances .


CreateOrUpdateTagsResponse
Returns information about the CreateOrUpdateTags response metadata. The CreateOrUpdateTags operation has a void result type.

DeleteAutoScalingGroupRequest
Container for the parameters to the DeleteAutoScalingGroup operation.

Deletes the specified Auto Scaling group if the group has no instances and no scaling activities in progress.

NOTE: To remove all instances before calling DeleteAutoScalingGroup, you can call UpdateAutoScalingGroup to set the minimum and maximum size of the AutoScalingGroup to zero.


DeleteAutoScalingGroupResponse
Returns information about the DeleteAutoScalingGroup response metadata. The DeleteAutoScalingGroup operation has a void result type.

DeleteLaunchConfigurationRequest
Container for the parameters to the DeleteLaunchConfiguration operation.

Deletes the specified LaunchConfiguration.

The specified launch configuration must not be attached to an Auto Scaling group. When this call completes, the launch configuration is no longer available for use.


DeleteLaunchConfigurationResponse
Returns information about the DeleteLaunchConfiguration response metadata. The DeleteLaunchConfiguration operation has a void result type.

DeleteNotificationConfigurationRequest
Container for the parameters to the DeleteNotificationConfiguration operation.

Deletes notifications created by PutNotificationConfiguration.


DeleteNotificationConfigurationResponse
Returns information about the DeleteNotificationConfiguration response metadata. The DeleteNotificationConfiguration operation has a void result type.

DeletePolicyRequest
Container for the parameters to the DeletePolicy operation.

Deletes a policy created by PutScalingPolicy.


DeletePolicyResponse
Returns information about the DeletePolicy response metadata. The DeletePolicy operation has a void result type.

DeleteScheduledActionRequest
Container for the parameters to the DeleteScheduledAction operation.

Deletes a scheduled action previously created using the PutScheduledUpdateGroupAction.


DeleteScheduledActionResponse
Returns information about the DeleteScheduledAction response metadata. The DeleteScheduledAction operation has a void result type.

DeleteTagsRequest
Container for the parameters to the DeleteTags operation.

Removes the specified tags or a set of tags from a set of resources.


DeleteTagsResponse
Returns information about the DeleteTags response metadata. The DeleteTags operation has a void result type.

DescribeAccountLimitsRequest
Container for the parameters to the DescribeAccountLimits operation.

Returns the limits for the Auto Scaling resources currently allowed for your AWS account.

Your AWS account comes with default limits on resources for Auto Scaling. There is a default limit of 20 Auto Scaling groups and 100 launch configurations per region.

If you reach the limits for the number of Auto Scaling groups or the launch configurations, you can go to the Support Center and place a request to raise the limits.


DescribeAccountLimitsResponse
Returns information about the DescribeAccountLimitsResult response and response metadata.

DescribeAccountLimitsResult

The output of the DescribeAccountLimitsResult action.


DescribeAdjustmentTypesRequest
Container for the parameters to the DescribeAdjustmentTypes operation.

Returns policy adjustment types for use in the PutScalingPolicy action.


DescribeAdjustmentTypesResponse
Returns information about the DescribeAdjustmentTypesResult response and response metadata.

DescribeAdjustmentTypesResult

The output of the DescribeAdjustmentTypes action.


DescribeAutoScalingGroupsRequest
Container for the parameters to the DescribeAutoScalingGroups operation.

Returns a full description of each Auto Scaling group in the given list. This includes all Amazon EC2 instances that are members of the group. If a list of names is not provided, the service returns the full details of all Auto Scaling groups.

This action supports pagination by returning a token if there are more pages to retrieve. To get the next page, call this action again with the returned token as the NextToken parameter.


DescribeAutoScalingGroupsResponse
Returns information about the DescribeAutoScalingGroupsResult response and response metadata.

DescribeAutoScalingGroupsResult

The AutoScalingGroupsType data type.


DescribeAutoScalingInstancesRequest
Container for the parameters to the DescribeAutoScalingInstances operation.

Returns a description of each Auto Scaling instance in the InstanceIds list. If a list is not provided, the service returns the full details of all instances up to a maximum of 50. By default, the service returns a list of 20 items.

This action supports pagination by returning a token if there are more pages to retrieve. To get the next page, call this action again with the returned token as the NextToken parameter.


DescribeAutoScalingInstancesResponse
Returns information about the DescribeAutoScalingInstancesResult response and response metadata.

DescribeAutoScalingInstancesResult

The AutoScalingInstancesType data type.


DescribeAutoScalingNotificationTypesRequest
Container for the parameters to the DescribeAutoScalingNotificationTypes operation.

Returns a list of all notification types that are supported by Auto Scaling.


DescribeAutoScalingNotificationTypesResponse
Returns information about the DescribeAutoScalingNotificationTypesResult response and response metadata.

DescribeAutoScalingNotificationTypesResult

The AutoScalingNotificationTypes data type.


DescribeLaunchConfigurationsRequest
Container for the parameters to the DescribeLaunchConfigurations operation.

Returns a full description of the launch configurations, or the specified launch configurations, if they exist.

If no name is specified, then the full details of all launch configurations are returned.


DescribeLaunchConfigurationsResponse
Returns information about the DescribeLaunchConfigurationsResult response and response metadata.

DescribeLaunchConfigurationsResult

The LaunchConfigurationsType data type.


DescribeMetricCollectionTypesRequest
Container for the parameters to the DescribeMetricCollectionTypes operation.

Returns a list of metrics and a corresponding list of granularities for each metric.


DescribeMetricCollectionTypesResponse
Returns information about the DescribeMetricCollectionTypesResult response and response metadata.

DescribeMetricCollectionTypesResult

The output of the DescribeMetricCollectionTypes action.


DescribeNotificationConfigurationsRequest
Container for the parameters to the DescribeNotificationConfigurations operation.

Returns a list of notification actions associated with Auto Scaling groups for specified events.


DescribeNotificationConfigurationsResponse
Returns information about the DescribeNotificationConfigurationsResult response and response metadata.

DescribeNotificationConfigurationsResult

The output of the DescribeNotificationConfigurations action.


DescribePoliciesRequest
Container for the parameters to the DescribePolicies operation.

Returns descriptions of what each policy does. This action supports pagination. If the response includes a token, there are more records available. To get the additional records, repeat the request with the response token as the NextToken parameter.


DescribePoliciesResponse
Returns information about the DescribePoliciesResult response and response metadata.

DescribePoliciesResult

The PoliciesType data type.


DescribeScalingActivitiesRequest
Container for the parameters to the DescribeScalingActivities operation.

Returns the scaling activities for the specified Auto Scaling group.

If the specified ActivityIds list is empty, all the activities from the past six weeks are returned. Activities are sorted by the start time. Activities still in progress appear first on the list.

This action supports pagination. If the response includes a token, there are more records available. To get the additional records, repeat the request with the response token as the NextToken parameter.


DescribeScalingActivitiesResponse
Returns information about the DescribeScalingActivitiesResult response and response metadata.

DescribeScalingActivitiesResult

The output for the DescribeScalingActivities action.


DescribeScalingProcessTypesRequest
Container for the parameters to the DescribeScalingProcessTypes operation.

Returns scaling process types for use in the ResumeProcesses and SuspendProcesses actions.


DescribeScalingProcessTypesResponse
Returns information about the DescribeScalingProcessTypesResult response and response metadata.

DescribeScalingProcessTypesResult

The output of the DescribeScalingProcessTypes action.


DescribeScheduledActionsRequest
Container for the parameters to the DescribeScheduledActions operation.

Lists all the actions scheduled for your Auto Scaling group that haven't been executed. To see a list of actions already executed, see the activity record returned in DescribeScalingActivities.


DescribeScheduledActionsResponse
Returns information about the DescribeScheduledActionsResult response and response metadata.

DescribeScheduledActionsResult

A scaling action that is scheduled for a future time and date. An action can be scheduled up to thirty days in advance.

Starting with API version 2011-01-01, you can use recurrence to specify that a scaling action occurs regularly on a schedule.


DescribeTagsRequest
Container for the parameters to the DescribeTags operation.

Lists the Auto Scaling group tags.

You can use filters to limit results when describing tags. For example, you can query for tags of a particular 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 your filters. If there's no match, no special message is returned.


DescribeTagsResponse
Returns information about the DescribeTagsResult response and response metadata.

DescribeTagsResult


DescribeTerminationPolicyTypesRequest
Container for the parameters to the DescribeTerminationPolicyTypes operation.

Returns a list of all termination policies supported by Auto Scaling.


DescribeTerminationPolicyTypesResponse
Returns information about the DescribeTerminationPolicyTypesResult response and response metadata.

DescribeTerminationPolicyTypesResult

The TerminationPolicyTypes data type.


DisableMetricsCollectionRequest
Container for the parameters to the DisableMetricsCollection operation.

Disables monitoring of group metrics for the Auto Scaling group specified in AutoScalingGroupName . You can specify the list of affected metrics with the Metrics parameter.


DisableMetricsCollectionResponse
Returns information about the DisableMetricsCollection response metadata. The DisableMetricsCollection operation has a void result type.

Ebs

The Ebs data type.


EnabledMetric

The EnabledMetric data type.


EnableMetricsCollectionRequest
Container for the parameters to the EnableMetricsCollection operation.

Enables monitoring of group metrics for the Auto Scaling group specified in AutoScalingGroupName . You can specify the list of enabled metrics with the Metrics parameter.

Auto Scaling metrics collection can be turned on only if the InstanceMonitoring flag, in the Auto Scaling group's launch configuration, is set to True .


EnableMetricsCollectionResponse
Returns information about the EnableMetricsCollection response metadata. The EnableMetricsCollection operation has a void result type.

ExecutePolicyRequest
Container for the parameters to the ExecutePolicy operation.

Executes the specified policy.


ExecutePolicyResponse
Returns information about the ExecutePolicy response metadata. The ExecutePolicy operation has a void result type.

Filter

The Filter data type.


Instance

The Instance data type.


InstanceMonitoring

The InstanceMonitoring data type.


InvalidNextTokenException
AmazonAutoScaling exception

LaunchConfiguration

The LaunchConfiguration data type.


LimitExceededException
AmazonAutoScaling exception

MetricCollectionType

The MetricCollectionType data type.


MetricGranularityType

The MetricGranularityType data type.


NotificationConfiguration

The NotificationConfiguration data type.


ProcessType

There are two primary Auto Scaling process types-- Launch and Terminate . The Launch process creates a new Amazon EC2 instance for an Auto Scaling group, and the Terminate process removes an existing Amazon EC2 instance.

The remaining Auto Scaling process types relate to specific Auto Scaling features:

  • AddToLoadBalancer
  • AlarmNotification
  • AZRebalance
  • HealthCheck
  • ReplaceUnhealthy
  • ScheduledActions

IMPORTANT: If you suspend Launch or Terminate, all other process types are affected to varying degrees. The following descriptions discuss how each process type is affected by a suspension of Launch or Terminate.

The AddToLoadBalancer process type adds instances to the load balancer when the instances are launched. If you suspend this process, Auto Scaling will launch the instances but will not add them to the load balancer. If you resume the AddToLoadBalancer process, Auto Scaling will also resume adding new instances to the load balancer when they are launched. However, Auto Scaling will not add running instances that were launched while the process was suspended; those instances must be added manually using the the RegisterInstancesWithLoadBalancer call in the Elastic Load Balancing API Reference .

The AlarmNotification process type accepts notifications from Amazon CloudWatch alarms that are associated with the Auto Scaling group. If you suspend the AlarmNotification process type, Auto Scaling will not automatically execute scaling policies that would be triggered by alarms.

Although the AlarmNotification process type is not directly affected by a suspension of Launch or Terminate , alarm notifications are often used to signal that a change in the size of the Auto Scaling group is warranted. If you suspend Launch or Terminate , Auto Scaling might not be able to implement the alarm's associated policy.

The AZRebalance process type seeks to maintain a balanced number of instances across Availability Zones within a Region. If you remove an Availability Zone from your Auto Scaling group or an Availability Zone otherwise becomes unhealthy or unavailable, Auto Scaling launches new instances in an unaffected Availability Zone before terminating the unhealthy or unavailable instances. When the unhealthy Availability Zone returns to a healthy state, Auto Scaling automatically redistributes the application instances evenly across all of the designated Availability Zones.

IMPORTANT: If you call SuspendProcesses on the launch process type, the AZRebalance process will neither launch new instances nor terminate existing instances. This is because the AZRebalance process terminates existing instances only after launching the replacement instances. If you call SuspendProcesses on the terminate process type, the AZRebalance process can cause your Auto Scaling group to grow up to ten percent larger than the maximum size. This is because Auto Scaling allows groups to temporarily grow larger than the maximum size during rebalancing activities. If Auto Scaling cannot terminate instances, your Auto Scaling group could remain up to ten percent larger than the maximum size until you resume the terminate process type.

The HealthCheck process type checks the health of the instances. Auto Scaling marks an instance as unhealthy if Amazon EC2 or Elastic Load Balancing informs Auto Scaling that the instance is unhealthy. The HealthCheck process can override the health status of an instance that you set with SetInstanceHealth.

The ReplaceUnhealthy process type terminates instances that are marked as unhealthy and subsequently creates new instances to replace them. This process calls both of the primary process types--first Terminate and then Launch .

IMPORTANT: The HealthCheck process type works in conjunction with the ReplaceUnhealthly process type to provide health check functionality. If you suspend either Launch or Terminate, the ReplaceUnhealthy process type will not function properly.

The ScheduledActions process type performs scheduled actions that you create with PutScheduledUpdateGroupAction. Scheduled actions often involve launching new instances or terminating existing instances. If you suspend either Launch or Terminate , your scheduled actions might not function as expected.


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 Get Email Notifications When Your Auto Scaling Group Changes

A new PutNotificationConfiguration overwrites an existing configuration.


PutNotificationConfigurationResponse
Returns information about the PutNotificationConfiguration response metadata. The PutNotificationConfiguration operation has a void result type.

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 parameter(s) you want to change. Any existing parameter not changed in an update to an existing policy is not changed in this update request.


PutScalingPolicyResponse
Returns information about the PutScalingPolicyResult response and response metadata.

PutScalingPolicyResult

The PolicyARNType data type.


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 information on creating or updating a scheduled action for your Auto Scaling group, see Scale Based on a Schedule .

NOTE: Auto Scaling supports the date and time expressed in "YYYY-MM-DDThh:mm:ssZ" format in UTC/GMT only.


PutScheduledUpdateGroupActionResponse
Returns information about the PutScheduledUpdateGroupAction response metadata. The PutScheduledUpdateGroupAction operation has a void result type.

ResourceInUseException
AmazonAutoScaling exception

ResumeProcessesRequest
Container for the parameters to the ResumeProcesses operation.

Resumes all suspended Auto Scaling processes for an Auto Scaling group. For information on suspending and resuming Auto Scaling process, see Suspend and Resume Auto Scaling Process .


ResumeProcessesResponse
Returns information about the ResumeProcesses response metadata. The ResumeProcesses operation has a void result type.

ScalingActivityInProgressException
AmazonAutoScaling exception

ScalingPolicy

The ScalingPolicy data type.


ScheduledUpdateGroupAction

This data type stores information about a scheduled update to an Auto Scaling group.


SetDesiredCapacityRequest
Container for the parameters to the SetDesiredCapacity operation.

Sets the desired size of the specified AutoScalingGroup.


SetDesiredCapacityResponse
Returns information about the SetDesiredCapacity response metadata. The SetDesiredCapacity operation has a void result type.

SetInstanceHealthRequest
Container for the parameters to the SetInstanceHealth operation.

Sets the health status of a specified instance that belongs to any of your Auto Scaling groups.

For more information, see Configure Health Checks for Your Auto Scaling group .


SetInstanceHealthResponse
Returns information about the SetInstanceHealth response metadata. The SetInstanceHealth operation has a void result type.

SuspendedProcess

An Auto Scaling process that has been suspended. For more information, see ProcessType.


SuspendProcessesRequest
Container for the parameters to the SuspendProcesses operation.

Suspends Auto Scaling processes for an Auto Scaling group. To suspend specific process types, specify them by name with the ScalingProcesses.member.N parameter. To suspend all process types, omit the ScalingProcesses.member.N parameter.

IMPORTANT: Suspending either of the two primary process types, Launch or Terminate, can prevent other process types from functioning properly.

To resume processes that have been suspended, use ResumeProcesses For more information on suspending and resuming Auto Scaling process, see Suspend and Resume Auto Scaling Process .


SuspendProcessesResponse
Returns information about the SuspendProcesses response metadata. The SuspendProcesses operation has a void result type.

Tag

The tag applied to an Auto Scaling group.


TagDescription

The tag applied to an Auto Scaling group.


TerminateInstanceInAutoScalingGroupRequest
Container for the parameters to the TerminateInstanceInAutoScalingGroup operation.

Terminates the specified instance. Optionally, the desired group size can be adjusted.

NOTE: This call simply registers a termination request. The termination of the instance cannot happen immediately.


TerminateInstanceInAutoScalingGroupResponse
Returns information about the TerminateInstanceInAutoScalingGroupResult response and response metadata.

TerminateInstanceInAutoScalingGroupResult

The output for the TerminateInstanceInAutoScalingGroup action.


UpdateAutoScalingGroupRequest
Container for the parameters to the UpdateAutoScalingGroup operation.

Updates the configuration for the specified AutoScalingGroup.

NOTE: To update an Auto Scaling group with a launch configuration that has the InstanceMonitoring flag set to False, you must first ensure that collection of group metrics is disabled. Otherwise, calls to UpdateAutoScalingGroup will fail. If you have previously enabled group metrics collection, you can disable collection of all group metrics by calling 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: If a new value is specified for MinSize without specifying the value for DesiredCapacity, and if the new MinSize is larger than the current size of the Auto Scaling Group, there will be an implicit call to SetDesiredCapacity to set the group to the new MinSize. If a new value is specified for MaxSize without specifying the value for DesiredCapacity, and the new MaxSize is smaller than the current size of the Auto Scaling Group, there will be an implicit call to SetDesiredCapacity to set the group to the new MaxSize. All other optional parameters are left unchanged if not passed in the request.


UpdateAutoScalingGroupResponse
Returns information about the UpdateAutoScalingGroup response metadata. The UpdateAutoScalingGroup operation has a void result type.