Policy

name string

The unique name of the resource.

args PolicyArgs

The arguments to resource properties.

opts CustomResourceOptions

Bag of options to control resource's behavior.

resource_name str

The unique name of the resource.

opts ResourceOptions

A bag of options that control this resource's behavior.

ctx Context

Context object for the current deployment.

name string

The unique name of the resource.

args PolicyArgs

The arguments to resource properties.

opts ResourceOption

Bag of options to control resource's behavior.

name string

The unique name of the resource.

args PolicyArgs

The arguments to resource properties.

opts CustomResourceOptions

Bag of options to control resource's behavior.

ResourceId string

The resource type and unique identifier string for the resource associated with the scaling policy. Documentation can be found in the ResourceId parameter at: AWS Application Auto Scaling API Reference

ScalableDimension string

The scalable dimension of the scalable target. Documentation can be found in the ScalableDimension parameter at: AWS Application Auto Scaling API Reference

ServiceNamespace string

The AWS service namespace of the scalable target. Documentation can be found in the ServiceNamespace parameter at: AWS Application Auto Scaling API Reference

Name string

The name of the policy.

PolicyType string

The policy type. Valid values are StepScaling and TargetTrackingScaling. Defaults to StepScaling. Certain services only support only one policy type. For more information see the Target Tracking Scaling Policies and Step Scaling Policies documentation.

StepScalingPolicyConfiguration PolicyStepScalingPolicyConfigurationArgs

Step scaling policy configuration, requires policy_type = "StepScaling" (default). See supported fields below.

TargetTrackingScalingPolicyConfiguration PolicyTargetTrackingScalingPolicyConfigurationArgs

A target tracking policy, requires policy_type = "TargetTrackingScaling". See supported fields below.

ResourceId string

The resource type and unique identifier string for the resource associated with the scaling policy. Documentation can be found in the ResourceId parameter at: AWS Application Auto Scaling API Reference

ScalableDimension string

The scalable dimension of the scalable target. Documentation can be found in the ScalableDimension parameter at: AWS Application Auto Scaling API Reference

ServiceNamespace string

The AWS service namespace of the scalable target. Documentation can be found in the ServiceNamespace parameter at: AWS Application Auto Scaling API Reference

Name string

The name of the policy.

PolicyType string

The policy type. Valid values are StepScaling and TargetTrackingScaling. Defaults to StepScaling. Certain services only support only one policy type. For more information see the Target Tracking Scaling Policies and Step Scaling Policies documentation.

StepScalingPolicyConfiguration PolicyStepScalingPolicyConfiguration

Step scaling policy configuration, requires policy_type = "StepScaling" (default). See supported fields below.

TargetTrackingScalingPolicyConfiguration PolicyTargetTrackingScalingPolicyConfiguration

A target tracking policy, requires policy_type = "TargetTrackingScaling". See supported fields below.

resourceId string

The resource type and unique identifier string for the resource associated with the scaling policy. Documentation can be found in the ResourceId parameter at: AWS Application Auto Scaling API Reference

scalableDimension string

The scalable dimension of the scalable target. Documentation can be found in the ScalableDimension parameter at: AWS Application Auto Scaling API Reference

serviceNamespace string

The AWS service namespace of the scalable target. Documentation can be found in the ServiceNamespace parameter at: AWS Application Auto Scaling API Reference

name string

The name of the policy.

policyType string

The policy type. Valid values are StepScaling and TargetTrackingScaling. Defaults to StepScaling. Certain services only support only one policy type. For more information see the Target Tracking Scaling Policies and Step Scaling Policies documentation.

stepScalingPolicyConfiguration PolicyStepScalingPolicyConfiguration

Step scaling policy configuration, requires policy_type = "StepScaling" (default). See supported fields below.

targetTrackingScalingPolicyConfiguration PolicyTargetTrackingScalingPolicyConfiguration

A target tracking policy, requires policy_type = "TargetTrackingScaling". See supported fields below.

resource_id str

The resource type and unique identifier string for the resource associated with the scaling policy. Documentation can be found in the ResourceId parameter at: AWS Application Auto Scaling API Reference

scalable_dimension str

The scalable dimension of the scalable target. Documentation can be found in the ScalableDimension parameter at: AWS Application Auto Scaling API Reference

service_namespace str

The AWS service namespace of the scalable target. Documentation can be found in the ServiceNamespace parameter at: AWS Application Auto Scaling API Reference

