Package software.amazon.awscdk.cfnpropertymixins.services.autoscaling

Class CfnScalingPolicyMixinProps.Jsii$Proxy

java.lang.Object

software.amazon.jsii.JsiiObject

software.amazon.awscdk.cfnpropertymixins.services.autoscaling.CfnScalingPolicyMixinProps.Jsii$Proxy

All Implemented Interfaces:

CfnScalingPolicyMixinProps, software.amazon.jsii.JsiiSerializable

Enclosing interface:

CfnScalingPolicyMixinProps

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

An implementation for CfnScalingPolicyMixinProps

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.autoscaling.CfnScalingPolicyMixinProps

CfnScalingPolicyMixinProps.Builder, CfnScalingPolicyMixinProps.Jsii$Proxy

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	Jsii$Proxy(CfnScalingPolicyMixinProps.Builder builder)	Constructor that initializes the object based on literal property values passed by the CfnScalingPolicyMixinProps.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 String	getAdjustmentType()	Specifies how the scaling adjustment is interpreted (for example, an absolute number or a percentage).
final Object	getAutoScalingGroupName()	The name of the Auto Scaling group.
final String	getCooldown()	A cooldown period, in seconds, that applies to a specific simple scaling policy.
final Number	getEstimatedInstanceWarmup()	Not needed if the default instance warmup is defined for the group..
final String	getMetricAggregationType()	The aggregation type for the CloudWatch metrics.
final Number	getMinAdjustmentMagnitude()	The minimum value to scale by when the adjustment type is PercentChangeInCapacity .
final String	getPolicyType()	One of the following policy types:.
final Object	getPredictiveScalingConfiguration()	A predictive scaling policy.
final Number	getScalingAdjustment()	The amount by which to scale, based on the specified adjustment type.
final Object	getStepAdjustments()	A set of adjustments that enable you to scale based on the size of the alarm breach.
final Object	getTargetTrackingConfiguration()	A target tracking scaling policy.
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(CfnScalingPolicyMixinProps.Builder builder)

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

Method Details

getAdjustmentType

public final String getAdjustmentType()

Description copied from interface: CfnScalingPolicyMixinProps

Specifies how the scaling adjustment is interpreted (for example, an absolute number or a percentage).

The valid values are ChangeInCapacity , ExactCapacity , and PercentChangeInCapacity .

Required if the policy type is StepScaling or SimpleScaling . For more information, see Scaling adjustment types in the Amazon EC2 Auto Scaling User Guide .

Specified by:

getAdjustmentType in interface CfnScalingPolicyMixinProps

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-autoscaling-scalingpolicy.html#cfn-autoscaling-scalingpolicy-adjustmenttype

getAutoScalingGroupName

public final Object getAutoScalingGroupName()

Description copied from interface: CfnScalingPolicyMixinProps

The name of the Auto Scaling group.

Returns union: either String or IAutoScalingGroupRef

Specified by:

getAutoScalingGroupName in interface CfnScalingPolicyMixinProps

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-autoscaling-scalingpolicy.html#cfn-autoscaling-scalingpolicy-autoscalinggroupname

getCooldown

public final String getCooldown()

Description copied from interface: CfnScalingPolicyMixinProps

A cooldown period, in seconds, that applies to a specific simple scaling policy.

When a cooldown period is specified here, it overrides the default cooldown.

Valid only if the policy type is SimpleScaling . For more information, see Scaling cooldowns for Amazon EC2 Auto Scaling in the Amazon EC2 Auto Scaling User Guide .

Default: None

Specified by:

getCooldown in interface CfnScalingPolicyMixinProps

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-autoscaling-scalingpolicy.html#cfn-autoscaling-scalingpolicy-cooldown

getEstimatedInstanceWarmup

public final Number getEstimatedInstanceWarmup()

Description copied from interface: CfnScalingPolicyMixinProps

Not needed if the default instance warmup is defined for the group..

The estimated time, in seconds, until a newly launched instance can contribute to the CloudWatch metrics. This warm-up period applies to instances launched due to a specific target tracking or step scaling policy. When a warm-up period is specified here, it overrides the default instance warmup.

Valid only if the policy type is TargetTrackingScaling or StepScaling .

The default is to use the value for the default instance warmup defined for the group. If default instance warmup is null, then EstimatedInstanceWarmup falls back to the value of default cooldown.

Specified by:

getEstimatedInstanceWarmup in interface CfnScalingPolicyMixinProps

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-autoscaling-scalingpolicy.html#cfn-autoscaling-scalingpolicy-estimatedinstancewarmup

getMetricAggregationType

public final String getMetricAggregationType()

Description copied from interface: CfnScalingPolicyMixinProps

