Class: AWS.AutoScalingPlans

Inherits:
AWS.Service show all
Identifier:
autoscalingplans
API Version:
2018-01-06
Defined in:
(unknown)

Overview

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

Service Description

Use AWS Auto Scaling to quickly discover all the scalable AWS resources for your application and configure dynamic scaling and predictive scaling for your resources using scaling plans. Use this service in conjunction with the Amazon EC2 Auto Scaling, Application Auto Scaling, Amazon CloudWatch, and AWS CloudFormation services.

Currently, predictive scaling is only available for Amazon EC2 Auto Scaling groups.

For more information 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();

Version:

  • 2018-01-06

Constructor Summary collapse

Property Summary collapse

Properties inherited from AWS.Service

apiVersions

Method Summary collapse

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.

Examples:

Constructing a AutoScalingPlans object

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

Options Hash (options):

  • params (map)

    An optional map of parameters to bind to every request sent by this service object. For more information on bound parameters, see "Working with Services" in the Getting Started Guide.

  • endpoint (String)

    The endpoint URI to send requests to. The default endpoint is built from the configured region. The endpoint should be a string like 'https://{service}.{region}.amazonaws.com'.

  • accessKeyId (String)

    your AWS access key ID.

  • secretAccessKey (String)

    your AWS secret access key.

  • sessionToken (AWS.Credentials)

    the optional AWS session token to sign requests with.

  • credentials (AWS.Credentials)

    the AWS credentials to sign requests with. You can either specify this object, or specify the accessKeyId and secretAccessKey options directly.

  • credentialProvider (AWS.CredentialProviderChain)

    the provider chain used to resolve credentials if no static credentials property is set.

  • region (String)

    the region to send service requests to. See AWS.AutoScalingPlans.region for more information.

  • maxRetries (Integer)

    the maximum amount of retries to attempt with a request. See AWS.AutoScalingPlans.maxRetries for more information.

  • maxRedirects (Integer)

    the maximum amount of redirects to follow with a request. See AWS.AutoScalingPlans.maxRedirects for more information.

  • sslEnabled (Boolean)

    whether to enable SSL for requests.

  • paramValidation (Boolean|map)

    whether input parameters should be validated against the operation description before sending the request. Defaults to true. Pass a map to enable any of the following specific validation features:

    • min [Boolean] — Validates that a value meets the min constraint. This is enabled by default when paramValidation is set to true.
    • max [Boolean] — Validates that a value meets the max constraint.
    • pattern [Boolean] — Validates that a string value matches a regular expression.
    • enum [Boolean] — Validates that a string value matches one of the allowable enum values.
  • computeChecksums (Boolean)

    whether to compute checksums for payload bodies when the service accepts it (currently supported in S3 only)

  • convertResponseTypes (Boolean)

    whether types are converted when parsing response data. Currently only supported for JSON based services. Turning this off may improve performance on large response payloads. Defaults to true.

  • correctClockSkew (Boolean)

    whether to apply a clock skew correction and retry requests that fail because of an skewed client clock. Defaults to false.

  • s3ForcePathStyle (Boolean)

    whether to force path style URLs for S3 objects.

  • s3BucketEndpoint (Boolean)

    whether the provided endpoint addresses an individual bucket (false if it addresses the root API endpoint). Note that setting this configuration option requires an endpoint to be provided explicitly to the service constructor.

  • s3DisableBodySigning (Boolean)

    whether S3 body signing should be disabled when using signature version v4. Body signing can only be disabled when using https. Defaults to true.

  • retryDelayOptions (map)

    A set of options to configure the retry delay on retryable errors. Currently supported options are:

    • base [Integer] — The base number of milliseconds to use in the exponential backoff for operation retries. Defaults to 100 ms for all services except DynamoDB, where it defaults to 50ms.
    • customBackoff [function] — A custom function that accepts a retry count and error and returns the amount of time to delay in milliseconds. If the result is a non-zero negative value, no further retry attempts will be made. The base option will be ignored if this option is supplied.
  • httpOptions (map)

    A set of options to pass to the low-level HTTP request. Currently supported options are:

    • proxy [String] — the URL to proxy requests through
    • agent [http.Agent, https.Agent] — the Agent object to perform HTTP requests with. Used for connection pooling. Defaults to the global agent (http.globalAgent) for non-SSL connections. Note that for SSL connections, a special Agent object is used in order to enable peer certificate verification. This feature is only available in the Node.js environment.
    • connectTimeout [Integer] — Sets the socket to timeout after failing to establish a connection with the server after connectTimeout milliseconds. This timeout has no effect once a socket connection has been established.
    • timeout [Integer] — Sets the socket to timeout after timeout milliseconds of inactivity on the socket. Defaults to two minutes (120000).
    • xhrAsync [Boolean] — Whether the SDK will send asynchronous HTTP requests. Used in the browser environment only. Set to false to send requests synchronously. Defaults to true (async on).
    • xhrWithCredentials [Boolean] — Sets the "withCredentials" property of an XMLHttpRequest object. Used in the browser environment only. Defaults to false.
  • apiVersion (String, Date)

    a String in YYYY-MM-DD format (or a date) that represents the latest possible API version that can be used in all services (unless overridden by apiVersions). Specify 'latest' to use the latest possible version.

  • apiVersions (map<String, String|Date>)

    a map of service identifiers (the lowercase service class name) with the API version to use when instantiating a service. Specify 'latest' for each individual that can use the latest available version.

  • logger (#write, #log)

    an object that responds to .write() (like a stream) or .log() (like the console object) in order to log information about requests

  • systemClockOffset (Number)

    an offset value in milliseconds to apply to all signing times. Use this to compensate for clock skew when your system may be out of sync with the service time. Note that this configuration option can only be applied to the global AWS.config object and cannot be overridden in service-specific configuration. Defaults to 0 milliseconds.

  • signatureVersion (String)

    the signature version to sign requests with (overriding the API configuration). Possible values are: 'v2', 'v3', 'v4'.

  • signatureCache (Boolean)

    whether the signature to sign requests with (overriding the API configuration) is cached. Only applies to the signature version 'v4'. Defaults to true.

  • dynamoDbCrc32 (Boolean)

    whether to validate the CRC32 checksum of HTTP response bodies returned by DynamoDB. Default: true.

  • useAccelerateEndpoint (Boolean)

    Whether to use the S3 Transfer Acceleration endpoint with the S3 service. Default: false.

  • clientSideMonitoring (Boolean)

    whether to collect and publish this client's performance metrics of all its API requests.

  • endpointDiscoveryEnabled (Boolean)

    whether to enable endpoint discovery for operations that allow optionally using an endpoint returned by the service. Defaults to 'false'

  • endpointCacheSize (Number)

    the size of the global cache storing endpoints from endpoint discovery operations. Once endpoint cache is created, updating this setting cannot change existing cache size. Defaults to 1000

  • hostPrefixEnabled (Boolean)

    whether to marshal request parameters to the prefix of hostname. Defaults to true.

  • stsRegionalEndpoints ('legacy'|'regional')

    whether to send sts request to global endpoints or regional endpoints. Defaults to 'legacy'.

Property Details

endpointAWS.Endpoint (readwrite)

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

Returns:

  • (AWS.Endpoint)

    an Endpoint object representing the endpoint URL for service requests.

Method Details

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

Creates a scaling plan.

Service Reference:

Examples:

Calling the createScalingPlan operation

var params = {
  ApplicationSource: { /* required */
    CloudFormationStackARN: 'STRING_VALUE',
    TagFilters: [
      {
        Key: 'STRING_VALUE',
        Values: [
          'STRING_VALUE',
          /* more items */
        ]
      },
      /* more items */
    ]
  },
  ScalingInstructions: [ /* required */
    {
      MaxCapacity: 'NUMBER_VALUE', /* required */
      MinCapacity: 'NUMBER_VALUE', /* required */
      ResourceId: 'STRING_VALUE', /* required */
      ScalableDimension: autoscaling:autoScalingGroup:DesiredCapacity | ecs:service:DesiredCount | ec2:spot-fleet-request:TargetCapacity | rds:cluster:ReadReplicaCount | dynamodb:table:ReadCapacityUnits | dynamodb:table:WriteCapacityUnits | dynamodb:index:ReadCapacityUnits | dynamodb:index:WriteCapacityUnits, /* required */
      ServiceNamespace: autoscaling | ecs | ec2 | rds | dynamodb, /* required */
      TargetTrackingConfigurations: [ /* required */
        {
          TargetValue: 'NUMBER_VALUE', /* required */
          CustomizedScalingMetricSpecification: {
            MetricName: 'STRING_VALUE', /* required */
            Namespace: 'STRING_VALUE', /* required */
            Statistic: Average | Minimum | Maximum | SampleCount | Sum, /* required */
            Dimensions: [
              {
                Name: 'STRING_VALUE', /* required */
                Value: 'STRING_VALUE' /* required */
              },
              /* more items */
            ],
            Unit: 'STRING_VALUE'
          },
          DisableScaleIn: true || false,
          EstimatedInstanceWarmup: 'NUMBER_VALUE',
          PredefinedScalingMetricSpecification: {
            PredefinedScalingMetricType: ASGAverageCPUUtilization | ASGAverageNetworkIn | ASGAverageNetworkOut | DynamoDBReadCapacityUtilization | DynamoDBWriteCapacityUtilization | ECSServiceAverageCPUUtilization | ECSServiceAverageMemoryUtilization | ALBRequestCountPerTarget | RDSReaderAverageCPUUtilization | RDSReaderAverageDatabaseConnections | EC2SpotFleetRequestAverageCPUUtilization | EC2SpotFleetRequestAverageNetworkIn | EC2SpotFleetRequestAverageNetworkOut, /* required */
            ResourceLabel: 'STRING_VALUE'
          },
          ScaleInCooldown: 'NUMBER_VALUE',
          ScaleOutCooldown: 'NUMBER_VALUE'
        },
        /* more items */
      ],
      CustomizedLoadMetricSpecification: {
        MetricName: 'STRING_VALUE', /* required */
        Namespace: 'STRING_VALUE', /* required */
        Statistic: Average | Minimum | Maximum | SampleCount | Sum, /* required */
        Dimensions: [
          {
            Name: 'STRING_VALUE', /* required */
            Value: 'STRING_VALUE' /* required */
          },
          /* more items */
        ],
        Unit: 'STRING_VALUE'
      },
      DisableDynamicScaling: true || false,
      PredefinedLoadMetricSpecification: {
        PredefinedLoadMetricType: ASGTotalCPUUtilization | ASGTotalNetworkIn | ASGTotalNetworkOut | ALBTargetGroupRequestCount, /* required */
        ResourceLabel: 'STRING_VALUE'
      },
      PredictiveScalingMaxCapacityBehavior: SetForecastCapacityToMaxCapacity | SetMaxCapacityToForecastCapacity | SetMaxCapacityAboveForecastCapacity,
      PredictiveScalingMaxCapacityBuffer: 'NUMBER_VALUE',
      PredictiveScalingMode: ForecastAndScale | ForecastOnly,
      ScalingPolicyUpdateBehavior: KeepExternalPolicies | ReplaceExternalPolicies,
      ScheduledActionBufferTime: 'NUMBER_VALUE'
    },
    /* more items */
  ],
  ScalingPlanName: 'STRING_VALUE' /* required */
};
autoscalingplans.createScalingPlan(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • ScalingPlanName — (String)

      The name of the scaling plan. Names cannot contain vertical bars, colons, or forward slashes.

    • ApplicationSource — (map)

      A CloudFormation stack or set of tags. You can create one scaling plan per application source.

      • CloudFormationStackARN — (String)

        The Amazon Resource Name (ARN) of a AWS CloudFormation stack.

      • TagFilters — (Array<map>)

        A set of tags (up to 50).

        • Key — (String)

          The tag key.

        • Values — (Array<String>)

          The tag values (0 to 20).

    • ScalingInstructions — (Array<map>)

      The scaling instructions.

      • ServiceNamespacerequired — (String)

        The namespace of the AWS service.

        Possible values include:
        • "autoscaling"
        • "ecs"
        • "ec2"
        • "rds"
        • "dynamodb"
      • ResourceIdrequired — (String)

        The ID of the resource. This string consists of the resource type and unique identifier.

        • Auto Scaling group - The resource type is autoScalingGroup and the unique identifier is the name of the Auto Scaling group. Example: autoScalingGroup/my-asg.

        • ECS service - The resource type is service and the unique identifier is the cluster name and service name. Example: service/default/sample-webapp.

        • Spot Fleet request - The resource type is spot-fleet-request and the unique identifier is the Spot Fleet request ID. Example: spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE.

        • DynamoDB table - The resource type is table and the unique identifier is the resource ID. Example: table/my-table.

        • DynamoDB global secondary index - The resource type is index and the unique identifier is the resource ID. Example: table/my-table/index/my-table-index.

        • Aurora DB cluster - The resource type is cluster and the unique identifier is the cluster name. Example: cluster:my-db-cluster.

      • ScalableDimensionrequired — (String)

        The scalable dimension associated with the resource.

        • autoscaling:autoScalingGroup:DesiredCapacity - The desired capacity of an Auto Scaling group.

        • ecs:service:DesiredCount - The desired task count of an ECS service.

        • ec2:spot-fleet-request:TargetCapacity - The target capacity of a Spot Fleet request.

        • dynamodb:table:ReadCapacityUnits - The provisioned read capacity for a DynamoDB table.

        • dynamodb:table:WriteCapacityUnits - The provisioned write capacity for a DynamoDB table.

        • dynamodb:index:ReadCapacityUnits - The provisioned read capacity for a DynamoDB global secondary index.

        • dynamodb:index:WriteCapacityUnits - The provisioned write capacity for a DynamoDB global secondary index.

        • rds:cluster:ReadReplicaCount - The count of Aurora Replicas in an Aurora DB cluster. Available for Aurora MySQL-compatible edition and Aurora PostgreSQL-compatible edition.

        Possible values include:
        • "autoscaling:autoScalingGroup:DesiredCapacity"
        • "ecs:service:DesiredCount"
        • "ec2:spot-fleet-request:TargetCapacity"
        • "rds:cluster:ReadReplicaCount"
        • "dynamodb:table:ReadCapacityUnits"
        • "dynamodb:table:WriteCapacityUnits"
        • "dynamodb:index:ReadCapacityUnits"
        • "dynamodb:index:WriteCapacityUnits"
      • MinCapacityrequired — (Integer)

        The minimum capacity of the resource.

      • MaxCapacityrequired — (Integer)

        The maximum capacity of the resource. The exception to this upper limit is if you specify a non-default setting for PredictiveScalingMaxCapacityBehavior.

      • TargetTrackingConfigurationsrequired — (Array<map>)

        The structure that defines new target tracking configurations (up to 10). Each of these structures includes a specific scaling metric and a target value for the metric, along with various parameters to use with dynamic scaling.

        With predictive scaling and dynamic scaling, the resource scales based on the target tracking configuration that provides the largest capacity for both scale in and scale out.

        Condition: The scaling metric must be unique across target tracking configurations.

        • PredefinedScalingMetricSpecification — (map)

          A predefined metric. You can specify either a predefined metric or a customized metric.

          • PredefinedScalingMetricTyperequired — (String)

            The metric type. The ALBRequestCountPerTarget metric type applies only to Auto Scaling groups, Spot Fleet requests, and ECS services.

            Possible values include:
            • "ASGAverageCPUUtilization"
            • "ASGAverageNetworkIn"
            • "ASGAverageNetworkOut"
            • "DynamoDBReadCapacityUtilization"
            • "DynamoDBWriteCapacityUtilization"
            • "ECSServiceAverageCPUUtilization"
            • "ECSServiceAverageMemoryUtilization"
            • "ALBRequestCountPerTarget"
            • "RDSReaderAverageCPUUtilization"
            • "RDSReaderAverageDatabaseConnections"
            • "EC2SpotFleetRequestAverageCPUUtilization"
            • "EC2SpotFleetRequestAverageNetworkIn"
            • "EC2SpotFleetRequestAverageNetworkOut"
          • ResourceLabel — (String)

            Identifies the resource associated with the metric type. You can't specify a resource label unless the metric type is ALBRequestCountPerTarget and there is a target group for an Application Load Balancer attached to the Auto Scaling group, Spot Fleet request, or ECS service.

            The format is app/<load-balancer-name>/<load-balancer-id>/targetgroup/<target-group-name>/<target-group-id>, where:

            • app/<load-balancer-name>/<load-balancer-id> is the final portion of the load balancer ARN.

            • targetgroup/<target-group-name>/<target-group-id> is the final portion of the target group ARN.

        • CustomizedScalingMetricSpecification — (map)

          A customized metric. You can specify either a predefined metric or a customized metric.

          • MetricNamerequired — (String)

            The name of the metric.

          • Namespacerequired — (String)

            The namespace of the metric.

          • Dimensions — (Array<map>)

            The dimensions of the metric.

            Conditional: If you published your metric with dimensions, you must specify the same dimensions in your customized scaling metric specification.

            • Namerequired — (String)

              The name of the dimension.

            • Valuerequired — (String)

              The value of the dimension.

          • Statisticrequired — (String)

            The statistic of the metric.

            Possible values include:
            • "Average"
            • "Minimum"
            • "Maximum"
            • "SampleCount"
            • "Sum"
          • Unit — (String)

            The unit of the metric.

        • TargetValuerequired — (Float)

          The target value for the metric. The range is 8.515920e-109 to 1.174271e+108 (Base 10) or 2e-360 to 2e360 (Base 2).

        • DisableScaleIn — (Boolean)

          Indicates whether scale in by the target tracking scaling policy is disabled. If the value is true, scale in is disabled and the target tracking scaling policy doesn't remove capacity from the scalable resource. Otherwise, scale in is enabled and the target tracking scaling policy can remove capacity from the scalable resource.

          The default value is false.

        • ScaleOutCooldown — (Integer)

          The amount of time, in seconds, after a scale-out activity completes before another scale-out activity can start. This value is not used if the scalable resource is an Auto Scaling group.

          While the cooldown period is in effect, the capacity that has been added by the previous scale-out event that initiated the cooldown is calculated as part of the desired capacity for the next scale out. The intention is to continuously (but not excessively) scale out.

        • ScaleInCooldown — (Integer)

          The amount of time, in seconds, after a scale in activity completes before another scale in activity can start. This value is not used if the scalable resource is an Auto Scaling group.

          The cooldown period is used to block subsequent scale in requests until it has expired. The intention is to scale in conservatively to protect your application's availability. However, if another alarm triggers a scale-out policy during the cooldown period after a scale-in, AWS Auto Scaling scales out your scalable target immediately.

        • EstimatedInstanceWarmup — (Integer)

          The estimated time, in seconds, until a newly launched instance can contribute to the CloudWatch metrics. This value is used only if the resource is an Auto Scaling group.

      • PredefinedLoadMetricSpecification — (map)

        The predefined load metric to use for predictive scaling. This parameter or a CustomizedLoadMetricSpecification is required when configuring predictive scaling, and cannot be used otherwise.

        • PredefinedLoadMetricTyperequired — (String)

          The metric type.

          Possible values include:
          • "ASGTotalCPUUtilization"
          • "ASGTotalNetworkIn"
          • "ASGTotalNetworkOut"
          • "ALBTargetGroupRequestCount"
        • ResourceLabel — (String)

          Identifies the resource associated with the metric type. You can't specify a resource label unless the metric type is ALBRequestCountPerTarget and there is a target group for an Application Load Balancer attached to the Auto Scaling group.

          The format is app/<load-balancer-name>/<load-balancer-id>/targetgroup/<target-group-name>/<target-group-id>, where:

          • app/<load-balancer-name>/<load-balancer-id> is the final portion of the load balancer ARN.

          • targetgroup/<target-group-name>/<target-group-id> is the final portion of the target group ARN.

      • CustomizedLoadMetricSpecification — (map)

        The customized load metric to use for predictive scaling. This parameter or a PredefinedLoadMetricSpecification is required when configuring predictive scaling, and cannot be used otherwise.

        • MetricNamerequired — (String)

          The name of the metric.

        • Namespacerequired — (String)

          The namespace of the metric.

        • Dimensions — (Array<map>)

          The dimensions of the metric.

          Conditional: If you published your metric with dimensions, you must specify the same dimensions in your customized load metric specification.

          • Namerequired — (String)

            The name of the dimension.

          • Valuerequired — (String)

            The value of the dimension.

        • Statisticrequired — (String)

          The statistic of the metric. Currently, the value must always be Sum.

          Possible values include:
          • "Average"
          • "Minimum"
          • "Maximum"
          • "SampleCount"
          • "Sum"
        • Unit — (String)

          The unit of the metric.

      • ScheduledActionBufferTime — (Integer)

        The amount of time, in seconds, to buffer the run time of scheduled scaling actions when scaling out. For example, if the forecast says to add capacity at 10:00 AM, and the buffer time is 5 minutes, then the run time of the corresponding scheduled scaling action will be 9:55 AM. The intention is to give resources time to be provisioned. For example, it can take a few minutes to launch an EC2 instance. The actual amount of time required depends on several factors, such as the size of the instance and whether there are startup scripts to complete.

        The value must be less than the forecast interval duration of 3600 seconds (60 minutes). The default is 300 seconds.

        Only valid when configuring predictive scaling.

      • PredictiveScalingMaxCapacityBehavior — (String)

        Defines the behavior that should be applied if the forecast capacity approaches or exceeds the maximum capacity specified for the resource. The default value is SetForecastCapacityToMaxCapacity.

        The following are possible values:

        • SetForecastCapacityToMaxCapacity - AWS Auto Scaling cannot scale resource capacity higher than the maximum capacity. The maximum capacity is enforced as a hard limit.

        • SetMaxCapacityToForecastCapacity - AWS Auto Scaling may scale resource capacity higher than the maximum capacity to equal but not exceed forecast capacity.

        • SetMaxCapacityAboveForecastCapacity - AWS Auto Scaling may scale resource capacity higher than the maximum capacity by a specified buffer value. The intention is to give the target tracking scaling policy extra capacity if unexpected traffic occurs.

        Only valid when configuring predictive scaling.

        Possible values include:
        • "SetForecastCapacityToMaxCapacity"
        • "SetMaxCapacityToForecastCapacity"
        • "SetMaxCapacityAboveForecastCapacity"
      • PredictiveScalingMaxCapacityBuffer — (Integer)

        The size of the capacity buffer to use when the forecast capacity is close to or exceeds the maximum capacity. The value is specified as a percentage relative to the forecast capacity. For example, if the buffer is 10, this means a 10 percent buffer, such that if the forecast capacity is 50, and the maximum capacity is 40, then the effective maximum capacity is 55.

        Only valid when configuring predictive scaling. Required if the PredictiveScalingMaxCapacityBehavior is set to SetMaxCapacityAboveForecastCapacity, and cannot be used otherwise.

        The range is 1-100.

      • PredictiveScalingMode — (String)

        The predictive scaling mode. The default value is ForecastAndScale. Otherwise, AWS Auto Scaling forecasts capacity but does not create any scheduled scaling actions based on the capacity forecast.

        Possible values include:
        • "ForecastAndScale"
        • "ForecastOnly"
      • ScalingPolicyUpdateBehavior — (String)

        Controls whether a resource's externally created scaling policies are kept or replaced.

        The default value is KeepExternalPolicies. If the parameter is set to ReplaceExternalPolicies, any scaling policies that are external to AWS Auto Scaling are deleted and new target tracking scaling policies created.

        Only valid when configuring dynamic scaling.

        Condition: The number of existing policies to be replaced must be less than or equal to 50. If there are more than 50 policies to be replaced, AWS Auto Scaling keeps all existing policies and does not create new ones.

        Possible values include:
        • "KeepExternalPolicies"
        • "ReplaceExternalPolicies"
      • DisableDynamicScaling — (Boolean)

        Controls whether dynamic scaling by AWS Auto Scaling is disabled. When dynamic scaling is enabled, AWS Auto Scaling creates target tracking scaling policies based on the specified target tracking configurations.

        The default is enabled (false).

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • ScalingPlanVersion — (Integer)

        The version number of the scaling plan. This value is always 1.

        Currently, you cannot specify multiple scaling plan versions.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

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.

Service Reference:

Examples:

Calling the deleteScalingPlan operation

var params = {
  ScalingPlanName: 'STRING_VALUE', /* required */
  ScalingPlanVersion: 'NUMBER_VALUE' /* required */
};
autoscalingplans.deleteScalingPlan(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • ScalingPlanName — (String)

      The name of the scaling plan.

    • ScalingPlanVersion — (Integer)

      The version number of the scaling plan.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

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

Describes the scalable resources in the specified scaling plan.

Service Reference:

Examples:

Calling the describeScalingPlanResources operation

var params = {
  ScalingPlanName: 'STRING_VALUE', /* required */
  ScalingPlanVersion: 'NUMBER_VALUE', /* required */
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
autoscalingplans.describeScalingPlanResources(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • ScalingPlanName — (String)

      The name of the scaling plan.

    • ScalingPlanVersion — (Integer)

      The version number of the scaling plan.

    • MaxResults — (Integer)

      The maximum number of scalable resources to return. The value must be between 1 and 50. The default value is 50.

    • NextToken — (String)

      The token for the next set of results.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • ScalingPlanResources — (Array<map>)

        Information about the scalable resources.

        • ScalingPlanNamerequired — (String)

          The name of the scaling plan.

        • ScalingPlanVersionrequired — (Integer)

          The version number of the scaling plan.

        • ServiceNamespacerequired — (String)

          The namespace of the AWS service.

          Possible values include:
          • "autoscaling"
          • "ecs"
          • "ec2"
          • "rds"
          • "dynamodb"
        • ResourceIdrequired — (String)

          The ID of the resource. This string consists of the resource type and unique identifier.

          • Auto Scaling group - The resource type is autoScalingGroup and the unique identifier is the name of the Auto Scaling group. Example: autoScalingGroup/my-asg.

          • ECS service - The resource type is service and the unique identifier is the cluster name and service name. Example: service/default/sample-webapp.

          • Spot Fleet request - The resource type is spot-fleet-request and the unique identifier is the Spot Fleet request ID. Example: spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE.

          • DynamoDB table - The resource type is table and the unique identifier is the resource ID. Example: table/my-table.

          • DynamoDB global secondary index - The resource type is index and the unique identifier is the resource ID. Example: table/my-table/index/my-table-index.

          • Aurora DB cluster - The resource type is cluster and the unique identifier is the cluster name. Example: cluster:my-db-cluster.

        • ScalableDimensionrequired — (String)

          The scalable dimension for the resource.

          • autoscaling:autoScalingGroup:DesiredCapacity - The desired capacity of an Auto Scaling group.

          • ecs:service:DesiredCount - The desired task count of an ECS service.

          • ec2:spot-fleet-request:TargetCapacity - The target capacity of a Spot Fleet request.

          • dynamodb:table:ReadCapacityUnits - The provisioned read capacity for a DynamoDB table.

          • dynamodb:table:WriteCapacityUnits - The provisioned write capacity for a DynamoDB table.

          • dynamodb:index:ReadCapacityUnits - The provisioned read capacity for a DynamoDB global secondary index.

          • dynamodb:index:WriteCapacityUnits - The provisioned write capacity for a DynamoDB global secondary index.

          • rds:cluster:ReadReplicaCount - The count of Aurora Replicas in an Aurora DB cluster. Available for Aurora MySQL-compatible edition and Aurora PostgreSQL-compatible edition.

          Possible values include:
          • "autoscaling:autoScalingGroup:DesiredCapacity"
          • "ecs:service:DesiredCount"
          • "ec2:spot-fleet-request:TargetCapacity"
          • "rds:cluster:ReadReplicaCount"
          • "dynamodb:table:ReadCapacityUnits"
          • "dynamodb:table:WriteCapacityUnits"
          • "dynamodb:index:ReadCapacityUnits"
          • "dynamodb:index:WriteCapacityUnits"
        • ScalingPolicies — (Array<map>)

          The scaling policies.

          • PolicyNamerequired — (String)

            The name of the scaling policy.

          • PolicyTyperequired — (String)

            The type of scaling policy.

            Possible values include:
            • "TargetTrackingScaling"
          • TargetTrackingConfiguration — (map)

            The target tracking scaling policy. Includes support for predefined or customized metrics.

            • PredefinedScalingMetricSpecification — (map)

              A predefined metric. You can specify either a predefined metric or a customized metric.

              • PredefinedScalingMetricTyperequired — (String)

                The metric type. The ALBRequestCountPerTarget metric type applies only to Auto Scaling groups, Spot Fleet requests, and ECS services.

                Possible values include:
                • "ASGAverageCPUUtilization"
                • "ASGAverageNetworkIn"
                • "ASGAverageNetworkOut"
                • "DynamoDBReadCapacityUtilization"
                • "DynamoDBWriteCapacityUtilization"
                • "ECSServiceAverageCPUUtilization"
                • "ECSServiceAverageMemoryUtilization"
                • "ALBRequestCountPerTarget"
                • "RDSReaderAverageCPUUtilization"
                • "RDSReaderAverageDatabaseConnections"
                • "EC2SpotFleetRequestAverageCPUUtilization"
                • "EC2SpotFleetRequestAverageNetworkIn"
                • "EC2SpotFleetRequestAverageNetworkOut"
              • ResourceLabel — (String)

                Identifies the resource associated with the metric type. You can't specify a resource label unless the metric type is ALBRequestCountPerTarget and there is a target group for an Application Load Balancer attached to the Auto Scaling group, Spot Fleet request, or ECS service.

                The format is app/<load-balancer-name>/<load-balancer-id>/targetgroup/<target-group-name>/<target-group-id>, where:

                • app/<load-balancer-name>/<load-balancer-id> is the final portion of the load balancer ARN.

                • targetgroup/<target-group-name>/<target-group-id> is the final portion of the target group ARN.

            • CustomizedScalingMetricSpecification — (map)

              A customized metric. You can specify either a predefined metric or a customized metric.

              • MetricNamerequired — (String)

                The name of the metric.

              • Namespacerequired — (String)

                The namespace of the metric.

              • Dimensions — (Array<map>)

                The dimensions of the metric.

                Conditional: If you published your metric with dimensions, you must specify the same dimensions in your customized scaling metric specification.

                • Namerequired — (String)

                  The name of the dimension.

                • Valuerequired — (String)

                  The value of the dimension.

              • Statisticrequired — (String)

                The statistic of the metric.

                Possible values include:
                • "Average"
                • "Minimum"
                • "Maximum"
                • "SampleCount"
                • "Sum"
              • Unit — (String)

                The unit of the metric.

            • TargetValuerequired — (Float)

              The target value for the metric. The range is 8.515920e-109 to 1.174271e+108 (Base 10) or 2e-360 to 2e360 (Base 2).

            • DisableScaleIn — (Boolean)

              Indicates whether scale in by the target tracking scaling policy is disabled. If the value is true, scale in is disabled and the target tracking scaling policy doesn't remove capacity from the scalable resource. Otherwise, scale in is enabled and the target tracking scaling policy can remove capacity from the scalable resource.

              The default value is false.

            • ScaleOutCooldown — (Integer)

              The amount of time, in seconds, after a scale-out activity completes before another scale-out activity can start. This value is not used if the scalable resource is an Auto Scaling group.

              While the cooldown period is in effect, the capacity that has been added by the previous scale-out event that initiated the cooldown is calculated as part of the desired capacity for the next scale out. The intention is to continuously (but not excessively) scale out.

            • ScaleInCooldown — (Integer)

              The amount of time, in seconds, after a scale in activity completes before another scale in activity can start. This value is not used if the scalable resource is an Auto Scaling group.

              The cooldown period is used to block subsequent scale in requests until it has expired. The intention is to scale in conservatively to protect your application's availability. However, if another alarm triggers a scale-out policy during the cooldown period after a scale-in, AWS Auto Scaling scales out your scalable target immediately.

            • EstimatedInstanceWarmup — (Integer)

              The estimated time, in seconds, until a newly launched instance can contribute to the CloudWatch metrics. This value is used only if the resource is an Auto Scaling group.

        • ScalingStatusCoderequired — (String)

          The scaling status of the resource.

          • Active - The scaling configuration is active.

          • Inactive - The scaling configuration is not active because the scaling plan is being created or the scaling configuration could not be applied. Check the status message for more information.

          • PartiallyActive - The scaling configuration is partially active because the scaling plan is being created or deleted or the scaling configuration could not be fully applied. Check the status message for more information.

          Possible values include:
          • "Inactive"
          • "PartiallyActive"
          • "Active"
        • ScalingStatusMessage — (String)

          A simple message about the current scaling status of the resource.

      • NextToken — (String)

        The token required to get the next set of results. This value is null if there are no more results to return.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

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

Describes one or more of your scaling plans.

Service Reference:

Examples:

Calling the describeScalingPlans operation

var params = {
  ApplicationSources: [
    {
      CloudFormationStackARN: 'STRING_VALUE',
      TagFilters: [
        {
          Key: 'STRING_VALUE',
          Values: [
            'STRING_VALUE',
            /* more items */
          ]
        },
        /* more items */
      ]
    },
    /* more items */
  ],
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE',
  ScalingPlanNames: [
    'STRING_VALUE',
    /* more items */
  ],
  ScalingPlanVersion: 'NUMBER_VALUE'
};
autoscalingplans.describeScalingPlans(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • ScalingPlanNames — (Array<String>)

      The names of the scaling plans (up to 10). If you specify application sources, you cannot specify scaling plan names.

    • ScalingPlanVersion — (Integer)

      The version number of the scaling plan. If you specify a scaling plan version, you must also specify a scaling plan name.

    • ApplicationSources — (Array<map>)

      The sources for the applications (up to 10). If you specify scaling plan names, you cannot specify application sources.

      • CloudFormationStackARN — (String)

        The Amazon Resource Name (ARN) of a AWS CloudFormation stack.

      • TagFilters — (Array<map>)

        A set of tags (up to 50).

        • Key — (String)

          The tag key.

        • Values — (Array<String>)

          The tag values (0 to 20).

    • MaxResults — (Integer)

      The maximum number of scalable resources to return. This value can be between 1 and 50. The default value is 50.

    • NextToken — (String)

      The token for the next set of results.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • ScalingPlans — (Array<map>)

        Information about the scaling plans.

        • ScalingPlanNamerequired — (String)

          The name of the scaling plan.

        • ScalingPlanVersionrequired — (Integer)

          The version number of the scaling plan.

        • ApplicationSourcerequired — (map)

          The application source.

          • CloudFormationStackARN — (String)

            The Amazon Resource Name (ARN) of a AWS CloudFormation stack.

          • TagFilters — (Array<map>)

            A set of tags (up to 50).

            • Key — (String)

              The tag key.

            • Values — (Array<String>)

              The tag values (0 to 20).

        • ScalingInstructionsrequired — (Array<map>)

          The scaling instructions.

          • ServiceNamespacerequired — (String)

            The namespace of the AWS service.

            Possible values include:
            • "autoscaling"
            • "ecs"
            • "ec2"
            • "rds"
            • "dynamodb"
          • ResourceIdrequired — (String)

            The ID of the resource. This string consists of the resource type and unique identifier.

            • Auto Scaling group - The resource type is autoScalingGroup and the unique identifier is the name of the Auto Scaling group. Example: autoScalingGroup/my-asg.

            • ECS service - The resource type is service and the unique identifier is the cluster name and service name. Example: service/default/sample-webapp.

            • Spot Fleet request - The resource type is spot-fleet-request and the unique identifier is the Spot Fleet request ID. Example: spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE.

            • DynamoDB table - The resource type is table and the unique identifier is the resource ID. Example: table/my-table.

            • DynamoDB global secondary index - The resource type is index and the unique identifier is the resource ID. Example: table/my-table/index/my-table-index.

            • Aurora DB cluster - The resource type is cluster and the unique identifier is the cluster name. Example: cluster:my-db-cluster.

          • ScalableDimensionrequired — (String)

            The scalable dimension associated with the resource.

            • autoscaling:autoScalingGroup:DesiredCapacity - The desired capacity of an Auto Scaling group.

            • ecs:service:DesiredCount - The desired task count of an ECS service.

            • ec2:spot-fleet-request:TargetCapacity - The target capacity of a Spot Fleet request.

            • dynamodb:table:ReadCapacityUnits - The provisioned read capacity for a DynamoDB table.

            • dynamodb:table:WriteCapacityUnits - The provisioned write capacity for a DynamoDB table.

            • dynamodb:index:ReadCapacityUnits - The provisioned read capacity for a DynamoDB global secondary index.

            • dynamodb:index:WriteCapacityUnits - The provisioned write capacity for a DynamoDB global secondary index.

            • rds:cluster:ReadReplicaCount - The count of Aurora Replicas in an Aurora DB cluster. Available for Aurora MySQL-compatible edition and Aurora PostgreSQL-compatible edition.

            Possible values include:
            • "autoscaling:autoScalingGroup:DesiredCapacity"
            • "ecs:service:DesiredCount"
            • "ec2:spot-fleet-request:TargetCapacity"
            • "rds:cluster:ReadReplicaCount"
            • "dynamodb:table:ReadCapacityUnits"
            • "dynamodb:table:WriteCapacityUnits"
            • "dynamodb:index:ReadCapacityUnits"
            • "dynamodb:index:WriteCapacityUnits"
          • MinCapacityrequired — (Integer)

            The minimum capacity of the resource.

          • MaxCapacityrequired — (Integer)

            The maximum capacity of the resource. The exception to this upper limit is if you specify a non-default setting for PredictiveScalingMaxCapacityBehavior.

          • TargetTrackingConfigurationsrequired — (Array<map>)

            The structure that defines new target tracking configurations (up to 10). Each of these structures includes a specific scaling metric and a target value for the metric, along with various parameters to use with dynamic scaling.

            With predictive scaling and dynamic scaling, the resource scales based on the target tracking configuration that provides the largest capacity for both scale in and scale out.

            Condition: The scaling metric must be unique across target tracking configurations.

            • PredefinedScalingMetricSpecification — (map)

              A predefined metric. You can specify either a predefined metric or a customized metric.

              • PredefinedScalingMetricTyperequired — (String)

                The metric type. The ALBRequestCountPerTarget metric type applies only to Auto Scaling groups, Spot Fleet requests, and ECS services.

                Possible values include:
                • "ASGAverageCPUUtilization"
                • "ASGAverageNetworkIn"
                • "ASGAverageNetworkOut"
                • "DynamoDBReadCapacityUtilization"
                • "DynamoDBWriteCapacityUtilization"
                • "ECSServiceAverageCPUUtilization"
                • "ECSServiceAverageMemoryUtilization"
                • "ALBRequestCountPerTarget"
                • "RDSReaderAverageCPUUtilization"
                • "RDSReaderAverageDatabaseConnections"
                • "EC2SpotFleetRequestAverageCPUUtilization"
                • "EC2SpotFleetRequestAverageNetworkIn"
                • "EC2SpotFleetRequestAverageNetworkOut"
              • ResourceLabel — (String)

                Identifies the resource associated with the metric type. You can't specify a resource label unless the metric type is ALBRequestCountPerTarget and there is a target group for an Application Load Balancer attached to the Auto Scaling group, Spot Fleet request, or ECS service.

                The format is app/<load-balancer-name>/<load-balancer-id>/targetgroup/<target-group-name>/<target-group-id>, where:

                • app/<load-balancer-name>/<load-balancer-id> is the final portion of the load balancer ARN.

                • targetgroup/<target-group-name>/<target-group-id> is the final portion of the target group ARN.

            • CustomizedScalingMetricSpecification — (map)

              A customized metric. You can specify either a predefined metric or a customized metric.

              • MetricNamerequired — (String)

                The name of the metric.

              • Namespacerequired — (String)

                The namespace of the metric.

              • Dimensions — (Array<map>)

                The dimensions of the metric.

                Conditional: If you published your metric with dimensions, you must specify the same dimensions in your customized scaling metric specification.

                • Namerequired — (String)

                  The name of the dimension.

                • Valuerequired — (String)

                  The value of the dimension.

              • Statisticrequired — (String)

                The statistic of the metric.

                Possible values include:
                • "Average"
                • "Minimum"
                • "Maximum"
                • "SampleCount"
                • "Sum"
              • Unit — (String)

                The unit of the metric.

            • TargetValuerequired — (Float)

              The target value for the metric. The range is 8.515920e-109 to 1.174271e+108 (Base 10) or 2e-360 to 2e360 (Base 2).

            • DisableScaleIn — (Boolean)

              Indicates whether scale in by the target tracking scaling policy is disabled. If the value is true, scale in is disabled and the target tracking scaling policy doesn't remove capacity from the scalable resource. Otherwise, scale in is enabled and the target tracking scaling policy can remove capacity from the scalable resource.

              The default value is false.

            • ScaleOutCooldown — (Integer)

              The amount of time, in seconds, after a scale-out activity completes before another scale-out activity can start. This value is not used if the scalable resource is an Auto Scaling group.

              While the cooldown period is in effect, the capacity that has been added by the previous scale-out event that initiated the cooldown is calculated as part of the desired capacity for the next scale out. The intention is to continuously (but not excessively) scale out.

            • ScaleInCooldown — (Integer)

              The amount of time, in seconds, after a scale in activity completes before another scale in activity can start. This value is not used if the scalable resource is an Auto Scaling group.

              The cooldown period is used to block subsequent scale in requests until it has expired. The intention is to scale in conservatively to protect your application's availability. However, if another alarm triggers a scale-out policy during the cooldown period after a scale-in, AWS Auto Scaling scales out your scalable target immediately.

            • EstimatedInstanceWarmup — (Integer)

              The estimated time, in seconds, until a newly launched instance can contribute to the CloudWatch metrics. This value is used only if the resource is an Auto Scaling group.

          • PredefinedLoadMetricSpecification — (map)

            The predefined load metric to use for predictive scaling. This parameter or a CustomizedLoadMetricSpecification is required when configuring predictive scaling, and cannot be used otherwise.

            • PredefinedLoadMetricTyperequired — (String)

              The metric type.

              Possible values include:
              • "ASGTotalCPUUtilization"
              • "ASGTotalNetworkIn"
              • "ASGTotalNetworkOut"
              • "ALBTargetGroupRequestCount"
            • ResourceLabel — (String)

              Identifies the resource associated with the metric type. You can't specify a resource label unless the metric type is ALBRequestCountPerTarget and there is a target group for an Application Load Balancer attached to the Auto Scaling group.

              The format is app/<load-balancer-name>/<load-balancer-id>/targetgroup/<target-group-name>/<target-group-id>, where:

              • app/<load-balancer-name>/<load-balancer-id> is the final portion of the load balancer ARN.

              • targetgroup/<target-group-name>/<target-group-id> is the final portion of the target group ARN.

          • CustomizedLoadMetricSpecification — (map)

            The customized load metric to use for predictive scaling. This parameter or a PredefinedLoadMetricSpecification is required when configuring predictive scaling, and cannot be used otherwise.

            • MetricNamerequired — (String)

              The name of the metric.

            • Namespacerequired — (String)

              The namespace of the metric.

            • Dimensions — (Array<map>)

              The dimensions of the metric.

              Conditional: If you published your metric with dimensions, you must specify the same dimensions in your customized load metric specification.

              • Namerequired — (String)

                The name of the dimension.

              • Valuerequired — (String)

                The value of the dimension.

            • Statisticrequired — (String)

              The statistic of the metric. Currently, the value must always be Sum.

              Possible values include:
              • "Average"
              • "Minimum"
              • "Maximum"
              • "SampleCount"
              • "Sum"
            • Unit — (String)

              The unit of the metric.

          • ScheduledActionBufferTime — (Integer)

            The amount of time, in seconds, to buffer the run time of scheduled scaling actions when scaling out. For example, if the forecast says to add capacity at 10:00 AM, and the buffer time is 5 minutes, then the run time of the corresponding scheduled scaling action will be 9:55 AM. The intention is to give resources time to be provisioned. For example, it can take a few minutes to launch an EC2 instance. The actual amount of time required depends on several factors, such as the size of the instance and whether there are startup scripts to complete.

            The value must be less than the forecast interval duration of 3600 seconds (60 minutes). The default is 300 seconds.

            Only valid when configuring predictive scaling.

          • PredictiveScalingMaxCapacityBehavior — (String)

            Defines the behavior that should be applied if the forecast capacity approaches or exceeds the maximum capacity specified for the resource. The default value is SetForecastCapacityToMaxCapacity.

            The following are possible values:

            • SetForecastCapacityToMaxCapacity - AWS Auto Scaling cannot scale resource capacity higher than the maximum capacity. The maximum capacity is enforced as a hard limit.

            • SetMaxCapacityToForecastCapacity - AWS Auto Scaling may scale resource capacity higher than the maximum capacity to equal but not exceed forecast capacity.

            • SetMaxCapacityAboveForecastCapacity - AWS Auto Scaling may scale resource capacity higher than the maximum capacity by a specified buffer value. The intention is to give the target tracking scaling policy extra capacity if unexpected traffic occurs.

            Only valid when configuring predictive scaling.

            Possible values include:
            • "SetForecastCapacityToMaxCapacity"
            • "SetMaxCapacityToForecastCapacity"
            • "SetMaxCapacityAboveForecastCapacity"
          • PredictiveScalingMaxCapacityBuffer — (Integer)

            The size of the capacity buffer to use when the forecast capacity is close to or exceeds the maximum capacity. The value is specified as a percentage relative to the forecast capacity. For example, if the buffer is 10, this means a 10 percent buffer, such that if the forecast capacity is 50, and the maximum capacity is 40, then the effective maximum capacity is 55.

            Only valid when configuring predictive scaling. Required if the PredictiveScalingMaxCapacityBehavior is set to SetMaxCapacityAboveForecastCapacity, and cannot be used otherwise.

            The range is 1-100.

          • PredictiveScalingMode — (String)

            The predictive scaling mode. The default value is ForecastAndScale. Otherwise, AWS Auto Scaling forecasts capacity but does not create any scheduled scaling actions based on the capacity forecast.

            Possible values include:
            • "ForecastAndScale"
            • "ForecastOnly"
          • ScalingPolicyUpdateBehavior — (String)

            Controls whether a resource's externally created scaling policies are kept or replaced.

            The default value is KeepExternalPolicies. If the parameter is set to ReplaceExternalPolicies, any scaling policies that are external to AWS Auto Scaling are deleted and new target tracking scaling policies created.

            Only valid when configuring dynamic scaling.

            Condition: The number of existing policies to be replaced must be less than or equal to 50. If there are more than 50 policies to be replaced, AWS Auto Scaling keeps all existing policies and does not create new ones.

            Possible values include:
            • "KeepExternalPolicies"
            • "ReplaceExternalPolicies"
          • DisableDynamicScaling — (Boolean)

            Controls whether dynamic scaling by AWS Auto Scaling is disabled. When dynamic scaling is enabled, AWS Auto Scaling creates target tracking scaling policies based on the specified target tracking configurations.

            The default is enabled (false).

        • StatusCoderequired — (String)

          The status of the scaling plan.

          • Active - The scaling plan is active.

          • ActiveWithProblems - The scaling plan is active, but the scaling configuration for one or more resources could not be applied.

          • CreationInProgress - The scaling plan is being created.

          • CreationFailed - The scaling plan could not be created.

          • DeletionInProgress - The scaling plan is being deleted.

          • DeletionFailed - The scaling plan could not be deleted.

          • UpdateInProgress - The scaling plan is being updated.

          • UpdateFailed - The scaling plan could not be updated.

          Possible values include:
          • "Active"
          • "ActiveWithProblems"
          • "CreationInProgress"
          • "CreationFailed"
          • "DeletionInProgress"
          • "DeletionFailed"
          • "UpdateInProgress"
          • "UpdateFailed"
        • StatusMessage — (String)

          A simple message about the current status of the scaling plan.

        • StatusStartTime — (Date)

          The Unix time stamp when the scaling plan entered the current status.

        • CreationTime — (Date)

          The Unix time stamp when the scaling plan was created.

      • NextToken — (String)

        The token required to get the next set of results. This value is null if there are no more results to return.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

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.

Examples:

Calling the getScalingPlanResourceForecastData operation

var params = {
  EndTime: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789, /* required */
  ForecastDataType: CapacityForecast | LoadForecast | ScheduledActionMinCapacity | ScheduledActionMaxCapacity, /* required */
  ResourceId: 'STRING_VALUE', /* required */
  ScalableDimension: autoscaling:autoScalingGroup:DesiredCapacity | ecs:service:DesiredCount | ec2:spot-fleet-request:TargetCapacity | rds:cluster:ReadReplicaCount | dynamodb:table:ReadCapacityUnits | dynamodb:table:WriteCapacityUnits | dynamodb:index:ReadCapacityUnits | dynamodb:index:WriteCapacityUnits, /* required */
  ScalingPlanName: 'STRING_VALUE', /* required */
  ScalingPlanVersion: 'NUMBER_VALUE', /* required */
  ServiceNamespace: autoscaling | ecs | ec2 | rds | dynamodb, /* required */
  StartTime: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789 /* required */
};
autoscalingplans.getScalingPlanResourceForecastData(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • ScalingPlanName — (String)

      The name of the scaling plan.

    • ScalingPlanVersion — (Integer)

      The version number of the scaling plan.

    • ServiceNamespace — (String)

      The namespace of the AWS service.

      Possible values include:
      • "autoscaling"
      • "ecs"
      • "ec2"
      • "rds"
      • "dynamodb"
    • ResourceId — (String)

      The ID of the resource. This string consists of the resource type and unique identifier.

      • Auto Scaling group - The resource type is autoScalingGroup and the unique identifier is the name of the Auto Scaling group. Example: autoScalingGroup/my-asg.

      • ECS service - The resource type is service and the unique identifier is the cluster name and service name. Example: service/default/sample-webapp.

      • Spot Fleet request - The resource type is spot-fleet-request and the unique identifier is the Spot Fleet request ID. Example: spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE.

      • DynamoDB table - The resource type is table and the unique identifier is the resource ID. Example: table/my-table.

      • DynamoDB global secondary index - The resource type is index and the unique identifier is the resource ID. Example: table/my-table/index/my-table-index.

      • Aurora DB cluster - The resource type is cluster and the unique identifier is the cluster name. Example: cluster:my-db-cluster.

    • ScalableDimension — (String)

      The scalable dimension for the resource.

      Possible values include:
      • "autoscaling:autoScalingGroup:DesiredCapacity"
      • "ecs:service:DesiredCount"
      • "ec2:spot-fleet-request:TargetCapacity"
      • "rds:cluster:ReadReplicaCount"
      • "dynamodb:table:ReadCapacityUnits"
      • "dynamodb:table:WriteCapacityUnits"
      • "dynamodb:index:ReadCapacityUnits"
      • "dynamodb:index:WriteCapacityUnits"
    • ForecastDataType — (String)

      The type of forecast data to get.

      • LoadForecast: The load metric forecast.

      • CapacityForecast: The capacity forecast.

      • ScheduledActionMinCapacity: The minimum capacity for each scheduled scaling action. This data is calculated as the larger of two values: the capacity forecast or the minimum capacity in the scaling instruction.

      • ScheduledActionMaxCapacity: The maximum capacity for each scheduled scaling action. The calculation used is determined by the predictive scaling maximum capacity behavior setting in the scaling instruction.

      Possible values include:
      • "CapacityForecast"
      • "LoadForecast"
      • "ScheduledActionMinCapacity"
      • "ScheduledActionMaxCapacity"
    • StartTime — (Date)

      The inclusive start time of the time range for the forecast data to get. The date and time can be at most 56 days before the current date and time.

    • EndTime — (Date)

      The exclusive end time of the time range for the forecast data to get. The maximum time duration between the start and end time is seven days.

      Although this parameter can accept a date and time that is more than two days in the future, the availability of forecast data has limits. AWS Auto Scaling only issues forecasts for periods of two days in advance.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Datapoints — (Array<map>)

        The data points to return.

        • Timestamp — (Date)

          The time stamp for the data point in UTC format.

        • Value — (Float)

          The value of the data point.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

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.

Service Reference:

Examples:

Calling the updateScalingPlan operation

var params = {
  ScalingPlanName: 'STRING_VALUE', /* required */
  ScalingPlanVersion: 'NUMBER_VALUE', /* required */
  ApplicationSource: {
    CloudFormationStackARN: 'STRING_VALUE',
    TagFilters: [
      {
        Key: 'STRING_VALUE',
        Values: [
          'STRING_VALUE',
          /* more items */
        ]
      },
      /* more items */
    ]
  },
  ScalingInstructions: [
    {
      MaxCapacity: 'NUMBER_VALUE', /* required */
      MinCapacity: 'NUMBER_VALUE', /* required */
      ResourceId: 'STRING_VALUE', /* required */
      ScalableDimension: autoscaling:autoScalingGroup:DesiredCapacity | ecs:service:DesiredCount | ec2:spot-fleet-request:TargetCapacity | rds:cluster:ReadReplicaCount | dynamodb:table:ReadCapacityUnits | dynamodb:table:WriteCapacityUnits | dynamodb:index:ReadCapacityUnits | dynamodb:index:WriteCapacityUnits, /* required */
      ServiceNamespace: autoscaling | ecs | ec2 | rds | dynamodb, /* required */
      TargetTrackingConfigurations: [ /* required */
        {
          TargetValue: 'NUMBER_VALUE', /* required */
          CustomizedScalingMetricSpecification: {
            MetricName: 'STRING_VALUE', /* required */
            Namespace: 'STRING_VALUE', /* required */
            Statistic: Average | Minimum | Maximum | SampleCount | Sum, /* required */
            Dimensions: [
              {
                Name: 'STRING_VALUE', /* required */
                Value: 'STRING_VALUE' /* required */
              },
              /* more items */
            ],
            Unit: 'STRING_VALUE'
          },
          DisableScaleIn: true || false,
          EstimatedInstanceWarmup: 'NUMBER_VALUE',
          PredefinedScalingMetricSpecification: {
            PredefinedScalingMetricType: ASGAverageCPUUtilization | ASGAverageNetworkIn | ASGAverageNetworkOut | DynamoDBReadCapacityUtilization | DynamoDBWriteCapacityUtilization | ECSServiceAverageCPUUtilization | ECSServiceAverageMemoryUtilization | ALBRequestCountPerTarget | RDSReaderAverageCPUUtilization | RDSReaderAverageDatabaseConnections | EC2SpotFleetRequestAverageCPUUtilization | EC2SpotFleetRequestAverageNetworkIn | EC2SpotFleetRequestAverageNetworkOut, /* required */
            ResourceLabel: 'STRING_VALUE'
          },
          ScaleInCooldown: 'NUMBER_VALUE',
          ScaleOutCooldown: 'NUMBER_VALUE'
        },
        /* more items */
      ],
      CustomizedLoadMetricSpecification: {
        MetricName: 'STRING_VALUE', /* required */
        Namespace: 'STRING_VALUE', /* required */
        Statistic: Average | Minimum | Maximum | SampleCount | Sum, /* required */
        Dimensions: [
          {
            Name: 'STRING_VALUE', /* required */
            Value: 'STRING_VALUE' /* required */
          },
          /* more items */
        ],
        Unit: 'STRING_VALUE'
      },
      DisableDynamicScaling: true || false,
      PredefinedLoadMetricSpecification: {
        PredefinedLoadMetricType: ASGTotalCPUUtilization | ASGTotalNetworkIn | ASGTotalNetworkOut | ALBTargetGroupRequestCount, /* required */
        ResourceLabel: 'STRING_VALUE'
      },
      PredictiveScalingMaxCapacityBehavior: SetForecastCapacityToMaxCapacity | SetMaxCapacityToForecastCapacity | SetMaxCapacityAboveForecastCapacity,
      PredictiveScalingMaxCapacityBuffer: 'NUMBER_VALUE',
      PredictiveScalingMode: ForecastAndScale | ForecastOnly,
      ScalingPolicyUpdateBehavior: KeepExternalPolicies | ReplaceExternalPolicies,
      ScheduledActionBufferTime: 'NUMBER_VALUE'
    },
    /* more items */
  ]
};
autoscalingplans.updateScalingPlan(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • ScalingPlanName — (String)

      The name of the scaling plan.

    • ScalingPlanVersion — (Integer)

      The version number of the scaling plan.

    • ApplicationSource — (map)

      A CloudFormation stack or set of tags.

      • CloudFormationStackARN — (String)

        The Amazon Resource Name (ARN) of a AWS CloudFormation stack.

      • TagFilters — (Array<map>)

        A set of tags (up to 50).

        • Key — (String)

          The tag key.

        • Values — (Array<String>)

          The tag values (0 to 20).

    • ScalingInstructions — (Array<map>)

      The scaling instructions.

      • ServiceNamespacerequired — (String)

        The namespace of the AWS service.

        Possible values include:
        • "autoscaling"
        • "ecs"
        • "ec2"
        • "rds"
        • "dynamodb"
      • ResourceIdrequired — (String)

        The ID of the resource. This string consists of the resource type and unique identifier.

        • Auto Scaling group - The resource type is autoScalingGroup and the unique identifier is the name of the Auto Scaling group. Example: autoScalingGroup/my-asg.

        • ECS service - The resource type is service and the unique identifier is the cluster name and service name. Example: service/default/sample-webapp.

        • Spot Fleet request - The resource type is spot-fleet-request and the unique identifier is the Spot Fleet request ID. Example: spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE.

        • DynamoDB table - The resource type is table and the unique identifier is the resource ID. Example: table/my-table.

        • DynamoDB global secondary index - The resource type is index and the unique identifier is the resource ID. Example: table/my-table/index/my-table-index.

        • Aurora DB cluster - The resource type is cluster and the unique identifier is the cluster name. Example: cluster:my-db-cluster.

      • ScalableDimensionrequired — (String)

        The scalable dimension associated with the resource.

        • autoscaling:autoScalingGroup:DesiredCapacity - The desired capacity of an Auto Scaling group.

        • ecs:service:DesiredCount - The desired task count of an ECS service.

        • ec2:spot-fleet-request:TargetCapacity - The target capacity of a Spot Fleet request.

        • dynamodb:table:ReadCapacityUnits - The provisioned read capacity for a DynamoDB table.

        • dynamodb:table:WriteCapacityUnits - The provisioned write capacity for a DynamoDB table.

        • dynamodb:index:ReadCapacityUnits - The provisioned read capacity for a DynamoDB global secondary index.

        • dynamodb:index:WriteCapacityUnits - The provisioned write capacity for a DynamoDB global secondary index.

        • rds:cluster:ReadReplicaCount - The count of Aurora Replicas in an Aurora DB cluster. Available for Aurora MySQL-compatible edition and Aurora PostgreSQL-compatible edition.

        Possible values include:
        • "autoscaling:autoScalingGroup:DesiredCapacity"
        • "ecs:service:DesiredCount"
        • "ec2:spot-fleet-request:TargetCapacity"
        • "rds:cluster:ReadReplicaCount"
        • "dynamodb:table:ReadCapacityUnits"
        • "dynamodb:table:WriteCapacityUnits"
        • "dynamodb:index:ReadCapacityUnits"
        • "dynamodb:index:WriteCapacityUnits"
      • MinCapacityrequired — (Integer)

        The minimum capacity of the resource.

      • MaxCapacityrequired — (Integer)

        The maximum capacity of the resource. The exception to this upper limit is if you specify a non-default setting for PredictiveScalingMaxCapacityBehavior.

      • TargetTrackingConfigurationsrequired — (Array<map>)

        The structure that defines new target tracking configurations (up to 10). Each of these structures includes a specific scaling metric and a target value for the metric, along with various parameters to use with dynamic scaling.

        With predictive scaling and dynamic scaling, the resource scales based on the target tracking configuration that provides the largest capacity for both scale in and scale out.

        Condition: The scaling metric must be unique across target tracking configurations.

        • PredefinedScalingMetricSpecification — (map)

          A predefined metric. You can specify either a predefined metric or a customized metric.

          • PredefinedScalingMetricTyperequired — (String)

            The metric type. The ALBRequestCountPerTarget metric type applies only to Auto Scaling groups, Spot Fleet requests, and ECS services.

            Possible values include:
            • "ASGAverageCPUUtilization"
            • "ASGAverageNetworkIn"
            • "ASGAverageNetworkOut"
            • "DynamoDBReadCapacityUtilization"
            • "DynamoDBWriteCapacityUtilization"
            • "ECSServiceAverageCPUUtilization"
            • "ECSServiceAverageMemoryUtilization"
            • "ALBRequestCountPerTarget"
            • "RDSReaderAverageCPUUtilization"
            • "RDSReaderAverageDatabaseConnections"
            • "EC2SpotFleetRequestAverageCPUUtilization"
            • "EC2SpotFleetRequestAverageNetworkIn"
            • "EC2SpotFleetRequestAverageNetworkOut"
          • ResourceLabel — (String)

            Identifies the resource associated with the metric type. You can't specify a resource label unless the metric type is ALBRequestCountPerTarget and there is a target group for an Application Load Balancer attached to the Auto Scaling group, Spot Fleet request, or ECS service.

            The format is app/<load-balancer-name>/<load-balancer-id>/targetgroup/<target-group-name>/<target-group-id>, where:

            • app/<load-balancer-name>/<load-balancer-id> is the final portion of the load balancer ARN.

            • targetgroup/<target-group-name>/<target-group-id> is the final portion of the target group ARN.

        • CustomizedScalingMetricSpecification — (map)

          A customized metric. You can specify either a predefined metric or a customized metric.

          • MetricNamerequired — (String)

            The name of the metric.

          • Namespacerequired — (String)

            The namespace of the metric.

          • Dimensions — (Array<map>)

            The dimensions of the metric.

            Conditional: If you published your metric with dimensions, you must specify the same dimensions in your customized scaling metric specification.

            • Namerequired — (String)

              The name of the dimension.

            • Valuerequired — (String)

              The value of the dimension.

          • Statisticrequired — (String)

            The statistic of the metric.

            Possible values include:
            • "Average"
            • "Minimum"
            • "Maximum"
            • "SampleCount"
            • "Sum"
          • Unit — (String)

            The unit of the metric.

        • TargetValuerequired — (Float)

          The target value for the metric. The range is 8.515920e-109 to 1.174271e+108 (Base 10) or 2e-360 to 2e360 (Base 2).

        • DisableScaleIn — (Boolean)

          Indicates whether scale in by the target tracking scaling policy is disabled. If the value is true, scale in is disabled and the target tracking scaling policy doesn't remove capacity from the scalable resource. Otherwise, scale in is enabled and the target tracking scaling policy can remove capacity from the scalable resource.

          The default value is false.

        • ScaleOutCooldown — (Integer)

          The amount of time, in seconds, after a scale-out activity completes before another scale-out activity can start. This value is not used if the scalable resource is an Auto Scaling group.

          While the cooldown period is in effect, the capacity that has been added by the previous scale-out event that initiated the cooldown is calculated as part of the desired capacity for the next scale out. The intention is to continuously (but not excessively) scale out.

        • ScaleInCooldown — (Integer)

          The amount of time, in seconds, after a scale in activity completes before another scale in activity can start. This value is not used if the scalable resource is an Auto Scaling group.

          The cooldown period is used to block subsequent scale in requests until it has expired. The intention is to scale in conservatively to protect your application's availability. However, if another alarm triggers a scale-out policy during the cooldown period after a scale-in, AWS Auto Scaling scales out your scalable target immediately.

        • EstimatedInstanceWarmup — (Integer)

          The estimated time, in seconds, until a newly launched instance can contribute to the CloudWatch metrics. This value is used only if the resource is an Auto Scaling group.

      • PredefinedLoadMetricSpecification — (map)

        The predefined load metric to use for predictive scaling. This parameter or a CustomizedLoadMetricSpecification is required when configuring predictive scaling, and cannot be used otherwise.

        • PredefinedLoadMetricTyperequired — (String)

          The metric type.

          Possible values include:
          • "ASGTotalCPUUtilization"
          • "ASGTotalNetworkIn"
          • "ASGTotalNetworkOut"
          • "ALBTargetGroupRequestCount"
        • ResourceLabel — (String)

          Identifies the resource associated with the metric type. You can't specify a resource label unless the metric type is ALBRequestCountPerTarget and there is a target group for an Application Load Balancer attached to the Auto Scaling group.

          The format is app/<load-balancer-name>/<load-balancer-id>/targetgroup/<target-group-name>/<target-group-id>, where:

          • app/<load-balancer-name>/<load-balancer-id> is the final portion of the load balancer ARN.

          • targetgroup/<target-group-name>/<target-group-id> is the final portion of the target group ARN.

      • CustomizedLoadMetricSpecification — (map)

        The customized load metric to use for predictive scaling. This parameter or a PredefinedLoadMetricSpecification is required when configuring predictive scaling, and cannot be used otherwise.

        • MetricNamerequired — (String)

          The name of the metric.

        • Namespacerequired — (String)

          The namespace of the metric.

        • Dimensions — (Array<map>)

          The dimensions of the metric.

          Conditional: If you published your metric with dimensions, you must specify the same dimensions in your customized load metric specification.

          • Namerequired — (String)

            The name of the dimension.

          • Valuerequired — (String)

            The value of the dimension.

        • Statisticrequired — (String)

          The statistic of the metric. Currently, the value must always be Sum.

          Possible values include:
          • "Average"
          • "Minimum"
          • "Maximum"
          • "SampleCount"
          • "Sum"
        • Unit — (String)

          The unit of the metric.

      • ScheduledActionBufferTime — (Integer)

        The amount of time, in seconds, to buffer the run time of scheduled scaling actions when scaling out. For example, if the forecast says to add capacity at 10:00 AM, and the buffer time is 5 minutes, then the run time of the corresponding scheduled scaling action will be 9:55 AM. The intention is to give resources time to be provisioned. For example, it can take a few minutes to launch an EC2 instance. The actual amount of time required depends on several factors, such as the size of the instance and whether there are startup scripts to complete.

        The value must be less than the forecast interval duration of 3600 seconds (60 minutes). The default is 300 seconds.

        Only valid when configuring predictive scaling.

      • PredictiveScalingMaxCapacityBehavior — (String)

        Defines the behavior that should be applied if the forecast capacity approaches or exceeds the maximum capacity specified for the resource. The default value is SetForecastCapacityToMaxCapacity.

        The following are possible values:

        • SetForecastCapacityToMaxCapacity - AWS Auto Scaling cannot scale resource capacity higher than the maximum capacity. The maximum capacity is enforced as a hard limit.

        • SetMaxCapacityToForecastCapacity - AWS Auto Scaling may scale resource capacity higher than the maximum capacity to equal but not exceed forecast capacity.

        • SetMaxCapacityAboveForecastCapacity - AWS Auto Scaling may scale resource capacity higher than the maximum capacity by a specified buffer value. The intention is to give the target tracking scaling policy extra capacity if unexpected traffic occurs.

        Only valid when configuring predictive scaling.

        Possible values include:
        • "SetForecastCapacityToMaxCapacity"
        • "SetMaxCapacityToForecastCapacity"
        • "SetMaxCapacityAboveForecastCapacity"
      • PredictiveScalingMaxCapacityBuffer — (Integer)

        The size of the capacity buffer to use when the forecast capacity is close to or exceeds the maximum capacity. The value is specified as a percentage relative to the forecast capacity. For example, if the buffer is 10, this means a 10 percent buffer, such that if the forecast capacity is 50, and the maximum capacity is 40, then the effective maximum capacity is 55.

        Only valid when configuring predictive scaling. Required if the PredictiveScalingMaxCapacityBehavior is set to SetMaxCapacityAboveForecastCapacity, and cannot be used otherwise.

        The range is 1-100.

      • PredictiveScalingMode — (String)

        The predictive scaling mode. The default value is ForecastAndScale. Otherwise, AWS Auto Scaling forecasts capacity but does not create any scheduled scaling actions based on the capacity forecast.

        Possible values include:
        • "ForecastAndScale"
        • "ForecastOnly"
      • ScalingPolicyUpdateBehavior — (String)

        Controls whether a resource's externally created scaling policies are kept or replaced.

        The default value is KeepExternalPolicies. If the parameter is set to ReplaceExternalPolicies, any scaling policies that are external to AWS Auto Scaling are deleted and new target tracking scaling policies created.

        Only valid when configuring dynamic scaling.

        Condition: The number of existing policies to be replaced must be less than or equal to 50. If there are more than 50 policies to be replaced, AWS Auto Scaling keeps all existing policies and does not create new ones.

        Possible values include:
        • "KeepExternalPolicies"
        • "ReplaceExternalPolicies"
      • DisableDynamicScaling — (Boolean)

        Controls whether dynamic scaling by AWS Auto Scaling is disabled. When dynamic scaling is enabled, AWS Auto Scaling creates target tracking scaling policies based on the specified target tracking configurations.

        The default is enabled (false).

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.