aws-cdk-lib.aws_applicationautoscaling.TargetTrackingScalingPolicy

TargetTrackingScalingPolicy

Construct›TargetTrackingScalingPolicy

implements

• IConstruct,
• IDependable

Source

aws-applicationautoscaling/lib/target-tracking-scaling-policy.ts

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import * as cdk from 'aws-cdk-lib';
import { aws_applicationautoscaling as appscaling } from 'aws-cdk-lib';
import { aws_cloudwatch as cloudwatch } from 'aws-cdk-lib';
import { aws_applicationautoscaling as interfaces_applicationautoscaling } from 'aws-cdk-lib/interfaces';

declare const metric: cloudwatch.Metric;
declare const scalableTargetRef: interfaces_applicationautoscaling.IScalableTargetRef;
const targetTrackingScalingPolicy = new appscaling.TargetTrackingScalingPolicy(this, 'MyTargetTrackingScalingPolicy', {
  scalingTarget: scalableTargetRef,
  targetValue: 123,

  // the properties below are optional
  customMetric: metric,
  disableScaleIn: false,
  policyName: 'policyName',
  predefinedMetric: appscaling.PredefinedMetric.APPSTREAM_AVERAGE_CAPACITY_UTILIZATION,
  resourceLabel: 'resourceLabel',
  scaleInCooldown: cdk.Duration.minutes(30),
  scaleOutCooldown: cdk.Duration.minutes(30),
});

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
import aws_cdk as cdk
from aws_cdk import aws_applicationautoscaling as appscaling
from aws_cdk import aws_cloudwatch as cloudwatch
from aws_cdk.interfaces import aws_applicationautoscaling as interfaces_applicationautoscaling

# metric: cloudwatch.Metric
# scalable_target_ref: interfaces_applicationautoscaling.IScalableTargetRef

target_tracking_scaling_policy = appscaling.TargetTrackingScalingPolicy(self, "MyTargetTrackingScalingPolicy",
    scaling_target=scalable_target_ref,
    target_value=123,

    # the properties below are optional
    custom_metric=metric,
    disable_scale_in=False,
    policy_name="policyName",
    predefined_metric=appscaling.PredefinedMetric.APPSTREAM_AVERAGE_CAPACITY_UTILIZATION,
    resource_label="resourceLabel",
    scale_in_cooldown=cdk.Duration.minutes(30),
    scale_out_cooldown=cdk.Duration.minutes(30)
)

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import software.amazon.awscdk.*;
import software.amazon.awscdk.services.applicationautoscaling.*;
import software.amazon.awscdk.services.cloudwatch.*;
import software.amazon.awscdk.interfaces.applicationautoscaling.*;

Metric metric;
IScalableTargetRef scalableTargetRef;

TargetTrackingScalingPolicy targetTrackingScalingPolicy = TargetTrackingScalingPolicy.Builder.create(this, "MyTargetTrackingScalingPolicy")
        .scalingTarget(scalableTargetRef)
        .targetValue(123)

        // the properties below are optional
        .customMetric(metric)
        .disableScaleIn(false)
        .policyName("policyName")
        .predefinedMetric(PredefinedMetric.APPSTREAM_AVERAGE_CAPACITY_UTILIZATION)
        .resourceLabel("resourceLabel")
        .scaleInCooldown(Duration.minutes(30))
        .scaleOutCooldown(Duration.minutes(30))
        .build();

// Install: dotnet add package Amazon.CDK.Lib
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK;
using Amazon.CDK.AWS.ApplicationAutoScaling;
using Amazon.CDK.AWS.CloudWatch;
using Amazon.CDK.Interfaces.ApplicationAutoScaling;

Metric metric;
IScalableTargetRef scalableTargetRef;

