This documentation is for the developer preview release of the AWS CDK. Do not use this version of the AWS CDK in production. Subsequent releases of the AWS CDK will likely include breaking changes.

@aws-cdk/aws-autoscalingplans

The CDK Construct Library for AWS Auto-Scaling Plans

This module is part of the AWS Cloud Development Kit project.

Reference

View in Nuget

csproj:

<PackageReference Include="Amazon.CDK.AWS.AutoScalingPlans" Version="0.25.3" />

dotnet:

dotnet add package Amazon.CDK.AWS.AutoScalingPlans --version 0.25.3

packages.config:

<package id="Amazon.CDK.AWS.AutoScalingPlans" version="0.25.3" />

View in Maven Central

Apache Buildr:

'software.amazon.awscdk:autoscalingplans:jar:0.25.3'

Apache Ivy:

<dependency groupId="software.amazon.awscdk" name="autoscalingplans" rev="0.25.3"/>

Apache Maven:

<dependency>
  <groupId>software.amazon.awscdk</groupId>
  <artifactId>autoscalingplans</artifactId>
  <version>0.25.3</version>
</dependency>

Gradle / Grails:

compile 'software.amazon.awscdk:autoscalingplans:0.25.3'

Groovy Grape:

@Grapes(
@Grab(group='software.amazon.awscdk', module='autoscalingplans', version='0.25.3')
)

View in NPM

npm:

$ npm i @aws-cdk/aws-autoscalingplans@0.25.3

package.json:

{
  "@aws-cdk/aws-autoscalingplans": "^0.25.3"
}

yarn:

$ yarn add @aws-cdk/aws-autoscalingplans@0.25.3

View in NPM

npm:

$ npm i @aws-cdk/aws-autoscalingplans@0.25.3

package.json:

{
  "@aws-cdk/aws-autoscalingplans": "^0.25.3"
}

yarn:

$ yarn add @aws-cdk/aws-autoscalingplans@0.25.3

CfnScalingPlan

class @aws-cdk/aws-autoscalingplans.CfnScalingPlan(scope, id, props)

Language-specific names:

using Amazon.CDK.AWS.AutoScalingPlans;
import software.amazon.awscdk.services.autoscalingplans.CfnScalingPlan;
const { CfnScalingPlan } = require('@aws-cdk/aws-autoscalingplans');
import { CfnScalingPlan } from '@aws-cdk/aws-autoscalingplans';
Extends:

@aws-cdk/cdk.Resource

Parameters:
renderProperties(properties) → string => any

Overrides @aws-cdk/cdk.Resource.renderProperties()

Protected method

Parameters:properties (any) –
Return type:string => any
resourceTypeName

The CloudFormation resource type name for this resource class.

Type:string (readonly) (static)
propertyOverrides
Type:CfnScalingPlanProps (readonly)
scalingPlanArn
Type:string (readonly)
scalingPlanName
Type:string (readonly)
scalingPlanVersion
Type:string (readonly)
class ApplicationSourceProperty

Language-specific names:

using Amazon.CDK.AWS.AutoScalingPlans;
import software.amazon.awscdk.services.autoscalingplans.CfnScalingPlan.ApplicationSourceProperty;
// CfnScalingPlan.ApplicationSourceProperty is an interface
import { CfnScalingPlan.ApplicationSourceProperty } from '@aws-cdk/aws-autoscalingplans';
cloudFormationStackArn

CfnScalingPlan.ApplicationSourceProperty.CloudFormationStackARN

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscalingplans-scalingplan-applicationsource.html#cfn-autoscalingplans-scalingplan-applicationsource-cloudformationstackarn

Type:string (optional)
tagFilters

CfnScalingPlan.ApplicationSourceProperty.TagFilters

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscalingplans-scalingplan-applicationsource.html#cfn-autoscalingplans-scalingplan-applicationsource-tagfilters

Type:@aws-cdk/cdk.Token or (@aws-cdk/cdk.Token or TagFilterProperty)[] (optional)
class CustomizedLoadMetricSpecificationProperty

Language-specific names:

