software.amazon.awscdk.services.autoscaling

Interface CfnScalingPolicyProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnScalingPolicyProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.47.0 (build 86d2c33)",
           date="2021-12-22T10:27:16.114Z")
 @Stability(value=Stable)
public interface CfnScalingPolicyProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a `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.*;
 CfnScalingPolicyProps cfnScalingPolicyProps = CfnScalingPolicyProps.builder()
         .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	Interface and Description
static class	CfnScalingPolicyProps.Builder A builder for CfnScalingPolicyProps
static class	CfnScalingPolicyProps.Jsii$Proxy An implementation for CfnScalingPolicyProps

Method Summary

Modifier and Type	Method and Description
static CfnScalingPolicyProps.Builder	builder()
default String	getAdjustmentType() `AWS::AutoScaling::ScalingPolicy.AdjustmentType`.
String	getAutoScalingGroupName() `AWS::AutoScaling::ScalingPolicy.AutoScalingGroupName`.
default String	getCooldown() `AWS::AutoScaling::ScalingPolicy.Cooldown`.
default Number	getEstimatedInstanceWarmup() `AWS::AutoScaling::ScalingPolicy.EstimatedInstanceWarmup`.
default String	getMetricAggregationType() `AWS::AutoScaling::ScalingPolicy.MetricAggregationType`.
default Number	getMinAdjustmentMagnitude() `AWS::AutoScaling::ScalingPolicy.MinAdjustmentMagnitude`.
default String	getPolicyType() `AWS::AutoScaling::ScalingPolicy.PolicyType`.
default Object	getPredictiveScalingConfiguration() `AWS::AutoScaling::ScalingPolicy.PredictiveScalingConfiguration`.
default Number	getScalingAdjustment() `AWS::AutoScaling::ScalingPolicy.ScalingAdjustment`.
default Object	getStepAdjustments() `AWS::AutoScaling::ScalingPolicy.StepAdjustments`.
default Object	getTargetTrackingConfiguration() `AWS::AutoScaling::ScalingPolicy.TargetTrackingConfiguration`.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getAdjustmentType

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

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

getAutoScalingGroupName

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

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

getCooldown

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

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

getEstimatedInstanceWarmup

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

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

getMetricAggregationType

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

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

getMinAdjustmentMagnitude

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

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

getPolicyType

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

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

getPredictiveScalingConfiguration

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

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

getScalingAdjustment

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

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

getStepAdjustments

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

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

getTargetTrackingConfiguration

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

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

builder

@Stability(value=Stable)
static CfnScalingPolicyProps.Builder builder()

Returns:

a CfnScalingPolicyProps.Builder of CfnScalingPolicyProps