Package software.amazon.awscdk.services.autoscaling

Class CfnScalingPolicy

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.CfnElement

software.amazon.awscdk.CfnRefElement

software.amazon.awscdk.CfnResource

software.amazon.awscdk.services.autoscaling.CfnScalingPolicy

All Implemented Interfaces:

IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.103.1 (build bef2dea)",
           date="2024-10-11T15:55:53.667Z")
@Stability(Stable)
public class CfnScalingPolicy
extends CfnResource
implements IInspectable

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:

 // 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
                                         .unit("unit")
                                         .build())
                                 .returnData(false)
                                 .build()))
                         .namespace("namespace")
                         .statistic("statistic")
                         .unit("unit")
                         .build())
                 .disableScaleIn(false)
                 .predefinedMetricSpecification(PredefinedMetricSpecificationProperty.builder()
                         .predefinedMetricType("predefinedMetricType")
                         // the properties below are optional
                         .resourceLabel("resourceLabel")
                         .build())
                 .build())
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-autoscaling-scalingpolicy.html

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	CfnScalingPolicy.Builder	A fluent builder for CfnScalingPolicy.
static interface	CfnScalingPolicy.CustomizedMetricSpecificationProperty	Contains customized metric specification information for a target tracking scaling policy for Amazon EC2 Auto Scaling.
static interface	CfnScalingPolicy.MetricDataQueryProperty	The metric data to return.
static interface	CfnScalingPolicy.MetricDimensionProperty	MetricDimension specifies a name/value pair that is part of the identity of a CloudWatch metric for the Dimensions property of the AWS::AutoScaling::ScalingPolicy CustomizedMetricSpecification property type.
static interface	CfnScalingPolicy.MetricProperty	Represents a specific metric.
static interface	CfnScalingPolicy.MetricStatProperty	MetricStat is a property of the AWS::AutoScaling::ScalingPolicy MetricDataQuery property type.
static interface	CfnScalingPolicy.PredefinedMetricSpecificationProperty	Contains predefined metric specification information for a target tracking scaling policy for Amazon EC2 Auto Scaling.
static interface	CfnScalingPolicy.PredictiveScalingConfigurationProperty	PredictiveScalingConfiguration is a property of the AWS::AutoScaling::ScalingPolicy resource that specifies a predictive scaling policy for Amazon EC2 Auto Scaling.
static interface	CfnScalingPolicy.PredictiveScalingCustomizedCapacityMetricProperty	Contains capacity metric information for the CustomizedCapacityMetricSpecification property of the AWS::AutoScaling::ScalingPolicy PredictiveScalingMetricSpecification property type.
static interface	CfnScalingPolicy.PredictiveScalingCustomizedLoadMetricProperty	Contains load metric information for the CustomizedLoadMetricSpecification property of the AWS::AutoScaling::ScalingPolicy PredictiveScalingMetricSpecification property type.
static interface	CfnScalingPolicy.PredictiveScalingCustomizedScalingMetricProperty	Contains scaling metric information for the CustomizedScalingMetricSpecification property of the AWS::AutoScaling::ScalingPolicy PredictiveScalingMetricSpecification property type.
static interface	CfnScalingPolicy.PredictiveScalingMetricSpecificationProperty	A structure that specifies a metric specification for the MetricSpecifications property of the AWS::AutoScaling::ScalingPolicy PredictiveScalingConfiguration property type.
static interface	CfnScalingPolicy.PredictiveScalingPredefinedLoadMetricProperty	Contains load metric information for the PredefinedLoadMetricSpecification property of the AWS::AutoScaling::ScalingPolicy PredictiveScalingMetricSpecification property type.
static interface	CfnScalingPolicy.PredictiveScalingPredefinedMetricPairProperty	Contains metric pair information for the PredefinedMetricPairSpecification property of the AWS::AutoScaling::ScalingPolicy PredictiveScalingMetricSpecification property type.
static interface	CfnScalingPolicy.PredictiveScalingPredefinedScalingMetricProperty	Contains scaling metric information for the PredefinedScalingMetricSpecification property of the AWS::AutoScaling::ScalingPolicy PredictiveScalingMetricSpecification property type.
static interface	CfnScalingPolicy.StepAdjustmentProperty	StepAdjustment specifies a step adjustment for the StepAdjustments property of the AWS::AutoScaling::ScalingPolicy resource.
static interface	CfnScalingPolicy.TargetTrackingConfigurationProperty	TargetTrackingConfiguration is a property of the AWS::AutoScaling::ScalingPolicy resource that specifies a target tracking scaling policy configuration for Amazon EC2 Auto Scaling.
static interface	CfnScalingPolicy.TargetTrackingMetricDataQueryProperty	The metric data to return.
static interface	CfnScalingPolicy.TargetTrackingMetricStatProperty	This structure defines the CloudWatch metric to return, along with the statistic and unit.

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default

