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.46.0 (build cd08c55)",
           date="2021-11-25T20:11:05.167Z")
 @Stability(value=Stable)
public class CfnScalingPolicy
extends CfnResource
implements IInspectable

A CloudFormation `AWS::AutoScaling::ScalingPolicy`.

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
                         .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()
                         .metricName("metricName")
                         .namespace("namespace")
                         .statistic("statistic")
                         // the properties below are optional
                         .dimensions(List.of(MetricDimensionProperty.builder()
                                 .name("name")
                                 .value("value")
                                 .build()))
                         .unit("unit")
                         .build())
                 .disableScaleIn(false)
                 .predefinedMetricSpecification(PredefinedMetricSpecificationProperty.builder()
                         .predefinedMetricType("predefinedMetricType")
                         // the properties below are optional
                         .resourceLabel("resourceLabel")
                         .build())
                 .build())
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CfnScalingPolicy.Builder A fluent builder for CfnScalingPolicy.
static interface	CfnScalingPolicy.CustomizedMetricSpecificationProperty Example:
static interface	CfnScalingPolicy.MetricDimensionProperty Example:
static interface	CfnScalingPolicy.PredefinedMetricSpecificationProperty Example:
static interface	CfnScalingPolicy.PredictiveScalingConfigurationProperty Example:
static interface	CfnScalingPolicy.PredictiveScalingMetricSpecificationProperty Example:
static interface	CfnScalingPolicy.PredictiveScalingPredefinedLoadMetricProperty Example:
static interface	CfnScalingPolicy.PredictiveScalingPredefinedMetricPairProperty Example:
static interface	CfnScalingPolicy.PredictiveScalingPredefinedScalingMetricProperty Example:
static interface	CfnScalingPolicy.StepAdjustmentProperty Example:
static interface	CfnScalingPolicy.TargetTrackingConfigurationProperty Example:

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

software.amazon.jsii.JsiiObject.InitializationMode

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

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

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

software.constructs.IConstruct.Jsii$Default

Field Summary

Fields

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

Constructor Summary

Constructors

Modifier	Constructor and Description
	CfnScalingPolicy(software.constructs.Construct scope, String id, CfnScalingPolicyProps props) Create a new `AWS::AutoScaling::ScalingPolicy`.
