ScalingPolicy

applicationautoscaling.services.k8s.aws/v1alpha1

Metadata#

Represents a scaling policy to use with Application Auto Scaling.

For more information about configuring scaling policies for a specific service, see Getting started with Application Auto Scaling (https://docs.aws.amazon.com/autoscaling/application/userguide/getting-started.html) in the Application Auto Scaling User Guide.

Spec#

policyName: string
policyType: string
resourceID: string
scalableDimension: string
serviceNamespace: string
stepScalingPolicyConfiguration: 
  adjustmentType: string
  cooldown: integer
  metricAggregationType: string
  minAdjustmentMagnitude: integer
  stepAdjustments:
  - metricIntervalLowerBound: number
    metricIntervalUpperBound: number
    scalingAdjustment: integer
targetTrackingScalingPolicyConfiguration: 
  customizedMetricSpecification: 
    dimensions:
    - name: string
      value: string
    metricName: string
    namespace: string
    statistic: string
    unit: string
  disableScaleIn: boolean
  predefinedMetricSpecification: 
    predefinedMetricType: string
    resourceLabel: string
  scaleInCooldown: integer
  scaleOutCooldown: integer
  targetValue: number

For the following examples, suppose that you have an alarm with a breach threshold of 50:

• To trigger the adjustment when the metric is greater than or equal to 50 and less than 60, specify a lower bound of 0 and an upper bound of

• To trigger the adjustment when the metric is greater than 40 and less than or equal to 50, specify a lower bound of -10 and an upper bound of

There are a few rules for the step adjustments for your step policy:

• The ranges of your step adjustments can’t overlap or have a gap.

• At most one step adjustment can have a null lower bound. If one step adjustment has a negative lower bound, then there must be a step adjustment with a null lower bound.

• At most one step adjustment can have a null upper bound. If one step adjustment has a positive upper bound, then there must be a step adjustment with a null upper bound.

• The upper and lower bound can’t be null in the same step adjustment. || stepScalingPolicyConfiguration.stepAdjustments.[].metricIntervalLowerBound
  Optional | number
  | | stepScalingPolicyConfiguration.stepAdjustments.[].metricIntervalUpperBound
  Optional | number
  | | stepScalingPolicyConfiguration.stepAdjustments.[].scalingAdjustment
  Optional | integer
  | | targetTrackingScalingPolicyConfiguration
  Optional | object
  A target tracking scaling policy. Includes support for predefined or customized
  metrics.
  
  This parameter is required if you are creating a policy and the policy type
  is TargetTrackingScaling. | | targetTrackingScalingPolicyConfiguration.customizedMetricSpecification
  Optional | object
  Represents a CloudWatch metric of your choosing for a target tracking scaling
  policy to use with Application Auto Scaling.
  
  For information about the available metrics for a service, see Amazon Web
  Services Services That Publish CloudWatch Metrics (https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/aws-services-cloudwatch-metrics.html)
  in the Amazon CloudWatch User Guide.
  
  To create your customized 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 (https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/publishingMetrics.html)
  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, and increase when capacity decreases.
  
  For more information about CloudWatch, see Amazon CloudWatch Concepts (https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/cloudwatch_concepts.html). | | targetTrackingScalingPolicyConfiguration.customizedMetricSpecification.dimensions
  Optional | array
  | | targetTrackingScalingPolicyConfiguration.customizedMetricSpecification.dimensions.[]
  Required | object
  Describes the dimension names and values associated with a metric. || targetTrackingScalingPolicyConfiguration.customizedMetricSpecification.dimensions.[].name
  Optional | string
  | | targetTrackingScalingPolicyConfiguration.customizedMetricSpecification.dimensions.[].value
  Optional | string
  | | targetTrackingScalingPolicyConfiguration.customizedMetricSpecification.metricName
  Optional | string
  | | targetTrackingScalingPolicyConfiguration.customizedMetricSpecification.namespace
  Optional | string
  | | targetTrackingScalingPolicyConfiguration.customizedMetricSpecification.statistic
  Optional | string
  | | targetTrackingScalingPolicyConfiguration.customizedMetricSpecification.unit
  Optional | string
  | | targetTrackingScalingPolicyConfiguration.disableScaleIn
  Optional | boolean
  | | targetTrackingScalingPolicyConfiguration.predefinedMetricSpecification
  Optional | object
  Represents a predefined metric for a target tracking scaling policy to use
  with Application Auto Scaling.
  
  Only the Amazon Web Services that you’re using send metrics to Amazon CloudWatch.
  To determine whether a desired metric already exists by looking up its namespace
  and dimension using the CloudWatch metrics dashboard in the console, follow
  the procedure in Building dashboards with CloudWatch (https://docs.aws.amazon.com/autoscaling/application/userguide/monitoring-cloudwatch.html)
  in the Application Auto Scaling User Guide. | | targetTrackingScalingPolicyConfiguration.predefinedMetricSpecification.predefinedMetricType
  Optional | string
  | | targetTrackingScalingPolicyConfiguration.predefinedMetricSpecification.resourceLabel
  Optional | string
  | | targetTrackingScalingPolicyConfiguration.scaleInCooldown
  Optional | integer
  | | targetTrackingScalingPolicyConfiguration.scaleOutCooldown
  Optional | integer
  | | targetTrackingScalingPolicyConfiguration.targetValue
  Optional | number
  |

Status#

ackResourceMetadata: 
  arn: string
  ownerAccountID: string
  region: string
alarms:
- alarmARN: string
  alarmName: string
conditions:
- lastTransitionTime: string
  message: string
  reason: string
  status: string
  type: string
creationTime: string
lastModifiedTime: string