TargetTrackingScalingPolicyProps¶
-
class
aws_cdk.aws_applicationautoscaling.
TargetTrackingScalingPolicyProps
(*, disable_scale_in=None, policy_name=None, scale_in_cooldown=None, scale_out_cooldown=None, target_value, custom_metric=None, predefined_metric=None, resource_label=None, scaling_target)¶ Bases:
aws_cdk.aws_applicationautoscaling.BasicTargetTrackingScalingPolicyProps
Properties for a concrete TargetTrackingPolicy.
Adds the scalingTarget.
- Parameters
disable_scale_in (
Optional
[bool
]) – 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: falsepolicy_name (
Optional
[str
]) – A name for the scaling policy. Default: - Automatically generated name.scale_in_cooldown (
Optional
[Duration
]) – 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 concurrencyscale_out_cooldown (
Optional
[Duration
]) – 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 concurrencytarget_value (
Union
[int
,float
]) – The target value for the metric.custom_metric (
Optional
[IMetric
]) – A custom metric for application autoscaling. 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. Default: - No custom metric.predefined_metric (
Optional
[PredefinedMetric
]) – A predefined metric for application autoscaling. 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. Default: - No predefined metrics.resource_label (
Optional
[str
]) – Identify the resource associated with the metric type. Only used for predefined metric ALBRequestCountPerTarget. Example value:app/<load-balancer-name>/<load-balancer-id>/targetgroup/<target-group-name>/<target-group-id>
Default: - No resource label.scaling_target (
IScalableTarget
) –
- ExampleMetadata
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. import aws_cdk.aws_applicationautoscaling as appscaling import aws_cdk.aws_cloudwatch as cloudwatch import aws_cdk.core as cdk # metric: cloudwatch.Metric # scalable_target: appscaling.ScalableTarget target_tracking_scaling_policy_props = appscaling.TargetTrackingScalingPolicyProps( scaling_target=scalable_target, 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) )
Attributes
-
custom_metric
¶ A custom metric for application autoscaling.
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.
- Default
No custom metric.
- Return type
Optional
[IMetric
]
-
disable_scale_in
¶ 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
- Return type
Optional
[bool
]
-
policy_name
¶ A name for the scaling policy.
- Default
Automatically generated name.
- Return type
Optional
[str
]
-
predefined_metric
¶ A predefined metric for application autoscaling.
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.
- Default
No predefined metrics.
- Return type
Optional
[PredefinedMetric
]
-
resource_label
¶ Identify the resource associated with the metric type.
Only used for predefined metric ALBRequestCountPerTarget.
Example value:
app/<load-balancer-name>/<load-balancer-id>/targetgroup/<target-group-name>/<target-group-id>
- Default
No resource label.
- Return type
Optional
[str
]
-
scale_in_cooldown
¶ 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
- Return type
Optional
[Duration
]
-
scale_out_cooldown
¶ 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
- Return type
Optional
[Duration
]
-
scaling_target
¶ - Return type
-
target_value
¶ The target value for the metric.
- Return type
Union
[int
,float
]