software.amazon.awscdk.services.applicationautoscaling

Class ScalableTarget

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.Resource

software.amazon.awscdk.services.applicationautoscaling.ScalableTarget

All Implemented Interfaces:

IResource, IScalableTarget, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:36.412Z")
 @Stability(value=Stable)
public class ScalableTarget
extends Resource
implements IScalableTarget

Define a scalable target.

Example:

 import software.amazon.awscdk.services.lambda.*;
 Code code;
 Function handler = Function.Builder.create(this, "MyFunction")
         .runtime(Runtime.PYTHON_3_7)
         .handler("index.handler")
         .code(code)
         .reservedConcurrentExecutions(2)
         .build();
 Version fnVer = handler.getCurrentVersion();
 ScalableTarget target = ScalableTarget.Builder.create(this, "ScalableTarget")
         .serviceNamespace(ServiceNamespace.LAMBDA)
         .maxCapacity(100)
         .minCapacity(10)
         .resourceId(String.format("function:%s:%s", handler.getFunctionName(), fnVer.getVersion()))
         .scalableDimension("lambda:function:ProvisionedConcurrency")
         .build();
 target.scaleToTrackMetric("PceTracking", BasicTargetTrackingScalingPolicyProps.builder()
         .targetValue(0.9)
         .predefinedMetric(PredefinedMetric.LAMBDA_PROVISIONED_CONCURRENCY_UTILIZATION)
         .build());
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ScalableTarget.Builder A fluent builder for ScalableTarget.

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.amazon.awscdk.services.applicationautoscaling.IScalableTarget

IScalableTarget.Jsii$Default, IScalableTarget.Jsii$Proxy

Constructor Summary

Constructors

Modifier	Constructor and Description
	ScalableTarget(software.constructs.Construct scope, String id, ScalableTargetProps props)
protected	ScalableTarget(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	ScalableTarget(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
void	addToRolePolicy(PolicyStatement statement) Add a policy statement to the role's policy.
static IScalableTarget	fromScalableTargetId(software.constructs.Construct scope, String id, String scalableTargetId)
IRole	getRole() The role used to give AutoScaling permissions to your resource.
String	getScalableTargetId() ID of the Scalable Target.
StepScalingPolicy	scaleOnMetric(String id, BasicStepScalingPolicyProps props) Scale out or in, in response to a metric.
void	scaleOnSchedule(String id, ScalingSchedule action) Scale out or in based on time.
TargetTrackingScalingPolicy	scaleToTrackMetric(String id, BasicTargetTrackingScalingPolicyProps props) Scale out or in in order to keep a metric around a target value.

Methods inherited from class software.amazon.awscdk.Resource

applyRemovalPolicy, generatePhysicalName, getEnv, getPhysicalName, getResourceArnAttribute, getResourceNameAttribute, getStack, isOwnedResource, isResource

Methods inherited from class software.constructs.Construct

getNode, isConstruct, toString

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, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awscdk.IResource

applyRemovalPolicy, getEnv, getStack

Methods inherited from interface software.constructs.IConstruct

getNode

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Constructor Detail

ScalableTarget

protected ScalableTarget(software.amazon.jsii.JsiiObjectRef objRef)

ScalableTarget

protected ScalableTarget(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

ScalableTarget

@Stability(value=Stable)
public ScalableTarget(@NotNull
                                               software.constructs.Construct scope,
                                               @NotNull
                                               String id,
                                               @NotNull
                                               ScalableTargetProps props)

Parameters:

scope - This parameter is required.

id - This parameter is required.

props - This parameter is required.

Method Detail

fromScalableTargetId

@Stability(value=Stable)
 @NotNull
public static IScalableTarget fromScalableTargetId(@NotNull
                                                                                      software.constructs.Construct scope,
                                                                                      @NotNull
                                                                                      String id,
                                                                                      @NotNull
                                                                                      String scalableTargetId)

Parameters:

scope - This parameter is required.

id - This parameter is required.

scalableTargetId - This parameter is required.

addToRolePolicy

@Stability(value=Stable)
public void addToRolePolicy(@NotNull
                                                     PolicyStatement statement)

Add a policy statement to the role's policy.

Parameters:

statement - This parameter is required.

scaleOnMetric

@Stability(value=Stable)
 @NotNull
public StepScalingPolicy scaleOnMetric(@NotNull
                                                                          String id,
                                                                          @NotNull
                                                                          BasicStepScalingPolicyProps props)

Scale out or in, in response to a metric.

Parameters:

id - This parameter is required.

props - This parameter is required.

scaleOnSchedule

@Stability(value=Stable)
public void scaleOnSchedule(@NotNull
                                                     String id,
                                                     @NotNull
                                                     ScalingSchedule action)

Scale out or in based on time.

Parameters:

id - This parameter is required.

action - This parameter is required.

scaleToTrackMetric

@Stability(value=Stable)
 @NotNull
public TargetTrackingScalingPolicy scaleToTrackMetric(@NotNull
                                                                                         String id,
                                                                                         @NotNull
                                                                                         BasicTargetTrackingScalingPolicyProps props)

Scale out or in in order to keep a metric around a target value.

Parameters:

id - This parameter is required.

props - This parameter is required.

getRole

@Stability(value=Stable)
 @NotNull
public IRole getRole()

The role used to give AutoScaling permissions to your resource.

getScalableTargetId

@Stability(value=Stable)
 @NotNull
public String getScalableTargetId()

ID of the Scalable Target.

Example value: service/ecsStack-MyECSCluster-AB12CDE3F4GH/ecsStack-MyECSService-AB12CDE3F4GH|ecs:service:DesiredCount|ecs

Specified by:

getScalableTargetId in interface IScalableTarget