Package software.amazon.awscdk.services.autoscalingplans

Interface CfnScalingPlanProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnScalingPlanProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.104.0 (build e79254c)",
           date="2024-11-22T02:23:57.468Z")
@Stability(Stable)
public interface CfnScalingPlanProps
extends software.amazon.jsii.JsiiSerializable

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();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-autoscalingplans-scalingplan.html

Nested Class Summary

Nested Classes

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

Method Summary

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

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getApplicationSource

@Stability(Stable)
@NotNull
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.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-autoscalingplans-scalingplan.html#cfn-autoscalingplans-scalingplan-applicationsource

getScalingInstructions

@Stability(Stable)
@NotNull
Object getScalingInstructions()

The scaling instructions.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-autoscalingplans-scalingplan.html#cfn-autoscalingplans-scalingplan-scalinginstructions

builder

@Stability(Stable)
static CfnScalingPlanProps.Builder builder()

Returns:

a CfnScalingPlanProps.Builder of CfnScalingPlanProps