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 ApplicationSource

Represents an application source.

Class ConcurrentUpdateException

AutoScalingPlans exception

Class CreateScalingPlanRequest

Container for the parameters to the CreateScalingPlan operation. Creates a scaling plan.

Class CreateScalingPlanResponse

This is the response object from the CreateScalingPlan operation.

Class CustomizedLoadMetricSpecification

Represents a CloudWatch metric of your choosing that can be used for predictive scaling.

For predictive scaling to work with a customized load metric specification, AWS Auto Scaling needs access to the Sum and Average statistics that CloudWatch computes from metric data. Statistics are calculations used to aggregate data over specified time periods.

When you choose a load metric, make sure that the required Sum and Average statistics for your metric are available in CloudWatch and that they provide relevant data for predictive scaling. The Sum statistic must represent the total load on the resource, and the Average statistic must represent the average load per capacity unit of the resource. For example, there is a metric that counts the number of requests processed by your Auto Scaling group. If the Sum statistic represents the total request count processed by the group, then the Average statistic for the specified metric must represent the average request count processed by each instance of the group.

For information about terminology, available metrics, or how to publish new metrics, see Amazon CloudWatch Concepts in the Amazon CloudWatch User Guide.

Class CustomizedScalingMetricSpecification

Represents a CloudWatch metric of your choosing that can be used for dynamic scaling as part of a target tracking scaling policy.

To create your customized scaling 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 Datapoint

Represents a single value in the forecast data used for predictive scaling.

Class DeleteScalingPlanRequest

Container for the parameters to the DeleteScalingPlan operation. Deletes the specified scaling plan.

Deleting a scaling plan deletes the underlying ScalingInstruction for all of the scalable resources that are covered by the plan.

If the plan has launched resources or has scaling activities in progress, you must delete those resources separately.

Class DeleteScalingPlanResponse

This is the response object from the DeleteScalingPlan operation.

Class DescribeScalingPlanResourcesRequest

Container for the parameters to the DescribeScalingPlanResources operation. Describes the scalable resources in the specified scaling plan.

Class DescribeScalingPlanResourcesResponse

This is the response object from the DescribeScalingPlanResources operation.

Class DescribeScalingPlansRequest

Container for the parameters to the DescribeScalingPlans operation. Describes one or more of your scaling plans.

Class DescribeScalingPlansResponse

This is the response object from the DescribeScalingPlans operation.

Class GetScalingPlanResourceForecastDataRequest

Container for the parameters to the GetScalingPlanResourceForecastData operation. Retrieves the forecast data for a scalable resource.

Capacity forecasts are represented as predicted values, or data points, that are calculated using historical data points from a specified CloudWatch load metric. Data points are available for up to 56 days.

Class GetScalingPlanResourceForecastDataResponse

This is the response object from the GetScalingPlanResourceForecastData operation.

Class InternalServiceException

AutoScalingPlans exception

Class InvalidNextTokenException

AutoScalingPlans exception

Class LimitExceededException

AutoScalingPlans exception

Class MetricDimension

Represents a dimension for a customized metric.

Class ObjectNotFoundException

AutoScalingPlans exception

Class PredefinedLoadMetricSpecification

Represents a predefined metric that can be used for predictive scaling.

Class PredefinedScalingMetricSpecification

Represents a predefined metric that can be used for dynamic scaling as part of a target tracking scaling policy.

Class ScalingInstruction

Describes a scaling instruction for a scalable resource.

The scaling instruction is used in combination with a scaling plan, which is a set of instructions for configuring dynamic scaling and predictive scaling for the scalable resources in your application. Each scaling instruction applies to one resource.

AWS Auto Scaling creates target tracking scaling policies based on the scaling instructions. Target tracking scaling policies adjust the capacity of your scalable resource as required to maintain resource utilization at the target value that you specified.

AWS Auto Scaling also configures predictive scaling for your Amazon EC2 Auto Scaling groups using a subset of parameters, including the load metric, the scaling metric, the target value for the scaling metric, the predictive scaling mode (forecast and scale or forecast only), and the desired behavior when the forecast capacity exceeds the maximum capacity of the resource. With predictive scaling, AWS Auto Scaling generates forecasts with traffic predictions for the two days ahead and schedules scaling actions that proactively add and remove resource capacity to match the forecast.

We recommend waiting a minimum of 24 hours after creating an Auto Scaling group to configure predictive scaling. At minimum, there must be 24 hours of historical data to generate a forecast.

For more information, see Getting Started with AWS Auto Scaling.

Class ScalingPlan

Represents a scaling plan.

Class ScalingPlanResource

Represents a scalable resource.

Class ScalingPolicy

Represents a scaling policy.

Class TagFilter

Represents a tag.

Class TargetTrackingConfiguration

Describes a target tracking configuration to use with AWS Auto Scaling. Used with ScalingInstruction and ScalingPolicy.

Class UpdateScalingPlanRequest

Container for the parameters to the UpdateScalingPlan operation. Updates the specified scaling plan.

You cannot update a scaling plan if it is in the process of being created, updated, or deleted.

Class UpdateScalingPlanResponse

This is the response object from the UpdateScalingPlan operation.

Class ValidationException

AutoScalingPlans exception