Package software.amazon.awscdk.services.autoscalingplans

Class CfnScalingPlan.ScalingInstructionProperty.Builder

java.lang.Object

software.amazon.awscdk.services.autoscalingplans.CfnScalingPlan.ScalingInstructionProperty.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnScalingPlan.ScalingInstructionProperty>

Enclosing interface:

CfnScalingPlan.ScalingInstructionProperty

@Stability(Stable)
public static final class CfnScalingPlan.ScalingInstructionProperty.Builder
extends Object
implements software.amazon.jsii.Builder<CfnScalingPlan.ScalingInstructionProperty>

A builder for CfnScalingPlan.ScalingInstructionProperty

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
CfnScalingPlan.ScalingInstructionProperty	build()	Builds the configured instance.
CfnScalingPlan.ScalingInstructionProperty.Builder	customizedLoadMetricSpecification(IResolvable customizedLoadMetricSpecification)	Sets the value of CfnScalingPlan.ScalingInstructionProperty.getCustomizedLoadMetricSpecification()
CfnScalingPlan.ScalingInstructionProperty.Builder	customizedLoadMetricSpecification(CfnScalingPlan.CustomizedLoadMetricSpecificationProperty customizedLoadMetricSpecification)	Sets the value of CfnScalingPlan.ScalingInstructionProperty.getCustomizedLoadMetricSpecification()
CfnScalingPlan.ScalingInstructionProperty.Builder	disableDynamicScaling(Boolean disableDynamicScaling)	Sets the value of CfnScalingPlan.ScalingInstructionProperty.getDisableDynamicScaling()
CfnScalingPlan.ScalingInstructionProperty.Builder	disableDynamicScaling(IResolvable disableDynamicScaling)	Sets the value of CfnScalingPlan.ScalingInstructionProperty.getDisableDynamicScaling()
CfnScalingPlan.ScalingInstructionProperty.Builder	maxCapacity(Number maxCapacity)	Sets the value of CfnScalingPlan.ScalingInstructionProperty.getMaxCapacity()
CfnScalingPlan.ScalingInstructionProperty.Builder	minCapacity(Number minCapacity)	Sets the value of CfnScalingPlan.ScalingInstructionProperty.getMinCapacity()
CfnScalingPlan.ScalingInstructionProperty.Builder	predefinedLoadMetricSpecification(IResolvable predefinedLoadMetricSpecification)	Sets the value of CfnScalingPlan.ScalingInstructionProperty.getPredefinedLoadMetricSpecification()
CfnScalingPlan.ScalingInstructionProperty.Builder	predefinedLoadMetricSpecification(CfnScalingPlan.PredefinedLoadMetricSpecificationProperty predefinedLoadMetricSpecification)	Sets the value of CfnScalingPlan.ScalingInstructionProperty.getPredefinedLoadMetricSpecification()
CfnScalingPlan.ScalingInstructionProperty.Builder	predictiveScalingMaxCapacityBehavior(String predictiveScalingMaxCapacityBehavior)	Sets the value of CfnScalingPlan.ScalingInstructionProperty.getPredictiveScalingMaxCapacityBehavior()
CfnScalingPlan.ScalingInstructionProperty.Builder	predictiveScalingMaxCapacityBuffer(Number predictiveScalingMaxCapacityBuffer)	Sets the value of CfnScalingPlan.ScalingInstructionProperty.getPredictiveScalingMaxCapacityBuffer()
CfnScalingPlan.ScalingInstructionProperty.Builder	predictiveScalingMode(String predictiveScalingMode)	Sets the value of CfnScalingPlan.ScalingInstructionProperty.getPredictiveScalingMode()
CfnScalingPlan.ScalingInstructionProperty.Builder	resourceId(String resourceId)	Sets the value of CfnScalingPlan.ScalingInstructionProperty.getResourceId()
CfnScalingPlan.ScalingInstructionProperty.Builder	scalableDimension(String scalableDimension)	Sets the value of CfnScalingPlan.ScalingInstructionProperty.getScalableDimension()
CfnScalingPlan.ScalingInstructionProperty.Builder	scalingPolicyUpdateBehavior(String scalingPolicyUpdateBehavior)	Sets the value of CfnScalingPlan.ScalingInstructionProperty.getScalingPolicyUpdateBehavior()
CfnScalingPlan.ScalingInstructionProperty.Builder	scheduledActionBufferTime(Number scheduledActionBufferTime)	Sets the value of CfnScalingPlan.ScalingInstructionProperty.getScheduledActionBufferTime()
CfnScalingPlan.ScalingInstructionProperty.Builder	serviceNamespace(String serviceNamespace)	Sets the value of CfnScalingPlan.ScalingInstructionProperty.getServiceNamespace()
CfnScalingPlan.ScalingInstructionProperty.Builder	targetTrackingConfigurations(List<? extends Object> targetTrackingConfigurations)	Sets the value of CfnScalingPlan.ScalingInstructionProperty.getTargetTrackingConfigurations()
CfnScalingPlan.ScalingInstructionProperty.Builder	targetTrackingConfigurations(IResolvable targetTrackingConfigurations)	Sets the value of CfnScalingPlan.ScalingInstructionProperty.getTargetTrackingConfigurations()