name str

The name of the policy.

policy_type str

The policy type. Valid values are StepScaling and TargetTrackingScaling. Defaults to StepScaling. Certain services only support only one policy type. For more information see the Target Tracking Scaling Policies and Step Scaling Policies documentation.

step_scaling_policy_configuration Dict[PolicyStepScalingPolicyConfiguration]

Step scaling policy configuration, requires policy_type = "StepScaling" (default). See supported fields below.

target_tracking_scaling_policy_configuration Dict[PolicyTargetTrackingScalingPolicyConfiguration]

A target tracking policy, requires policy_type = "TargetTrackingScaling". See supported fields below.

Arn string

The ARN assigned by AWS to the scaling policy.

Id string

The provider-assigned unique ID for this managed resource.

Arn string

The ARN assigned by AWS to the scaling policy.

Id string

The provider-assigned unique ID for this managed resource.

arn string

The ARN assigned by AWS to the scaling policy.

id string

The provider-assigned unique ID for this managed resource.

arn str

The ARN assigned by AWS to the scaling policy.

id str

The provider-assigned unique ID for this managed resource.

name

The unique name of the resulting resource.

id

The unique provider ID of the resource to lookup.

state

Any extra arguments used during the lookup.

opts

A bag of options that control this resource's behavior.

resource_name

The unique name of the resulting resource.

id

The unique provider ID of the resource to lookup.

name

The unique name of the resulting resource.

id

The unique provider ID of the resource to lookup.

state

Any extra arguments used during the lookup.

opts

A bag of options that control this resource's behavior.

name

The unique name of the resulting resource.

id

The unique provider ID of the resource to lookup.

state

Any extra arguments used during the lookup.

opts

A bag of options that control this resource's behavior.

Arn string

The ARN assigned by AWS to the scaling policy.

Name string

The name of the policy.

PolicyType string

The policy type. Valid values are StepScaling and TargetTrackingScaling. Defaults to StepScaling. Certain services only support only one policy type. For more information see the Target Tracking Scaling Policies and Step Scaling Policies documentation.

ResourceId string

The resource type and unique identifier string for the resource associated with the scaling policy. Documentation can be found in the ResourceId parameter at: AWS Application Auto Scaling API Reference

ScalableDimension string

The scalable dimension of the scalable target. Documentation can be found in the ScalableDimension parameter at: AWS Application Auto Scaling API Reference

ServiceNamespace string

The AWS service namespace of the scalable target. Documentation can be found in the ServiceNamespace parameter at: AWS Application Auto Scaling API Reference

StepScalingPolicyConfiguration PolicyStepScalingPolicyConfigurationArgs

Step scaling policy configuration, requires policy_type = "StepScaling" (default). See supported fields below.

TargetTrackingScalingPolicyConfiguration PolicyTargetTrackingScalingPolicyConfigurationArgs

A target tracking policy, requires policy_type = "TargetTrackingScaling". See supported fields below.

Arn string

The ARN assigned by AWS to the scaling policy.

Name string

The name of the policy.

PolicyType string

The policy type. Valid values are StepScaling and TargetTrackingScaling. Defaults to StepScaling. Certain services only support only one policy type. For more information see the Target Tracking Scaling Policies and Step Scaling Policies documentation.

ResourceId string

The resource type and unique identifier string for the resource associated with the scaling policy. Documentation can be found in the ResourceId parameter at: AWS Application Auto Scaling API Reference

ScalableDimension string

The scalable dimension of the scalable target. Documentation can be found in the ScalableDimension parameter at: AWS Application Auto Scaling API Reference

ServiceNamespace string

The AWS service namespace of the scalable target. Documentation can be found in the ServiceNamespace parameter at: AWS Application Auto Scaling API Reference

StepScalingPolicyConfiguration PolicyStepScalingPolicyConfiguration

Step scaling policy configuration, requires policy_type = "StepScaling" (default). See supported fields below.

TargetTrackingScalingPolicyConfiguration PolicyTargetTrackingScalingPolicyConfiguration

A target tracking policy, requires policy_type = "TargetTrackingScaling". See supported fields below.

arn string

The ARN assigned by AWS to the scaling policy.

name string

The name of the policy.

policyType string

The policy type. Valid values are StepScaling and TargetTrackingScaling. Defaults to StepScaling. Certain services only support only one policy type. For more information see the Target Tracking Scaling Policies and Step Scaling Policies documentation.