The aggregation type for the CloudWatch metrics.

The valid values are Minimum , Maximum , and Average . If the aggregation type is null, the value is treated as Average .

Valid only if the policy type is StepScaling .

Specified by:

getMetricAggregationType in interface CfnScalingPolicyMixinProps

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-autoscaling-scalingpolicy.html#cfn-autoscaling-scalingpolicy-metricaggregationtype

getMinAdjustmentMagnitude

public final Number getMinAdjustmentMagnitude()

Description copied from interface: CfnScalingPolicyMixinProps

The minimum value to scale by when the adjustment type is PercentChangeInCapacity .

For example, suppose that you create a step scaling policy to scale out an Auto Scaling group by 25 percent and you specify a MinAdjustmentMagnitude of 2. If the group has 4 instances and the scaling policy is performed, 25 percent of 4 is 1. However, because you specified a MinAdjustmentMagnitude of 2, Amazon EC2 Auto Scaling scales out the group by 2 instances.

Valid only if the policy type is StepScaling or SimpleScaling . For more information, see Scaling adjustment types in the Amazon EC2 Auto Scaling User Guide .

Some Auto Scaling groups use instance weights. In this case, set the MinAdjustmentMagnitude to a value that is at least as large as your largest instance weight.

Specified by:

getMinAdjustmentMagnitude in interface CfnScalingPolicyMixinProps

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-autoscaling-scalingpolicy.html#cfn-autoscaling-scalingpolicy-minadjustmentmagnitude

getPolicyType

public final String getPolicyType()

Description copied from interface: CfnScalingPolicyMixinProps

One of the following policy types:.

• TargetTrackingScaling
• StepScaling
• SimpleScaling (default)
• PredictiveScaling

Specified by:

getPolicyType in interface CfnScalingPolicyMixinProps

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-autoscaling-scalingpolicy.html#cfn-autoscaling-scalingpolicy-policytype

getPredictiveScalingConfiguration

public final Object getPredictiveScalingConfiguration()

Description copied from interface: CfnScalingPolicyMixinProps

A predictive scaling policy. Provides support for predefined and custom metrics.

Predefined metrics include CPU utilization, network in/out, and the Application Load Balancer request count.

Required if the policy type is PredictiveScaling .

Returns union: either IResolvable or CfnScalingPolicyPropsMixin.PredictiveScalingConfigurationProperty

Specified by:

getPredictiveScalingConfiguration in interface CfnScalingPolicyMixinProps

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-autoscaling-scalingpolicy.html#cfn-autoscaling-scalingpolicy-predictivescalingconfiguration

getScalingAdjustment

public final Number getScalingAdjustment()

Description copied from interface: CfnScalingPolicyMixinProps

The amount by which to scale, based on the specified adjustment type.

A positive value adds to the current capacity while a negative number removes from the current capacity. For exact capacity, you must specify a non-negative value.

Required if the policy type is SimpleScaling . (Not used with any other policy type.)

Specified by:

getScalingAdjustment in interface CfnScalingPolicyMixinProps

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-autoscaling-scalingpolicy.html#cfn-autoscaling-scalingpolicy-scalingadjustment

getStepAdjustments

public final Object getStepAdjustments()

Description copied from interface: CfnScalingPolicyMixinProps

A set of adjustments that enable you to scale based on the size of the alarm breach.

Required if the policy type is StepScaling . (Not used with any other policy type.)

Returns union: either IResolvable or Listinvalid input: '<'either IResolvable or CfnScalingPolicyPropsMixin.StepAdjustmentProperty>

Specified by:

getStepAdjustments in interface CfnScalingPolicyMixinProps

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-autoscaling-scalingpolicy.html#cfn-autoscaling-scalingpolicy-stepadjustments

getTargetTrackingConfiguration

public final Object getTargetTrackingConfiguration()

Description copied from interface: CfnScalingPolicyMixinProps

A target tracking scaling policy. Provides support for predefined or custom metrics.

The following predefined metrics are available:

• ASGAverageCPUUtilization
• ASGAverageNetworkIn
• ASGAverageNetworkOut
• ALBRequestCountPerTarget

If you specify ALBRequestCountPerTarget for the metric, you must specify the ResourceLabel property with the PredefinedMetricSpecification .

Required if the policy type is TargetTrackingScaling .

Returns union: either IResolvable or CfnScalingPolicyPropsMixin.TargetTrackingConfigurationProperty

Specified by:

getTargetTrackingConfiguration in interface CfnScalingPolicyMixinProps

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-autoscaling-scalingpolicy.html#cfn-autoscaling-scalingpolicy-targettrackingconfiguration

$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