Class: AWS.AutoScalingPlans

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. Currently, the only valid value is 1.

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.

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. Currently, the only valid value is 1.

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

      • ScalingPlanName — required — (String)

        The name of the scaling plan.

      • ScalingPlanVersion — required — (Integer)

        The version number of the scaling plan.

      • ServiceNamespace — required — (String)

        The namespace of the AWS service.

        Possible values include:
        • "autoscaling"
        • "ecs"
        • "ec2"
        • "rds"
        • "dynamodb"
      • ResourceId — required — (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 — required — (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.

        • PolicyName — required — (String)

          The name of the scaling policy.

        • PolicyType — required — (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.

            • PredefinedScalingMetricType — required — (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.

              You create the resource label by appending the final portion of the load balancer ARN and the final portion of the target group ARN into a single value, separated by a forward slash (/). 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.

              This is an example: app/EC2Co-EcsEl-1TKLTMITMM0EO/f37c06a68c1748aa/targetgroup/EC2Co-Defau-LDNM7Q3ZH1ZN/6d4ea56ca2d6a18d.

              To find the ARN for an Application Load Balancer, use the DescribeLoadBalancers API operation. To find the ARN for the target group, use the DescribeTargetGroups API operation.

          • CustomizedScalingMetricSpecification — (map)

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

            • MetricName — required — (String)

              The name of the metric.

            • Namespace — required — (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.

              • Name — required — (String)

                The name of the dimension.

              • Value — required — (String)

                The value of the dimension.

            • Statistic — required — (String)

              The statistic of the metric.

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

              The unit of the metric.

          • TargetValue — required — (Float)

            The target value for the metric. Although this property accepts numbers of type Double, it won't accept values that are either too small or too large. Values must be in the range of -2³⁶⁰ to 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, to wait for a previous scale-out activity to take effect. This property is not used if the scalable resource is an Auto Scaling group.

            With the scale-out cooldown period, the intention is to continuously (but not excessively) scale out. After Auto Scaling successfully scales out using a target tracking scaling policy, it starts to calculate the cooldown time. The scaling policy won't increase the desired capacity again unless either a larger scale out is triggered or the cooldown period ends.

          • ScaleInCooldown — (Integer)

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

            With the scale-in cooldown period, the intention is to scale in conservatively to protect your application’s availability, so scale-in activities are blocked until the cooldown period has expired. However, if another alarm triggers a scale-out activity during the scale-in cooldown period, Auto Scaling scales out the target immediately. In this case, the scale-in cooldown period stops and doesn't complete.

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

      • ScalingStatusCode — required — (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.

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. Currently, the only valid value is 1.

    Note: 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.

      • ScalingPlanName — required — (String)

        The name of the scaling plan.

      • ScalingPlanVersion — required — (Integer)

        The version number of the scaling plan.

      • ApplicationSource — required — (map)

        A CloudFormation stack or a 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 — required — (Array<map>)

        The scaling instructions.

        • ServiceNamespace — required — (String)

          The namespace of the AWS service.

          Possible values include:
          • "autoscaling"
          • "ecs"
          • "ec2"
          • "rds"
          • "dynamodb"
        • ResourceId — required — (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 — required — (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"
        • MinCapacity — required — (Integer)

          The minimum capacity of the resource.

        • MaxCapacity — required — (Integer)

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

        • TargetTrackingConfigurations — required — (Array<map>)

          The target tracking configurations (up to 10). Each of these structures must specify a unique scaling metric and a target value for the metric.

          • PredefinedScalingMetricSpecification — (map)

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

            • PredefinedScalingMetricType — required — (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.

              You create the resource label by appending the final portion of the load balancer ARN and the final portion of the target group ARN into a single value, separated by a forward slash (/). 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.

              This is an example: app/EC2Co-EcsEl-1TKLTMITMM0EO/f37c06a68c1748aa/targetgroup/EC2Co-Defau-LDNM7Q3ZH1ZN/6d4ea56ca2d6a18d.

              To find the ARN for an Application Load Balancer, use the DescribeLoadBalancers API operation. To find the ARN for the target group, use the DescribeTargetGroups API operation.

          • CustomizedScalingMetricSpecification — (map)

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

            • MetricName — required — (String)

              The name of the metric.

            • Namespace — required — (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.

              • Name — required — (String)

                The name of the dimension.

              • Value — required — (String)

                The value of the dimension.

            • Statistic — required — (String)

              The statistic of the metric.

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

              The unit of the metric.

          • TargetValue — required — (Float)

            The target value for the metric. Although this property accepts numbers of type Double, it won't accept values that are either too small or too large. Values must be in the range of -2³⁶⁰ to 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, to wait for a previous scale-out activity to take effect. This property is not used if the scalable resource is an Auto Scaling group.

            With the scale-out cooldown period, the intention is to continuously (but not excessively) scale out. After Auto Scaling successfully scales out using a target tracking scaling policy, it starts to calculate the cooldown time. The scaling policy won't increase the desired capacity again unless either a larger scale out is triggered or the cooldown period ends.

          • ScaleInCooldown — (Integer)

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

            With the scale-in cooldown period, the intention is to scale in conservatively to protect your application’s availability, so scale-in activities are blocked until the cooldown period has expired. However, if another alarm triggers a scale-out activity during the scale-in cooldown period, Auto Scaling scales out the target immediately. In this case, the scale-in cooldown period stops and doesn't complete.

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

          • PredefinedLoadMetricType — required — (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 ALBTargetGroupRequestCount and there is a target group for an Application Load Balancer attached to the Auto Scaling group.

            You create the resource label by appending the final portion of the load balancer ARN and the final portion of the target group ARN into a single value, separated by a forward slash (/). 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.

            This is an example: app/EC2Co-EcsEl-1TKLTMITMM0EO/f37c06a68c1748aa/targetgroup/EC2Co-Defau-LDNM7Q3ZH1ZN/6d4ea56ca2d6a18d.

            To find the ARN for an Application Load Balancer, use the DescribeLoadBalancers API operation. To find the ARN for the target group, use the DescribeTargetGroups API operation.

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

          • MetricName — required — (String)

            The name of the metric.

          • Namespace — required — (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.

            • Name — required — (String)

              The name of the dimension.

            • Value — required — (String)

              The value of the dimension.

          • Statistic — required — (String)

            The statistic of the metric. The only valid value is 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).

      • StatusCode — required — (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.

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. Currently, the only valid value is 1.

  • ServiceNamespace — (String)

    The namespace of the AWS service. The only valid value is autoscaling.

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

    The ID of the resource. This string consists of a prefix (autoScalingGroup) followed by the name of a specified Auto Scaling group (my-asg). Example: autoScalingGroup/my-asg.

  • ScalableDimension — (String)

    The scalable dimension for the resource. The only valid value is autoscaling:autoScalingGroup:DesiredCapacity.

    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.

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. The only valid value is 1. Currently, you cannot have multiple scaling plan versions.

  • ApplicationSource — (map)

    A CloudFormation stack or set of tags.

    For more information, see ApplicationSource in the AWS Auto Scaling API Reference.

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

    For more information, see ScalingInstruction in the AWS Auto Scaling API Reference.

    • ServiceNamespace — required — (String)

      The namespace of the AWS service.

      Possible values include:
      • "autoscaling"
      • "ecs"
      • "ec2"
      • "rds"
      • "dynamodb"
    • ResourceId — required — (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 — required — (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"
    • MinCapacity — required — (Integer)

      The minimum capacity of the resource.

    • MaxCapacity — required — (Integer)

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

    • TargetTrackingConfigurations — required — (Array<map>)

      The target tracking configurations (up to 10). Each of these structures must specify a unique scaling metric and a target value for the metric.

      • PredefinedScalingMetricSpecification — (map)

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

        • PredefinedScalingMetricType — required — (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.

          You create the resource label by appending the final portion of the load balancer ARN and the final portion of the target group ARN into a single value, separated by a forward slash (/). 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.

          This is an example: app/EC2Co-EcsEl-1TKLTMITMM0EO/f37c06a68c1748aa/targetgroup/EC2Co-Defau-LDNM7Q3ZH1ZN/6d4ea56ca2d6a18d.

          To find the ARN for an Application Load Balancer, use the DescribeLoadBalancers API operation. To find the ARN for the target group, use the DescribeTargetGroups API operation.

      • CustomizedScalingMetricSpecification — (map)

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

        • MetricName — required — (String)

          The name of the metric.

        • Namespace — required — (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.

          • Name — required — (String)

            The name of the dimension.

          • Value — required — (String)

            The value of the dimension.

        • Statistic — required — (String)

          The statistic of the metric.

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

          The unit of the metric.

      • TargetValue — required — (Float)

        The target value for the metric. Although this property accepts numbers of type Double, it won't accept values that are either too small or too large. Values must be in the range of -2³⁶⁰ to 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, to wait for a previous scale-out activity to take effect. This property is not used if the scalable resource is an Auto Scaling group.

        With the scale-out cooldown period, the intention is to continuously (but not excessively) scale out. After Auto Scaling successfully scales out using a target tracking scaling policy, it starts to calculate the cooldown time. The scaling policy won't increase the desired capacity again unless either a larger scale out is triggered or the cooldown period ends.

      • ScaleInCooldown — (Integer)

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

        With the scale-in cooldown period, the intention is to scale in conservatively to protect your application’s availability, so scale-in activities are blocked until the cooldown period has expired. However, if another alarm triggers a scale-out activity during the scale-in cooldown period, Auto Scaling scales out the target immediately. In this case, the scale-in cooldown period stops and doesn't complete.

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

      • PredefinedLoadMetricType — required — (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 ALBTargetGroupRequestCount and there is a target group for an Application Load Balancer attached to the Auto Scaling group.

        You create the resource label by appending the final portion of the load balancer ARN and the final portion of the target group ARN into a single value, separated by a forward slash (/). 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.

        This is an example: app/EC2Co-EcsEl-1TKLTMITMM0EO/f37c06a68c1748aa/targetgroup/EC2Co-Defau-LDNM7Q3ZH1ZN/6d4ea56ca2d6a18d.

        To find the ARN for an Application Load Balancer, use the DescribeLoadBalancers API operation. To find the ARN for the target group, use the DescribeTargetGroups API operation.

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

      • MetricName — required — (String)

        The name of the metric.

      • Namespace — required — (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.

        • Name — required — (String)

          The name of the dimension.

        • Value — required — (String)

          The value of the dimension.

      • Statistic — required — (String)

        The statistic of the metric. The only valid value is 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.