Skip to content

Latest commit

 

History

History

amazonaws_autoscaling_plans

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
README.md
README.md
 
 
index.js
index.js
 
 
openapi.json
openapi.json
 
 
package.json
package.json
 
 

README.md

@datafire/amazonaws_autoscaling_plans

Client library for AWS Auto Scaling Plans

Installation and Usage

npm install --save @datafire/amazonaws_autoscaling_plans
let amazonaws_autoscaling_plans = require('@datafire/amazonaws_autoscaling_plans').create({
  accessKeyId: "",
  secretAccessKey: "",
  region: ""
});

.then(data => {
  console.log(data);
});

Description

AWS Auto Scaling

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.

Actions

CreateScalingPlan

amazonaws_autoscaling_plans.CreateScalingPlan({
  "ScalingPlanName": null,
  "ApplicationSource": null,
  "ScalingInstructions": null
}, context)

Input

  • input object
    • ApplicationSource required
      • CloudFormationStackARN
      • TagFilters
    • ScalingInstructions required
    • ScalingPlanName required

Output

DeleteScalingPlan

amazonaws_autoscaling_plans.DeleteScalingPlan({
  "ScalingPlanName": null,
  "ScalingPlanVersion": null
}, context)

Input

  • input object
    • ScalingPlanName required
    • ScalingPlanVersion required

Output

DescribeScalingPlanResources

amazonaws_autoscaling_plans.DescribeScalingPlanResources({
  "ScalingPlanName": null,
  "ScalingPlanVersion": null
}, context)

Input

  • input object
    • MaxResults
    • NextToken
    • ScalingPlanName required
    • ScalingPlanVersion required

Output

DescribeScalingPlans

amazonaws_autoscaling_plans.DescribeScalingPlans({}, context)

Input

Output

GetScalingPlanResourceForecastData

amazonaws_autoscaling_plans.GetScalingPlanResourceForecastData({
  "ScalingPlanName": null,
  "ScalingPlanVersion": null,
  "ServiceNamespace": null,
  "ResourceId": null,
  "ScalableDimension": null,
  "ForecastDataType": null,
  "StartTime": null,
  "EndTime": null
}, context)

Input

  • input object
    • EndTime required
    • ForecastDataType required
    • ResourceId required
    • ScalableDimension required
    • ScalingPlanName required
    • ScalingPlanVersion required
    • ServiceNamespace required
    • StartTime required

Output

UpdateScalingPlan

amazonaws_autoscaling_plans.UpdateScalingPlan({
  "ScalingPlanName": null,
  "ScalingPlanVersion": null
}, context)

Input

  • input object
    • ApplicationSource
      • CloudFormationStackARN
      • TagFilters
    • ScalingInstructions
    • ScalingPlanName required
    • ScalingPlanVersion required

Output

Definitions

ApplicationSource

  • ApplicationSource object: Represents an application source.
    • CloudFormationStackARN
    • TagFilters

ApplicationSources

ConcurrentUpdateException

Cooldown

  • Cooldown integer

CreateScalingPlanRequest

  • CreateScalingPlanRequest object
    • ApplicationSource required
      • CloudFormationStackARN
      • TagFilters
    • ScalingInstructions required
    • ScalingPlanName required

CreateScalingPlanResponse

  • CreateScalingPlanResponse object
    • ScalingPlanVersion required

CustomizedLoadMetricSpecification

  • CustomizedLoadMetricSpecification object:

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

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

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

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

    • Dimensions
    • MetricName required
    • Namespace required
    • Statistic required
    • Unit

CustomizedScalingMetricSpecification

  • CustomizedScalingMetricSpecification object:

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

    To create your customized scaling metric specification:

    • Add values for each required parameter from CloudWatch. You can use an existing metric, or a new metric that you create. To use your own metric, you must first publish the metric to CloudWatch. For more information, see Publish Custom Metrics in the Amazon CloudWatch User Guide.

    • Choose a metric that changes proportionally with capacity. The value of the metric should increase or decrease in inverse proportion to the number of capacity units. That is, the value of the metric should decrease when capacity increases.

    For more information about CloudWatch, see Amazon CloudWatch Concepts.

    • Dimensions
    • MetricName required
    • Namespace required
    • Statistic required
    • Unit