Methods inherited from class java.lang.Object

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

Constructor Details

Builder

public Builder()

Method Details

maxCapacity

@Stability(Stable)
public CfnScalingPlan.ScalingInstructionProperty.Builder maxCapacity(Number maxCapacity)

Sets the value of CfnScalingPlan.ScalingInstructionProperty.getMaxCapacity()

Parameters:

maxCapacity - The maximum capacity of the resource. This parameter is required. The exception to this upper limit is if you specify a non-default setting for PredictiveScalingMaxCapacityBehavior .

Returns:

this

minCapacity

@Stability(Stable)
public CfnScalingPlan.ScalingInstructionProperty.Builder minCapacity(Number minCapacity)

Sets the value of CfnScalingPlan.ScalingInstructionProperty.getMinCapacity()

Parameters:

minCapacity - The minimum capacity of the resource. This parameter is required.

Returns:

this

resourceId

@Stability(Stable)
public CfnScalingPlan.ScalingInstructionProperty.Builder resourceId(String resourceId)

Sets the value of CfnScalingPlan.ScalingInstructionProperty.getResourceId()

Parameters:

resourceId - The ID of the resource. This string consists of the resource type and unique identifier. This parameter is required.

• 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 .

Returns:

this

scalableDimension

@Stability(Stable)
public CfnScalingPlan.ScalingInstructionProperty.Builder scalableDimension(String scalableDimension)

Sets the value of CfnScalingPlan.ScalingInstructionProperty.getScalableDimension()

Parameters:

scalableDimension - The scalable dimension associated with the resource. This parameter is required.

• 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.

Returns:

this

serviceNamespace

@Stability(Stable)
public CfnScalingPlan.ScalingInstructionProperty.Builder serviceNamespace(String serviceNamespace)

Sets the value of CfnScalingPlan.ScalingInstructionProperty.getServiceNamespace()

Parameters:

serviceNamespace - The namespace of the AWS service. This parameter is required.

Returns:

this

targetTrackingConfigurations

@Stability(Stable)
public CfnScalingPlan.ScalingInstructionProperty.Builder targetTrackingConfigurations(IResolvable targetTrackingConfigurations)

Sets the value of CfnScalingPlan.ScalingInstructionProperty.getTargetTrackingConfigurations()

Parameters:

targetTrackingConfigurations - The target tracking configurations (up to 10). This parameter is required. Each of these structures must specify a unique scaling metric and a target value for the metric.

Returns:

this

targetTrackingConfigurations

@Stability(Stable)
public CfnScalingPlan.ScalingInstructionProperty.Builder targetTrackingConfigurations(List<? extends Object> targetTrackingConfigurations)

Sets the value of CfnScalingPlan.ScalingInstructionProperty.getTargetTrackingConfigurations()

Parameters:

targetTrackingConfigurations - The target tracking configurations (up to 10). This parameter is required. Each of these structures must specify a unique scaling metric and a target value for the metric.

Returns:

this

customizedLoadMetricSpecification

@Stability(Stable)
public CfnScalingPlan.ScalingInstructionProperty.Builder customizedLoadMetricSpecification(IResolvable customizedLoadMetricSpecification)

Sets the value of CfnScalingPlan.ScalingInstructionProperty.getCustomizedLoadMetricSpecification()

Parameters:

customizedLoadMetricSpecification - 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:

this

customizedLoadMetricSpecification

@Stability(Stable)
public CfnScalingPlan.ScalingInstructionProperty.Builder customizedLoadMetricSpecification(CfnScalingPlan.CustomizedLoadMetricSpecificationProperty customizedLoadMetricSpecification)

