software.amazon.awscdk.services.applicationautoscaling

Class ScalableTarget.Builder

java.lang.Object

software.amazon.awscdk.services.applicationautoscaling.ScalableTarget.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<ScalableTarget>

Enclosing class:

ScalableTarget

@Stability(value=Experimental)
public static final class ScalableTarget.Builder
extends Object
implements software.amazon.jsii.Builder<ScalableTarget>

(experimental) A fluent builder for ScalableTarget.

Method Summary

Modifier and Type	Method and Description
ScalableTarget	build()
static ScalableTarget.Builder	create(software.constructs.Construct scope, String id)
ScalableTarget.Builder	maxCapacity(Number maxCapacity) (experimental) The maximum value that Application Auto Scaling can use to scale a target during a scaling activity.
ScalableTarget.Builder	minCapacity(Number minCapacity) (experimental) The minimum value that Application Auto Scaling can use to scale a target during a scaling activity.
ScalableTarget.Builder	resourceId(String resourceId) (experimental) The resource identifier to associate with this scalable target.
ScalableTarget.Builder	role(IRole role) (experimental) Role that allows Application Auto Scaling to modify your scalable target.
ScalableTarget.Builder	scalableDimension(String scalableDimension) (experimental) The scalable dimension that's associated with the scalable target.
ScalableTarget.Builder	serviceNamespace(ServiceNamespace serviceNamespace) (experimental) The namespace of the AWS service that provides the resource or custom-resource for a resource provided by your own application or service.

Methods inherited from class java.lang.Object

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

Method Detail

create

@Stability(value=Experimental)
public static ScalableTarget.Builder create(software.constructs.Construct scope,
                                                                           String id)

Parameters:

scope - This parameter is required.

id - This parameter is required.

Returns:

a new instance of ScalableTarget.Builder.

maxCapacity

@Stability(value=Experimental)
public ScalableTarget.Builder maxCapacity(Number maxCapacity)

(experimental) The maximum value that Application Auto Scaling can use to scale a target during a scaling activity.

Parameters:

maxCapacity - The maximum value that Application Auto Scaling can use to scale a target during a scaling activity. This parameter is required.

Returns:

this

minCapacity

@Stability(value=Experimental)
public ScalableTarget.Builder minCapacity(Number minCapacity)

(experimental) The minimum value that Application Auto Scaling can use to scale a target during a scaling activity.

Parameters:

minCapacity - The minimum value that Application Auto Scaling can use to scale a target during a scaling activity. This parameter is required.

Returns:

this

resourceId

@Stability(value=Experimental)
public ScalableTarget.Builder resourceId(String resourceId)

(experimental) The resource identifier to associate with this scalable target.

This string consists of the resource type and unique identifier.

Example:

 // Example automatically generated without compilation. See https://github.com/aws/jsii/issues/826
 service / ecsStack - MyECSCluster - AB12CDE3F4GH / ecsStack - MyECSService - AB12CDE3F4GH;

Parameters:

resourceId - The resource identifier to associate with this scalable target. This parameter is required.

Returns:

this

See Also:

https://docs.aws.amazon.com/autoscaling/application/APIReference/API_RegisterScalableTarget.html

scalableDimension

@Stability(value=Experimental)
public ScalableTarget.Builder scalableDimension(String scalableDimension)

(experimental) The scalable dimension that's associated with the scalable target.

Specify the service namespace, resource type, and scaling property.

Example:

 // Example automatically generated without compilation. See https://github.com/aws/jsii/issues/826
 ecs:service:DesiredCount

Parameters:

scalableDimension - The scalable dimension that's associated with the scalable target. This parameter is required.

Returns:

this

See Also:

https://docs.aws.amazon.com/autoscaling/application/APIReference/API_ScalingPolicy.html

serviceNamespace

@Stability(value=Experimental)
public ScalableTarget.Builder serviceNamespace(ServiceNamespace serviceNamespace)

(experimental) The namespace of the AWS service that provides the resource or custom-resource for a resource provided by your own application or service.

For valid AWS service namespace values, see the RegisterScalableTarget action in the Application Auto Scaling API Reference.

Parameters:

serviceNamespace - The namespace of the AWS service that provides the resource or custom-resource for a resource provided by your own application or service. This parameter is required.

Returns:

this

See Also:

https://docs.aws.amazon.com/autoscaling/application/APIReference/API_RegisterScalableTarget.html

role

@Stability(value=Experimental)
public ScalableTarget.Builder role(IRole role)

(experimental) Role that allows Application Auto Scaling to modify your scalable target.

Default: A role is automatically created

Parameters:

role - Role that allows Application Auto Scaling to modify your scalable target. This parameter is required.

Returns:

this

build

@Stability(value=Experimental)
public ScalableTarget build()

Specified by:

build in interface software.amazon.jsii.Builder<ScalableTarget>