resourceId string

The resource type and unique identifier string for the resource associated with the scaling policy. Documentation can be found in the ResourceId parameter at: AWS Application Auto Scaling API Reference

scalableDimension string

The scalable dimension of the scalable target. Documentation can be found in the ScalableDimension parameter at: AWS Application Auto Scaling API Reference

serviceNamespace string

The AWS service namespace of the scalable target. Documentation can be found in the ServiceNamespace parameter at: AWS Application Auto Scaling API Reference

stepScalingPolicyConfiguration PolicyStepScalingPolicyConfiguration

Step scaling policy configuration, requires policy_type = "StepScaling" (default). See supported fields below.

targetTrackingScalingPolicyConfiguration PolicyTargetTrackingScalingPolicyConfiguration

A target tracking policy, requires policy_type = "TargetTrackingScaling". See supported fields below.

arn str

The ARN assigned by AWS to the scaling policy.

name str

The name of the policy.

policy_type str

The policy type. Valid values are StepScaling and TargetTrackingScaling. Defaults to StepScaling. Certain services only support only one policy type. For more information see the Target Tracking Scaling Policies and Step Scaling Policies documentation.

resource_id str

The resource type and unique identifier string for the resource associated with the scaling policy. Documentation can be found in the ResourceId parameter at: AWS Application Auto Scaling API Reference

scalable_dimension str

The scalable dimension of the scalable target. Documentation can be found in the ScalableDimension parameter at: AWS Application Auto Scaling API Reference

service_namespace str

The AWS service namespace of the scalable target. Documentation can be found in the ServiceNamespace parameter at: AWS Application Auto Scaling API Reference

step_scaling_policy_configuration Dict[PolicyStepScalingPolicyConfiguration]

Step scaling policy configuration, requires policy_type = "StepScaling" (default). See supported fields below.

target_tracking_scaling_policy_configuration Dict[PolicyTargetTrackingScalingPolicyConfiguration]

A target tracking policy, requires policy_type = "TargetTrackingScaling". See supported fields below.

See the input and output API doc for this type.

See the input and output API doc for this type.

See the input and output API doc for this type.

AdjustmentType string

Specifies whether the adjustment is an absolute number or a percentage of the current capacity. Valid values are ChangeInCapacity, ExactCapacity, and PercentChangeInCapacity.

Cooldown int

The amount of time, in seconds, after a scaling activity completes and before the next scaling activity can start.

MetricAggregationType string

The aggregation type for the policy’s metrics. Valid values are “Minimum”, “Maximum”, and “Average”. Without a value, AWS will treat the aggregation type as “Average”.

MinAdjustmentMagnitude int

The minimum number to adjust your scalable dimension as a result of a scaling activity. If the adjustment type is PercentChangeInCapacity, the scaling policy changes the scalable dimension of the scalable target by this amount.

StepAdjustments List<PolicyStepScalingPolicyConfigurationStepAdjustmentArgs>

A set of adjustments that manage scaling. These have the following structure:

AdjustmentType string

Specifies whether the adjustment is an absolute number or a percentage of the current capacity. Valid values are ChangeInCapacity, ExactCapacity, and PercentChangeInCapacity.

Cooldown int

The amount of time, in seconds, after a scaling activity completes and before the next scaling activity can start.

MetricAggregationType string

The aggregation type for the policy’s metrics. Valid values are “Minimum”, “Maximum”, and “Average”. Without a value, AWS will treat the aggregation type as “Average”.

MinAdjustmentMagnitude int

The minimum number to adjust your scalable dimension as a result of a scaling activity. If the adjustment type is PercentChangeInCapacity, the scaling policy changes the scalable dimension of the scalable target by this amount.

StepAdjustments []PolicyStepScalingPolicyConfigurationStepAdjustment

A set of adjustments that manage scaling. These have the following structure:

adjustmentType string

Specifies whether the adjustment is an absolute number or a percentage of the current capacity. Valid values are ChangeInCapacity, ExactCapacity, and PercentChangeInCapacity.

cooldown number

The amount of time, in seconds, after a scaling activity completes and before the next scaling activity can start.

metricAggregationType string

The aggregation type for the policy’s metrics. Valid values are “Minimum”, “Maximum”, and “Average”. Without a value, AWS will treat the aggregation type as “Average”.