using Amazon.CDK.AWS.AutoScalingPlans;
import software.amazon.awscdk.services.autoscalingplans.CfnScalingPlan.CustomizedLoadMetricSpecificationProperty;
// CfnScalingPlan.CustomizedLoadMetricSpecificationProperty is an interface
import { CfnScalingPlan.CustomizedLoadMetricSpecificationProperty } from '@aws-cdk/aws-autoscalingplans';
metricName

CfnScalingPlan.CustomizedLoadMetricSpecificationProperty.MetricName

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscalingplans-scalingplan-customizedloadmetricspecification.html#cfn-autoscalingplans-scalingplan-customizedloadmetricspecification-metricname

Type:string
namespace

CfnScalingPlan.CustomizedLoadMetricSpecificationProperty.Namespace

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscalingplans-scalingplan-customizedloadmetricspecification.html#cfn-autoscalingplans-scalingplan-customizedloadmetricspecification-namespace

Type:string
statistic

CfnScalingPlan.CustomizedLoadMetricSpecificationProperty.Statistic

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscalingplans-scalingplan-customizedloadmetricspecification.html#cfn-autoscalingplans-scalingplan-customizedloadmetricspecification-statistic

Type:string
dimensions

CfnScalingPlan.CustomizedLoadMetricSpecificationProperty.Dimensions

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscalingplans-scalingplan-customizedloadmetricspecification.html#cfn-autoscalingplans-scalingplan-customizedloadmetricspecification-dimensions

Type:@aws-cdk/cdk.Token or (@aws-cdk/cdk.Token or MetricDimensionProperty)[] (optional)
unit

CfnScalingPlan.CustomizedLoadMetricSpecificationProperty.Unit

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscalingplans-scalingplan-customizedloadmetricspecification.html#cfn-autoscalingplans-scalingplan-customizedloadmetricspecification-unit

Type:string (optional)
class CustomizedScalingMetricSpecificationProperty

Language-specific names:

using Amazon.CDK.AWS.AutoScalingPlans;
import software.amazon.awscdk.services.autoscalingplans.CfnScalingPlan.CustomizedScalingMetricSpecificationProperty;
// CfnScalingPlan.CustomizedScalingMetricSpecificationProperty is an interface
import { CfnScalingPlan.CustomizedScalingMetricSpecificationProperty } from '@aws-cdk/aws-autoscalingplans';
metricName

CfnScalingPlan.CustomizedScalingMetricSpecificationProperty.MetricName

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscalingplans-scalingplan-customizedscalingmetricspecification.html#cfn-autoscalingplans-scalingplan-customizedscalingmetricspecification-metricname

Type:string
namespace

CfnScalingPlan.CustomizedScalingMetricSpecificationProperty.Namespace

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscalingplans-scalingplan-customizedscalingmetricspecification.html#cfn-autoscalingplans-scalingplan-customizedscalingmetricspecification-namespace

Type:string
statistic

CfnScalingPlan.CustomizedScalingMetricSpecificationProperty.Statistic

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscalingplans-scalingplan-customizedscalingmetricspecification.html#cfn-autoscalingplans-scalingplan-customizedscalingmetricspecification-statistic

Type:string
dimensions

CfnScalingPlan.CustomizedScalingMetricSpecificationProperty.Dimensions

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscalingplans-scalingplan-customizedscalingmetricspecification.html#cfn-autoscalingplans-scalingplan-customizedscalingmetricspecification-dimensions

Type:@aws-cdk/cdk.Token or (@aws-cdk/cdk.Token or MetricDimensionProperty)[] (optional)
unit

CfnScalingPlan.CustomizedScalingMetricSpecificationProperty.Unit

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscalingplans-scalingplan-customizedscalingmetricspecification.html#cfn-autoscalingplans-scalingplan-customizedscalingmetricspecification-unit

Type:string (optional)
class MetricDimensionProperty

Language-specific names:

using Amazon.CDK.AWS.AutoScalingPlans;
import software.amazon.awscdk.services.autoscalingplans.CfnScalingPlan.MetricDimensionProperty;
// CfnScalingPlan.MetricDimensionProperty is an interface
import { CfnScalingPlan.MetricDimensionProperty } from '@aws-cdk/aws-autoscalingplans';
name

CfnScalingPlan.MetricDimensionProperty.Name

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscalingplans-scalingplan-metricdimension.html#cfn-autoscalingplans-scalingplan-metricdimension-name