Datapoint

  • Datapoint object: Represents a single value in the forecast data used for predictive scaling.
    • Timestamp
    • Value

Datapoints

DeleteScalingPlanRequest

  • DeleteScalingPlanRequest object
    • ScalingPlanName required
    • ScalingPlanVersion required

DeleteScalingPlanResponse

  • DeleteScalingPlanResponse object

DescribeScalingPlanResourcesRequest

  • DescribeScalingPlanResourcesRequest object
    • MaxResults
    • NextToken
    • ScalingPlanName required
    • ScalingPlanVersion required

DescribeScalingPlanResourcesResponse

  • DescribeScalingPlanResourcesResponse object

DescribeScalingPlansRequest

DescribeScalingPlansResponse

  • DescribeScalingPlansResponse object

DisableDynamicScaling

  • DisableDynamicScaling boolean

DisableScaleIn

  • DisableScaleIn boolean

ForecastDataType

  • ForecastDataType string (values: CapacityForecast, LoadForecast, ScheduledActionMinCapacity, ScheduledActionMaxCapacity)

GetScalingPlanResourceForecastDataRequest

  • GetScalingPlanResourceForecastDataRequest object
    • EndTime required
    • ForecastDataType required
    • ResourceId required
    • ScalableDimension required
    • ScalingPlanName required
    • ScalingPlanVersion required
    • ServiceNamespace required
    • StartTime required

GetScalingPlanResourceForecastDataResponse

  • GetScalingPlanResourceForecastDataResponse object

InternalServiceException

InvalidNextTokenException

LimitExceededException

LoadMetricType

  • LoadMetricType string (values: ASGTotalCPUUtilization, ASGTotalNetworkIn, ASGTotalNetworkOut, ALBTargetGroupRequestCount)

MaxResults

  • MaxResults integer

MetricDimension

  • MetricDimension object: Represents a dimension for a customized metric.
    • Name required
    • Value required

MetricDimensionName

  • MetricDimensionName string

MetricDimensionValue

  • MetricDimensionValue string

MetricDimensions

MetricName

  • MetricName string

MetricNamespace

  • MetricNamespace string

MetricScale

  • MetricScale number

MetricStatistic

  • MetricStatistic string (values: Average, Minimum, Maximum, SampleCount, Sum)

MetricUnit

  • MetricUnit string

NextToken

  • NextToken string

ObjectNotFoundException

PolicyName

  • PolicyName string

PolicyType

  • PolicyType string (values: TargetTrackingScaling)

PredefinedLoadMetricSpecification

  • PredefinedLoadMetricSpecification object: Represents a predefined metric that can be used for predictive scaling.
    • PredefinedLoadMetricType required
    • ResourceLabel

PredefinedScalingMetricSpecification

  • PredefinedScalingMetricSpecification object: Represents a predefined metric that can be used for dynamic scaling as part of a target tracking scaling policy.
    • PredefinedScalingMetricType required
    • ResourceLabel

PredictiveScalingMaxCapacityBehavior

  • PredictiveScalingMaxCapacityBehavior string (values: SetForecastCapacityToMaxCapacity, SetMaxCapacityToForecastCapacity, SetMaxCapacityAboveForecastCapacity)

PredictiveScalingMode

  • PredictiveScalingMode string (values: ForecastAndScale, ForecastOnly)

ResourceCapacity

  • ResourceCapacity integer

ResourceIdMaxLen1600

  • ResourceIdMaxLen1600 string

ResourceLabel

  • ResourceLabel string

ScalableDimension

  • ScalableDimension string (values: 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)

ScalingInstruction

  • ScalingInstruction object:

    Describes a scaling instruction for a scalable resource.

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

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

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

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

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

    • CustomizedLoadMetricSpecification
      • Dimensions
      • MetricName required
      • Namespace required
      • Statistic required
      • Unit
    • DisableDynamicScaling
    • MaxCapacity required
    • MinCapacity required
    • PredefinedLoadMetricSpecification
      • PredefinedLoadMetricType required
      • ResourceLabel
    • PredictiveScalingMaxCapacityBehavior
    • PredictiveScalingMaxCapacityBuffer
    • PredictiveScalingMode
    • ResourceId required
    • ScalableDimension required
    • ScalingPolicyUpdateBehavior
    • ScheduledActionBufferTime
    • ServiceNamespace required
    • TargetTrackingConfigurations required