Nested classes/interfaces inherited from interface software.amazon.awscdk.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Field Summary

Fields

Modifier and Type	Field	Description
static final String	CFN_RESOURCE_TYPE_NAME	The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	CfnScalingPolicy(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnScalingPolicy(software.amazon.jsii.JsiiObjectRef objRef)
	CfnScalingPolicy(software.constructs.Construct scope, String id, CfnScalingPolicyProps props)

Method Summary

Modifier and Type	Method	Description
String	getAdjustmentType()	Specifies how the scaling adjustment is interpreted (for example, an absolute number or a percentage).
String	getAttrArn()	Returns the ARN of a scaling policy.
String	getAttrPolicyName()	Returns the name of a scaling policy.
String	getAutoScalingGroupName()	The name of the Auto Scaling group.
protected Map<String,Object>	getCfnProperties()
String	getCooldown()	A cooldown period, in seconds, that applies to a specific simple scaling policy.
Number	getEstimatedInstanceWarmup()	Not needed if the default instance warmup is defined for the group..
String	getMetricAggregationType()	The aggregation type for the CloudWatch metrics.
Number	getMinAdjustmentMagnitude()	The minimum value to scale by when the adjustment type is PercentChangeInCapacity .
String	getPolicyType()	One of the following policy types:.
Object	getPredictiveScalingConfiguration()	A predictive scaling policy.
Number	getScalingAdjustment()	The amount by which to scale, based on the specified adjustment type.
Object	getStepAdjustments()	A set of adjustments that enable you to scale based on the size of the alarm breach.
Object	getTargetTrackingConfiguration()	A target tracking scaling policy.
void	inspect(TreeInspector inspector)	Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setAdjustmentType(String value)	Specifies how the scaling adjustment is interpreted (for example, an absolute number or a percentage).
void	setAutoScalingGroupName(String value)	The name of the Auto Scaling group.
void	setCooldown(String value)	A cooldown period, in seconds, that applies to a specific simple scaling policy.
void	setEstimatedInstanceWarmup(Number value)	Not needed if the default instance warmup is defined for the group..
void	setMetricAggregationType(String value)	The aggregation type for the CloudWatch metrics.
void	setMinAdjustmentMagnitude(Number value)	The minimum value to scale by when the adjustment type is PercentChangeInCapacity .
void	setPolicyType(String value)	One of the following policy types:.
void	setPredictiveScalingConfiguration(IResolvable value)	A predictive scaling policy.
void	setPredictiveScalingConfiguration(CfnScalingPolicy.PredictiveScalingConfigurationProperty value)	A predictive scaling policy.
void	setScalingAdjustment(Number value)	The amount by which to scale, based on the specified adjustment type.
void	setStepAdjustments(List<Object> value)	A set of adjustments that enable you to scale based on the size of the alarm breach.
void	setStepAdjustments(IResolvable value)	A set of adjustments that enable you to scale based on the size of the alarm breach.
void	setTargetTrackingConfiguration(IResolvable value)	A target tracking scaling policy.
void	setTargetTrackingConfiguration(CfnScalingPolicy.TargetTrackingConfigurationProperty value)	A target tracking scaling policy.

Methods inherited from class software.amazon.awscdk.CfnResource

addDeletionOverride, addDependency, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, getUpdatedProperties, isCfnResource, obtainDependencies, obtainResourceDependencies, removeDependency, replaceDependency, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.constructs.Construct

getNode, isConstruct

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Details

CFN_RESOURCE_TYPE_NAME

@Stability(Stable)
public static final String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Details

CfnScalingPolicy

protected CfnScalingPolicy(software.amazon.jsii.JsiiObjectRef objRef)

CfnScalingPolicy

protected CfnScalingPolicy(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

CfnScalingPolicy

@Stability(Stable)
public CfnScalingPolicy(@NotNull
 software.constructs.Construct scope,
 @NotNull
 String id,
 @NotNull
 CfnScalingPolicyProps props)

Parameters:

scope - Scope in which this resource is defined. This parameter is required.

id - Construct identifier for this resource (unique in its scope). This parameter is required.

props - Resource properties. This parameter is required.

Method Details

inspect

@Stability(Stable)
public void inspect(@NotNull
 TreeInspector inspector)

Examines the CloudFormation resource and discloses attributes.

Specified by:

inspect in interface IInspectable

Parameters:

inspector - tree inspector to collect and process attributes. This parameter is required.

renderProperties

@Stability(Stable)
@NotNull
protected Map<String,Object> renderProperties(@NotNull
 Map<String,Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getAttrArn

@Stability(Stable)
@NotNull
public String getAttrArn()

Returns the ARN of a scaling policy.

getAttrPolicyName

@Stability(Stable)
@NotNull
public String getAttrPolicyName()

Returns the name of a scaling policy.

getCfnProperties

@Stability(Stable)
@NotNull
protected Map<String,Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getAutoScalingGroupName

@Stability(Stable)
@NotNull
public String getAutoScalingGroupName()

The name of the Auto Scaling group.

setAutoScalingGroupName

@Stability(Stable)
public void setAutoScalingGroupName(@NotNull
 String value)

The name of the Auto Scaling group.

getAdjustmentType

@Stability(Stable)
@Nullable
public String getAdjustmentType()

Specifies how the scaling adjustment is interpreted (for example, an absolute number or a percentage).

setAdjustmentType

@Stability(Stable)
public void setAdjustmentType(@Nullable
 String value)

Specifies how the scaling adjustment is interpreted (for example, an absolute number or a percentage).

getCooldown

@Stability(Stable)
@Nullable
public String getCooldown()

A cooldown period, in seconds, that applies to a specific simple scaling policy.

setCooldown

@Stability(Stable)
public void setCooldown(@Nullable
 String value)

A cooldown period, in seconds, that applies to a specific simple scaling policy.

getEstimatedInstanceWarmup

@Stability(Stable)
@Nullable
public Number getEstimatedInstanceWarmup()

Not needed if the default instance warmup is defined for the group..

setEstimatedInstanceWarmup

@Stability(Stable)
public void setEstimatedInstanceWarmup(@Nullable
 Number value)

Not needed if the default instance warmup is defined for the group..

getMetricAggregationType

@Stability(Stable)
@Nullable
public String getMetricAggregationType()

The aggregation type for the CloudWatch metrics.

setMetricAggregationType

@Stability(Stable)
public void setMetricAggregationType(@Nullable
 String value)

The aggregation type for the CloudWatch metrics.

getMinAdjustmentMagnitude

@Stability(Stable)
@Nullable
public Number getMinAdjustmentMagnitude()

The minimum value to scale by when the adjustment type is PercentChangeInCapacity .

setMinAdjustmentMagnitude

@Stability(Stable)
public void setMinAdjustmentMagnitude(@Nullable
 Number value)

The minimum value to scale by when the adjustment type is PercentChangeInCapacity .

getPolicyType

@Stability(Stable)
@Nullable
public String getPolicyType()

One of the following policy types:.

setPolicyType

@Stability(Stable)
public void setPolicyType(@Nullable
 String value)

One of the following policy types:.

getPredictiveScalingConfiguration

@Stability(Stable)
@Nullable
public Object getPredictiveScalingConfiguration()

A predictive scaling policy.

Provides support for predefined and custom metrics.

setPredictiveScalingConfiguration

@Stability(Stable)
public void setPredictiveScalingConfiguration(@Nullable
 IResolvable value)

A predictive scaling policy.

Provides support for predefined and custom metrics.

setPredictiveScalingConfiguration

@Stability(Stable)
public void setPredictiveScalingConfiguration(@Nullable
 CfnScalingPolicy.PredictiveScalingConfigurationProperty value)

A predictive scaling policy.

Provides support for predefined and custom metrics.

getScalingAdjustment

@Stability(Stable)
@Nullable
public Number getScalingAdjustment()

The amount by which to scale, based on the specified adjustment type.

setScalingAdjustment

@Stability(Stable)
public void setScalingAdjustment(@Nullable
 Number value)

The amount by which to scale, based on the specified adjustment type.

getStepAdjustments

@Stability(Stable)
@Nullable
public Object getStepAdjustments()

A set of adjustments that enable you to scale based on the size of the alarm breach.

setStepAdjustments

@Stability(Stable)
public void setStepAdjustments(@Nullable
 IResolvable value)

A set of adjustments that enable you to scale based on the size of the alarm breach.

setStepAdjustments

@Stability(Stable)
public void setStepAdjustments(@Nullable
 List<Object> value)

A set of adjustments that enable you to scale based on the size of the alarm breach.

getTargetTrackingConfiguration

@Stability(Stable)
@Nullable
public Object getTargetTrackingConfiguration()

A target tracking scaling policy.

Provides support for predefined or custom metrics.

setTargetTrackingConfiguration

@Stability(Stable)
public void setTargetTrackingConfiguration(@Nullable
 IResolvable value)

A target tracking scaling policy.

Provides support for predefined or custom metrics.

setTargetTrackingConfiguration

@Stability(Stable)
public void setTargetTrackingConfiguration(@Nullable
 CfnScalingPolicy.TargetTrackingConfigurationProperty value)

A target tracking scaling policy.

Provides support for predefined or custom metrics.