protected	CfnScalingPolicy(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnScalingPolicy(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
String	getAdjustmentType() `AWS::AutoScaling::ScalingPolicy.AdjustmentType`.
String	getAutoScalingGroupName() `AWS::AutoScaling::ScalingPolicy.AutoScalingGroupName`.
protected Map<String,Object>	getCfnProperties()
String	getCooldown() `AWS::AutoScaling::ScalingPolicy.Cooldown`.
Number	getEstimatedInstanceWarmup() `AWS::AutoScaling::ScalingPolicy.EstimatedInstanceWarmup`.
String	getMetricAggregationType() `AWS::AutoScaling::ScalingPolicy.MetricAggregationType`.
Number	getMinAdjustmentMagnitude() `AWS::AutoScaling::ScalingPolicy.MinAdjustmentMagnitude`.
String	getPolicyType() `AWS::AutoScaling::ScalingPolicy.PolicyType`.
Object	getPredictiveScalingConfiguration() `AWS::AutoScaling::ScalingPolicy.PredictiveScalingConfiguration`.
Number	getScalingAdjustment() `AWS::AutoScaling::ScalingPolicy.ScalingAdjustment`.
Object	getStepAdjustments() `AWS::AutoScaling::ScalingPolicy.StepAdjustments`.
Object	getTargetTrackingConfiguration() `AWS::AutoScaling::ScalingPolicy.TargetTrackingConfiguration`.
void	inspect(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setAdjustmentType(String value) `AWS::AutoScaling::ScalingPolicy.AdjustmentType`.
void	setAutoScalingGroupName(String value) `AWS::AutoScaling::ScalingPolicy.AutoScalingGroupName`.
void	setCooldown(String value) `AWS::AutoScaling::ScalingPolicy.Cooldown`.
void	setEstimatedInstanceWarmup(Number value) `AWS::AutoScaling::ScalingPolicy.EstimatedInstanceWarmup`.
void	setMetricAggregationType(String value) `AWS::AutoScaling::ScalingPolicy.MetricAggregationType`.
void	setMinAdjustmentMagnitude(Number value) `AWS::AutoScaling::ScalingPolicy.MinAdjustmentMagnitude`.
void	setPolicyType(String value) `AWS::AutoScaling::ScalingPolicy.PolicyType`.
void	setPredictiveScalingConfiguration(CfnScalingPolicy.PredictiveScalingConfigurationProperty value) `AWS::AutoScaling::ScalingPolicy.PredictiveScalingConfiguration`.
void	setPredictiveScalingConfiguration(IResolvable value) `AWS::AutoScaling::ScalingPolicy.PredictiveScalingConfiguration`.
void	setScalingAdjustment(Number value) `AWS::AutoScaling::ScalingPolicy.ScalingAdjustment`.
void	setStepAdjustments(IResolvable value) `AWS::AutoScaling::ScalingPolicy.StepAdjustments`.
void	setStepAdjustments(List<Object> value) `AWS::AutoScaling::ScalingPolicy.StepAdjustments`.
void	setTargetTrackingConfiguration(CfnScalingPolicy.TargetTrackingConfigurationProperty value) `AWS::AutoScaling::ScalingPolicy.TargetTrackingConfiguration`.
void	setTargetTrackingConfiguration(IResolvable value) `AWS::AutoScaling::ScalingPolicy.TargetTrackingConfiguration`.

Methods inherited from class software.amazon.awscdk.CfnResource

addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, isCfnResource, 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 Detail

CFN_RESOURCE_TYPE_NAME

@Stability(value=Stable)
public static final String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Detail

CfnScalingPolicy

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

CfnScalingPolicy

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

CfnScalingPolicy

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

Create a new `AWS::AutoScaling::ScalingPolicy`.

Parameters:

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

id - - scoped id of the resource. This parameter is required.

props - - resource properties. This parameter is required.

Method Detail

inspect

@Stability(value=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(value=Stable)
 @NotNull
protected Map<String,Object> renderProperties(@NotNull
                                                                                 Map<String,Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getAdjustmentType

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

`AWS::AutoScaling::ScalingPolicy.AdjustmentType`.

setAdjustmentType

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

`AWS::AutoScaling::ScalingPolicy.AdjustmentType`.

getAutoScalingGroupName

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

`AWS::AutoScaling::ScalingPolicy.AutoScalingGroupName`.

setAutoScalingGroupName

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

`AWS::AutoScaling::ScalingPolicy.AutoScalingGroupName`.

getCfnProperties

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

Overrides:

getCfnProperties in class CfnResource

getCooldown

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

`AWS::AutoScaling::ScalingPolicy.Cooldown`.

setCooldown

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

`AWS::AutoScaling::ScalingPolicy.Cooldown`.

getEstimatedInstanceWarmup

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

`AWS::AutoScaling::ScalingPolicy.EstimatedInstanceWarmup`.

setEstimatedInstanceWarmup

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

`AWS::AutoScaling::ScalingPolicy.EstimatedInstanceWarmup`.

getMetricAggregationType

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

`AWS::AutoScaling::ScalingPolicy.MetricAggregationType`.

setMetricAggregationType

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

`AWS::AutoScaling::ScalingPolicy.MetricAggregationType`.

getMinAdjustmentMagnitude

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

`AWS::AutoScaling::ScalingPolicy.MinAdjustmentMagnitude`.

setMinAdjustmentMagnitude

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

`AWS::AutoScaling::ScalingPolicy.MinAdjustmentMagnitude`.

getPolicyType

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

`AWS::AutoScaling::ScalingPolicy.PolicyType`.

setPolicyType

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

`AWS::AutoScaling::ScalingPolicy.PolicyType`.

getPredictiveScalingConfiguration

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

`AWS::AutoScaling::ScalingPolicy.PredictiveScalingConfiguration`.

setPredictiveScalingConfiguration

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

`AWS::AutoScaling::ScalingPolicy.PredictiveScalingConfiguration`.

setPredictiveScalingConfiguration

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

`AWS::AutoScaling::ScalingPolicy.PredictiveScalingConfiguration`.

getScalingAdjustment

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

`AWS::AutoScaling::ScalingPolicy.ScalingAdjustment`.

setScalingAdjustment

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

`AWS::AutoScaling::ScalingPolicy.ScalingAdjustment`.

getStepAdjustments

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

`AWS::AutoScaling::ScalingPolicy.StepAdjustments`.

setStepAdjustments

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

`AWS::AutoScaling::ScalingPolicy.StepAdjustments`.

setStepAdjustments

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

`AWS::AutoScaling::ScalingPolicy.StepAdjustments`.

getTargetTrackingConfiguration

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

`AWS::AutoScaling::ScalingPolicy.TargetTrackingConfiguration`.

setTargetTrackingConfiguration

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

`AWS::AutoScaling::ScalingPolicy.TargetTrackingConfiguration`.

setTargetTrackingConfiguration

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

`AWS::AutoScaling::ScalingPolicy.TargetTrackingConfiguration`.