Sets the value of CfnScalingPlan.ScalingInstructionProperty.getCustomizedLoadMetricSpecification()

Parameters:

customizedLoadMetricSpecification - 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:

this

disableDynamicScaling

@Stability(Stable)
public CfnScalingPlan.ScalingInstructionProperty.Builder disableDynamicScaling(Boolean disableDynamicScaling)

Sets the value of CfnScalingPlan.ScalingInstructionProperty.getDisableDynamicScaling()

Parameters:

disableDynamicScaling - Controls whether dynamic scaling by AWS Auto 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:

this

disableDynamicScaling

@Stability(Stable)
public CfnScalingPlan.ScalingInstructionProperty.Builder disableDynamicScaling(IResolvable disableDynamicScaling)

Sets the value of CfnScalingPlan.ScalingInstructionProperty.getDisableDynamicScaling()

Parameters:

disableDynamicScaling - Controls whether dynamic scaling by AWS Auto 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:

this

predefinedLoadMetricSpecification

@Stability(Stable)
public CfnScalingPlan.ScalingInstructionProperty.Builder predefinedLoadMetricSpecification(IResolvable predefinedLoadMetricSpecification)

Sets the value of CfnScalingPlan.ScalingInstructionProperty.getPredefinedLoadMetricSpecification()

Parameters:

predefinedLoadMetricSpecification - 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:

this

predefinedLoadMetricSpecification

@Stability(Stable)
public CfnScalingPlan.ScalingInstructionProperty.Builder predefinedLoadMetricSpecification(CfnScalingPlan.PredefinedLoadMetricSpecificationProperty predefinedLoadMetricSpecification)

Sets the value of CfnScalingPlan.ScalingInstructionProperty.getPredefinedLoadMetricSpecification()

Parameters:

predefinedLoadMetricSpecification - 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:

this

predictiveScalingMaxCapacityBehavior

@Stability(Stable)
public CfnScalingPlan.ScalingInstructionProperty.Builder predictiveScalingMaxCapacityBehavior(String predictiveScalingMaxCapacityBehavior)

Sets the value of CfnScalingPlan.ScalingInstructionProperty.getPredictiveScalingMaxCapacityBehavior()

Parameters:

predictiveScalingMaxCapacityBehavior - 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.

Returns:

this

predictiveScalingMaxCapacityBuffer

@Stability(Stable)
public CfnScalingPlan.ScalingInstructionProperty.Builder predictiveScalingMaxCapacityBuffer(Number predictiveScalingMaxCapacityBuffer)

Sets the value of CfnScalingPlan.ScalingInstructionProperty.getPredictiveScalingMaxCapacityBuffer()

Parameters:

predictiveScalingMaxCapacityBuffer - 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.

Returns:

this

predictiveScalingMode

@Stability(Stable)
public CfnScalingPlan.ScalingInstructionProperty.Builder predictiveScalingMode(String predictiveScalingMode)

Sets the value of CfnScalingPlan.ScalingInstructionProperty.getPredictiveScalingMode()

Parameters:

predictiveScalingMode - 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.

Returns:

this

scalingPolicyUpdateBehavior

@Stability(Stable)
public CfnScalingPlan.ScalingInstructionProperty.Builder scalingPolicyUpdateBehavior(String scalingPolicyUpdateBehavior)

Sets the value of CfnScalingPlan.ScalingInstructionProperty.getScalingPolicyUpdateBehavior()

Parameters:

scalingPolicyUpdateBehavior - Controls whether your scaling policies that are external to AWS Auto Scaling are deleted and new target tracking scaling policies created. The default value is KeepExternalPolicies .

Valid only when configuring dynamic scaling.

Returns:

this

scheduledActionBufferTime

@Stability(Stable)
public CfnScalingPlan.ScalingInstructionProperty.Builder scheduledActionBufferTime(Number scheduledActionBufferTime)

Sets the value of CfnScalingPlan.ScalingInstructionProperty.getScheduledActionBufferTime()

Parameters:

scheduledActionBufferTime - 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.

Returns:

this

build

@Stability(Stable)
public CfnScalingPlan.ScalingInstructionProperty build()

Builds the configured instance.

Specified by:

build in interface software.amazon.jsii.Builder<CfnScalingPlan.ScalingInstructionProperty>

Returns:

a new instance of CfnScalingPlan.ScalingInstructionProperty

Throws:

NullPointerException - if any required attribute was not provided