Type:string
value

CfnScalingPlan.MetricDimensionProperty.Value

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscalingplans-scalingplan-metricdimension.html#cfn-autoscalingplans-scalingplan-metricdimension-value

Type:string
class PredefinedLoadMetricSpecificationProperty

Language-specific names:

using Amazon.CDK.AWS.AutoScalingPlans;
import software.amazon.awscdk.services.autoscalingplans.CfnScalingPlan.PredefinedLoadMetricSpecificationProperty;
// CfnScalingPlan.PredefinedLoadMetricSpecificationProperty is an interface
import { CfnScalingPlan.PredefinedLoadMetricSpecificationProperty } from '@aws-cdk/aws-autoscalingplans';
predefinedLoadMetricType

CfnScalingPlan.PredefinedLoadMetricSpecificationProperty.PredefinedLoadMetricType

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscalingplans-scalingplan-predefinedloadmetricspecification.html#cfn-autoscalingplans-scalingplan-predefinedloadmetricspecification-predefinedloadmetrictype

Type:string
resourceLabel

CfnScalingPlan.PredefinedLoadMetricSpecificationProperty.ResourceLabel

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscalingplans-scalingplan-predefinedloadmetricspecification.html#cfn-autoscalingplans-scalingplan-predefinedloadmetricspecification-resourcelabel

Type:string (optional)
class PredefinedScalingMetricSpecificationProperty

Language-specific names:

using Amazon.CDK.AWS.AutoScalingPlans;
import software.amazon.awscdk.services.autoscalingplans.CfnScalingPlan.PredefinedScalingMetricSpecificationProperty;
// CfnScalingPlan.PredefinedScalingMetricSpecificationProperty is an interface
import { CfnScalingPlan.PredefinedScalingMetricSpecificationProperty } from '@aws-cdk/aws-autoscalingplans';
predefinedScalingMetricType

CfnScalingPlan.PredefinedScalingMetricSpecificationProperty.PredefinedScalingMetricType

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscalingplans-scalingplan-predefinedscalingmetricspecification.html#cfn-autoscalingplans-scalingplan-predefinedscalingmetricspecification-predefinedscalingmetrictype

Type:string
resourceLabel

CfnScalingPlan.PredefinedScalingMetricSpecificationProperty.ResourceLabel

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscalingplans-scalingplan-predefinedscalingmetricspecification.html#cfn-autoscalingplans-scalingplan-predefinedscalingmetricspecification-resourcelabel

Type:string (optional)
class ScalingInstructionProperty

Language-specific names:

using Amazon.CDK.AWS.AutoScalingPlans;
import software.amazon.awscdk.services.autoscalingplans.CfnScalingPlan.ScalingInstructionProperty;
// CfnScalingPlan.ScalingInstructionProperty is an interface
import { CfnScalingPlan.ScalingInstructionProperty } from '@aws-cdk/aws-autoscalingplans';
maxCapacity

CfnScalingPlan.ScalingInstructionProperty.MaxCapacity

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscalingplans-scalingplan-scalinginstruction.html#cfn-autoscalingplans-scalingplan-scalinginstruction-maxcapacity

Type:number or @aws-cdk/cdk.Token
minCapacity

CfnScalingPlan.ScalingInstructionProperty.MinCapacity

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscalingplans-scalingplan-scalinginstruction.html#cfn-autoscalingplans-scalingplan-scalinginstruction-mincapacity

Type:number or @aws-cdk/cdk.Token
resourceId

CfnScalingPlan.ScalingInstructionProperty.ResourceId

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscalingplans-scalingplan-scalinginstruction.html#cfn-autoscalingplans-scalingplan-scalinginstruction-resourceid

Type:string
scalableDimension

CfnScalingPlan.ScalingInstructionProperty.ScalableDimension

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscalingplans-scalingplan-scalinginstruction.html#cfn-autoscalingplans-scalingplan-scalinginstruction-scalabledimension

Type:string
serviceNamespace

CfnScalingPlan.ScalingInstructionProperty.ServiceNamespace

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscalingplans-scalingplan-scalinginstruction.html#cfn-autoscalingplans-scalingplan-scalinginstruction-servicenamespace

