Package software.amazon.awscdk.services.autoscaling

Interface BaseTargetTrackingProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Subinterfaces:

BasicTargetTrackingScalingPolicyProps, CpuUtilizationScalingProps, MetricTargetTrackingProps, NetworkUtilizationScalingProps, RequestCountScalingProps, TargetTrackingScalingPolicyProps

All Known Implementing Classes:

BaseTargetTrackingProps.Jsii$Proxy, BasicTargetTrackingScalingPolicyProps.Jsii$Proxy, CpuUtilizationScalingProps.Jsii$Proxy, MetricTargetTrackingProps.Jsii$Proxy, NetworkUtilizationScalingProps.Jsii$Proxy, RequestCountScalingProps.Jsii$Proxy, TargetTrackingScalingPolicyProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)",
           date="2023-06-19T16:30:45.188Z")
@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.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.autoscaling.*;
 import software.amazon.awscdk.core.*;
 BaseTargetTrackingProps baseTargetTrackingProps = BaseTargetTrackingProps.builder()
         .cooldown(Duration.minutes(30))
         .disableScaleIn(false)
         .estimatedInstanceWarmup(Duration.minutes(30))
         .build();
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static BaseTargetTrackingProps.Builder	builder()
default Duration	getCooldown()	Period after a scaling completes before another scaling activity can start.
default Boolean	getDisableScaleIn()	Indicates whether scale in by the target tracking policy is disabled.
default Duration	getEstimatedInstanceWarmup()	Estimated time until a newly launched instance can send metrics to CloudWatch.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getCooldown

@Stability(Stable)
@Nullable
default Duration getCooldown()

Period after a scaling completes before another scaling activity can start.

Default: - The default cooldown configured on the AutoScalingGroup.

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 autoscaling group. Otherwise, scale in is enabled and the target tracking policy can remove capacity from the group.

Default: false

getEstimatedInstanceWarmup

@Stability(Stable)
@Nullable
default Duration getEstimatedInstanceWarmup()

Estimated time until a newly launched instance can send metrics to CloudWatch.

Default: - Same as the cooldown.

builder

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

Returns:

a BaseTargetTrackingProps.Builder of BaseTargetTrackingProps