CfnScalingPolicy L1 construct
The AWS::AutoScaling::ScalingPolicy resource specifies an Amazon EC2 Auto Scaling scaling policy so that the Auto Scaling group can scale the number of instances available for your application.
For more information about using scaling policies to scale your Auto Scaling group automatically, see Dynamic scaling and Predictive scaling in the Amazon EC2 Auto Scaling User Guide .
Example
ts
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_autoscaling as autoscaling } from 'aws-cdk-lib';
const cfnScalingPolicy = new autoscaling.CfnScalingPolicy(this, 'MyCfnScalingPolicy', {
autoScalingGroupName: 'autoScalingGroupName',
// the properties below are optional
adjustmentType: 'adjustmentType',
cooldown: 'cooldown',
estimatedInstanceWarmup: 123,
metricAggregationType: 'metricAggregationType',
minAdjustmentMagnitude: 123,
policyType: 'policyType',
predictiveScalingConfiguration: {
metricSpecifications: [{
targetValue: 123,
// the properties below are optional
customizedCapacityMetricSpecification: {
metricDataQueries: [{
id: 'id',
// the properties below are optional
expression: 'expression',
label: 'label',
metricStat: {
metric: {
metricName: 'metricName',
namespace: 'namespace',
// the properties below are optional
dimensions: [{
name: 'name',
value: 'value',
}],
},
stat: 'stat',
// the properties below are optional
unit: 'unit',
},
returnData: false,
}],
},
customizedLoadMetricSpecification: {
metricDataQueries: [{
id: 'id',
// the properties below are optional
expression: 'expression',
label: 'label',
metricStat: {
metric: {
metricName: 'metricName',
namespace: 'namespace',
// the properties below are optional
dimensions: [{
name: 'name',
value: 'value',
}],
},
stat: 'stat',
// the properties below are optional
unit: 'unit',
},
returnData: false,
}],
},
customizedScalingMetricSpecification: {
metricDataQueries: [{
id: 'id',
// the properties below are optional
expression: 'expression',
label: 'label',
metricStat: {
metric: {
metricName: 'metricName',
namespace: 'namespace',
// the properties below are optional
dimensions: [{
name: 'name',
value: 'value',
}],
},
stat: 'stat',
// the properties below are optional
unit: 'unit',
},
returnData: false,
}],
},
predefinedLoadMetricSpecification: {
predefinedMetricType: 'predefinedMetricType',
// the properties below are optional
resourceLabel: 'resourceLabel',
},
predefinedMetricPairSpecification: {
predefinedMetricType: 'predefinedMetricType',
// the properties below are optional
resourceLabel: 'resourceLabel',
},
predefinedScalingMetricSpecification: {
predefinedMetricType: 'predefinedMetricType',
// the properties below are optional
resourceLabel: 'resourceLabel',
},
}],
// the properties below are optional
maxCapacityBreachBehavior: 'maxCapacityBreachBehavior',
maxCapacityBuffer: 123,
mode: 'mode',
schedulingBufferTime: 123,
},
scalingAdjustment: 123,
stepAdjustments: [{
scalingAdjustment: 123,
// the properties below are optional
metricIntervalLowerBound: 123,
metricIntervalUpperBound: 123,
}],
targetTrackingConfiguration: {
targetValue: 123,
// the properties below are optional
customizedMetricSpecification: {
dimensions: [{
name: 'name',
value: 'value',
}],
metricName: 'metricName',
metrics: [{
id: 'id',
// the properties below are optional
expression: 'expression',
label: 'label',
metricStat: {
metric: {
metricName: 'metricName',
namespace: 'namespace',
// the properties below are optional
dimensions: [{
name: 'name',
value: 'value',
}],
},
stat: 'stat',
// the properties below are optional
period: 123,
unit: 'unit',
},
period: 123,
returnData: false,
}],
namespace: 'namespace',
period: 123,
statistic: 'statistic',
unit: 'unit',
},
disableScaleIn: false,
predefinedMetricSpecification: {
predefinedMetricType: 'predefinedMetricType',
// the properties below are optional
resourceLabel: 'resourceLabel',
},
},
});
python
# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_autoscaling as autoscaling
cfn_scaling_policy = autoscaling.CfnScalingPolicy(self, "MyCfnScalingPolicy",
auto_scaling_group_name="autoScalingGroupName",
# the properties below are optional
adjustment_type="adjustmentType",
cooldown="cooldown",
estimated_instance_warmup=123,
metric_aggregation_type="metricAggregationType",
min_adjustment_magnitude=123,
policy_type="policyType",
predictive_scaling_configuration=autoscaling.CfnScalingPolicy.PredictiveScalingConfigurationProperty(
metric_specifications=[autoscaling.CfnScalingPolicy.PredictiveScalingMetricSpecificationProperty(
target_value=123,
# the properties below are optional
customized_capacity_metric_specification=autoscaling.CfnScalingPolicy.PredictiveScalingCustomizedCapacityMetricProperty(
metric_data_queries=[autoscaling.CfnScalingPolicy.MetricDataQueryProperty(
id="id",
# the properties below are optional
expression="expression",
label="label",
metric_stat=autoscaling.CfnScalingPolicy.MetricStatProperty(
metric=autoscaling.CfnScalingPolicy.MetricProperty(
metric_name="metricName",
namespace="namespace",
# the properties below are optional
dimensions=[autoscaling.CfnScalingPolicy.MetricDimensionProperty(
name="name",
value="value"
)]
),
stat="stat",
# the properties below are optional
unit="unit"
),
return_data=False
)]
),
customized_load_metric_specification=autoscaling.CfnScalingPolicy.PredictiveScalingCustomizedLoadMetricProperty(
metric_data_queries=[autoscaling.CfnScalingPolicy.MetricDataQueryProperty(
id="id",
# the properties below are optional
expression="expression",
label="label",
metric_stat=autoscaling.CfnScalingPolicy.MetricStatProperty(
metric=autoscaling.CfnScalingPolicy.MetricProperty(
metric_name="metricName",
namespace="namespace",
# the properties below are optional
dimensions=[autoscaling.CfnScalingPolicy.MetricDimensionProperty(
name="name",
value="value"
)]
),
stat="stat",
# the properties below are optional
unit="unit"
),
return_data=False
)]
),
customized_scaling_metric_specification=autoscaling.CfnScalingPolicy.PredictiveScalingCustomizedScalingMetricProperty(
metric_data_queries=[autoscaling.CfnScalingPolicy.MetricDataQueryProperty(
id="id",
# the properties below are optional
expression="expression",
label="label",
metric_stat=autoscaling.CfnScalingPolicy.MetricStatProperty(
metric=autoscaling.CfnScalingPolicy.MetricProperty(
metric_name="metricName",
namespace="namespace",
# the properties below are optional
dimensions=[autoscaling.CfnScalingPolicy.MetricDimensionProperty(
name="name",
value="value"
)]
),
stat="stat",
# the properties below are optional
unit="unit"
),
return_data=False
)]
),
predefined_load_metric_specification=autoscaling.CfnScalingPolicy.PredictiveScalingPredefinedLoadMetricProperty(
predefined_metric_type="predefinedMetricType",
# the properties below are optional
resource_label="resourceLabel"
),
predefined_metric_pair_specification=autoscaling.CfnScalingPolicy.PredictiveScalingPredefinedMetricPairProperty(
predefined_metric_type="predefinedMetricType",
# the properties below are optional
resource_label="resourceLabel"
),
predefined_scaling_metric_specification=autoscaling.CfnScalingPolicy.PredictiveScalingPredefinedScalingMetricProperty(
predefined_metric_type="predefinedMetricType",
# the properties below are optional
resource_label="resourceLabel"
)
)],
# the properties below are optional
max_capacity_breach_behavior="maxCapacityBreachBehavior",
max_capacity_buffer=123,
mode="mode",
scheduling_buffer_time=123
),
scaling_adjustment=123,
step_adjustments=[autoscaling.CfnScalingPolicy.StepAdjustmentProperty(
scaling_adjustment=123,
# the properties below are optional
metric_interval_lower_bound=123,
metric_interval_upper_bound=123
)],
target_tracking_configuration=autoscaling.CfnScalingPolicy.TargetTrackingConfigurationProperty(
target_value=123,
# the properties below are optional
customized_metric_specification=autoscaling.CfnScalingPolicy.CustomizedMetricSpecificationProperty(
dimensions=[autoscaling.CfnScalingPolicy.MetricDimensionProperty(
name="name",
value="value"
)],
metric_name="metricName",
metrics=[autoscaling.CfnScalingPolicy.TargetTrackingMetricDataQueryProperty(
id="id",
# the properties below are optional
expression="expression",
label="label",
metric_stat=autoscaling.CfnScalingPolicy.TargetTrackingMetricStatProperty(
metric=autoscaling.CfnScalingPolicy.MetricProperty(
metric_name="metricName",
namespace="namespace",
# the properties below are optional
dimensions=[autoscaling.CfnScalingPolicy.MetricDimensionProperty(
name="name",
value="value"
)]
),
stat="stat",
# the properties below are optional
period=123,
unit="unit"
),
period=123,
return_data=False
)],
namespace="namespace",
period=123,
statistic="statistic",
unit="unit"
),
disable_scale_in=False,
predefined_metric_specification=autoscaling.CfnScalingPolicy.PredefinedMetricSpecificationProperty(
predefined_metric_type="predefinedMetricType",
# the properties below are optional
resource_label="resourceLabel"
)
)
)
java
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import software.amazon.awscdk.services.autoscaling.*;
CfnScalingPolicy cfnScalingPolicy = CfnScalingPolicy.Builder.create(this, "MyCfnScalingPolicy")
.autoScalingGroupName("autoScalingGroupName")
// the properties below are optional
.adjustmentType("adjustmentType")
.cooldown("cooldown")
.estimatedInstanceWarmup(123)
.metricAggregationType("metricAggregationType")
.minAdjustmentMagnitude(123)
.policyType("policyType")
.predictiveScalingConfiguration(PredictiveScalingConfigurationProperty.builder()
.metricSpecifications(List.of(PredictiveScalingMetricSpecificationProperty.builder()
.targetValue(123)
// the properties below are optional
.customizedCapacityMetricSpecification(PredictiveScalingCustomizedCapacityMetricProperty.builder()
.metricDataQueries(List.of(MetricDataQueryProperty.builder()
.id("id")
// the properties below are optional
.expression("expression")
.label("label")
.metricStat(MetricStatProperty.builder()
.metric(MetricProperty.builder()
.metricName("metricName")
.namespace("namespace")
// the properties below are optional
.dimensions(List.of(MetricDimensionProperty.builder()
.name("name")
.value("value")
.build()))
.build())
.stat("stat")
// the properties below are optional
.unit("unit")
.build())
.returnData(false)
.build()))
.build())
.customizedLoadMetricSpecification(PredictiveScalingCustomizedLoadMetricProperty.builder()
.metricDataQueries(List.of(MetricDataQueryProperty.builder()
.id("id")
// the properties below are optional
.expression("expression")
.label("label")
.metricStat(MetricStatProperty.builder()
.metric(MetricProperty.builder()
.metricName("metricName")
.namespace("namespace")
// the properties below are optional
.dimensions(List.of(MetricDimensionProperty.builder()
.name("name")
.value("value")
.build()))
.build())
.stat("stat")
// the properties below are optional
.unit("unit")
.build())
.returnData(false)
.build()))
.build())
.customizedScalingMetricSpecification(PredictiveScalingCustomizedScalingMetricProperty.builder()
.metricDataQueries(List.of(MetricDataQueryProperty.builder()
.id("id")
// the properties below are optional
.expression("expression")
.label("label")
.metricStat(MetricStatProperty.builder()
.metric(MetricProperty.builder()
.metricName("metricName")
.namespace("namespace")
// the properties below are optional
.dimensions(List.of(MetricDimensionProperty.builder()
.name("name")
.value("value")
.build()))
.build())
.stat("stat")
// the properties below are optional
.unit("unit")
.build())
.returnData(false)
.build()))
.build())
.predefinedLoadMetricSpecification(PredictiveScalingPredefinedLoadMetricProperty.builder()
.predefinedMetricType("predefinedMetricType")
// the properties below are optional
.resourceLabel("resourceLabel")
.build())
.predefinedMetricPairSpecification(PredictiveScalingPredefinedMetricPairProperty.builder()
.predefinedMetricType("predefinedMetricType")
// the properties below are optional
.resourceLabel("resourceLabel")
.build())
.predefinedScalingMetricSpecification(PredictiveScalingPredefinedScalingMetricProperty.builder()
.predefinedMetricType("predefinedMetricType")
// the properties below are optional
.resourceLabel("resourceLabel")
.build())
.build()))
// the properties below are optional
.maxCapacityBreachBehavior("maxCapacityBreachBehavior")
.maxCapacityBuffer(123)
.mode("mode")
.schedulingBufferTime(123)
.build())
.scalingAdjustment(123)
.stepAdjustments(List.of(StepAdjustmentProperty.builder()
.scalingAdjustment(123)
// the properties below are optional
.metricIntervalLowerBound(123)
.metricIntervalUpperBound(123)
.build()))
.targetTrackingConfiguration(TargetTrackingConfigurationProperty.builder()
.targetValue(123)
// the properties below are optional
.customizedMetricSpecification(CustomizedMetricSpecificationProperty.builder()
.dimensions(List.of(MetricDimensionProperty.builder()
.name("name")
.value("value")
.build()))
.metricName("metricName")
.metrics(List.of(TargetTrackingMetricDataQueryProperty.builder()
.id("id")
// the properties below are optional
.expression("expression")
.label("label")
.metricStat(TargetTrackingMetricStatProperty.builder()
.metric(MetricProperty.builder()
.metricName("metricName")
.namespace("namespace")
// the properties below are optional
.dimensions(List.of(MetricDimensionProperty.builder()
.name("name")
.value("value")
.build()))
.build())
.stat("stat")
// the properties below are optional
.period(123)
.unit("unit")
.build())
.period(123)
.returnData(false)
.build()))
.namespace("namespace")
.period(123)
.statistic("statistic")
.unit("unit")
.build())
.disableScaleIn(false)
.predefinedMetricSpecification(PredefinedMetricSpecificationProperty.builder()
.predefinedMetricType("predefinedMetricType")
// the properties below are optional
.resourceLabel("resourceLabel")
.build())
.build())
.build();
csharp
// Install: dotnet add package Amazon.CDK.Lib
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.AutoScaling;
var cfnScalingPolicy = new CfnScalingPolicy(this, "MyCfnScalingPolicy", new CfnScalingPolicyProps {
AutoScalingGroupName = "autoScalingGroupName",
// the properties below are optional
AdjustmentType = "adjustmentType",
Cooldown = "cooldown",
EstimatedInstanceWarmup = 123,
MetricAggregationType = "metricAggregationType",
MinAdjustmentMagnitude = 123,
PolicyType = "policyType",
PredictiveScalingConfiguration = new PredictiveScalingConfigurationProperty {
MetricSpecifications = new [] { new PredictiveScalingMetricSpecificationProperty {
TargetValue = 123,
// the properties below are optional
CustomizedCapacityMetricSpecification = new PredictiveScalingCustomizedCapacityMetricProperty {
MetricDataQueries = new [] { new MetricDataQueryProperty {
Id = "id",
// the properties below are optional
Expression = "expression",
Label = "label",
MetricStat = new MetricStatProperty {
Metric = new MetricProperty {
MetricName = "metricName",
Namespace = "namespace",
// the properties below are optional
Dimensions = new [] { new MetricDimensionProperty {
Name = "name",
Value = "value"
} }
},
Stat = "stat",
// the properties below are optional
Unit = "unit"
},
ReturnData = false
} }
},
CustomizedLoadMetricSpecification = new PredictiveScalingCustomizedLoadMetricProperty {
MetricDataQueries = new [] { new MetricDataQueryProperty {
Id = "id",
// the properties below are optional
Expression = "expression",
Label = "label",
MetricStat = new MetricStatProperty {
Metric = new MetricProperty {
MetricName = "metricName",
Namespace = "namespace",
// the properties below are optional
Dimensions = new [] { new MetricDimensionProperty {
Name = "name",
Value = "value"
} }
},
Stat = "stat",
// the properties below are optional
Unit = "unit"
},
ReturnData = false
} }
},
CustomizedScalingMetricSpecification = new PredictiveScalingCustomizedScalingMetricProperty {
MetricDataQueries = new [] { new MetricDataQueryProperty {
Id = "id",
// the properties below are optional
Expression = "expression",
Label = "label",
MetricStat = new MetricStatProperty {
Metric = new MetricProperty {
MetricName = "metricName",
Namespace = "namespace",
// the properties below are optional
Dimensions = new [] { new MetricDimensionProperty {
Name = "name",
Value = "value"
} }
},
Stat = "stat",
// the properties below are optional
Unit = "unit"
},
ReturnData = false
} }
},
PredefinedLoadMetricSpecification = new PredictiveScalingPredefinedLoadMetricProperty {
PredefinedMetricType = "predefinedMetricType",
// the properties below are optional
ResourceLabel = "resourceLabel"
},
PredefinedMetricPairSpecification = new PredictiveScalingPredefinedMetricPairProperty {
PredefinedMetricType = "predefinedMetricType",
// the properties below are optional
ResourceLabel = "resourceLabel"
},
PredefinedScalingMetricSpecification = new PredictiveScalingPredefinedScalingMetricProperty {
PredefinedMetricType = "predefinedMetricType",
// the properties below are optional
ResourceLabel = "resourceLabel"
}
} },
// the properties below are optional
MaxCapacityBreachBehavior = "maxCapacityBreachBehavior",
MaxCapacityBuffer = 123,
Mode = "mode",
SchedulingBufferTime = 123
},
ScalingAdjustment = 123,
StepAdjustments = new [] { new StepAdjustmentProperty {
ScalingAdjustment = 123,
// the properties below are optional
MetricIntervalLowerBound = 123,
MetricIntervalUpperBound = 123
} },
TargetTrackingConfiguration = new TargetTrackingConfigurationProperty {
TargetValue = 123,
// the properties below are optional
CustomizedMetricSpecification = new CustomizedMetricSpecificationProperty {
Dimensions = new [] { new MetricDimensionProperty {
Name = "name",
Value = "value"
} },
MetricName = "metricName",
Metrics = new [] { new TargetTrackingMetricDataQueryProperty {
Id = "id",
// the properties below are optional
Expression = "expression",
Label = "label",
MetricStat = new TargetTrackingMetricStatProperty {
Metric = new MetricProperty {
MetricName = "metricName",
Namespace = "namespace",
// the properties below are optional
Dimensions = new [] { new MetricDimensionProperty {
Name = "name",
Value = "value"
} }
},
Stat = "stat",
// the properties below are optional
Period = 123,
Unit = "unit"
},
Period = 123,
ReturnData = false
} },
Namespace = "namespace",
Period = 123,
Statistic = "statistic",
Unit = "unit"
},
DisableScaleIn = false,
PredefinedMetricSpecification = new PredefinedMetricSpecificationProperty {
PredefinedMetricType = "predefinedMetricType",
// the properties below are optional
ResourceLabel = "resourceLabel"
}
}
});
go
// Install: go get github.com/aws/aws-cdk-go/awscdk/v2
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
cfnScalingPolicy := awscdk.Aws_autoscaling.NewCfnScalingPolicy(this, jsii.String("MyCfnScalingPolicy"), &CfnScalingPolicyProps{
AutoScalingGroupName: jsii.String("autoScalingGroupName"),
// the properties below are optional
AdjustmentType: jsii.String("adjustmentType"),
Cooldown: jsii.String("cooldown"),
EstimatedInstanceWarmup: jsii.Number(123),
MetricAggregationType: jsii.String("metricAggregationType"),
MinAdjustmentMagnitude: jsii.Number(123),
PolicyType: jsii.String("policyType"),
PredictiveScalingConfiguration: &PredictiveScalingConfigurationProperty{
MetricSpecifications: []interface{}{
&PredictiveScalingMetricSpecificationProperty{
TargetValue: jsii.Number(123),
// the properties below are optional
CustomizedCapacityMetricSpecification: &PredictiveScalingCustomizedCapacityMetricProperty{
MetricDataQueries: []interface{}{
&MetricDataQueryProperty{
Id: jsii.String("id"),
// the properties below are optional
Expression: jsii.String("expression"),
Label: jsii.String("label"),
MetricStat: &MetricStatProperty{
Metric: &MetricProperty{
MetricName: jsii.String("metricName"),
Namespace: jsii.String("namespace"),
// the properties below are optional
Dimensions: []interface{}{
&MetricDimensionProperty{
Name: jsii.String("name"),
Value: jsii.String("value"),
},
},
},
Stat: jsii.String("stat"),
// the properties below are optional
Unit: jsii.String("unit"),
},
ReturnData: jsii.Boolean(false),
},
},
},
CustomizedLoadMetricSpecification: &PredictiveScalingCustomizedLoadMetricProperty{
MetricDataQueries: []interface{}{
&MetricDataQueryProperty{
Id: jsii.String("id"),
// the properties below are optional
Expression: jsii.String("expression"),
Label: jsii.String("label"),
MetricStat: &MetricStatProperty{
Metric: &MetricProperty{
MetricName: jsii.String("metricName"),
Namespace: jsii.String("namespace"),
// the properties below are optional
Dimensions: []interface{}{
&MetricDimensionProperty{
Name: jsii.String("name"),
Value: jsii.String("value"),
},
},
},
Stat: jsii.String("stat"),
// the properties below are optional
Unit: jsii.String("unit"),
},
ReturnData: jsii.Boolean(false),
},
},
},
CustomizedScalingMetricSpecification: &PredictiveScalingCustomizedScalingMetricProperty{
MetricDataQueries: []interface{}{
&MetricDataQueryProperty{
Id: jsii.String("id"),
// the properties below are optional
Expression: jsii.String("expression"),
Label: jsii.String("label"),
MetricStat: &MetricStatProperty{
Metric: &MetricProperty{
MetricName: jsii.String("metricName"),
Namespace: jsii.String("namespace"),
// the properties below are optional
Dimensions: []interface{}{
&MetricDimensionProperty{
Name: jsii.String("name"),
Value: jsii.String("value"),
},
},
},
Stat: jsii.String("stat"),
// the properties below are optional
Unit: jsii.String("unit"),
},
ReturnData: jsii.Boolean(false),
},
},
},
PredefinedLoadMetricSpecification: &PredictiveScalingPredefinedLoadMetricProperty{
PredefinedMetricType: jsii.String("predefinedMetricType"),
// the properties below are optional
ResourceLabel: jsii.String("resourceLabel"),
},
PredefinedMetricPairSpecification: &PredictiveScalingPredefinedMetricPairProperty{
PredefinedMetricType: jsii.String("predefinedMetricType"),
// the properties below are optional
ResourceLabel: jsii.String("resourceLabel"),
},
PredefinedScalingMetricSpecification: &PredictiveScalingPredefinedScalingMetricProperty{
PredefinedMetricType: jsii.String("predefinedMetricType"),
// the properties below are optional
ResourceLabel: jsii.String("resourceLabel"),
},
},
},
// the properties below are optional
MaxCapacityBreachBehavior: jsii.String("maxCapacityBreachBehavior"),
MaxCapacityBuffer: jsii.Number(123),
Mode: jsii.String("mode"),
SchedulingBufferTime: jsii.Number(123),
},
ScalingAdjustment: jsii.Number(123),
StepAdjustments: []interface{}{
&StepAdjustmentProperty{
ScalingAdjustment: jsii.Number(123),
// the properties below are optional
MetricIntervalLowerBound: jsii.Number(123),
MetricIntervalUpperBound: jsii.Number(123),
},
},
TargetTrackingConfiguration: &TargetTrackingConfigurationProperty{
TargetValue: jsii.Number(123),
// the properties below are optional
CustomizedMetricSpecification: &CustomizedMetricSpecificationProperty{
Dimensions: []interface{}{
&MetricDimensionProperty{
Name: jsii.String("name"),
Value: jsii.String("value"),
},
},
MetricName: jsii.String("metricName"),
Metrics: []interface{}{
&TargetTrackingMetricDataQueryProperty{
Id: jsii.String("id"),
// the properties below are optional
Expression: jsii.String("expression"),
Label: jsii.String("label"),
MetricStat: &TargetTrackingMetricStatProperty{
Metric: &MetricProperty{
MetricName: jsii.String("metricName"),
Namespace: jsii.String("namespace"),
// the properties below are optional
Dimensions: []interface{}{
&MetricDimensionProperty{
Name: jsii.String("name"),
Value: jsii.String("value"),
},
},
},
Stat: jsii.String("stat"),
// the properties below are optional
Period: jsii.Number(123),
Unit: jsii.String("unit"),
},
Period: jsii.Number(123),
ReturnData: jsii.Boolean(false),
},
},
Namespace: jsii.String("namespace"),
Period: jsii.Number(123),
Statistic: jsii.String("statistic"),
Unit: jsii.String("unit"),
},
DisableScaleIn: jsii.Boolean(false),
PredefinedMetricSpecification: &PredefinedMetricSpecificationProperty{
PredefinedMetricType: jsii.String("predefinedMetricType"),
// the properties below are optional
ResourceLabel: jsii.String("resourceLabel"),
},
},
})
Initializer
ts
new CfnScalingPolicy(scope: Construct, id: string, props: CfnScalingPolicyProps)
python
CfnScalingPolicy(scope: Construct, id: str, props: CfnScalingPolicyProps)
java
new CfnScalingPolicy(Construct scope, String id, CfnScalingPolicyProps props)
csharp
new CfnScalingPolicy(Construct scope, string id, CfnScalingPolicyProps props)
go
NewCfnScalingPolicy(Scope Construct, Id *string, Props CfnScalingPolicyProps)
Construct Props
adjustmentTypestringadjustment_typestradjustmentTypeStringAdjustmentTypestringAdjustmentType*string#Specifies how the scaling adjustment is interpreted (for example, an absolute number or a percentage).
notes
The valid values are ChangeInCapacity , ExactCapacity , and PercentChangeInCapacity .
Required if the policy type is StepScaling or SimpleScaling . For more information, see Scaling adjustment types in the Amazon EC2 Auto Scaling User Guide .
autoScalingGroupNamestring | IAutoScalingGroupRefauto_scaling_group_nametyping.Union[str, IAutoScalingGroupRef]autoScalingGroupNameStringAutoScalingGroupNamestringAutoScalingGroupNameinterface{}required#The name of the Auto Scaling group.
A cooldown period, in seconds, that applies to a specific simple scaling policy.
notes
When a cooldown period is specified here, it overrides the default cooldown.
Valid only if the policy type is SimpleScaling . For more information, see Scaling cooldowns for Amazon EC2 Auto Scaling in the Amazon EC2 Auto Scaling User Guide .
Default: None
estimatedInstanceWarmupnumberestimated_instance_warmupint | floatestimatedInstanceWarmupNumberEstimatedInstanceWarmupdoubleEstimatedInstanceWarmup*float64#*Not needed if the default instance warmup is defined for the group.*.
notes
The estimated time, in seconds, until a newly launched instance can contribute to the CloudWatch metrics. This warm-up period applies to instances launched due to a specific target tracking or step scaling policy. When a warm-up period is specified here, it overrides the default instance warmup.
Valid only if the policy type is TargetTrackingScaling or StepScaling .
The default is to use the value for the default instance warmup defined for the group. If default instance warmup is null, then
EstimatedInstanceWarmupfalls back to the value of default cooldown.
metricAggregationTypestringmetric_aggregation_typestrmetricAggregationTypeStringMetricAggregationTypestringMetricAggregationType*string#The aggregation type for the CloudWatch metrics.
The valid values are Minimum , Maximum , and Average . If the aggregation type is null, the value is treated as Average .
Valid only if the policy type is StepScaling .
minAdjustmentMagnitudenumbermin_adjustment_magnitudeint | floatminAdjustmentMagnitudeNumberMinAdjustmentMagnitudedoubleMinAdjustmentMagnitude*float64#The minimum value to scale by when the adjustment type is `PercentChangeInCapacity` .
notes
For example, suppose that you create a step scaling policy to scale out an Auto Scaling group by 25 percent and you specify a MinAdjustmentMagnitude of 2. If the group has 4 instances and the scaling policy is performed, 25 percent of 4 is 1. However, because you specified a MinAdjustmentMagnitude of 2, Amazon EC2 Auto Scaling scales out the group by 2 instances.
Valid only if the policy type is StepScaling or SimpleScaling . For more information, see Scaling adjustment types in the Amazon EC2 Auto Scaling User Guide .
Some Auto Scaling groups use instance weights. In this case, set the
MinAdjustmentMagnitudeto a value that is at least as large as your largest instance weight.
One of the following policy types:.
TargetTrackingScalingStepScalingSimpleScaling(default)PredictiveScaling
predictiveScalingConfigurationIResolvable | CfnScalingPolicy.PredictiveScalingConfigurationPropertypredictive_scaling_configurationtyping.Union[IResolvable, PredictiveScalingConfigurationProperty]predictiveScalingConfigurationIResolvablePredictiveScalingConfigurationIResolvablePredictiveScalingConfigurationinterface{}#A predictive scaling policy. Provides support for predefined and custom metrics.
Predefined metrics include CPU utilization, network in/out, and the Application Load Balancer request count.
Required if the policy type is PredictiveScaling .
scalingAdjustmentnumberscaling_adjustmentint | floatscalingAdjustmentNumberScalingAdjustmentdoubleScalingAdjustment*float64#The amount by which to scale, based on the specified adjustment type.
notes
A positive value adds to the current capacity while a negative number removes from the current capacity. For exact capacity, you must specify a non-negative value.
Required if the policy type is SimpleScaling . (Not used with any other policy type.)
stepAdjustmentsIResolvable | IResolvable | CfnScalingPolicy.StepAdjustmentProperty[]step_adjustmentstyping.Union[IResolvable, typing.List[typing.Union[IResolvable, StepAdjustmentProperty]]]stepAdjustmentsIResolvableStepAdjustmentsIResolvableStepAdjustmentsinterface{}#A set of adjustments that enable you to scale based on the size of the alarm breach.
Required if the policy type is StepScaling . (Not used with any other policy type.)
targetTrackingConfigurationIResolvable | CfnScalingPolicy.TargetTrackingConfigurationPropertytarget_tracking_configurationtyping.Union[IResolvable, TargetTrackingConfigurationProperty]targetTrackingConfigurationIResolvableTargetTrackingConfigurationIResolvableTargetTrackingConfigurationinterface{}#A target tracking scaling policy. Provides support for predefined or custom metrics.
notes
The following predefined metrics are available:
ASGAverageCPUUtilizationASGAverageNetworkInASGAverageNetworkOutALBRequestCountPerTarget
If you specify ALBRequestCountPerTarget for the metric, you must specify the ResourceLabel property with the PredefinedMetricSpecification .
Required if the policy type is TargetTrackingScaling .
Properties
adjustmentTypestringadjustment_typestradjustmentTypeStringAdjustmentTypestringAdjustmentType*string#Specifies how the scaling adjustment is interpreted (for example, an absolute number or a percentage).
Returns the ARN of a scaling policy.
attrPolicyNamestringattr_policy_namestrattrPolicyNameStringAttrPolicyNamestringAttrPolicyName*stringrequired#Returns the name of a scaling policy.
autoScalingGroupNamestringauto_scaling_group_namestrautoScalingGroupNameStringAutoScalingGroupNamestringAutoScalingGroupName*stringrequired#The name of the Auto Scaling group.
CFN_RESOURCE_TYPE_NAMEstringcfn_resource_type_namestrCFN_RESOURCE_TYPE_NAMEStringCFN_RESOURCE_TYPE_NAMEstringCFN_RESOURCE_TYPE_NAME*stringrequiredstatic#The CloudFormation resource type name for this resource class.
cfnOptionsICfnResourceOptionscfn_optionsICfnResourceOptionscfnOptionsICfnResourceOptionsCfnOptionsICfnResourceOptionsCfnOptionsICfnResourceOptionsrequired#Options for this resource, such as condition, update policy etc.
cfnResourceTypestringcfn_resource_typestrcfnResourceTypeStringCfnResourceTypestringCfnResourceType*stringrequired#AWS resource type.
A cooldown period, in seconds, that applies to a specific simple scaling policy.
creationStackstring[]creation_stacktyping.List[str]creationStackList<String>CreationStackstring[]CreationStack*[]*stringrequired#estimatedInstanceWarmupnumberestimated_instance_warmupint | floatestimatedInstanceWarmupNumberEstimatedInstanceWarmupdoubleEstimatedInstanceWarmup*float64#*Not needed if the default instance warmup is defined for the group.*.
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).
metricAggregationTypestringmetric_aggregation_typestrmetricAggregationTypeStringMetricAggregationTypestringMetricAggregationType*string#The aggregation type for the CloudWatch metrics.
minAdjustmentMagnitudenumbermin_adjustment_magnitudeint | floatminAdjustmentMagnitudeNumberMinAdjustmentMagnitudedoubleMinAdjustmentMagnitude*float64#The minimum value to scale by when the adjustment type is `PercentChangeInCapacity` .
One of the following policy types:.
predictiveScalingConfigurationIResolvable | CfnScalingPolicy.PredictiveScalingConfigurationPropertypredictive_scaling_configurationtyping.Union[IResolvable, PredictiveScalingConfigurationProperty]predictiveScalingConfigurationIResolvablePredictiveScalingConfigurationIResolvablePredictiveScalingConfigurationinterface{}#A predictive scaling policy.
Provides support for predefined and custom metrics.
Return a string that will be resolved to a CloudFormation `{ Ref }` for this element.
If, by any chance, the intrinsic reference of a resource is not a string, you could coerce it to an IResolvable through Lazy.any({ produce: resource.ref }).
scalingAdjustmentnumberscaling_adjustmentint | floatscalingAdjustmentNumberScalingAdjustmentdoubleScalingAdjustment*float64#The amount by which to scale, based on the specified adjustment type.
scalingPolicyRefScalingPolicyReferencescaling_policy_refScalingPolicyReferencescalingPolicyRefScalingPolicyReferenceScalingPolicyRefScalingPolicyReferenceScalingPolicyRefScalingPolicyReferencerequired#A reference to a ScalingPolicy resource.
The stack in which this element is defined.
CfnElements must be defined within a stack scope (directly or indirectly).
stepAdjustmentsIResolvable | IResolvable | CfnScalingPolicy.StepAdjustmentProperty[]step_adjustmentstyping.Union[IResolvable, typing.List[typing.Union[IResolvable, StepAdjustmentProperty]]]stepAdjustmentsIResolvableStepAdjustmentsIResolvableStepAdjustmentsinterface{}#A set of adjustments that enable you to scale based on the size of the alarm breach.
targetTrackingConfigurationIResolvable | CfnScalingPolicy.TargetTrackingConfigurationPropertytarget_tracking_configurationtyping.Union[IResolvable, TargetTrackingConfigurationProperty]targetTrackingConfigurationIResolvableTargetTrackingConfigurationIResolvableTargetTrackingConfigurationinterface{}#A target tracking scaling policy.
Provides support for predefined or custom metrics.
Methods
addDeletionOverride(path: string): voiddef add_deletion_override(self, path: str) -> Nonepublic void addDeletionOverride(String path)public void AddDeletionOverride(string path)func AddDeletionOverride(Path *string)#Syntactic sugar for `addOverride(path, undefined)`.
1 parameter
Parameters
pathpathpathpathPath— The path of the value to delete.
addDependency(target: CfnResource): voiddef add_dependency(self, target: CfnResource) -> Nonepublic void addDependency(CfnResource target)public void AddDependency(CfnResource target)func AddDependency(Target CfnResource)deprecated#Use `addResourceDependency` instead.
This method has been renamed to addResourceDependency to more clearly set it apart from construct.node.addDependency. See the documentation of that function for more details.
addDependsOn(target: CfnResource): voiddef add_depends_on(self, target: CfnResource) -> Nonepublic void addDependsOn(CfnResource target)public void AddDependsOn(CfnResource target)func AddDependsOn(Target CfnResource)deprecated#Use `addResourceDependency` instead.
notes
This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope.
This method has been renamed to addResourceDependency, which makes it more clear that this method operates at a different level from the construct-level construct.node.addDependency() mechanism.
addMetadata(key: string, value: any): voiddef add_metadata(self, key: str, value: Any) -> Nonepublic void addMetadata(String key, Object value)public void AddMetadata(string key, object value)func AddMetadata(Key *string, Value interface{})#Add a value to the CloudFormation Resource Metadata.
addOverride(path: string, value: any): voiddef add_override(self, path: str, value: Any) -> Nonepublic void addOverride(String path, Object value)public void AddOverride(string path, object value)func AddOverride(Path *string, Value interface{})#Adds an override to the synthesized CloudFormation resource.
notes · 2 parameters
To add a property override, either use addPropertyOverride or prefix path with "Properties." (i.e. Properties.TopicName).
If the override is nested, separate each nested level using a dot (.) in the path parameter. If there is an array as part of the nesting, specify the index in the path.
To include a literal . in the property name, prefix with a \. In most programming languages you will need to write this as "\\." because the \ itself will need to be escaped.
For example,
typescript
cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']);
cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE');
would add the overrides
json
"Properties": {
"GlobalSecondaryIndexes": [
{
"Projection": {
"NonKeyAttributes": [ "myattribute" ]
...
}
...
},
{
"ProjectionType": "INCLUDE"
...
},
]
...
}
The value argument to addOverride will not be processed or translated in any way. Pass raw JSON values in here with the correct capitalization for CloudFormation. If you pass CDK classes or structs, they will be rendered with lowercased key names, and CloudFormation will reject the template.
Parameters
pathpathpathpathPath— - The path of the property, you can use dot notation to override values in complex types.valuevaluevaluevalueValue— - The value.
addPropertyDeletionOverride(propertyPath: string): voiddef add_property_deletion_override(self, property_path: str) -> Nonepublic void addPropertyDeletionOverride(String propertyPath)public void AddPropertyDeletionOverride(string propertyPath)func AddPropertyDeletionOverride(PropertyPath *string)#Adds an override that deletes the value of a property from the resource definition.
1 parameter
Parameters
propertyPathproperty_pathpropertyPathpropertyPathPropertyPath— The path to the property.
addPropertyOverride(propertyPath: string, value: any): voiddef add_property_override(self, property_path: str, value: Any) -> Nonepublic void addPropertyOverride(String propertyPath, Object value)public void AddPropertyOverride(string propertyPath, object value)func AddPropertyOverride(PropertyPath *string, Value interface{})#Adds an override to a resource property.
Syntactic sugar for addOverride("Properties.<...>", value).
2 parameters
Parameters
propertyPathproperty_pathpropertyPathpropertyPathPropertyPath— The path of the property.valuevaluevaluevalueValue— The value.
addResourceDependency(target: CfnResource, reason?: string): voiddef add_resource_dependency(self, target: CfnResource, reason: typing.Optional[str] = None) -> Nonepublic void addResourceDependency(CfnResource target, String reason)public void AddResourceDependency(CfnResource target, string? reason = null)func AddResourceDependency(Target CfnResource, Reason *string)#Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
notes
This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope.
This method only adds dependencies between L1 resources. If you are looking for a generic construct-to-construct dependency mechanism that works for all constructs including L2s, use construct.node.addDependency instead.
applyCrossStackReferenceStrength(strength: ReferenceStrength): voiddef apply_cross_stack_reference_strength(self, strength: ReferenceStrength) -> Nonepublic void applyCrossStackReferenceStrength(ReferenceStrength strength)public void ApplyCrossStackReferenceStrength(ReferenceStrength strength)func ApplyCrossStackReferenceStrength(Strength ReferenceStrength)#Sets the cross-stack reference strength for this resource.
When set, any cross-stack reference to this resource will use the specified strength instead of the global default from the consuming stack's context.
1 parameter
Parameters
strengthstrengthstrengthstrengthStrength— - The reference strength to use for this resource.
applyRemovalPolicy(policy?: RemovalPolicy, options?: RemovalPolicyOptions): voiddef apply_removal_policy(self, policy: typing.Optional[RemovalPolicy] = None, options: typing.Optional[RemovalPolicyOptions] = None) -> Nonepublic void applyRemovalPolicy(RemovalPolicy policy, RemovalPolicyOptions options)public void ApplyRemovalPolicy(RemovalPolicy? policy = null, RemovalPolicyOptions? options = null)func ApplyRemovalPolicy(Policy RemovalPolicy, Options RemovalPolicyOptions)#Sets the deletion policy of the resource based on the removal policy specified.
notes
The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you've removed it from the CDK application or because you've made a change that requires the resource to be replaced.
The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN). In some cases, a snapshot can be taken of the resource prior to deletion (RemovalPolicy.SNAPSHOT). A list of resources that support this policy can be found in the following link:
arnForScalingPolicy(resource: IScalingPolicyRef): string@staticmethod def arn_for_scaling_policy(resource: IScalingPolicyRef) -> strpublic static String arnForScalingPolicy(IScalingPolicyRef resource)public static string ArnForScalingPolicy(IScalingPolicyRef resource)func ArnForScalingPolicy(Resource IScalingPolicyRef) *stringstatic#cfnPropertyName(cdkPropertyName: string): stringdef cfn_property_name(self, cdk_property_name: str) -> strpublic String cfnPropertyName(String cdkPropertyName)public string CfnPropertyName(string cdkPropertyName)func CfnPropertyName(CdkPropertyName *string) *string#getAtt(attributeName: string, typeHint?: ResolutionTypeHint): Referencedef get_att(self, attribute_name: str, type_hint: typing.Optional[ResolutionTypeHint] = None) -> Referencepublic Reference getAtt(String attributeName, ResolutionTypeHint typeHint)public Reference GetAtt(string attributeName, ResolutionTypeHint? typeHint = null)func GetAtt(AttributeName *string, TypeHint ResolutionTypeHint) Reference#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.
1 parameter
Parameters
attributeNameattribute_nameattributeNameattributeNameAttributeName— The name of the attribute.
getMetadata(key: string): anydef get_metadata(self, key: str) -> Anypublic Object getMetadata(String key)public object GetMetadata(string key)func GetMetadata(Key *string) interface{}#Retrieve a value value from the CloudFormation Resource Metadata.
inspect(inspector: TreeInspector): voiddef inspect(self, inspector: TreeInspector) -> Nonepublic void inspect(TreeInspector inspector)public void Inspect(TreeInspector inspector)func Inspect(Inspector TreeInspector)#Examines the CloudFormation resource and discloses attributes.
1 parameter
Parameters
inspectorinspectorinspectorinspectorInspector— tree inspector to collect and process attributes.
isCfnElement(x: any): boolean@staticmethod def is_cfn_element(x: Any) -> boolpublic static Boolean isCfnElement(Object x)public static bool IsCfnElement(object x)func IsCfnElement(X interface{}) *boolstatic#Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template).
Uses duck-typing instead of instanceof to allow stack elements from different versions of this library to be included in the same stack.
returns
Returns: The construct as a stack element or undefined if it is not a stack element.
isCfnResource(x: any): boolean@staticmethod def is_cfn_resource(x: Any) -> boolpublic static Boolean isCfnResource(Object x)public static bool IsCfnResource(object x)func IsCfnResource(X interface{}) *boolstatic#Check whether the given object is a CfnResource.
isCfnScalingPolicy(x: any): boolean@staticmethod def is_cfn_scaling_policy(x: Any) -> boolpublic static Boolean isCfnScalingPolicy(Object x)public static bool IsCfnScalingPolicy(object x)func IsCfnScalingPolicy(X interface{}) *boolstatic#Checks whether the given object is a CfnScalingPolicy.
isConstruct(x: any): boolean@staticmethod def is_construct(x: Any) -> boolpublic static Boolean isConstruct(Object x)public static bool IsConstruct(object x)func IsConstruct(X interface{}) *boolstatic#Checks if `x` is a construct.
notes · 1 parameter · returns
Use this method instead of instanceof to properly detect Construct instances, even when the construct library is symlinked.
Explanation: in JavaScript, multiple copies of the constructs library on disk are seen as independent, completely different libraries. As a consequence, the class Construct in each copy of the constructs library is seen as a different class, and an instance of one class will not test as instanceof the other class. npm install will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the constructs library can be accidentally installed, and instanceof will behave unpredictably. It is safest to avoid using instanceof, and using this type-testing method instead.
Parameters
xxxxX— Any object.
Returns: true if x is an object created from a class which extends Construct.
obtainDependencies(): Stack | CfnResource[]def obtain_dependencies(self, ) -> typing.List[typing.Union[Stack, CfnResource]]public List<Stack> obtainDependencies()public Stack[] ObtainDependencies()func ObtainDependencies() *[]interface{}#Retrieves an array of resources and stacks this resource depends on.
For resources depended on directly, returns the CfnResource object. For dependencies on other stacks, returns the Stack object. The order of the array is not guaranteed.
overrideLogicalId(newLogicalId: string): voiddef override_logical_id(self, new_logical_id: str) -> Nonepublic void overrideLogicalId(String newLogicalId)public void OverrideLogicalId(string newLogicalId)func OverrideLogicalId(NewLogicalId *string)#Overrides the auto-generated logical ID with a specific ID.
1 parameter
Parameters
newLogicalIdnew_logical_idnewLogicalIdnewLogicalIdNewLogicalId— The new logical ID to use for this stack element.
removeDependency(target: CfnResource): voiddef remove_dependency(self, target: CfnResource) -> Nonepublic void removeDependency(CfnResource target)public void RemoveDependency(CfnResource target)func RemoveDependency(Target CfnResource)deprecated#Use `removeResourceDependency` instead
This can be used for resources across stacks (including nested stacks) and the dependency will automatically be removed from the relevant scope.
removeResourceDependency(target: CfnResource): voiddef remove_resource_dependency(self, target: CfnResource) -> Nonepublic void removeResourceDependency(CfnResource target)public void RemoveResourceDependency(CfnResource target)func RemoveResourceDependency(Target CfnResource)#Indicates that this resource no longer depends on another resource.
This can be used for resources across stacks (including nested stacks) and the dependency will automatically be removed from the relevant scope.
replaceDependency(target: CfnResource, newTarget: CfnResource): voiddef replace_dependency(self, target: CfnResource, new_target: CfnResource) -> Nonepublic void replaceDependency(CfnResource target, CfnResource newTarget)public void ReplaceDependency(CfnResource target, CfnResource newTarget)func ReplaceDependency(Target CfnResource, NewTarget CfnResource)#Replaces one dependency with another.
2 parameters
Parameters
targettargettargettargetTarget— The dependency to replace.newTargetnew_targetnewTargetnewTargetNewTarget— The new dependency to add.
toString(): stringdef to_string(self, ) -> strpublic String toString()public string ToString()func ToString() *string#Returns a string representation of this construct.
returns
Returns: a string representation of this resource
with(...mixins: IMixin[]): IConstructdef with(self, mixins: IMixin) -> IConstructpublic IConstruct with(IMixin mixins)public IConstruct With(IMixin mixins)func With(Mixins IMixin) IConstruct#Applies one or more mixins to this construct.
Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple with() calls if subsequent mixins should apply to added constructs.