Package software.amazon.awscdk.services.applicationautoscaling

Interface ScalableTargetProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

ScalableTargetProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.101.0 (build b95fe5d)",
           date="2024-07-11T03:45:49.648Z")
@Stability(Stable)
public interface ScalableTargetProps
extends software.amazon.jsii.JsiiSerializable

Properties for a scalable target.

Example:

 ScalableTarget shardsScalableTarget = ScalableTarget.Builder.create(this, "ElastiCacheRedisShardsScalableTarget")
         .serviceNamespace(ServiceNamespace.ELASTICACHE)
         .scalableDimension("elasticache:replication-group:NodeGroups")
         .minCapacity(2)
         .maxCapacity(10)
         .resourceId("replication-group/main-cluster")
         .build();
 shardsScalableTarget.scaleToTrackMetric("ElastiCacheRedisShardsCPUUtilization", BasicTargetTrackingScalingPolicyProps.builder()
         .targetValue(20)
         .predefinedMetric(PredefinedMetric.ELASTICACHE_PRIMARY_ENGINE_CPU_UTILIZATION)
         .build());
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	ScalableTargetProps.Builder	A builder for ScalableTargetProps
static final class	ScalableTargetProps.Jsii$Proxy	An implementation for ScalableTargetProps

Method Summary

Modifier and Type	Method	Description
static ScalableTargetProps.Builder	builder()
Number	getMaxCapacity()	The maximum value that Application Auto Scaling can use to scale a target during a scaling activity.
Number	getMinCapacity()	The minimum value that Application Auto Scaling can use to scale a target during a scaling activity.
String	getResourceId()	The resource identifier to associate with this scalable target.
default IRole	getRole()	Role that allows Application Auto Scaling to modify your scalable target.
String	getScalableDimension()	The scalable dimension that's associated with the scalable target.
ServiceNamespace	getServiceNamespace()	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 interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getMaxCapacity

@Stability(Stable)
@NotNull
Number getMaxCapacity()

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

getMinCapacity

@Stability(Stable)
@NotNull
Number getMinCapacity()

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

getResourceId

@Stability(Stable)
@NotNull
String getResourceId()

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

See Also:

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

getScalableDimension

@Stability(Stable)
@NotNull
String getScalableDimension()

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

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

Example value: ecs:service:DesiredCount

See Also:

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

getServiceNamespace

@Stability(Stable)
@NotNull
ServiceNamespace getServiceNamespace()

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.

See Also:

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

getRole

@Stability(Stable)
@Nullable
default IRole getRole()

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

Default: A role is automatically created

builder

@Stability(Stable)
static ScalableTargetProps.Builder builder()

Returns:

a ScalableTargetProps.Builder of ScalableTargetProps