Type:string
targetTrackingConfigurations

CfnScalingPlan.ScalingInstructionProperty.TargetTrackingConfigurations

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscalingplans-scalingplan-scalinginstruction.html#cfn-autoscalingplans-scalingplan-scalinginstruction-targettrackingconfigurations

Type:@aws-cdk/cdk.Token or (@aws-cdk/cdk.Token or TargetTrackingConfigurationProperty)[]
customizedLoadMetricSpecification

CfnScalingPlan.ScalingInstructionProperty.CustomizedLoadMetricSpecification

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscalingplans-scalingplan-scalinginstruction.html#cfn-autoscalingplans-scalingplan-scalinginstruction-customizedloadmetricspecification

Type:@aws-cdk/cdk.Token or CustomizedLoadMetricSpecificationProperty (optional)
disableDynamicScaling

CfnScalingPlan.ScalingInstructionProperty.DisableDynamicScaling

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscalingplans-scalingplan-scalinginstruction.html#cfn-autoscalingplans-scalingplan-scalinginstruction-disabledynamicscaling

Type:boolean or @aws-cdk/cdk.Token (optional)
predefinedLoadMetricSpecification

CfnScalingPlan.ScalingInstructionProperty.PredefinedLoadMetricSpecification

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscalingplans-scalingplan-scalinginstruction.html#cfn-autoscalingplans-scalingplan-scalinginstruction-predefinedloadmetricspecification

Type:@aws-cdk/cdk.Token or PredefinedLoadMetricSpecificationProperty (optional)
predictiveScalingMaxCapacityBehavior

CfnScalingPlan.ScalingInstructionProperty.PredictiveScalingMaxCapacityBehavior

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscalingplans-scalingplan-scalinginstruction.html#cfn-autoscalingplans-scalingplan-scalinginstruction-predictivescalingmaxcapacitybehavior

Type:string (optional)
predictiveScalingMaxCapacityBuffer

CfnScalingPlan.ScalingInstructionProperty.PredictiveScalingMaxCapacityBuffer

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscalingplans-scalingplan-scalinginstruction.html#cfn-autoscalingplans-scalingplan-scalinginstruction-predictivescalingmaxcapacitybuffer

Type:number or @aws-cdk/cdk.Token (optional)
predictiveScalingMode

CfnScalingPlan.ScalingInstructionProperty.PredictiveScalingMode

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscalingplans-scalingplan-scalinginstruction.html#cfn-autoscalingplans-scalingplan-scalinginstruction-predictivescalingmode

Type:string (optional)
scalingPolicyUpdateBehavior

CfnScalingPlan.ScalingInstructionProperty.ScalingPolicyUpdateBehavior

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscalingplans-scalingplan-scalinginstruction.html#cfn-autoscalingplans-scalingplan-scalinginstruction-scalingpolicyupdatebehavior

Type:string (optional)
scheduledActionBufferTime

CfnScalingPlan.ScalingInstructionProperty.ScheduledActionBufferTime

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscalingplans-scalingplan-scalinginstruction.html#cfn-autoscalingplans-scalingplan-scalinginstruction-scheduledactionbuffertime

Type:number or @aws-cdk/cdk.Token (optional)
class TagFilterProperty

Language-specific names:

using Amazon.CDK.AWS.AutoScalingPlans;
import software.amazon.awscdk.services.autoscalingplans.CfnScalingPlan.TagFilterProperty;
// CfnScalingPlan.TagFilterProperty is an interface
import { CfnScalingPlan.TagFilterProperty } from '@aws-cdk/aws-autoscalingplans';
key

CfnScalingPlan.TagFilterProperty.Key

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscalingplans-scalingplan-tagfilter.html#cfn-autoscalingplans-scalingplan-tagfilter-key

Type:string
values

CfnScalingPlan.TagFilterProperty.Values

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscalingplans-scalingplan-tagfilter.html#cfn-autoscalingplans-scalingplan-tagfilter-values

Type:@aws-cdk/cdk.Token or (string or @aws-cdk/cdk.Token)[] (optional)
class TargetTrackingConfigurationProperty

Language-specific names:

