AWS.AutoScalingPlans — AWS SDK for JavaScript (original) (raw)

We recommend that you migrate to AWS SDK for JavaScript v3. For dates, additional details, and information on how to migrate, please refer to the linked announcement.

Overview

Constructs a service interface object. Each API operation is exposed as a function on service.

Service Description

Use AWS Auto Scaling to create scaling plans for your applications to automatically scale your scalable AWS resources.

API Summary

You can use the AWS Auto Scaling service API to accomplish the following tasks:

• Create and manage scaling plans
• Define target tracking scaling policies to dynamically scale your resources based on utilization
• Scale Amazon EC2 Auto Scaling groups using predictive scaling and dynamic scaling to scale your Amazon EC2 capacity faster
• Set minimum and maximum capacity limits
• Retrieve information on existing scaling plans
• Access current forecast data and historical forecast data for up to 56 days previous

To learn more about AWS Auto Scaling, including information about granting IAM users required permissions for AWS Auto Scaling actions, see the AWS Auto Scaling User Guide.

Sending a Request Using AutoScalingPlans

var autoscalingplans = new AWS.AutoScalingPlans();
autoscalingplans.createScalingPlan(params, function (err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Locking the API Version

In order to ensure that the AutoScalingPlans object uses this specific API, you can construct the object by passing the apiVersion option to the constructor:

var autoscalingplans = new AWS.AutoScalingPlans({apiVersion: '2018-01-06'});

You can also set the API version globally in AWS.config.apiVersions using the autoscalingplans service identifier:

AWS.config.apiVersions = {
  autoscalingplans: '2018-01-06',
  // other service API versions
};

var autoscalingplans = new AWS.AutoScalingPlans();

Constructor Summarycollapse

• new AWS.AutoScalingPlans(options = {}) ⇒ Object constructor
  Constructs a service object.

Property Summarycollapse

• endpoint ⇒ AWS.Endpoint readwrite
  An Endpoint object representing the endpoint URL for service requests.

Properties inherited from AWS.Service

apiVersions

Method Summarycollapse

• createScalingPlan(params = {}, callback) ⇒ AWS.Request
• deleteScalingPlan(params = {}, callback) ⇒ AWS.Request
  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.
  .
• describeScalingPlanResources(params = {}, callback) ⇒ AWS.Request
  Describes the scalable resources in the specified scaling plan.
  .
• describeScalingPlans(params = {}, callback) ⇒ AWS.Request
  Describes one or more of your scaling plans.
  .
• getScalingPlanResourceForecastData(params = {}, callback) ⇒ AWS.Request
  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.
• updateScalingPlan(params = {}, callback) ⇒ AWS.Request
  Updates the specified scaling plan.
  You cannot update a scaling plan if it is in the process of being created, updated, or deleted.
  .

Methods inherited from AWS.Service

makeRequest, makeUnauthenticatedRequest, waitFor, setupRequestListeners, defineService

Constructor Details

new AWS.AutoScalingPlans(options = {}) ⇒ Object

Constructs a service object. This object has one method for each API operation.

Property Details

endpoint ⇒ AWS.Endpoint

Returns an Endpoint object representing the endpoint URL for service requests.

Method Details

createScalingPlan(params = {}, callback) ⇒ AWS.Request

deleteScalingPlan(params = {}, callback) ⇒ AWS.Request

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.

describeScalingPlanResources(params = {}, callback) ⇒ AWS.Request

Describes the scalable resources in the specified scaling plan.

describeScalingPlans(params = {}, callback) ⇒ AWS.Request

Describes one or more of your scaling plans.

getScalingPlanResourceForecastData(params = {}, callback) ⇒ AWS.Request

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.

updateScalingPlan(params = {}, callback) ⇒ AWS.Request

Updates the specified scaling plan.

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