class CfnScalingPlanPropsMixin

Language	Type name
.NET	Amazon.CDK.Mixins.Preview.AWS.AutoScalingPlans.Mixins.CfnScalingPlanPropsMixin
Go	github.com/aws/aws-cdk-go/awscdkmixinspreview/v2/awsautoscalingplans/mixins#CfnScalingPlanPropsMixin
Java	software.amazon.awscdk.mixins.preview.services.autoscalingplans.mixins.CfnScalingPlanPropsMixin
Python	aws_cdk.mixins_preview.aws_autoscalingplans.mixins.CfnScalingPlanPropsMixin
TypeScript	@aws-cdk/mixins-preview » aws_autoscalingplans » mixins » CfnScalingPlanPropsMixin

Implements IMixin

Extends Mixin

The AWS::AutoScalingPlans::ScalingPlan resource defines an AWS Auto Scaling scaling plan.

A scaling plan is used to scale application resources to size them appropriately to ensure that enough resource is available in the application at peak times and to reduce allocated resource during periods of low utilization. The following resources can be added to a scaling plan:

• Amazon EC2 Auto Scaling groups
• Amazon EC2 Spot Fleet requests
• Amazon ECS services
• Amazon DynamoDB tables and global secondary indexes
• Amazon Aurora Replicas

For more information, see the Scaling Plans User Guide

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-autoscalingplans-scalingplan.html

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { mixins } from '@aws-cdk/mixins-preview';
import { mixins as autoscalingplans_mixins } from '@aws-cdk/mixins-preview/aws-autoscalingplans';
const cfnScalingPlanPropsMixin = new autoscalingplans_mixins.CfnScalingPlanPropsMixin({
  applicationSource: {
    cloudFormationStackArn: 'cloudFormationStackArn',
    tagFilters: [{
      key: 'key',
      values: ['values'],
    }],
  },
  scalingInstructions: [{
    customizedLoadMetricSpecification: {
      dimensions: [{
        name: 'name',
        value: 'value',
      }],
      metricName: 'metricName',
      namespace: 'namespace',
      statistic: 'statistic',
      unit: 'unit',
    },
    disableDynamicScaling: false,
    maxCapacity: 123,
    minCapacity: 123,
    predefinedLoadMetricSpecification: {
      predefinedLoadMetricType: 'predefinedLoadMetricType',
      resourceLabel: 'resourceLabel',
    },
    predictiveScalingMaxCapacityBehavior: 'predictiveScalingMaxCapacityBehavior',
    predictiveScalingMaxCapacityBuffer: 123,
    predictiveScalingMode: 'predictiveScalingMode',
    resourceId: 'resourceId',
    scalableDimension: 'scalableDimension',
    scalingPolicyUpdateBehavior: 'scalingPolicyUpdateBehavior',
    scheduledActionBufferTime: 123,
    serviceNamespace: 'serviceNamespace',
    targetTrackingConfigurations: [{
      customizedScalingMetricSpecification: {
        dimensions: [{
          name: 'name',
          value: 'value',
        }],
        metricName: 'metricName',
        namespace: 'namespace',
        statistic: 'statistic',
        unit: 'unit',
      },
      disableScaleIn: false,
      estimatedInstanceWarmup: 123,
      predefinedScalingMetricSpecification: {
        predefinedScalingMetricType: 'predefinedScalingMetricType',
        resourceLabel: 'resourceLabel',
      },
      scaleInCooldown: 123,
      scaleOutCooldown: 123,
      targetValue: 123,
    }],
  }],
}, /* all optional props */ {
  strategy: mixins.PropertyMergeStrategy.OVERRIDE,
});

Initializer

new CfnScalingPlanPropsMixin(props: CfnScalingPlanMixinProps, options?: CfnPropertyMixinOptions)

Parameters

• props CfnScalingPlanMixinProps — L1 properties to apply.
• options CfnPropertyMixinOptions — Mixin options.

Create a mixin to apply properties to AWS::AutoScalingPlans::ScalingPlan.

Properties

Name	Type	Description
props	CfnScalingPlanMixinProps
strategy	PropertyMergeStrategy
static CFN_PROPERTY_KEYS	string[]

---

props

Type: CfnScalingPlanMixinProps

---

strategy

Type: PropertyMergeStrategy

---

static CFN_PROPERTY_KEYS

Type: string[]

Methods

Name	Description
applyTo(construct)	Apply the mixin properties to the construct.
supports(construct)	Check if this mixin supports the given construct.

---

applyTo(construct)

public applyTo(construct: IConstruct): IConstruct

Parameters

• construct IConstruct

Returns

• IConstruct

Apply the mixin properties to the construct.

---

supports(construct)

public supports(construct: IConstruct): boolean

Parameters

• construct IConstruct

Returns

• boolean

Check if this mixin supports the given construct.