var targetTrackingScalingPolicy = new TargetTrackingScalingPolicy(this, "MyTargetTrackingScalingPolicy", new TargetTrackingScalingPolicyProps {
    ScalingTarget = scalableTargetRef,
    TargetValue = 123,

    // the properties below are optional
    CustomMetric = metric,
    DisableScaleIn = false,
    PolicyName = "policyName",
    PredefinedMetric = PredefinedMetric.APPSTREAM_AVERAGE_CAPACITY_UTILIZATION,
    ResourceLabel = "resourceLabel",
    ScaleInCooldown = Duration.Minutes(30),
    ScaleOutCooldown = Duration.Minutes(30)
});

// Install: go get github.com/aws/aws-cdk-go/awscdk/v2
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
import "github.com/aws/aws-cdk-go/awscdk"
import "github.com/aws/aws-cdk-go/awscdk"
import "github.com/aws/aws-cdk-go/awscdk"

var metric Metric
var scalableTargetRef IScalableTargetRef

targetTrackingScalingPolicy := awscdk.Aws_applicationautoscaling.NewTargetTrackingScalingPolicy(this, jsii.String("MyTargetTrackingScalingPolicy"), &TargetTrackingScalingPolicyProps{
	ScalingTarget: scalableTargetRef,
	TargetValue: jsii.Number(123),

	// the properties below are optional
	CustomMetric: metric,
	DisableScaleIn: jsii.Boolean(false),
	PolicyName: jsii.String("policyName"),
	PredefinedMetric: awscdk.*Aws_applicationautoscaling.PredefinedMetric_APPSTREAM_AVERAGE_CAPACITY_UTILIZATION,
	ResourceLabel: jsii.String("resourceLabel"),
	ScaleInCooldown: cdk.Duration_Minutes(jsii.Number(30)),
	ScaleOutCooldown: cdk.Duration_*Minutes(jsii.Number(30)),
})

Initializer

new TargetTrackingScalingPolicy(scope: Construct, id: string, props: TargetTrackingScalingPolicyProps)

TargetTrackingScalingPolicy(scope: Construct, id: str, props: TargetTrackingScalingPolicyProps)

new TargetTrackingScalingPolicy(Construct scope, String id, TargetTrackingScalingPolicyProps props)

new TargetTrackingScalingPolicy(Construct scope, string id, TargetTrackingScalingPolicyProps props)

NewTargetTrackingScalingPolicy(Scope Construct, Id *string, Props TargetTrackingScalingPolicyProps)

Construct Props

customMetric?optionalIMetriccustom_metric?optionalIMetriccustomMetric?optionalIMetricCustomMetric?optionalIMetricCustomMetric?optionalIMetric#

A custom metric for application autoscaling.

Default: No custom metric.

notes

The metric must track utilization. Scaling out will happen if the metric is higher than the target value, scaling in will happen in the metric is lower than the target value.

The metric must be in the same account and region as the scaling policy.

Exactly one of customMetric or predefinedMetric must be specified.

disableScaleIn?optionalbooleandisable_scale_in?optionalbooldisableScaleIn?optionalBooleanDisableScaleIn?optionalboolDisableScaleIn?optional*bool= false#

Indicates whether scale in by the target tracking policy is disabled.

If the value is true, scale in is disabled and the target tracking policy won't remove capacity from the scalable resource. Otherwise, scale in is enabled and the target tracking policy can remove capacity from the scalable resource.

policyName?optionalstringpolicy_name?optionalstrpolicyName?optionalStringPolicyName?optionalstringPolicyName?optional*string#

A name for the scaling policy.

Default: Automatically generated name.

predefinedMetric?optionalPredefinedMetricpredefined_metric?optionalPredefinedMetricpredefinedMetric?optionalPredefinedMetricPredefinedMetric?optionalPredefinedMetricPredefinedMetric?optionalPredefinedMetric#

A predefined metric for application autoscaling.

Default: No predefined metrics.

notes

The metric must track utilization. Scaling out will happen if the metric is higher than the target value, scaling in will happen in the metric is lower than the target value.

