Interface BaseTargetTrackingProps

All Superinterfaces:
software.amazon.jsii.JsiiSerializable
All Known Subinterfaces:
BasicTargetTrackingScalingPolicyProps, CpuUtilizationScalingProps, InvocationsScalingProps, MemoryUtilizationScalingProps, RequestCountScalingProps, TargetTrackingScalingPolicyProps, TrackCustomMetricProps, UtilizationScalingOptions, UtilizationScalingProps
All Known Implementing Classes:
BaseTargetTrackingProps.Jsii$Proxy, BasicTargetTrackingScalingPolicyProps.Jsii$Proxy, CpuUtilizationScalingProps.Jsii$Proxy, InvocationsScalingProps.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.94.0 (build b380f01)", date="2024-03-01T20:58:18.757Z") @Stability(Stable) public interface BaseTargetTrackingProps extends software.amazon.jsii.JsiiSerializable
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.

Example:

 // 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.*;
 BaseTargetTrackingProps baseTargetTrackingProps = BaseTargetTrackingProps.builder()
         .disableScaleIn(false)
         .policyName("policyName")
         .scaleInCooldown(Duration.minutes(30))
         .scaleOutCooldown(Duration.minutes(30))
         .build();
 
  • Method Details

    • getDisableScaleIn

      @Stability(Stable) @Nullable default Boolean getDisableScaleIn()
      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(Stable) @Nullable default String getPolicyName()
      A name for the scaling policy.

      Default: - Automatically generated name.

    • getScaleInCooldown

      @Stability(Stable) @Nullable default Duration getScaleInCooldown()
      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(Stable) @Nullable default Duration getScaleOutCooldown()
      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(Stable) static BaseTargetTrackingProps.Builder builder()
      Returns:
      a BaseTargetTrackingProps.Builder of BaseTargetTrackingProps