Package software.amazon.awscdk.services.applicationautoscaling

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.applicationautoscaling.CfnScalingPolicy

All Implemented Interfaces:

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

@Generated(value="jsii-pacmak/1.104.0 (build e79254c)",
           date="2025-01-15T21:09:14.157Z")
@Stability(Stable)
public class CfnScalingPolicy
extends CfnResource
implements IInspectable

The AWS::ApplicationAutoScaling::ScalingPolicy resource defines a scaling policy that Application Auto Scaling uses to adjust the capacity of a scalable target.

For more information, see Target tracking scaling policies and Step scaling policies in the Application 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.applicationautoscaling.*;
 CfnScalingPolicy cfnScalingPolicy = CfnScalingPolicy.Builder.create(this, "MyCfnScalingPolicy")
         .policyName("policyName")
         .policyType("policyType")
         // the properties below are optional
         .predictiveScalingPolicyConfiguration(PredictiveScalingPolicyConfigurationProperty.builder()
                 .metricSpecifications(List.of(PredictiveScalingMetricSpecificationProperty.builder()
                         .targetValue(123)
                         // the properties below are optional
                         .customizedCapacityMetricSpecification(PredictiveScalingCustomizedCapacityMetricProperty.builder()
                                 .metricDataQueries(List.of(PredictiveScalingMetricDataQueryProperty.builder()
                                         .expression("expression")
                                         .id("id")
                                         .label("label")
                                         .metricStat(PredictiveScalingMetricStatProperty.builder()
                                                 .metric(PredictiveScalingMetricProperty.builder()
                                                         .dimensions(List.of(PredictiveScalingMetricDimensionProperty.builder()
                                                                 .name("name")
                                                                 .value("value")
                                                                 .build()))
                                                         .metricName("metricName")
                                                         .namespace("namespace")
                                                         .build())
                                                 .stat("stat")
                                                 .unit("unit")
                                                 .build())
                                         .returnData(false)
                                         .build()))
                                 .build())
                         .customizedLoadMetricSpecification(PredictiveScalingCustomizedLoadMetricProperty.builder()
                                 .metricDataQueries(List.of(PredictiveScalingMetricDataQueryProperty.builder()
                                         .expression("expression")
                                         .id("id")
                                         .label("label")
                                         .metricStat(PredictiveScalingMetricStatProperty.builder()
                                                 .metric(PredictiveScalingMetricProperty.builder()
                                                         .dimensions(List.of(PredictiveScalingMetricDimensionProperty.builder()
                                                                 .name("name")
                                                                 .value("value")
                                                                 .build()))
                                                         .metricName("metricName")
                                                         .namespace("namespace")
                                                         .build())
                                                 .stat("stat")
                                                 .unit("unit")
                                                 .build())
                                         .returnData(false)
                                         .build()))
                                 .build())
                         .customizedScalingMetricSpecification(PredictiveScalingCustomizedScalingMetricProperty.builder()
                                 .metricDataQueries(List.of(PredictiveScalingMetricDataQueryProperty.builder()
                                         .expression("expression")
                                         .id("id")
                                         .label("label")
                                         .metricStat(PredictiveScalingMetricStatProperty.builder()
                                                 .metric(PredictiveScalingMetricProperty.builder()
                                                         .dimensions(List.of(PredictiveScalingMetricDimensionProperty.builder()
                                                                 .name("name")
                                                                 .value("value")
                                                                 .build()))
                                                         .metricName("metricName")
                                                         .namespace("namespace")
                                                         .build())
                                                 .stat("stat")
                                                 .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())
         .resourceId("resourceId")
         .scalableDimension("scalableDimension")
         .scalingTargetId("scalingTargetId")
         .serviceNamespace("serviceNamespace")
         .stepScalingPolicyConfiguration(StepScalingPolicyConfigurationProperty.builder()
                 .adjustmentType("adjustmentType")
                 .cooldown(123)
                 .metricAggregationType("metricAggregationType")
                 .minAdjustmentMagnitude(123)
                 .stepAdjustments(List.of(StepAdjustmentProperty.builder()
                         .scalingAdjustment(123)
                         // the properties below are optional
                         .metricIntervalLowerBound(123)
                         .metricIntervalUpperBound(123)
                         .build()))
                 .build())
         .targetTrackingScalingPolicyConfiguration(TargetTrackingScalingPolicyConfigurationProperty.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()
                                 .expression("expression")
                                 .id("id")
                                 .label("label")
                                 .metricStat(TargetTrackingMetricStatProperty.builder()
                                         .metric(TargetTrackingMetricProperty.builder()
                                                 .dimensions(List.of(TargetTrackingMetricDimensionProperty.builder()
                                                         .name("name")
                                                         .value("value")
                                                         .build()))
                                                 .metricName("metricName")
                                                 .namespace("namespace")
                                                 .build())
                                         .stat("stat")
                                         .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())
                 .scaleInCooldown(123)
                 .scaleOutCooldown(123)
                 .build())
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-applicationautoscaling-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 Application Auto Scaling.
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::ApplicationAutoScaling::ScalingPolicy CustomizedMetricSpecification property type.
static interface	CfnScalingPolicy.PredefinedMetricSpecificationProperty	Contains predefined metric specification information for a target tracking scaling policy for Application Auto Scaling.
static interface	CfnScalingPolicy.PredictiveScalingCustomizedCapacityMetricProperty	Represents a CloudWatch metric of your choosing for a predictive scaling policy.
static interface	CfnScalingPolicy.PredictiveScalingCustomizedLoadMetricProperty	The customized load metric specification.
static interface	CfnScalingPolicy.PredictiveScalingCustomizedScalingMetricProperty	One or more metric data queries to provide data points for a metric specification.
static interface	CfnScalingPolicy.PredictiveScalingMetricDataQueryProperty	The metric data to return.
static interface	CfnScalingPolicy.PredictiveScalingMetricDimensionProperty	Describes the dimension of a metric.
static interface	CfnScalingPolicy.PredictiveScalingMetricProperty	Describes the scaling metric.
static interface	CfnScalingPolicy.PredictiveScalingMetricSpecificationProperty	This structure specifies the metrics and target utilization settings for a predictive scaling policy.
static interface	CfnScalingPolicy.PredictiveScalingMetricStatProperty	This structure defines the CloudWatch metric to return, along with the statistic and unit.
static interface	CfnScalingPolicy.PredictiveScalingPolicyConfigurationProperty	Represents a predictive scaling policy configuration.
static interface	CfnScalingPolicy.PredictiveScalingPredefinedLoadMetricProperty	Describes a load metric for a predictive scaling policy.
static interface	CfnScalingPolicy.PredictiveScalingPredefinedMetricPairProperty	Represents a metric pair for a predictive scaling policy.
static interface	CfnScalingPolicy.PredictiveScalingPredefinedScalingMetricProperty	Describes a scaling metric for a predictive scaling policy.
static interface	CfnScalingPolicy.StepAdjustmentProperty	StepAdjustment specifies a step adjustment for the StepAdjustments property of the AWS::ApplicationAutoScaling::ScalingPolicy StepScalingPolicyConfiguration property type.
static interface	CfnScalingPolicy.StepScalingPolicyConfigurationProperty	StepScalingPolicyConfiguration is a property of the AWS::ApplicationAutoScaling::ScalingPolicy resource that specifies a step scaling policy configuration for Application Auto Scaling.
static interface	CfnScalingPolicy.TargetTrackingMetricDataQueryProperty	The metric data to return.
static interface	CfnScalingPolicy.TargetTrackingMetricDimensionProperty	TargetTrackingMetricDimension specifies a name/value pair that is part of the identity of a CloudWatch metric for the Dimensions property of the AWS::ApplicationAutoScaling::ScalingPolicy TargetTrackingMetric property type.
static interface	CfnScalingPolicy.TargetTrackingMetricProperty	Represents a specific metric for a target tracking scaling policy for Application Auto Scaling.
static interface	CfnScalingPolicy.TargetTrackingMetricStatProperty	This structure defines the CloudWatch metric to return, along with the statistic and unit.
static interface	CfnScalingPolicy.TargetTrackingScalingPolicyConfigurationProperty	TargetTrackingScalingPolicyConfiguration is a property of the AWS::ApplicationAutoScaling::ScalingPolicy resource that specifies a target tracking scaling policy configuration for Application Auto Scaling.

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	getAttrArn()	Returns the ARN of a scaling policy.
protected Map<String,Object>	getCfnProperties()
String	getPolicyName()	The name of the scaling policy.
String	getPolicyType()	The scaling policy type.
Object	getPredictiveScalingPolicyConfiguration()	The predictive scaling policy configuration.
String	getResourceId()	The identifier of the resource associated with the scaling policy.
String	getScalableDimension()	The scalable dimension.
String	getScalingTargetId()	The CloudFormation-generated ID of an Application Auto Scaling scalable target.
String	getServiceNamespace()	The namespace of the AWS service that provides the resource, or a custom-resource .
Object	getStepScalingPolicyConfiguration()	A step scaling policy.
Object	getTargetTrackingScalingPolicyConfiguration()	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	setPolicyName(String value)	The name of the scaling policy.
void	setPolicyType(String value)	The scaling policy type.
void	setPredictiveScalingPolicyConfiguration(IResolvable value)	The predictive scaling policy configuration.
void	setPredictiveScalingPolicyConfiguration(CfnScalingPolicy.PredictiveScalingPolicyConfigurationProperty value)	The predictive scaling policy configuration.
void	setResourceId(String value)	The identifier of the resource associated with the scaling policy.
void	setScalableDimension(String value)	The scalable dimension.
void	setScalingTargetId(String value)	The CloudFormation-generated ID of an Application Auto Scaling scalable target.
void	setServiceNamespace(String value)	The namespace of the AWS service that provides the resource, or a custom-resource .
void	setStepScalingPolicyConfiguration(IResolvable value)	A step scaling policy.
void	setStepScalingPolicyConfiguration(CfnScalingPolicy.StepScalingPolicyConfigurationProperty value)	A step scaling policy.
void	setTargetTrackingScalingPolicyConfiguration(IResolvable value)	A target tracking scaling policy.
void	setTargetTrackingScalingPolicyConfiguration(CfnScalingPolicy.TargetTrackingScalingPolicyConfigurationProperty 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.

getCfnProperties

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

Overrides:

getCfnProperties in class CfnResource

getPolicyName

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

The name of the scaling policy.

setPolicyName

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

The name of the scaling policy.

getPolicyType

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

The scaling policy type.

setPolicyType

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

The scaling policy type.

getPredictiveScalingPolicyConfiguration

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

The predictive scaling policy configuration.

setPredictiveScalingPolicyConfiguration

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

The predictive scaling policy configuration.

setPredictiveScalingPolicyConfiguration

@Stability(Stable)
public void setPredictiveScalingPolicyConfiguration(@Nullable
 CfnScalingPolicy.PredictiveScalingPolicyConfigurationProperty value)

The predictive scaling policy configuration.

getResourceId

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

The identifier of the resource associated with the scaling policy.

setResourceId

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

The identifier of the resource associated with the scaling policy.

getScalableDimension

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

The scalable dimension.

This string consists of the service namespace, resource type, and scaling property.

setScalableDimension

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

The scalable dimension.

This string consists of the service namespace, resource type, and scaling property.

getScalingTargetId

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

The CloudFormation-generated ID of an Application Auto Scaling scalable target.

setScalingTargetId

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

The CloudFormation-generated ID of an Application Auto Scaling scalable target.

getServiceNamespace

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

The namespace of the AWS service that provides the resource, or a custom-resource .

setServiceNamespace

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

The namespace of the AWS service that provides the resource, or a custom-resource .

getStepScalingPolicyConfiguration

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

A step scaling policy.

setStepScalingPolicyConfiguration

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

A step scaling policy.

setStepScalingPolicyConfiguration

@Stability(Stable)
public void setStepScalingPolicyConfiguration(@Nullable
 CfnScalingPolicy.StepScalingPolicyConfigurationProperty value)

A step scaling policy.

getTargetTrackingScalingPolicyConfiguration

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

A target tracking scaling policy.

setTargetTrackingScalingPolicyConfiguration

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

A target tracking scaling policy.

setTargetTrackingScalingPolicyConfiguration

@Stability(Stable)
public void setTargetTrackingScalingPolicyConfiguration(@Nullable
 CfnScalingPolicy.TargetTrackingScalingPolicyConfigurationProperty value)

A target tracking scaling policy.