software.amazon.awscdk.services.autoscalingplans

Interface CfnScalingPlan.ScalingInstructionProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnScalingPlan.ScalingInstructionProperty.Jsii$Proxy

Enclosing class:

CfnScalingPlan

@Stability(value=Stable)
public static interface CfnScalingPlan.ScalingInstructionProperty
extends software.amazon.jsii.JsiiSerializable

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.*;
 ScalingInstructionProperty scalingInstructionProperty = 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();
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and Description
static CfnScalingPlan.ScalingInstructionProperty.Builder	builder()
default Object	getCustomizedLoadMetricSpecification() `CfnScalingPlan.ScalingInstructionProperty.CustomizedLoadMetricSpecification`.
default Object	getDisableDynamicScaling() `CfnScalingPlan.ScalingInstructionProperty.DisableDynamicScaling`.
Number	getMaxCapacity() `CfnScalingPlan.ScalingInstructionProperty.MaxCapacity`.
Number	getMinCapacity() `CfnScalingPlan.ScalingInstructionProperty.MinCapacity`.
default Object	getPredefinedLoadMetricSpecification() `CfnScalingPlan.ScalingInstructionProperty.PredefinedLoadMetricSpecification`.
default String	getPredictiveScalingMaxCapacityBehavior() `CfnScalingPlan.ScalingInstructionProperty.PredictiveScalingMaxCapacityBehavior`.
default Number	getPredictiveScalingMaxCapacityBuffer() `CfnScalingPlan.ScalingInstructionProperty.PredictiveScalingMaxCapacityBuffer`.
default String	getPredictiveScalingMode() `CfnScalingPlan.ScalingInstructionProperty.PredictiveScalingMode`.
String	getResourceId() `CfnScalingPlan.ScalingInstructionProperty.ResourceId`.
String	getScalableDimension() `CfnScalingPlan.ScalingInstructionProperty.ScalableDimension`.
default String	getScalingPolicyUpdateBehavior() `CfnScalingPlan.ScalingInstructionProperty.ScalingPolicyUpdateBehavior`.
default Number	getScheduledActionBufferTime() `CfnScalingPlan.ScalingInstructionProperty.ScheduledActionBufferTime`.
String	getServiceNamespace() `CfnScalingPlan.ScalingInstructionProperty.ServiceNamespace`.
Object	getTargetTrackingConfigurations() `CfnScalingPlan.ScalingInstructionProperty.TargetTrackingConfigurations`.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getCustomizedLoadMetricSpecification

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

`CfnScalingPlan.ScalingInstructionProperty.CustomizedLoadMetricSpecification`.

getDisableDynamicScaling

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

`CfnScalingPlan.ScalingInstructionProperty.DisableDynamicScaling`.

getMaxCapacity

@Stability(value=Stable)
 @NotNull
Number getMaxCapacity()

`CfnScalingPlan.ScalingInstructionProperty.MaxCapacity`.

getMinCapacity

@Stability(value=Stable)
 @NotNull
Number getMinCapacity()

`CfnScalingPlan.ScalingInstructionProperty.MinCapacity`.

getPredefinedLoadMetricSpecification

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

`CfnScalingPlan.ScalingInstructionProperty.PredefinedLoadMetricSpecification`.

getPredictiveScalingMaxCapacityBehavior

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

`CfnScalingPlan.ScalingInstructionProperty.PredictiveScalingMaxCapacityBehavior`.

getPredictiveScalingMaxCapacityBuffer

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

`CfnScalingPlan.ScalingInstructionProperty.PredictiveScalingMaxCapacityBuffer`.

getPredictiveScalingMode

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

`CfnScalingPlan.ScalingInstructionProperty.PredictiveScalingMode`.

getResourceId

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

`CfnScalingPlan.ScalingInstructionProperty.ResourceId`.

getScalableDimension

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

`CfnScalingPlan.ScalingInstructionProperty.ScalableDimension`.

getScalingPolicyUpdateBehavior

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

`CfnScalingPlan.ScalingInstructionProperty.ScalingPolicyUpdateBehavior`.

getScheduledActionBufferTime

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

`CfnScalingPlan.ScalingInstructionProperty.ScheduledActionBufferTime`.

getServiceNamespace

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

`CfnScalingPlan.ScalingInstructionProperty.ServiceNamespace`.

getTargetTrackingConfigurations

@Stability(value=Stable)
 @NotNull
Object getTargetTrackingConfigurations()

`CfnScalingPlan.ScalingInstructionProperty.TargetTrackingConfigurations`.

builder

@Stability(value=Stable)
static CfnScalingPlan.ScalingInstructionProperty.Builder builder()

Returns:

a CfnScalingPlan.ScalingInstructionProperty.Builder of CfnScalingPlan.ScalingInstructionProperty