minAdjustmentMagnitude number

The minimum number to adjust your scalable dimension as a result of a scaling activity. If the adjustment type is PercentChangeInCapacity, the scaling policy changes the scalable dimension of the scalable target by this amount.

stepAdjustments PolicyStepScalingPolicyConfigurationStepAdjustment[]

A set of adjustments that manage scaling. These have the following structure:

adjustment_type str

Specifies whether the adjustment is an absolute number or a percentage of the current capacity. Valid values are ChangeInCapacity, ExactCapacity, and PercentChangeInCapacity.

cooldown float

The amount of time, in seconds, after a scaling activity completes and before the next scaling activity can start.

metric_aggregation_type str

The aggregation type for the policy’s metrics. Valid values are “Minimum”, “Maximum”, and “Average”. Without a value, AWS will treat the aggregation type as “Average”.

min_adjustment_magnitude float

The minimum number to adjust your scalable dimension as a result of a scaling activity. If the adjustment type is PercentChangeInCapacity, the scaling policy changes the scalable dimension of the scalable target by this amount.

step_adjustments List[PolicyStepScalingPolicyConfigurationStepAdjustment]

A set of adjustments that manage scaling. These have the following structure:

See the input and output API doc for this type.

See the input and output API doc for this type.

See the input and output API doc for this type.

ScalingAdjustment int

The number of members by which to scale, when the adjustment bounds are breached. A positive value scales up. A negative value scales down.

MetricIntervalLowerBound string

The lower bound for the difference between the alarm threshold and the CloudWatch metric. Without a value, AWS will treat this bound as negative infinity.

MetricIntervalUpperBound string

The upper bound for the difference between the alarm threshold and the CloudWatch metric. Without a value, AWS will treat this bound as infinity. The upper bound must be greater than the lower bound.

ScalingAdjustment int

The number of members by which to scale, when the adjustment bounds are breached. A positive value scales up. A negative value scales down.

MetricIntervalLowerBound string

The lower bound for the difference between the alarm threshold and the CloudWatch metric. Without a value, AWS will treat this bound as negative infinity.

MetricIntervalUpperBound string

The upper bound for the difference between the alarm threshold and the CloudWatch metric. Without a value, AWS will treat this bound as infinity. The upper bound must be greater than the lower bound.

scalingAdjustment number

The number of members by which to scale, when the adjustment bounds are breached. A positive value scales up. A negative value scales down.

metricIntervalLowerBound string

The lower bound for the difference between the alarm threshold and the CloudWatch metric. Without a value, AWS will treat this bound as negative infinity.

metricIntervalUpperBound string

The upper bound for the difference between the alarm threshold and the CloudWatch metric. Without a value, AWS will treat this bound as infinity. The upper bound must be greater than the lower bound.

scaling_adjustment float

The number of members by which to scale, when the adjustment bounds are breached. A positive value scales up. A negative value scales down.

metricIntervalLowerBound str

The lower bound for the difference between the alarm threshold and the CloudWatch metric. Without a value, AWS will treat this bound as negative infinity.

metricIntervalUpperBound str

The upper bound for the difference between the alarm threshold and the CloudWatch metric. Without a value, AWS will treat this bound as infinity. The upper bound must be greater than the lower bound.

See the input and output API doc for this type.

See the input and output API doc for this type.

See the input and output API doc for this type.

TargetValue double

The target value for the metric.

CustomizedMetricSpecification PolicyTargetTrackingScalingPolicyConfigurationCustomizedMetricSpecificationArgs

A custom CloudWatch metric. Documentation can be found at: AWS Customized Metric Specification. See supported fields below.

DisableScaleIn 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. The default value is false.

PredefinedMetricSpecification PolicyTargetTrackingScalingPolicyConfigurationPredefinedMetricSpecificationArgs

A predefined metric. See supported fields below.

ScaleInCooldown int

The amount of time, in seconds, after a scale in activity completes before another scale in activity can start.

ScaleOutCooldown int

The amount of time, in seconds, after a scale out activity completes before another scale out activity can start.

TargetValue float64

The target value for the metric.

CustomizedMetricSpecification PolicyTargetTrackingScalingPolicyConfigurationCustomizedMetricSpecification

A custom CloudWatch metric. Documentation can be found at: AWS Customized Metric Specification. See supported fields below.

DisableScaleIn 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. The default value is false.

