pulumi-aws-native-kotlin/com.pulumi.awsnative.applicationautoscaling.kotlin.outputs

Package-level declarations

Types

Link copied to clipboard
data class GetScalableTargetResult(val id: String? = null, val maxCapacity: Int? = null, val minCapacity: Int? = null, val scheduledActions: List<ScalableTargetScheduledAction>? = null, val suspendedState: ScalableTargetSuspendedState? = null)
Link copied to clipboard
data class GetScalingPolicyResult(val arn: String? = null, val policyType: String? = null, val predictiveScalingPolicyConfiguration: ScalingPolicyPredictiveScalingPolicyConfiguration? = null, val stepScalingPolicyConfiguration: ScalingPolicyStepScalingPolicyConfiguration? = null, val targetTrackingScalingPolicyConfiguration: ScalingPolicyTargetTrackingScalingPolicyConfiguration? = null)
Link copied to clipboard
data class ScalableTargetAction(val maxCapacity: Int? = null, val minCapacity: Int? = null)

`ScalableTargetAction` specifies the minimum and maximum capacity for the `ScalableTargetAction` property of the AWS::ApplicationAutoScaling::ScalableTarget ScheduledAction property type.

Link copied to clipboard
data class ScalableTargetScheduledAction(val endTime: String? = null, val scalableTargetAction: ScalableTargetAction? = null, val schedule: String, val scheduledActionName: String, val startTime: String? = null, val timezone: String? = null)

`ScheduledAction` is a property of the AWS::ApplicationAutoScaling::ScalableTarget resource that specifies a scheduled action for a scalable target. For more information, see Scheduled scaling in the Application Auto Scaling User Guide.

Link copied to clipboard
data class ScalableTargetSuspendedState(val dynamicScalingInSuspended: Boolean? = null, val dynamicScalingOutSuspended: Boolean? = null, val scheduledScalingSuspended: Boolean? = null)

`SuspendedState` is a property of the AWS::ApplicationAutoScaling::ScalableTarget resource that specifies whether the scaling activities for a scalable target are in a suspended state. For more information, see Suspending and resuming scaling in the Application Auto Scaling User Guide.

data class ScalingPolicyCustomizedMetricSpecification(val dimensions: List<ScalingPolicyMetricDimension>? = null, val metricName: String? = null, val metrics: List<ScalingPolicyTargetTrackingMetricDataQuery>? = null, val namespace: String? = null, val statistic: String? = null, val unit: String? = null)

Contains customized metric specification information for a target tracking scaling policy for Application Auto Scaling. For information about the available metrics for a service, see services that publish CloudWatch metrics in the Amazon CloudWatch User Guide. To create your customized metric specification:

Link copied to clipboard
data class ScalingPolicyMetricDimension(val name: String, val value: String)

`MetricDimension` specifies a name/value pair that is part of the identity of a CloudWatch metric for the `Dimensions` property of the AWS::ApplicationAutoScaling::ScalingPolicy CustomizedMetricSpecification property type. Duplicate dimensions are not allowed.

data class ScalingPolicyPredefinedMetricSpecification(val predefinedMetricType: String, val resourceLabel: String? = null)

Contains predefined metric specification information for a target tracking scaling policy for Application Auto Scaling. `PredefinedMetricSpecification` is a property of the AWS::ApplicationAutoScaling::ScalingPolicy TargetTrackingScalingPolicyConfiguration property type.

data class ScalingPolicyPredictiveScalingCustomizedCapacityMetric(val metricDataQueries: List<ScalingPolicyPredictiveScalingMetricDataQuery>)

Represents a CloudWatch metric of your choosing for a predictive scaling policy.

data class ScalingPolicyPredictiveScalingCustomizedLoadMetric(val metricDataQueries: List<ScalingPolicyPredictiveScalingMetricDataQuery>)

The customized load metric specification.

data class ScalingPolicyPredictiveScalingCustomizedScalingMetric(val metricDataQueries: List<ScalingPolicyPredictiveScalingMetricDataQuery>)

One or more metric data queries to provide data points for a metric specification.

Link copied to clipboard
data class ScalingPolicyPredictiveScalingMetric(val dimensions: List<ScalingPolicyPredictiveScalingMetricDimension>? = null, val metricName: String? = null, val namespace: String? = null)

Describes the scaling metric.

data class ScalingPolicyPredictiveScalingMetricDataQuery(val expression: String? = null, val id: String? = null, val label: String? = null, val metricStat: ScalingPolicyPredictiveScalingMetricStat? = null, val returnData: Boolean? = null)

The metric data to return. Also defines whether this call is returning data for one metric only, or whether it is performing a math expression on the values of returned metric statistics to create a new time series. A time series is a series of data points, each of which is associated with a timestamp.

data class ScalingPolicyPredictiveScalingMetricDimension(val name: String? = null, val value: String? = null)

Describes the dimension of a metric.

data class ScalingPolicyPredictiveScalingMetricSpecification(val customizedCapacityMetricSpecification: ScalingPolicyPredictiveScalingCustomizedCapacityMetric? = null, val customizedLoadMetricSpecification: ScalingPolicyPredictiveScalingCustomizedLoadMetric? = null, val customizedScalingMetricSpecification: ScalingPolicyPredictiveScalingCustomizedScalingMetric? = null, val predefinedLoadMetricSpecification: ScalingPolicyPredictiveScalingPredefinedLoadMetric? = null, val predefinedMetricPairSpecification: ScalingPolicyPredictiveScalingPredefinedMetricPair? = null, val predefinedScalingMetricSpecification: ScalingPolicyPredictiveScalingPredefinedScalingMetric? = null, val targetValue: Double)

