Package software.amazon.awscdk.cfnpropertymixins.services.autoscalingplans

Class CfnScalingPlanPropsMixin.ScalingInstructionProperty.Jsii$Proxy

java.lang.Object

software.amazon.jsii.JsiiObject

software.amazon.awscdk.cfnpropertymixins.services.autoscalingplans.CfnScalingPlanPropsMixin.ScalingInstructionProperty.Jsii$Proxy

All Implemented Interfaces:

CfnScalingPlanPropsMixin.ScalingInstructionProperty, software.amazon.jsii.JsiiSerializable

Enclosing interface:

CfnScalingPlanPropsMixin.ScalingInstructionProperty

@Stability(Stable)
@Internal
public static final class CfnScalingPlanPropsMixin.ScalingInstructionProperty.Jsii$Proxy
extends software.amazon.jsii.JsiiObject
implements CfnScalingPlanPropsMixin.ScalingInstructionProperty

An implementation for CfnScalingPlanPropsMixin.ScalingInstructionProperty

Nested Class Summary

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

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.amazon.awscdk.cfnpropertymixins.services.autoscalingplans.CfnScalingPlanPropsMixin.ScalingInstructionProperty

CfnScalingPlanPropsMixin.ScalingInstructionProperty.Builder, CfnScalingPlanPropsMixin.ScalingInstructionProperty.Jsii$Proxy

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	Jsii$Proxy(CfnScalingPlanPropsMixin.ScalingInstructionProperty.Builder builder)	Constructor that initializes the object based on literal property values passed by the CfnScalingPlanPropsMixin.ScalingInstructionProperty.Builder.
protected	Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef)	Constructor that initializes the object based on values retrieved from the JsiiObject.

Method Summary

Modifier and Type	Method	Description
com.fasterxml.jackson.databind.JsonNode	$jsii$toJson()
final boolean	equals(Object o)
final Object	getCustomizedLoadMetricSpecification()	The customized load metric to use for predictive scaling.
final Object	getDisableDynamicScaling()	Controls whether dynamic scaling is disabled.
final Number	getMaxCapacity()	The maximum capacity of the resource.
final Number	getMinCapacity()	The minimum capacity of the resource.
final Object	getPredefinedLoadMetricSpecification()	The predefined load metric to use for predictive scaling.
final String	getPredictiveScalingMaxCapacityBehavior()	Defines the behavior that should be applied if the forecast capacity approaches or exceeds the maximum capacity specified for the resource.
final Number	getPredictiveScalingMaxCapacityBuffer()	The size of the capacity buffer to use when the forecast capacity is close to or exceeds the maximum capacity.
final String	getPredictiveScalingMode()	The predictive scaling mode.
final String	getResourceId()	The ID of the resource.
final String	getScalableDimension()	The scalable dimension associated with the resource.
final String	getScalingPolicyUpdateBehavior()	Controls whether a resource's externally created scaling policies are deleted and new target tracking scaling policies created.
final Number	getScheduledActionBufferTime()	The amount of time, in seconds, to buffer the run time of scheduled scaling actions when scaling out.
final String	getServiceNamespace()	The namespace of the AWS service.
final Object	getTargetTrackingConfigurations()	The target tracking configurations (up to 10).
final int	hashCode()

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, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Details

Jsii$Proxy

protected Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef)

Constructor that initializes the object based on values retrieved from the JsiiObject.

Parameters:

objRef - Reference to the JSII managed object.

Jsii$Proxy

protected Jsii$Proxy(CfnScalingPlanPropsMixin.ScalingInstructionProperty.Builder builder)

Constructor that initializes the object based on literal property values passed by the CfnScalingPlanPropsMixin.ScalingInstructionProperty.Builder.

Method Details

getCustomizedLoadMetricSpecification

public final Object getCustomizedLoadMetricSpecification()

Description copied from interface: CfnScalingPlanPropsMixin.ScalingInstructionProperty

The customized load metric to use for predictive scaling.

This property or a PredefinedLoadMetricSpecification is required when configuring predictive scaling, and cannot be used otherwise.

Returns union: either IResolvable or CfnScalingPlanPropsMixin.CustomizedLoadMetricSpecificationProperty

Specified by:

getCustomizedLoadMetricSpecification in interface CfnScalingPlanPropsMixin.ScalingInstructionProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscalingplans-scalingplan-scalinginstruction.html#cfn-autoscalingplans-scalingplan-scalinginstruction-customizedloadmetricspecification

getDisableDynamicScaling

public final Object getDisableDynamicScaling()

Description copied from interface: CfnScalingPlanPropsMixin.ScalingInstructionProperty

Controls whether dynamic scaling is disabled.

When dynamic scaling is enabled, AWS Auto Scaling creates target tracking scaling policies based on the specified target tracking configurations.

The default is enabled ( false ).

Returns union: either Boolean or IResolvable

Specified by:

getDisableDynamicScaling in interface CfnScalingPlanPropsMixin.ScalingInstructionProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscalingplans-scalingplan-scalinginstruction.html#cfn-autoscalingplans-scalingplan-scalinginstruction-disabledynamicscaling