PredefinedMetricSpecification PolicyTargetTrackingScalingPolicyConfigurationPredefinedMetricSpecification

A predefined metric. See supported fields below.

ScaleInCooldown int

The amount of time, in seconds, after a scale in activity completes before another scale in activity can start.

ScaleOutCooldown int

The amount of time, in seconds, after a scale out activity completes before another scale out activity can start.

targetValue number

The target value for the metric.

customizedMetricSpecification PolicyTargetTrackingScalingPolicyConfigurationCustomizedMetricSpecification

A custom CloudWatch metric. Documentation can be found at: AWS Customized Metric Specification. See supported fields below.

disableScaleIn boolean

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. The default value is false.

predefinedMetricSpecification PolicyTargetTrackingScalingPolicyConfigurationPredefinedMetricSpecification

A predefined metric. See supported fields below.

scaleInCooldown number

The amount of time, in seconds, after a scale in activity completes before another scale in activity can start.

scaleOutCooldown number

The amount of time, in seconds, after a scale out activity completes before another scale out activity can start.

targetValue float

The target value for the metric.

customizedMetricSpecification Dict[PolicyTargetTrackingScalingPolicyConfigurationCustomizedMetricSpecification]

A custom CloudWatch metric. Documentation can be found at: AWS Customized Metric Specification. See supported fields below.

disableScaleIn 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. The default value is false.

predefinedMetricSpecification Dict[PolicyTargetTrackingScalingPolicyConfigurationPredefinedMetricSpecification]

A predefined metric. See supported fields below.

scaleInCooldown float

The amount of time, in seconds, after a scale in activity completes before another scale in activity can start.

scaleOutCooldown float

The amount of time, in seconds, after a scale out activity completes before another scale out activity can start.

See the input and output API doc for this type.

See the input and output API doc for this type.

See the input and output API doc for this type.

MetricName string

The name of the metric.

Namespace string

The namespace of the metric.

Statistic string

The statistic of the metric. Valid values: Average, Minimum, Maximum, SampleCount, and Sum.

Dimensions List<PolicyTargetTrackingScalingPolicyConfigurationCustomizedMetricSpecificationDimensionArgs>

Configuration block(s) with the dimensions of the metric if the metric was published with dimensions. Detailed below.

Unit string

The unit of the metric.

MetricName string

The name of the metric.

Namespace string

The namespace of the metric.

Statistic string

The statistic of the metric. Valid values: Average, Minimum, Maximum, SampleCount, and Sum.

Dimensions []PolicyTargetTrackingScalingPolicyConfigurationCustomizedMetricSpecificationDimension

Configuration block(s) with the dimensions of the metric if the metric was published with dimensions. Detailed below.

Unit string

The unit of the metric.

metricName string

The name of the metric.

namespace string

The namespace of the metric.

statistic string

The statistic of the metric. Valid values: Average, Minimum, Maximum, SampleCount, and Sum.

dimensions PolicyTargetTrackingScalingPolicyConfigurationCustomizedMetricSpecificationDimension[]

Configuration block(s) with the dimensions of the metric if the metric was published with dimensions. Detailed below.

unit string

The unit of the metric.

metric_name str

The name of the metric.

namespace str

The namespace of the metric.

statistic str

The statistic of the metric. Valid values: Average, Minimum, Maximum, SampleCount, and Sum.

dimensions List[PolicyTargetTrackingScalingPolicyConfigurationCustomizedMetricSpecificationDimension]

Configuration block(s) with the dimensions of the metric if the metric was published with dimensions. Detailed below.

unit str

The unit of the metric.

See the input and output API doc for this type.

See the input and output API doc for this type.

See the input and output API doc for this type.

Name string

The name of the policy.

Value string

Value of the dimension.

Name string

The name of the policy.

Value string

Value of the dimension.

name string

The name of the policy.

value string

Value of the dimension.

name str

The name of the policy.

value str

Value of the dimension.

See the input and output API doc for this type.

See the input and output API doc for this type.

See the input and output API doc for this type.

PredefinedMetricType string

The metric type.

ResourceLabel string

Reserved for future use.

PredefinedMetricType string

The metric type.

ResourceLabel string

Reserved for future use.

predefinedMetricType string

The metric type.

resourceLabel string

Reserved for future use.

predefinedMetricType str

The metric type.

resourceLabel str

Reserved for future use.