software.amazon.awscdk.services.applicationautoscaling

Class ScalableTarget.Builder

java.lang.Object

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

Enclosing class:

ScalableTarget

public static final class ScalableTarget.Builder
extends java.lang.Object

A fluent builder for ScalableTarget.

Method Summary

Modifier and Type	Method and Description
ScalableTarget	build()
static ScalableTarget.Builder	create(software.constructs.Construct scope, java.lang.String id)
ScalableTarget.Builder	maxCapacity(java.lang.Number maxCapacity) The maximum value that Application Auto Scaling can use to scale a target during a scaling activity.
ScalableTarget.Builder	minCapacity(java.lang.Number minCapacity) The minimum value that Application Auto Scaling can use to scale a target during a scaling activity.
ScalableTarget.Builder	resourceId(java.lang.String resourceId) The resource identifier to associate with this scalable target.
ScalableTarget.Builder	role(IRole role) Role that allows Application Auto Scaling to modify your scalable target.
ScalableTarget.Builder	scalableDimension(java.lang.String scalableDimension) The scalable dimension that's associated with the scalable target.
ScalableTarget.Builder	serviceNamespace(ServiceNamespace serviceNamespace) 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

public static ScalableTarget.Builder create(software.constructs.Construct scope,
                                            java.lang.String id)

Parameters:

scope - This parameter is required.

id - This parameter is required.

Returns:

a new instance of ScalableTarget.Builder.

maxCapacity

public ScalableTarget.Builder maxCapacity(java.lang.Number maxCapacity)

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

public ScalableTarget.Builder minCapacity(java.lang.Number minCapacity)

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

public ScalableTarget.Builder resourceId(java.lang.String resourceId)

The resource identifier to associate with this scalable target.

This string consists of the resource type and unique identifier.

Example value: 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

public ScalableTarget.Builder scalableDimension(java.lang.String scalableDimension)

The scalable dimension that's associated with the scalable target.

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

Example value: 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

public ScalableTarget.Builder serviceNamespace(ServiceNamespace serviceNamespace)

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

public ScalableTarget.Builder role(IRole role)

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

public ScalableTarget build()