MetricTriggerArgs

data class MetricTriggerArgs(val dimensions: Output<List<ScaleRuleMetricDimensionArgs>>? = null, val dividePerInstance: Output<Boolean>? = null, val metricName: Output<String>, val metricNamespace: Output<String>? = null, val metricResourceLocation: Output<String>? = null, val metricResourceUri: Output<String>, val operator: Output<ComparisonOperationType>, val statistic: Output<MetricStatisticType>, val threshold: Output<Double>, val timeAggregation: Output<TimeAggregationType>, val timeGrain: Output<String>, val timeWindow: Output<String>) : ConvertibleToJava<MetricTriggerArgs>

The trigger that results in a scaling action.

Constructors

Link copied to clipboard
constructor(dimensions: Output<List<ScaleRuleMetricDimensionArgs>>? = null, dividePerInstance: Output<Boolean>? = null, metricName: Output<String>, metricNamespace: Output<String>? = null, metricResourceLocation: Output<String>? = null, metricResourceUri: Output<String>, operator: Output<ComparisonOperationType>, statistic: Output<MetricStatisticType>, threshold: Output<Double>, timeAggregation: Output<TimeAggregationType>, timeGrain: Output<String>, timeWindow: Output<String>)

Properties

Link copied to clipboard

List of dimension conditions. For example: [{"DimensionName":"AppName","Operator":"Equals","Values":"App1"},{"DimensionName":"Deployment","Operator":"Equals","Values":"default"}].

Link copied to clipboard
val dividePerInstance: Output<Boolean>? = null

a value indicating whether metric should divide per instance.

Link copied to clipboard
val metricName: Output<String>

the name of the metric that defines what the rule monitors.

Link copied to clipboard
val metricNamespace: Output<String>? = null

the namespace of the metric that defines what the rule monitors.

Link copied to clipboard
val metricResourceLocation: Output<String>? = null

the location of the resource the rule monitors.

Link copied to clipboard

the resource identifier of the resource the rule monitors.

Link copied to clipboard

the operator that is used to compare the metric data and the threshold.

Link copied to clipboard

the metric statistic type. How the metrics from multiple instances are combined.

Link copied to clipboard
val threshold: Output<Double>

the threshold of the metric that triggers the scale action.

Link copied to clipboard

time aggregation type. How the data that is collected should be combined over time. The default value is Average.

Link copied to clipboard
val timeGrain: Output<String>

the granularity of metrics the rule monitors. Must be one of the predefined values returned from metric definitions for the metric. Must be between 12 hours and 1 minute.

Link copied to clipboard
val timeWindow: Output<String>

the range of time in which instance data is collected. This value must be greater than the delay in metric collection, which can vary from resource-to-resource. Must be between 12 hours and 5 minutes.

Functions

Link copied to clipboard
open override fun toJava(): MetricTriggerArgs