software.amazon.awscdk.services.applicationautoscaling

Interface CfnScalingPolicyProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnScalingPolicyProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.46.0 (build cd08c55)",
           date="2021-11-25T20:11:04.934Z")
 @Stability(value=Stable)
public interface CfnScalingPolicyProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a `AWS::ApplicationAutoScaling::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.applicationautoscaling.*;
 CfnScalingPolicyProps cfnScalingPolicyProps = CfnScalingPolicyProps.builder()
         .policyName("policyName")
         .policyType("policyType")
         // the properties below are optional
         .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()
                         .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())
                 .scaleInCooldown(123)
                 .scaleOutCooldown(123)
                 .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()
String	getPolicyName() `AWS::ApplicationAutoScaling::ScalingPolicy.PolicyName`.
String	getPolicyType() `AWS::ApplicationAutoScaling::ScalingPolicy.PolicyType`.
default String	getResourceId() `AWS::ApplicationAutoScaling::ScalingPolicy.ResourceId`.
default String	getScalableDimension() `AWS::ApplicationAutoScaling::ScalingPolicy.ScalableDimension`.
default String	getScalingTargetId() `AWS::ApplicationAutoScaling::ScalingPolicy.ScalingTargetId`.
default String	getServiceNamespace() `AWS::ApplicationAutoScaling::ScalingPolicy.ServiceNamespace`.
default Object	getStepScalingPolicyConfiguration() `AWS::ApplicationAutoScaling::ScalingPolicy.StepScalingPolicyConfiguration`.
default Object	getTargetTrackingScalingPolicyConfiguration() `AWS::ApplicationAutoScaling::ScalingPolicy.TargetTrackingScalingPolicyConfiguration`.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getPolicyName

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

`AWS::ApplicationAutoScaling::ScalingPolicy.PolicyName`.

getPolicyType

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

`AWS::ApplicationAutoScaling::ScalingPolicy.PolicyType`.

getResourceId

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

`AWS::ApplicationAutoScaling::ScalingPolicy.ResourceId`.

getScalableDimension

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

`AWS::ApplicationAutoScaling::ScalingPolicy.ScalableDimension`.

getScalingTargetId

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

`AWS::ApplicationAutoScaling::ScalingPolicy.ScalingTargetId`.

getServiceNamespace

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

`AWS::ApplicationAutoScaling::ScalingPolicy.ServiceNamespace`.

getStepScalingPolicyConfiguration

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

`AWS::ApplicationAutoScaling::ScalingPolicy.StepScalingPolicyConfiguration`.

getTargetTrackingScalingPolicyConfiguration

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

`AWS::ApplicationAutoScaling::ScalingPolicy.TargetTrackingScalingPolicyConfiguration`.

builder

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

Returns:

a CfnScalingPolicyProps.Builder of CfnScalingPolicyProps