getMaxCapacity

public final Number getMaxCapacity()

Description copied from interface: CfnScalingPlanPropsMixin.ScalingInstructionProperty

The maximum capacity of the resource.

The exception to this upper limit is if you specify a non-default setting for PredictiveScalingMaxCapacityBehavior .

Specified by:

getMaxCapacity in interface CfnScalingPlanPropsMixin.ScalingInstructionProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscalingplans-scalingplan-scalinginstruction.html#cfn-autoscalingplans-scalingplan-scalinginstruction-maxcapacity

getMinCapacity

public final Number getMinCapacity()

Description copied from interface: CfnScalingPlanPropsMixin.ScalingInstructionProperty

The minimum capacity of the resource.

Specified by:

getMinCapacity in interface CfnScalingPlanPropsMixin.ScalingInstructionProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscalingplans-scalingplan-scalinginstruction.html#cfn-autoscalingplans-scalingplan-scalinginstruction-mincapacity

getPredefinedLoadMetricSpecification

public final Object getPredefinedLoadMetricSpecification()

Description copied from interface: CfnScalingPlanPropsMixin.ScalingInstructionProperty

The predefined load metric to use for predictive scaling.

This property or a CustomizedLoadMetricSpecification is required when configuring predictive scaling, and cannot be used otherwise.

Returns union: either IResolvable or CfnScalingPlanPropsMixin.PredefinedLoadMetricSpecificationProperty

Specified by:

getPredefinedLoadMetricSpecification in interface CfnScalingPlanPropsMixin.ScalingInstructionProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscalingplans-scalingplan-scalinginstruction.html#cfn-autoscalingplans-scalingplan-scalinginstruction-predefinedloadmetricspecification

getPredictiveScalingMaxCapacityBehavior

public final String getPredictiveScalingMaxCapacityBehavior()

Description copied from interface: CfnScalingPlanPropsMixin.ScalingInstructionProperty

Defines the behavior that should be applied if the forecast capacity approaches or exceeds the maximum capacity specified for the resource.

The default value is SetForecastCapacityToMaxCapacity .

The following are possible values:

• SetForecastCapacityToMaxCapacity - AWS Auto Scaling cannot scale resource capacity higher than the maximum capacity. The maximum capacity is enforced as a hard limit.
• SetMaxCapacityToForecastCapacity - AWS Auto Scaling can scale resource capacity higher than the maximum capacity to equal but not exceed forecast capacity.
• SetMaxCapacityAboveForecastCapacity - AWS Auto Scaling can scale resource capacity higher than the maximum capacity by a specified buffer value. The intention is to give the target tracking scaling policy extra capacity if unexpected traffic occurs.

Valid only when configuring predictive scaling.

Specified by:

getPredictiveScalingMaxCapacityBehavior in interface CfnScalingPlanPropsMixin.ScalingInstructionProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscalingplans-scalingplan-scalinginstruction.html#cfn-autoscalingplans-scalingplan-scalinginstruction-predictivescalingmaxcapacitybehavior

getPredictiveScalingMaxCapacityBuffer

public final Number getPredictiveScalingMaxCapacityBuffer()

Description copied from interface: CfnScalingPlanPropsMixin.ScalingInstructionProperty

The size of the capacity buffer to use when the forecast capacity is close to or exceeds the maximum capacity.

The value is specified as a percentage relative to the forecast capacity. For example, if the buffer is 10, this means a 10 percent buffer. With a 10 percent buffer, if the forecast capacity is 50, and the maximum capacity is 40, then the effective maximum capacity is 55.

Valid only when configuring predictive scaling. Required if PredictiveScalingMaxCapacityBehavior is set to SetMaxCapacityAboveForecastCapacity , and cannot be used otherwise.

The range is 1-100.

Specified by:

getPredictiveScalingMaxCapacityBuffer in interface CfnScalingPlanPropsMixin.ScalingInstructionProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscalingplans-scalingplan-scalinginstruction.html#cfn-autoscalingplans-scalingplan-scalinginstruction-predictivescalingmaxcapacitybuffer

getPredictiveScalingMode

public final String getPredictiveScalingMode()

Description copied from interface: CfnScalingPlanPropsMixin.ScalingInstructionProperty

The predictive scaling mode.

The default value is ForecastAndScale . Otherwise, AWS Auto Scaling forecasts capacity but does not apply any scheduled scaling actions based on the capacity forecast.

Specified by:

getPredictiveScalingMode in interface CfnScalingPlanPropsMixin.ScalingInstructionProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscalingplans-scalingplan-scalinginstruction.html#cfn-autoscalingplans-scalingplan-scalinginstruction-predictivescalingmode

getResourceId

public final String getResourceId()

Description copied from interface: CfnScalingPlanPropsMixin.ScalingInstructionProperty

The ID of the resource. This string consists of the resource type and unique identifier.