This structure specifies the metrics and target utilization settings for a predictive scaling policy. You must specify either a metric pair, or a load metric and a scaling metric individually. Specifying a metric pair instead of individual metrics provides a simpler way to configure metrics for a scaling policy. You choose the metric pair, and the policy automatically knows the correct sum and average statistics to use for the load metric and the scaling metric.

Link copied to clipboard
data class ScalingPolicyPredictiveScalingMetricStat(val metric: ScalingPolicyPredictiveScalingMetric? = null, val stat: String? = null, val unit: String? = null)

This structure defines the CloudWatch metric to return, along with the statistic and unit.

data class ScalingPolicyPredictiveScalingPolicyConfiguration(val maxCapacityBreachBehavior: String? = null, val maxCapacityBuffer: Int? = null, val metricSpecifications: List<ScalingPolicyPredictiveScalingMetricSpecification>, val mode: String? = null, val schedulingBufferTime: Int? = null)

Represents a predictive scaling policy configuration.

data class ScalingPolicyPredictiveScalingPredefinedLoadMetric(val predefinedMetricType: String, val resourceLabel: String? = null)

Describes a load metric for a predictive scaling policy. When returned in the output of `DescribePolicies`, it indicates that a predictive scaling policy uses individually specified load and scaling metrics instead of a metric pair.

data class ScalingPolicyPredictiveScalingPredefinedMetricPair(val predefinedMetricType: String, val resourceLabel: String? = null)

Represents a metric pair for a predictive scaling policy.

data class ScalingPolicyPredictiveScalingPredefinedScalingMetric(val predefinedMetricType: String, val resourceLabel: String? = null)

Describes a scaling metric for a predictive scaling policy. When returned in the output of `DescribePolicies`, it indicates that a predictive scaling policy uses individually specified load and scaling metrics instead of a metric pair.

Link copied to clipboard
data class ScalingPolicyStepAdjustment(val metricIntervalLowerBound: Double? = null, val metricIntervalUpperBound: Double? = null, val scalingAdjustment: Int)

`StepAdjustment` specifies a step adjustment for the `StepAdjustments` property of the AWS::ApplicationAutoScaling::ScalingPolicy StepScalingPolicyConfiguration property type. For the following examples, suppose that you have an alarm with a breach threshold of 50:

data class ScalingPolicyStepScalingPolicyConfiguration(val adjustmentType: String? = null, val cooldown: Int? = null, val metricAggregationType: String? = null, val minAdjustmentMagnitude: Int? = null, val stepAdjustments: List<ScalingPolicyStepAdjustment>? = null)

`StepScalingPolicyConfiguration` is a property of the AWS::ApplicationAutoScaling::ScalingPolicy resource that specifies a step scaling policy configuration for Application Auto Scaling. For more information, see Step scaling policies in the Application Auto Scaling User Guide.

Link copied to clipboard
data class ScalingPolicyTargetTrackingMetric(val dimensions: List<ScalingPolicyTargetTrackingMetricDimension>? = null, val metricName: String? = null, val namespace: String? = null)

Represents a specific metric for a target tracking scaling policy for Application Auto Scaling. Metric is a property of the AWS::ApplicationAutoScaling::ScalingPolicy TargetTrackingMetricStat property type.

data class ScalingPolicyTargetTrackingMetricDataQuery(val expression: String? = null, val id: String? = null, val label: String? = null, val metricStat: ScalingPolicyTargetTrackingMetricStat? = null, val returnData: Boolean? = null)

The metric data to return. Also defines whether this call is returning data for one metric only, or whether it is performing a math expression on the values of returned metric statistics to create a new time series. A time series is a series of data points, each of which is associated with a timestamp. You can call for a single metric or perform math expressions on multiple metrics. Any expressions used in a metric specification must eventually return a single time series. For more information and examples, see Create a target tracking scaling policy for Application Auto Scaling using metric math in the Application Auto Scaling User Guide. `TargetTrackingMetricDataQuery` is a property of the AWS::ApplicationAutoScaling::ScalingPolicy CustomizedMetricSpecification property type.

data class ScalingPolicyTargetTrackingMetricDimension(val name: String? = null, val value: String? = null)

`TargetTrackingMetricDimension` specifies a name/value pair that is part of the identity of a CloudWatch metric for the `Dimensions` property of the AWS::ApplicationAutoScaling::ScalingPolicy TargetTrackingMetric property type. Duplicate dimensions are not allowed.

Link copied to clipboard
data class ScalingPolicyTargetTrackingMetricStat(val metric: ScalingPolicyTargetTrackingMetric? = null, val stat: String? = null, val unit: String? = null)

This structure defines the CloudWatch metric to return, along with the statistic and unit. `TargetTrackingMetricStat` is a property of the AWS::ApplicationAutoScaling::ScalingPolicy TargetTrackingMetricDataQuery property type. For more information about the CloudWatch terminology below, see Amazon CloudWatch concepts in the Amazon CloudWatch User Guide.

data class ScalingPolicyTargetTrackingScalingPolicyConfiguration(val customizedMetricSpecification: ScalingPolicyCustomizedMetricSpecification? = null, val disableScaleIn: Boolean? = null, val predefinedMetricSpecification: ScalingPolicyPredefinedMetricSpecification? = null, val scaleInCooldown: Int? = null, val scaleOutCooldown: Int? = null, val targetValue: Double)

`TargetTrackingScalingPolicyConfiguration` is a property of the AWS::ApplicationAutoScaling::ScalingPolicy resource that specifies a target tracking scaling policy configuration for Application Auto Scaling. Use a target tracking scaling policy to adjust the capacity of the specified scalable target in response to actual workloads, so that resource utilization remains at or near the target utilization value. For more information, see Target tracking scaling policies in the Application Auto Scaling User Guide.