Exactly one of customMetric or predefinedMetric must be specified.

resourceLabel?optionalstringresource_label?optionalstrresourceLabel?optionalStringResourceLabel?optionalstringResourceLabel?optional*string#

Identify the resource associated with the metric type.

Default: No resource label.

Only used for predefined metric ALBRequestCountPerTarget.

Example value: app/<load-balancer-name>/<load-balancer-id>/targetgroup/<target-group-name>/<target-group-id>

scaleInCooldown?optionalDurationscale_in_cooldown?optionalDurationscaleInCooldown?optionalDurationScaleInCooldown?optionalDurationScaleInCooldown?optionalDuration#

Period after a scale in activity completes before another scale in activity can start.

Default: Duration.seconds(300) for the following scalable targets: ECS services, Spot Fleet requests, EMR clusters, AppStream 2.0 fleets, Aurora DB clusters, Amazon SageMaker endpoint variants, Custom resources. For all other scalable targets, the default value is Duration.seconds(0): DynamoDB tables, DynamoDB global secondary indexes, Amazon Comprehend document classification endpoints, Lambda provisioned concurrency

scaleOutCooldown?optionalDurationscale_out_cooldown?optionalDurationscaleOutCooldown?optionalDurationScaleOutCooldown?optionalDurationScaleOutCooldown?optionalDuration#

Period after a scale out activity completes before another scale out activity can start.

Default: Duration.seconds(300) for the following scalable targets: ECS services, Spot Fleet requests, EMR clusters, AppStream 2.0 fleets, Aurora DB clusters, Amazon SageMaker endpoint variants, Custom resources. For all other scalable targets, the default value is Duration.seconds(0): DynamoDB tables, DynamoDB global secondary indexes, Amazon Comprehend document classification endpoints, Lambda provisioned concurrency

scalingTargetIScalableTargetRefscaling_targetIScalableTargetRefscalingTargetIScalableTargetRefScalingTargetIScalableTargetRefScalingTargetIScalableTargetRefrequired#

targetValuenumbertarget_valueint | floattargetValueNumberTargetValuedoubleTargetValue*float64required#

The target value for the metric.

Properties

nodeNodenodeNodenodeNodeNodeNodeNodeNode#

The tree node.

scalingPolicyArnstringscaling_policy_arnstrscalingPolicyArnStringScalingPolicyArnstringScalingPolicyArn*string#

ARN of the scaling policy.

Methods

isConstruct(x: any): boolean@staticmethod def is_construct(x: Any) -> boolpublic static Boolean isConstruct(Object x)public static bool IsConstruct(object x)func IsConstruct(X interface{}) *boolstatic#

Checks if `x` is a construct.

notes · 1 parameter · returns

Use this method instead of instanceof to properly detect Construct instances, even when the construct library is symlinked.

Explanation: in JavaScript, multiple copies of the constructs library on disk are seen as independent, completely different libraries. As a consequence, the class Construct in each copy of the constructs library is seen as a different class, and an instance of one class will not test as instanceof the other class. npm install will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the constructs library can be accidentally installed, and instanceof will behave unpredictably. It is safest to avoid using instanceof, and using this type-testing method instead.

Parameters

• xxxxX — Any object.

Returns: true if x is an object created from a class which extends Construct.

toString(): stringdef to_string(self, ) -> strpublic String toString()public string ToString()func ToString() *string#

Returns a string representation of this construct.

with(...mixins: IMixin[]): IConstructdef with(self, mixins: IMixin) -> IConstructpublic IConstruct with(IMixin mixins)public IConstruct With(IMixin mixins)func With(Mixins IMixin) IConstruct#

Applies one or more mixins to this construct.

Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple with() calls if subsequent mixins should apply to added constructs.

1 parameter · returns

Parameters

• mixinsmixinsmixinsmixinsMixins — The mixins to apply.

Returns: This construct for chaining