software.amazon.awscdk.services.autoscalingplans

Class CfnScalingPlan

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.CfnElement

software.amazon.awscdk.CfnRefElement

software.amazon.awscdk.CfnResource

software.amazon.awscdk.services.autoscalingplans.CfnScalingPlan

All Implemented Interfaces:

IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.46.0 (build cd08c55)",
           date="2021-11-25T20:11:05.189Z")
 @Stability(value=Stable)
public class CfnScalingPlan
extends CfnResource
implements IInspectable

A CloudFormation `AWS::AutoScalingPlans::ScalingPlan`.

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.*;
 CfnScalingPlan cfnScalingPlan = CfnScalingPlan.Builder.create(this, "MyCfnScalingPlan")
         .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	Class and Description
static interface	CfnScalingPlan.ApplicationSourceProperty Example:
static class	CfnScalingPlan.Builder A fluent builder for CfnScalingPlan.
static interface	CfnScalingPlan.CustomizedLoadMetricSpecificationProperty Example:
static interface	CfnScalingPlan.CustomizedScalingMetricSpecificationProperty Example:
static interface	CfnScalingPlan.MetricDimensionProperty Example:
static interface	CfnScalingPlan.PredefinedLoadMetricSpecificationProperty Example:
static interface	CfnScalingPlan.PredefinedScalingMetricSpecificationProperty Example:
static interface	CfnScalingPlan.ScalingInstructionProperty Example:
static interface	CfnScalingPlan.TagFilterProperty Example:
static interface	CfnScalingPlan.TargetTrackingConfigurationProperty Example:

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.amazon.awscdk.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default

Field Summary

Fields

Modifier and Type	Field and Description
static String	CFN_RESOURCE_TYPE_NAME The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors

Modifier	Constructor and Description
	CfnScalingPlan(software.constructs.Construct scope, String id, CfnScalingPlanProps props) Create a new `AWS::AutoScalingPlans::ScalingPlan`.
protected	CfnScalingPlan(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnScalingPlan(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
Object	getApplicationSource() `AWS::AutoScalingPlans::ScalingPlan.ApplicationSource`.
String	getAttrScalingPlanName()
String	getAttrScalingPlanVersion()
protected Map<String,Object>	getCfnProperties()
Object	getScalingInstructions() `AWS::AutoScalingPlans::ScalingPlan.ScalingInstructions`.
void	inspect(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setApplicationSource(CfnScalingPlan.ApplicationSourceProperty value) `AWS::AutoScalingPlans::ScalingPlan.ApplicationSource`.
void	setApplicationSource(IResolvable value) `AWS::AutoScalingPlans::ScalingPlan.ApplicationSource`.
void	setScalingInstructions(IResolvable value) `AWS::AutoScalingPlans::ScalingPlan.ScalingInstructions`.
void	setScalingInstructions(List<Object> value) `AWS::AutoScalingPlans::ScalingPlan.ScalingInstructions`.

Methods inherited from class software.amazon.awscdk.CfnResource

addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, isCfnResource, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.constructs.Construct

getNode, isConstruct

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Detail

CFN_RESOURCE_TYPE_NAME

@Stability(value=Stable)
public static final String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Detail

CfnScalingPlan

protected CfnScalingPlan(software.amazon.jsii.JsiiObjectRef objRef)

CfnScalingPlan

protected CfnScalingPlan(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

CfnScalingPlan

@Stability(value=Stable)
public CfnScalingPlan(@NotNull
                                               software.constructs.Construct scope,
                                               @NotNull
                                               String id,
                                               @NotNull
                                               CfnScalingPlanProps props)

Create a new `AWS::AutoScalingPlans::ScalingPlan`.

Parameters:

scope - - scope in which this resource is defined. This parameter is required.

id - - scoped id of the resource. This parameter is required.

props - - resource properties. This parameter is required.

Method Detail

inspect

@Stability(value=Stable)
public void inspect(@NotNull
                                             TreeInspector inspector)

Examines the CloudFormation resource and discloses attributes.

Specified by:

inspect in interface IInspectable

Parameters:

inspector - - tree inspector to collect and process attributes. This parameter is required.

renderProperties

@Stability(value=Stable)
 @NotNull
protected Map<String,Object> renderProperties(@NotNull
                                                                                 Map<String,Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getApplicationSource

@Stability(value=Stable)
 @NotNull
public Object getApplicationSource()

`AWS::AutoScalingPlans::ScalingPlan.ApplicationSource`.

setApplicationSource

@Stability(value=Stable)
public void setApplicationSource(@NotNull
                                                          CfnScalingPlan.ApplicationSourceProperty value)

`AWS::AutoScalingPlans::ScalingPlan.ApplicationSource`.

setApplicationSource

@Stability(value=Stable)
public void setApplicationSource(@NotNull
                                                          IResolvable value)

`AWS::AutoScalingPlans::ScalingPlan.ApplicationSource`.

getAttrScalingPlanName

@Stability(value=Stable)
 @NotNull
public String getAttrScalingPlanName()

getAttrScalingPlanVersion

@Stability(value=Stable)
 @NotNull
public String getAttrScalingPlanVersion()

getCfnProperties

@Stability(value=Stable)
 @NotNull
protected Map<String,Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getScalingInstructions

@Stability(value=Stable)
 @NotNull
public Object getScalingInstructions()

`AWS::AutoScalingPlans::ScalingPlan.ScalingInstructions`.

setScalingInstructions

@Stability(value=Stable)
public void setScalingInstructions(@NotNull
                                                            IResolvable value)

`AWS::AutoScalingPlans::ScalingPlan.ScalingInstructions`.

setScalingInstructions

@Stability(value=Stable)
public void setScalingInstructions(@NotNull
                                                            List<Object> value)

`AWS::AutoScalingPlans::ScalingPlan.ScalingInstructions`.