software.amazon.awscdk.services.autoscalingplans

Interface CfnScalingPlanProps

All Known Implementing Classes:

CfnScalingPlanProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.73.0 (build 6faeda3)",
           date="2023-01-31T18:36:45.720Z")
public interface CfnScalingPlanProps

Properties for defining a `CfnScalingPlan`.

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.autoscalingplans.*;
 CfnScalingPlanProps cfnScalingPlanProps = CfnScalingPlanProps.builder()
         .applicationSource(ApplicationSourceProperty.builder()
                 .cloudFormationStackArn("cloudFormationStackArn")
                 .tagFilters(List.of(TagFilterProperty.builder()
                         .key("key")
                         // the properties below are optional
                         .values(List.of("values"))
                         .build()))
                 .build())
         .scalingInstructions(List.of(ScalingInstructionProperty.builder()
                 .maxCapacity(123)
                 .minCapacity(123)
                 .resourceId("resourceId")
                 .scalableDimension("scalableDimension")
                 .serviceNamespace("serviceNamespace")
                 .targetTrackingConfigurations(List.of(TargetTrackingConfigurationProperty.builder()
                         .targetValue(123)
                         // the properties below are optional
                         .customizedScalingMetricSpecification(CustomizedScalingMetricSpecificationProperty.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)
                         .estimatedInstanceWarmup(123)
                         .predefinedScalingMetricSpecification(PredefinedScalingMetricSpecificationProperty.builder()
                                 .predefinedScalingMetricType("predefinedScalingMetricType")
                                 // the properties below are optional
                                 .resourceLabel("resourceLabel")
                                 .build())
                         .scaleInCooldown(123)
                         .scaleOutCooldown(123)
                         .build()))
                 // the properties below are optional
                 .customizedLoadMetricSpecification(CustomizedLoadMetricSpecificationProperty.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())
                 .disableDynamicScaling(false)
                 .predefinedLoadMetricSpecification(PredefinedLoadMetricSpecificationProperty.builder()
                         .predefinedLoadMetricType("predefinedLoadMetricType")
                         // the properties below are optional
                         .resourceLabel("resourceLabel")
                         .build())
                 .predictiveScalingMaxCapacityBehavior("predictiveScalingMaxCapacityBehavior")
                 .predictiveScalingMaxCapacityBuffer(123)
                 .predictiveScalingMode("predictiveScalingMode")
                 .scalingPolicyUpdateBehavior("scalingPolicyUpdateBehavior")
                 .scheduledActionBufferTime(123)
                 .build()))
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	CfnScalingPlanProps.Builder A builder for CfnScalingPlanProps
static class	CfnScalingPlanProps.Jsii$Proxy An implementation for CfnScalingPlanProps

Method Summary

Modifier and Type	Method and Description
static CfnScalingPlanProps.Builder	builder()
java.lang.Object	getApplicationSource() A CloudFormation stack or a set of tags.
java.lang.Object	getScalingInstructions() The scaling instructions.

Method Detail

getApplicationSource

java.lang.Object getApplicationSource()

A CloudFormation stack or a set of tags.

You can create one scaling plan per application source. The ApplicationSource property must be present to ensure interoperability with the AWS Auto Scaling console.

getScalingInstructions

java.lang.Object getScalingInstructions()

The scaling instructions.

builder

static CfnScalingPlanProps.Builder builder()

Returns:

a CfnScalingPlanProps.Builder of CfnScalingPlanProps