using Amazon.CDK.AWS.AutoScalingPlans;
import software.amazon.awscdk.services.autoscalingplans.CfnScalingPlan.TargetTrackingConfigurationProperty;
// CfnScalingPlan.TargetTrackingConfigurationProperty is an interface
import { CfnScalingPlan.TargetTrackingConfigurationProperty } from '@aws-cdk/aws-autoscalingplans';
targetValue

CfnScalingPlan.TargetTrackingConfigurationProperty.TargetValue

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscalingplans-scalingplan-targettrackingconfiguration.html#cfn-autoscalingplans-scalingplan-targettrackingconfiguration-targetvalue

Type:number or @aws-cdk/cdk.Token
customizedScalingMetricSpecification

CfnScalingPlan.TargetTrackingConfigurationProperty.CustomizedScalingMetricSpecification

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscalingplans-scalingplan-targettrackingconfiguration.html#cfn-autoscalingplans-scalingplan-targettrackingconfiguration-customizedscalingmetricspecification

Type:@aws-cdk/cdk.Token or CustomizedScalingMetricSpecificationProperty (optional)
disableScaleIn

CfnScalingPlan.TargetTrackingConfigurationProperty.DisableScaleIn

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscalingplans-scalingplan-targettrackingconfiguration.html#cfn-autoscalingplans-scalingplan-targettrackingconfiguration-disablescalein

Type:boolean or @aws-cdk/cdk.Token (optional)
estimatedInstanceWarmup

CfnScalingPlan.TargetTrackingConfigurationProperty.EstimatedInstanceWarmup

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscalingplans-scalingplan-targettrackingconfiguration.html#cfn-autoscalingplans-scalingplan-targettrackingconfiguration-estimatedinstancewarmup

Type:number or @aws-cdk/cdk.Token (optional)
predefinedScalingMetricSpecification

CfnScalingPlan.TargetTrackingConfigurationProperty.PredefinedScalingMetricSpecification

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscalingplans-scalingplan-targettrackingconfiguration.html#cfn-autoscalingplans-scalingplan-targettrackingconfiguration-predefinedscalingmetricspecification

Type:@aws-cdk/cdk.Token or PredefinedScalingMetricSpecificationProperty (optional)
scaleInCooldown

CfnScalingPlan.TargetTrackingConfigurationProperty.ScaleInCooldown

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscalingplans-scalingplan-targettrackingconfiguration.html#cfn-autoscalingplans-scalingplan-targettrackingconfiguration-scaleincooldown

Type:number or @aws-cdk/cdk.Token (optional)
scaleOutCooldown

CfnScalingPlan.TargetTrackingConfigurationProperty.ScaleOutCooldown

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscalingplans-scalingplan-targettrackingconfiguration.html#cfn-autoscalingplans-scalingplan-targettrackingconfiguration-scaleoutcooldown

Type:number or @aws-cdk/cdk.Token (optional)
toString() → string

Inherited from @aws-cdk/cdk.Construct

Returns a string representation of this construct.

Return type:string
validate() → string[]

Inherited from @aws-cdk/cdk.Construct

Validate the current construct.

This method can be implemented by derived constructs in order to perform

validation logic. It is called on all constructs before synthesis.

Protected method

Returns:An array of validation error messages, or an empty array if there the construct is valid.
Return type:string[]
dependencyRoots

Inherited from @aws-cdk/cdk.Construct

The set of constructs that form the root of this dependable

All resources under all returned constructs are included in the ordering

dependency.

Type:@aws-cdk/cdk.IConstruct[] (readonly)
node

Inherited from @aws-cdk/cdk.Construct

Construct node.

Type:@aws-cdk/cdk.ConstructNode (readonly)
ref

Inherited from @aws-cdk/cdk.Referenceable

Returns a token to a CloudFormation { Ref } that references this entity based on it’s logical ID.

Type:string (readonly)
addDeletionOverride(path)

Inherited from @aws-cdk/cdk.Resource

Syntactic sugar for addOverride(path, undefined).

Parameters:path (string) – The path of the value to delete
addDependsOn(resource)

Inherited from @aws-cdk/cdk.Resource

Indicates that this resource depends on another resource and cannot be provisioned

unless the other resource has been successfully provisioned.