• Auto Scaling group - The resource type is autoScalingGroup and the unique identifier is the name of the Auto Scaling group. Example: autoScalingGroup/my-asg .
• ECS service - The resource type is service and the unique identifier is the cluster name and service name. Example: service/default/sample-webapp .
• Spot Fleet request - The resource type is spot-fleet-request and the unique identifier is the Spot Fleet request ID. Example: spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE .
• DynamoDB table - The resource type is table and the unique identifier is the resource ID. Example: table/my-table .
• DynamoDB global secondary index - The resource type is index and the unique identifier is the resource ID. Example: table/my-table/index/my-table-index .
• Aurora DB cluster - The resource type is cluster and the unique identifier is the cluster name. Example: cluster:my-db-cluster .

Specified by:

getResourceId in interface CfnScalingPlanPropsMixin.ScalingInstructionProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscalingplans-scalingplan-scalinginstruction.html#cfn-autoscalingplans-scalingplan-scalinginstruction-resourceid

getScalableDimension

public final String getScalableDimension()

Description copied from interface: CfnScalingPlanPropsMixin.ScalingInstructionProperty

The scalable dimension associated with the resource.

• autoscaling:autoScalingGroup:DesiredCapacity - The desired capacity of an Auto Scaling group.
• ecs:service:DesiredCount - The desired task count of an ECS service.
• ec2:spot-fleet-request:TargetCapacity - The target capacity of a Spot Fleet request.
• dynamodb:table:ReadCapacityUnits - The provisioned read capacity for a DynamoDB table.
• dynamodb:table:WriteCapacityUnits - The provisioned write capacity for a DynamoDB table.
• dynamodb:index:ReadCapacityUnits - The provisioned read capacity for a DynamoDB global secondary index.
• dynamodb:index:WriteCapacityUnits - The provisioned write capacity for a DynamoDB global secondary index.
• rds:cluster:ReadReplicaCount - The count of Aurora Replicas in an Aurora DB cluster. Available for Aurora MySQL-compatible edition and Aurora PostgreSQL-compatible edition.

Specified by:

getScalableDimension in interface CfnScalingPlanPropsMixin.ScalingInstructionProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscalingplans-scalingplan-scalinginstruction.html#cfn-autoscalingplans-scalingplan-scalinginstruction-scalabledimension

getScalingPolicyUpdateBehavior

public final String getScalingPolicyUpdateBehavior()

Description copied from interface: CfnScalingPlanPropsMixin.ScalingInstructionProperty

Controls whether a resource's externally created scaling policies are deleted and new target tracking scaling policies created.

The default value is KeepExternalPolicies .

Valid only when configuring dynamic scaling.

Specified by:

getScalingPolicyUpdateBehavior in interface CfnScalingPlanPropsMixin.ScalingInstructionProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscalingplans-scalingplan-scalinginstruction.html#cfn-autoscalingplans-scalingplan-scalinginstruction-scalingpolicyupdatebehavior

getScheduledActionBufferTime

public final Number getScheduledActionBufferTime()

Description copied from interface: CfnScalingPlanPropsMixin.ScalingInstructionProperty

The amount of time, in seconds, to buffer the run time of scheduled scaling actions when scaling out.

For example, if the forecast says to add capacity at 10:00 AM, and the buffer time is 5 minutes, then the run time of the corresponding scheduled scaling action will be 9:55 AM. The intention is to give resources time to be provisioned. For example, it can take a few minutes to launch an EC2 instance. The actual amount of time required depends on several factors, such as the size of the instance and whether there are startup scripts to complete.

The value must be less than the forecast interval duration of 3600 seconds (60 minutes). The default is 300 seconds.

Valid only when configuring predictive scaling.

Specified by:

getScheduledActionBufferTime in interface CfnScalingPlanPropsMixin.ScalingInstructionProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscalingplans-scalingplan-scalinginstruction.html#cfn-autoscalingplans-scalingplan-scalinginstruction-scheduledactionbuffertime

getServiceNamespace

public final String getServiceNamespace()

Description copied from interface: CfnScalingPlanPropsMixin.ScalingInstructionProperty

The namespace of the AWS service.

Specified by:

getServiceNamespace in interface CfnScalingPlanPropsMixin.ScalingInstructionProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscalingplans-scalingplan-scalinginstruction.html#cfn-autoscalingplans-scalingplan-scalinginstruction-servicenamespace

getTargetTrackingConfigurations

public final Object getTargetTrackingConfigurations()

Description copied from interface: CfnScalingPlanPropsMixin.ScalingInstructionProperty

The target tracking configurations (up to 10).

Each of these structures must specify a unique scaling metric and a target value for the metric.

Returns union: either IResolvable or Listinvalid input: '<'either IResolvable or CfnScalingPlanPropsMixin.TargetTrackingConfigurationProperty>

Specified by:

getTargetTrackingConfigurations in interface CfnScalingPlanPropsMixin.ScalingInstructionProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscalingplans-scalingplan-scalinginstruction.html#cfn-autoscalingplans-scalingplan-scalinginstruction-targettrackingconfigurations

$jsii$toJson

@Internal
public com.fasterxml.jackson.databind.JsonNode $jsii$toJson()

Specified by:

$jsii$toJson in interface software.amazon.jsii.JsiiSerializable

equals

public final boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public final int hashCode()

Overrides:

hashCode in class Object