PolicyState class
Input properties used for looking up and filtering Policy resources.
Constructors
-
PolicyState({Input<
String?> ? adjustmentType, Input<String?> ? arn, Input<String?> ? autoscalingGroupName, Input<int?> ? cooldown, Input<bool?> ? enabled, Input<int?> ? estimatedInstanceWarmup, Input<String?> ? metricAggregationType, Input<int?> ? minAdjustmentMagnitude, Input<String?> ? name, Input<String?> ? policyType, Input<PolicyPredictiveScalingConfiguration?> ? predictiveScalingConfiguration, Input<String?> ? region, Input<int?> ? scalingAdjustment, Input<List< ? stepAdjustments, Input<PolicyStepAdjustment> ?>PolicyTargetTrackingConfiguration?> ? targetTrackingConfiguration}) -
Creates a new PolicyState.
adjustmentTypeWhether the adjustment is an absolute number or a percentage of the current capacity. Valid values areChangeInCapacity,ExactCapacity, andPercentChangeInCapacity.arnARN assigned by AWS to the scaling policy.autoscalingGroupNameName of the autoscaling group.cooldownAmount of time, in seconds, after a scaling activity completes and before the next scaling activity can start.enabledWhether the scaling policy is enabled or disabled. Default:true.estimatedInstanceWarmupEstimated time, in seconds, until a newly launched instance will contribute CloudWatch metrics. Without a value, AWS will default to the group's specified cooldown period.metricAggregationTypeAggregation type for the policy's metrics. Valid values are "Minimum", "Maximum", and "Average". Without a value, AWS will treat the aggregation type as "Average".minAdjustmentMagnitudeMinimum value to scale by whenadjustmentTypeis set toPercentChangeInCapacity.nameName of the policy.policyTypePolicy type, either "SimpleScaling", "StepScaling", "TargetTrackingScaling", or "PredictiveScaling". If this value isn't provided, AWS will default to "SimpleScaling."predictiveScalingConfigurationPredictive scaling policy configuration to use with Amazon EC2 Auto Scaling.regionRegion where this resource will be managed. Defaults to the Region set in the provider configuration.scalingAdjustmentNumber of members by which tostepAdjustmentsSet of adjustments that managetargetTrackingConfigurationTarget tracking policy. These have the following structure:const -
PolicyState.fromMap(Map<
String, dynamic> map) -
factory
Properties
-
adjustmentType
→ Input<
String?> ? -
Whether the adjustment is an absolute number or a percentage of the current capacity. Valid values are
ChangeInCapacity,ExactCapacity, andPercentChangeInCapacity.final -
arn
→ Input<
String?> ? -
ARN assigned by AWS to the scaling policy.
final
-
autoscalingGroupName
→ Input<
String?> ? -
Name of the autoscaling group.
final
-
cooldown
→ Input<
int?> ? -
Amount of time, in seconds, after a scaling activity completes and before the next scaling activity can start.
final
-
enabled
→ Input<
bool?> ? -
Whether the scaling policy is enabled or disabled. Default:
true.final -
estimatedInstanceWarmup
→ Input<
int?> ? -
Estimated time, in seconds, until a newly launched instance will contribute CloudWatch metrics. Without a value, AWS will default to the group's specified cooldown period.
final
- hashCode → int
-
The hash code for this object.
no setterinherited
-
metricAggregationType
→ Input<
String?> ? -
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".
final
-
minAdjustmentMagnitude
→ Input<
int?> ? -
Minimum value to scale by when
adjustmentTypeis set toPercentChangeInCapacity.final -
name
→ Input<
String?> ? -
Name of the policy.
final
-
policyType
→ Input<
String?> ? -
Policy type, either "SimpleScaling", "StepScaling", "TargetTrackingScaling", or "PredictiveScaling". If this value isn't provided, AWS will default to "SimpleScaling."
final
-
predictiveScalingConfiguration
→ Input<
PolicyPredictiveScalingConfiguration?> ? -
Predictive scaling policy configuration to use with Amazon EC2 Auto Scaling.
final
-
region
→ Input<
String?> ? -
Region where this resource will be managed. Defaults to the Region set in the provider configuration.
final
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
-
scalingAdjustment
→ Input<
int?> ? -
Number of members by which to
scale, when the adjustment bounds are breached. A positive value scales
up. A negative value scales down.
final
-
stepAdjustments
→ Input<
List< ?PolicyStepAdjustment> ?> -
Set of adjustments that manage
group scaling. These have the following structure:
final
-
targetTrackingConfiguration
→ Input<
PolicyTargetTrackingConfiguration?> ? -
Target tracking policy. These have the following structure:
final
Methods
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
toMap(
) → Map< String, dynamic> -
toString(
) → String -
A string representation of this object.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited