@datafire/amazonaws_autoscaling_plans
v5.0.0
Published
DataFire integration for AWS Auto Scaling Plans
Downloads
3
Readme
@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: ""
});
amazonaws_autoscaling_plans.CreateScalingPlan({
"ScalingPlanName": "",
"ApplicationSource": {},
"ScalingInstructions": []
}).then(data => {
console.log(data);
});
Description
Actions
CreateScalingPlan
amazonaws_autoscaling_plans.CreateScalingPlan({
"ScalingPlanName": "",
"ApplicationSource": {},
"ScalingInstructions": []
}, context)
Input
- input
object
- ApplicationSource required ApplicationSource
- ScalingInstructions required ScalingInstructions
- ScalingPlanName required ScalingPlanName
Output
- output CreateScalingPlanResponse
DeleteScalingPlan
amazonaws_autoscaling_plans.DeleteScalingPlan({
"ScalingPlanName": "",
"ScalingPlanVersion": 0
}, context)
Input
- input
object
- ScalingPlanName required ScalingPlanName
- ScalingPlanVersion required ScalingPlanVersion
Output
- output DeleteScalingPlanResponse
DescribeScalingPlanResources
amazonaws_autoscaling_plans.DescribeScalingPlanResources({
"ScalingPlanName": "",
"ScalingPlanVersion": 0
}, context)
Input
- input
object
- MaxResults MaxResults
- NextToken NextToken
- ScalingPlanName required ScalingPlanName
- ScalingPlanVersion required ScalingPlanVersion
Output
DescribeScalingPlans
amazonaws_autoscaling_plans.DescribeScalingPlans({}, context)
Input
- input
object
- ApplicationSources ApplicationSources
- MaxResults MaxResults
- NextToken NextToken
- ScalingPlanNames ScalingPlanNames
- ScalingPlanVersion ScalingPlanVersion
Output
- output DescribeScalingPlansResponse
Definitions
ApplicationSource
- ApplicationSource
object
: Represents an application source.- CloudFormationStackARN XmlString
ApplicationSources
- ApplicationSources
array
- items ApplicationSource
ConcurrentUpdateException
- ConcurrentUpdateException
object
: Concurrent updates caused an exception, for example, if you request an update to a scaling plan that already has a pending update.- Message ErrorMessage
Cooldown
- Cooldown
integer
CreateScalingPlanRequest
- CreateScalingPlanRequest
object
- ApplicationSource required ApplicationSource
- ScalingInstructions required ScalingInstructions
- ScalingPlanName required ScalingPlanName
CreateScalingPlanResponse
- CreateScalingPlanResponse
object
- ScalingPlanVersion required ScalingPlanVersion
CustomizedScalingMetricSpecification
- CustomizedScalingMetricSpecification
object
: Represents a customized metric for a target tracking policy.- Dimensions MetricDimensions
- MetricName required MetricName
- Namespace required MetricNamespace
- Statistic required MetricStatistic
- Unit MetricUnit
DeleteScalingPlanRequest
- DeleteScalingPlanRequest
object
- ScalingPlanName required ScalingPlanName
- ScalingPlanVersion required ScalingPlanVersion
DeleteScalingPlanResponse
- DeleteScalingPlanResponse
object
DescribeScalingPlanResourcesRequest
- DescribeScalingPlanResourcesRequest
object
- MaxResults MaxResults
- NextToken NextToken
- ScalingPlanName required ScalingPlanName
- ScalingPlanVersion required ScalingPlanVersion
DescribeScalingPlanResourcesResponse
- DescribeScalingPlanResourcesResponse
object
- NextToken NextToken
- ScalingPlanResources ScalingPlanResources
DescribeScalingPlansRequest
- DescribeScalingPlansRequest
object
- ApplicationSources ApplicationSources
- MaxResults MaxResults
- NextToken NextToken
- ScalingPlanNames ScalingPlanNames
- ScalingPlanVersion ScalingPlanVersion
DescribeScalingPlansResponse
- DescribeScalingPlansResponse
object
- NextToken NextToken
- ScalingPlans ScalingPlans
DisableScaleIn
- DisableScaleIn
boolean
ErrorMessage
- ErrorMessage
string
InternalServiceException
- InternalServiceException
object
: The service encountered an internal error.- Message ErrorMessage
InvalidNextTokenException
- InvalidNextTokenException
object
: The token provided is not valid.- Message ErrorMessage
LimitExceededException
- LimitExceededException
object
: Your account exceeded a limit. This exception is thrown when a per-account resource limit is exceeded.- Message ErrorMessage
MaxResults
- MaxResults
integer
MetricDimension
- MetricDimension
object
: Represents a dimension for a customized metric.- Name required MetricDimensionName
- Value required MetricDimensionValue
MetricDimensionName
- MetricDimensionName
string
MetricDimensionValue
- MetricDimensionValue
string
MetricDimensions
- MetricDimensions
array
- items MetricDimension
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
- ObjectNotFoundException
object
: The specified object could not be found.- Message ErrorMessage
PolicyName
- PolicyName
string
PolicyType
- PolicyType
string
(values: TargetTrackingScaling)
PredefinedScalingMetricSpecification
- PredefinedScalingMetricSpecification
object
: Represents a predefined metric for a target tracking policy.- PredefinedScalingMetricType required ScalingMetricType
- ResourceLabel ResourceLabel
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
: Specifies the scaling configuration for a scalable resource.- MaxCapacity required ResourceCapacity
- MinCapacity required ResourceCapacity
- ResourceId required ResourceIdMaxLen1600
- ScalableDimension required ScalableDimension
- ServiceNamespace required ServiceNamespace
- TargetTrackingConfigurations required TargetTrackingConfigurations
ScalingInstructions
- ScalingInstructions
array
- items ScalingInstruction
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 ApplicationSource
- CreationTime TimestampType
- ScalingInstructions required ScalingInstructions
- ScalingPlanName required ScalingPlanName
- ScalingPlanVersion required ScalingPlanVersion
- StatusCode required ScalingPlanStatusCode
- StatusMessage XmlString
ScalingPlanName
- ScalingPlanName
string
ScalingPlanNames
- ScalingPlanNames
array
- items ScalingPlanName
ScalingPlanResource
- ScalingPlanResource
object
: Represents a scalable resource.- ResourceId required ResourceIdMaxLen1600
- ScalableDimension required ScalableDimension
- ScalingPlanName required ScalingPlanName
- ScalingPlanVersion required ScalingPlanVersion
- ScalingPolicies ScalingPolicies
- ScalingStatusCode required ScalingStatusCode
- ScalingStatusMessage XmlString
- ServiceNamespace required ServiceNamespace
ScalingPlanResources
- ScalingPlanResources
array
- items ScalingPlanResource
ScalingPlanStatusCode
- ScalingPlanStatusCode
string
(values: Active, ActiveWithProblems, CreationInProgress, CreationFailed, DeletionInProgress, DeletionFailed)
ScalingPlanVersion
- ScalingPlanVersion
integer
ScalingPlans
- ScalingPlans
array
- items ScalingPlan
ScalingPolicies
- ScalingPolicies
array
- items ScalingPolicy
ScalingPolicy
- ScalingPolicy
object
: Represents a scaling policy.- PolicyName required PolicyName
- PolicyType required PolicyType
- TargetTrackingConfiguration TargetTrackingConfiguration
ScalingStatusCode
- ScalingStatusCode
string
(values: Inactive, PartiallyActive, Active)
ServiceNamespace
- ServiceNamespace
string
(values: autoscaling, ecs, ec2, rds, dynamodb)
TargetTrackingConfiguration
- TargetTrackingConfiguration
object
: Represents a target tracking scaling policy.- CustomizedScalingMetricSpecification CustomizedScalingMetricSpecification
- DisableScaleIn DisableScaleIn
- EstimatedInstanceWarmup Cooldown
- PredefinedScalingMetricSpecification PredefinedScalingMetricSpecification
- ScaleInCooldown Cooldown
- ScaleOutCooldown Cooldown
- TargetValue required MetricScale
TargetTrackingConfigurations
- TargetTrackingConfigurations
array
TimestampType
- TimestampType
string
ValidationException
- ValidationException
object
: An exception was thrown for a validation issue. Review the parameters provided.- Message ErrorMessage
XmlString
- XmlString
string