software.amazon.awscdk.services.applicationautoscaling

Class CfnScalingPolicy

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.applicationautoscaling.CfnScalingPolicy

All Implemented Interfaces:

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

@Generated(value="jsii-pacmak/1.47.0 (build 86d2c33)",
           date="2021-12-22T10:27:15.872Z")
 @Stability(value=Stable)
public class CfnScalingPolicy
extends CfnResource
implements IInspectable

A CloudFormation `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.*;
 CfnScalingPolicy cfnScalingPolicy = CfnScalingPolicy.Builder.create(this, "MyCfnScalingPolicy")
         .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	Class and Description
static class	CfnScalingPolicy.Builder A fluent builder for CfnScalingPolicy.
static interface	CfnScalingPolicy.CustomizedMetricSpecificationProperty Example:
static interface	CfnScalingPolicy.MetricDimensionProperty Example:
static interface	CfnScalingPolicy.PredefinedMetricSpecificationProperty Example:
static interface	CfnScalingPolicy.StepAdjustmentProperty Example:
static interface	CfnScalingPolicy.StepScalingPolicyConfigurationProperty Example:
static interface	CfnScalingPolicy.TargetTrackingScalingPolicyConfigurationProperty 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
	CfnScalingPolicy(software.constructs.Construct scope, String id, CfnScalingPolicyProps props) Create a new `AWS::ApplicationAutoScaling::ScalingPolicy`.
protected	CfnScalingPolicy(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnScalingPolicy(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
protected Map<String,Object>	getCfnProperties()
String	getPolicyName() `AWS::ApplicationAutoScaling::ScalingPolicy.PolicyName`.
String	getPolicyType() `AWS::ApplicationAutoScaling::ScalingPolicy.PolicyType`.
String	getResourceId() `AWS::ApplicationAutoScaling::ScalingPolicy.ResourceId`.
String	getScalableDimension() `AWS::ApplicationAutoScaling::ScalingPolicy.ScalableDimension`.
String	getScalingTargetId() `AWS::ApplicationAutoScaling::ScalingPolicy.ScalingTargetId`.
String	getServiceNamespace() `AWS::ApplicationAutoScaling::ScalingPolicy.ServiceNamespace`.
Object	getStepScalingPolicyConfiguration() `AWS::ApplicationAutoScaling::ScalingPolicy.StepScalingPolicyConfiguration`.
Object	getTargetTrackingScalingPolicyConfiguration() `AWS::ApplicationAutoScaling::ScalingPolicy.TargetTrackingScalingPolicyConfiguration`.
void	inspect(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setPolicyName(String value) `AWS::ApplicationAutoScaling::ScalingPolicy.PolicyName`.
void	setPolicyType(String value) `AWS::ApplicationAutoScaling::ScalingPolicy.PolicyType`.
void	setResourceId(String value) `AWS::ApplicationAutoScaling::ScalingPolicy.ResourceId`.
void	setScalableDimension(String value) `AWS::ApplicationAutoScaling::ScalingPolicy.ScalableDimension`.
void	setScalingTargetId(String value) `AWS::ApplicationAutoScaling::ScalingPolicy.ScalingTargetId`.
void	setServiceNamespace(String value) `AWS::ApplicationAutoScaling::ScalingPolicy.ServiceNamespace`.
void	setStepScalingPolicyConfiguration(CfnScalingPolicy.StepScalingPolicyConfigurationProperty value) `AWS::ApplicationAutoScaling::ScalingPolicy.StepScalingPolicyConfiguration`.
void	setStepScalingPolicyConfiguration(IResolvable value) `AWS::ApplicationAutoScaling::ScalingPolicy.StepScalingPolicyConfiguration`.
void	setTargetTrackingScalingPolicyConfiguration(CfnScalingPolicy.TargetTrackingScalingPolicyConfigurationProperty value) `AWS::ApplicationAutoScaling::ScalingPolicy.TargetTrackingScalingPolicyConfiguration`.
void	setTargetTrackingScalingPolicyConfiguration(IResolvable value) `AWS::ApplicationAutoScaling::ScalingPolicy.TargetTrackingScalingPolicyConfiguration`.

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

CfnScalingPolicy

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

CfnScalingPolicy

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

CfnScalingPolicy

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

Create a new `AWS::ApplicationAutoScaling::ScalingPolicy`.

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.

getCfnProperties

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

Overrides:

getCfnProperties in class CfnResource

getPolicyName

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

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

setPolicyName

@Stability(value=Stable)
public void setPolicyName(@NotNull
                                                   String value)

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

getPolicyType

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

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

setPolicyType

@Stability(value=Stable)
public void setPolicyType(@NotNull
                                                   String value)

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

getResourceId

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

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

setResourceId

@Stability(value=Stable)
public void setResourceId(@Nullable
                                                   String value)

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

getScalableDimension

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

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

setScalableDimension

@Stability(value=Stable)
public void setScalableDimension(@Nullable
                                                          String value)

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

getScalingTargetId

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

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

setScalingTargetId

@Stability(value=Stable)
public void setScalingTargetId(@Nullable
                                                        String value)

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

getServiceNamespace

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

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

setServiceNamespace

@Stability(value=Stable)
public void setServiceNamespace(@Nullable
                                                         String value)

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

getStepScalingPolicyConfiguration

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

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

setStepScalingPolicyConfiguration

@Stability(value=Stable)
public void setStepScalingPolicyConfiguration(@Nullable
                                                                       CfnScalingPolicy.StepScalingPolicyConfigurationProperty value)

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

setStepScalingPolicyConfiguration

@Stability(value=Stable)
public void setStepScalingPolicyConfiguration(@Nullable
                                                                       IResolvable value)

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

getTargetTrackingScalingPolicyConfiguration

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

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

setTargetTrackingScalingPolicyConfiguration

@Stability(value=Stable)
public void setTargetTrackingScalingPolicyConfiguration(@Nullable
                                                                                 CfnScalingPolicy.TargetTrackingScalingPolicyConfigurationProperty value)

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

setTargetTrackingScalingPolicyConfiguration

@Stability(value=Stable)
public void setTargetTrackingScalingPolicyConfiguration(@Nullable
                                                                                 IResolvable value)

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