ScalingInstructions

ScalingMetricType

  • ScalingMetricType string (values: ASGAverageCPUUtilization, ASGAverageNetworkIn, ASGAverageNetworkOut, DynamoDBReadCapacityUtilization, DynamoDBWriteCapacityUtilization, ECSServiceAverageCPUUtilization, ECSServiceAverageMemoryUtilization, ALBRequestCountPerTarget, RDSReaderAverageCPUUtilization, RDSReaderAverageDatabaseConnections, EC2SpotFleetRequestAverageCPUUtilization, EC2SpotFleetRequestAverageNetworkIn, EC2SpotFleetRequestAverageNetworkOut)

ScalingPlan

  • ScalingPlan object: Represents a scaling plan.
    • ApplicationSource required
      • CloudFormationStackARN
      • TagFilters
    • CreationTime
    • ScalingInstructions required
    • ScalingPlanName required
    • ScalingPlanVersion required
    • StatusCode required
    • StatusMessage
    • StatusStartTime

ScalingPlanName

  • ScalingPlanName string

ScalingPlanNames

ScalingPlanResource

  • ScalingPlanResource object: Represents a scalable resource.
    • ResourceId required
    • ScalableDimension required
    • ScalingPlanName required
    • ScalingPlanVersion required
    • ScalingPolicies
    • ScalingStatusCode required
    • ScalingStatusMessage
    • ServiceNamespace required

ScalingPlanResources

ScalingPlanStatusCode

  • ScalingPlanStatusCode string (values: Active, ActiveWithProblems, CreationInProgress, CreationFailed, DeletionInProgress, DeletionFailed, UpdateInProgress, UpdateFailed)

ScalingPlanVersion

  • ScalingPlanVersion integer

ScalingPlans

ScalingPolicies

ScalingPolicy

  • ScalingPolicy object: Represents a scaling policy.
    • PolicyName required
    • PolicyType required
    • TargetTrackingConfiguration
      • CustomizedScalingMetricSpecification
        • Dimensions
        • MetricName required
        • Namespace required
        • Statistic required
        • Unit
      • DisableScaleIn
      • EstimatedInstanceWarmup
      • PredefinedScalingMetricSpecification
        • PredefinedScalingMetricType required
        • ResourceLabel
      • ScaleInCooldown
      • ScaleOutCooldown
      • TargetValue required

ScalingPolicyUpdateBehavior

  • ScalingPolicyUpdateBehavior string (values: KeepExternalPolicies, ReplaceExternalPolicies)

ScalingStatusCode

  • ScalingStatusCode string (values: Inactive, PartiallyActive, Active)

ScheduledActionBufferTime

  • ScheduledActionBufferTime integer

ServiceNamespace

  • ServiceNamespace string (values: autoscaling, ecs, ec2, rds, dynamodb)

TagFilter

TagFilters

TagValues

TargetTrackingConfiguration

  • TargetTrackingConfiguration object: Describes a target tracking configuration to use with AWS Auto Scaling. Used with ScalingInstruction and ScalingPolicy.
    • CustomizedScalingMetricSpecification
      • Dimensions
      • MetricName required
      • Namespace required
      • Statistic required
      • Unit
    • DisableScaleIn
    • EstimatedInstanceWarmup
    • PredefinedScalingMetricSpecification
      • PredefinedScalingMetricType required
      • ResourceLabel
    • ScaleInCooldown
    • ScaleOutCooldown
    • TargetValue required

TargetTrackingConfigurations

TimestampType

  • TimestampType string

UpdateScalingPlanRequest

  • UpdateScalingPlanRequest object
    • ApplicationSource
      • CloudFormationStackARN
      • TagFilters
    • ScalingInstructions
    • ScalingPlanName required
    • ScalingPlanVersion required

UpdateScalingPlanResponse

  • UpdateScalingPlanResponse object

ValidationException

XmlString

  • XmlString string

XmlStringMaxLen128

  • XmlStringMaxLen128 string

XmlStringMaxLen256

  • XmlStringMaxLen256 string