software.amazon.awscdk.services.applicationautoscaling

Interface BaseTargetTrackingProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Subinterfaces:

BasicTargetTrackingScalingPolicyProps, CpuUtilizationScalingProps, MemoryUtilizationScalingProps, RequestCountScalingProps, TargetTrackingScalingPolicyProps, TrackCustomMetricProps, UtilizationScalingOptions, UtilizationScalingProps

All Known Implementing Classes:

BaseTargetTrackingProps.Jsii$Proxy, BasicTargetTrackingScalingPolicyProps.Jsii$Proxy, CpuUtilizationScalingProps.Jsii$Proxy, MemoryUtilizationScalingProps.Jsii$Proxy, RequestCountScalingProps.Jsii$Proxy, TargetTrackingScalingPolicyProps.Jsii$Proxy, TrackCustomMetricProps.Jsii$Proxy, UtilizationScalingOptions.Jsii$Proxy, UtilizationScalingProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.29.0 (build 41df200)",
           date="2021-06-02T09:54:56.956Z")
 @Stability(value=Experimental)
public interface BaseTargetTrackingProps
extends software.amazon.jsii.JsiiSerializable

(experimental) Base interface for target tracking props.

Contains the attributes that are common to target tracking policies, except the ones relating to the metric and to the scalable target.

This interface is reused by more specific target tracking props objects in other services.

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and Description
static BaseTargetTrackingProps.Builder	builder()
default Boolean	getDisableScaleIn() (experimental) Indicates whether scale in by the target tracking policy is disabled.
default String	getPolicyName() (experimental) A name for the scaling policy.
default Duration	getScaleInCooldown() (experimental) Period after a scale in activity completes before another scale in activity can start.
default Duration	getScaleOutCooldown() (experimental) Period after a scale out activity completes before another scale out activity can start.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getDisableScaleIn

@Stability(value=Experimental)
 @Nullable
default Boolean getDisableScaleIn()

(experimental) 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.

Default: false

getPolicyName

@Stability(value=Experimental)
 @Nullable
default String getPolicyName()

(experimental) A name for the scaling policy.

Default: - Automatically generated name.

getScaleInCooldown

@Stability(value=Experimental)
 @Nullable
default Duration getScaleInCooldown()

(experimental) 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

getScaleOutCooldown

@Stability(value=Experimental)
 @Nullable
default Duration getScaleOutCooldown()

(experimental) 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

builder

@Stability(value=Experimental)
static BaseTargetTrackingProps.Builder builder()

Returns:

a BaseTargetTrackingProps.Builder of BaseTargetTrackingProps