C# (CSharp) Amazon.AutoScaling.Model Namespace

Nested Namespaces

Amazon.AutoScaling.Model.Internal

Classes

Name Description
Activity
AdjustmentType

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

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

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

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

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.

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

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 instead, see AttachLoadBalancerTargetGroups.

To describe the load balancers for an Auto Scaling group, use DescribeLoadBalancers. To detach the load balancer from the Auto Scaling group, use DetachLoadBalancers.

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

AutoScalingGroup

The AutoScalingGroup data type.

AutoScalingInstanceDetails

The AutoScalingInstanceDetails data type.

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

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.

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

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

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.

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.

DeleteNotificationConfigurationRequest Container for the parameters to the DeleteNotificationConfiguration operation.

Deletes notifications created by PutNotificationConfiguration.

DeletePolicyRequest Container for the parameters to the DeletePolicy operation.

Deletes a policy created by PutScalingPolicy.

DeleteScheduledActionRequest Container for the parameters to the DeleteScheduledAction operation.

Deletes a scheduled action previously created using the PutScheduledUpdateGroupAction.

DeleteTagsRequest Container for the parameters to the DeleteTags operation.

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

DescribeAccountLimitsResponse Contains the parameters for DescribeAccountLimits.
DescribeAccountLimitsResult

The output of the DescribeAccountLimitsResult action.

DescribeAdjustmentTypesResponse Returns information about the DescribeAdjustmentTypes response and response metadata.
DescribeAdjustmentTypesResult

The output of the DescribeAdjustmentTypes action.

DescribeAutoScalingGroupsRequest
DescribeAutoScalingGroupsResponse Returns information about the DescribeAutoScalingGroups response and response metadata.
DescribeAutoScalingGroupsResult
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 Contains the output of DescribeAutoScalingInstances.
DescribeAutoScalingInstancesResult
DescribeAutoScalingNotificationTypesResponse Returns information about the DescribeAutoScalingNotificationTypes response and response metadata.
DescribeAutoScalingNotificationTypesResult
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
DescribeLaunchConfigurationsResult

The LaunchConfigurationsType data type.

DescribeLifecycleHookTypesResponse Contains the output of DescribeLifecycleHookTypes.
DescribeLifecycleHooksRequest Container for the parameters to the DescribeLifecycleHooks operation. Describes the lifecycle hooks for the specified Auto Scaling group.
DescribeLifecycleHooksResponse Contains the output of DescribeLifecycleHooks.
DescribeLoadBalancerTargetGroupsRequest Container for the parameters to the DescribeLoadBalancerTargetGroups operation. Describes the target groups for the specified Auto Scaling group.
DescribeLoadBalancerTargetGroupsResponse Contains the output of DescribeLoadBalancerTargetGroups.
DescribeLoadBalancersRequest Container for the parameters to the DescribeLoadBalancers operation. Describes the load balancers for the specified Auto Scaling group.

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

DescribeLoadBalancersResponse Contains the output of DescribeLoadBalancers.
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 Contains the output from DescribeNotificationConfigurations.
DescribePoliciesRequest Container for the parameters to the DescribePolicies operation. Describes the policies for the specified Auto Scaling group.
DescribePoliciesResponse Returns information about the DescribePoliciesResult response and response metadata.
DescribePoliciesResult

The PoliciesType data type.

DescribeScalingActivitiesRequest
DescribeScalingActivitiesResponse Contains the output of DescribeScalingActivities.
DescribeScalingActivitiesResult

The output for the DescribeScalingActivities action.

DescribeScalingProcessTypesResponse Contains the output of DescribeScalingProcessTypes.
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 action already executed, see the activity record returned in DescribeScalingActivities.

DescribeScheduledActionsResponse Contains the output of DescribeScheduledActions.
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 Contains the output of DescribeTags.
DescribeTagsResult

DescribeTerminationPolicyTypesResponse Returns information about the DescribeTerminationPolicyTypesResult response and response metadata.
DescribeTerminationPolicyTypesResult

The TerminationPolicyTypes data type.

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.

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

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

DetachInstancesResponse Configuration for accessing Amazon DetachInstances service
DetachLoadBalancerTargetGroupsRequest Container for the parameters to the DetachLoadBalancerTargetGroups operation. Detaches one or more target groups from the specified Auto Scaling group.
DetachLoadBalancersRequest Container for the parameters to the DetachLoadBalancers operation. Detaches one or more Classic load balancers from the specified Auto Scaling group.

Note that this operation detaches only Classic load balancers. If you have Application load balancers, use DetachLoadBalancerTargetGroups instead.

When you detach a load balancer, it enters the Removing state while deregistering the instances in the group. When all instances are deregistered, then you can no longer describe the load balancer using DescribeLoadBalancers. Note that the instances remain running.

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.

Ebs

The Ebs data type.

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

The EnabledMetric data type.

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

EnterStandbyResponse Contains the output of EnterStandby.
ExecutePolicyRequest Container for the parameters to the ExecutePolicy operation.

Runs the policy you create for your Auto Scaling group in PutScalingPolicy.

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

ExitStandbyResponse Contains the parameters for ExitStandby.
Filter Describes a filter.
Instance
InstanceMonitoring

The InstanceMonitoring data type.

InvalidNextTokenException
LaunchConfiguration Describes a launch configuration.
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 User Guide.

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

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

MetricCollectionType

The MetricCollectionType data type.

MetricGranularityType

The MetricGranularityType data type.

NotificationConfiguration Describes a notification.
ProcessType Describes a process type.

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

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

If you exceed your maximum limit of lifecycle hooks, which by default is 50 per Auto Scaling group, the call fails. For information about updating this limit, see AWS Service Limits in the Amazon Web Services General Reference.

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.

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.

PutScalingPolicyResponse Returns information about the PutScalingPolicy 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.

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

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

ScalingActivityInProgressException
ScalingPolicy Describes a scaling policy.
ScheduledUpdateGroupAction

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

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

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 .

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

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

SuspendedProcess

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

Tag Describes a tag for an Auto Scaling group.
TagDescription Describes a tag for an Auto Scaling group.
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.

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.enabled 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. Triggers that are currently in progress aren't affected.

NOTE: If the new values are specified for the MinSize or MaxSize parameters, then there will be an implicit call to SetDesiredCapacity to set the group to the new MaxSize. All optional parameters are left unchanged if not passed in the request.