Parameters:resource (@aws-cdk/cdk.Resource) –
addOverride(path, value)

Inherited from @aws-cdk/cdk.Resource

Adds an override to the synthesized CloudFormation resource. To add a

property override, either use addPropertyOverride or prefix path with

“Properties.” (i.e. Properties.TopicName).

Parameters:
  • path (string) – The path of the property, you can use dot notation to override values in complex types. Any intermdediate keys will be created as needed.
  • value (any) – The value. Could be primitive or complex.
addPropertyDeletionOverride(propertyPath)

Inherited from @aws-cdk/cdk.Resource

Adds an override that deletes the value of a property from the resource definition.

Parameters:propertyPath (string) – The path to the property.
addPropertyOverride(propertyPath, value)

Inherited from @aws-cdk/cdk.Resource

Adds an override to a resource property.

Syntactic sugar for addOverride(“Properties.<…>”, value).

Parameters:
  • propertyPath (string) – The path of the property
  • value (any) – The value
getAtt(attributeName) → @aws-cdk/cdk.CfnReference

Inherited from @aws-cdk/cdk.Resource

Returns a token for an runtime attribute of this resource.

Ideally, use generated attribute accessors (e.g. resource.arn), but this can be used for future compatibility

in case there is no generated attribute.

Parameters:attributeName (string) – The name of the attribute.
Return type:@aws-cdk/cdk.CfnReference
toCloudFormation() → json

Inherited from @aws-cdk/cdk.Resource

Emits CloudFormation for this resource.

Return type:json
options

Inherited from @aws-cdk/cdk.Resource

Options for this resource, such as condition, update policy etc.

Type:@aws-cdk/cdk.ResourceOptions (readonly)
properties

Inherited from @aws-cdk/cdk.Resource

AWS resource properties.

This object is rendered via a call to “renderProperties(this.properties)”.

Protected property

Type:any (readonly)
resourceType

Inherited from @aws-cdk/cdk.Resource

AWS resource type.

Type:string (readonly)
untypedPropertyOverrides

Inherited from @aws-cdk/cdk.Resource

AWS resource property overrides.

During synthesis, the method “renderProperties(this.overrides)” is called

with this object, and merged on top of the output of

“renderProperties(this.properties)”.

Derived classes should expose a strongly-typed version of this object as

a public property called propertyOverrides.

Protected property

Type:any (readonly)
overrideLogicalId(newLogicalId)

Inherited from @aws-cdk/cdk.StackElement

Overrides the auto-generated logical ID with a specific ID.

Parameters:newLogicalId (string) – The new logical ID to use for this stack element.
prepare()

Inherited from @aws-cdk/cdk.StackElement

Automatically detect references in this StackElement

Protected method

creationStackTrace

Inherited from @aws-cdk/cdk.StackElement

Type:string[] (readonly)
logicalId

Inherited from @aws-cdk/cdk.StackElement

The logical ID for this CloudFormation stack element. The logical ID of the element

is calculated from the path of the resource node in the construct tree.

To override this value, use overrideLogicalId(newLogicalId).

Type:string (readonly)
stackPath

Inherited from @aws-cdk/cdk.StackElement

Return the path with respect to the stack

Type:string (readonly)

CfnScalingPlanProps (interface)

class @aws-cdk/aws-autoscalingplans.CfnScalingPlanProps

Language-specific names:

using Amazon.CDK.AWS.AutoScalingPlans;
import software.amazon.awscdk.services.autoscalingplans.CfnScalingPlanProps;
// CfnScalingPlanProps is an interface
import { CfnScalingPlanProps } from '@aws-cdk/aws-autoscalingplans';
applicationSource

AWS::AutoScalingPlans::ScalingPlan.ApplicationSource

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-autoscalingplans-scalingplan.html#cfn-autoscalingplans-scalingplan-applicationsource

Type:ApplicationSourceProperty or @aws-cdk/cdk.Token
scalingInstructions

AWS::AutoScalingPlans::ScalingPlan.ScalingInstructions

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-autoscalingplans-scalingplan.html#cfn-autoscalingplans-scalingplan-scalinginstructions

Type:@aws-cdk/cdk.Token or (@aws-cdk/cdk.Token or ScalingInstructionProperty)[]