public static final class CfnAnomalyDetector.MetricDataQueryProperty.Builder
extends java.lang.Object
CfnAnomalyDetector.MetricDataQueryProperty| Constructor and Description |
|---|
Builder() |
public CfnAnomalyDetector.MetricDataQueryProperty.Builder id(java.lang.String id)
CfnAnomalyDetector.MetricDataQueryProperty.getId()id - A short name used to tie this object to the results in the response. This parameter is required.
This name must be unique within a single call to GetMetricData . If you are performing math expressions on this set of data, this name represents that data and can serve as a variable in the mathematical expression. The valid characters are letters, numbers, and underscore. The first character must be a lowercase letter.thispublic CfnAnomalyDetector.MetricDataQueryProperty.Builder accountId(java.lang.String accountId)
CfnAnomalyDetector.MetricDataQueryProperty.getAccountId()accountId - The ID of the account where the metrics are located, if this is a cross-account alarm.
Use this field only for PutMetricAlarm operations. It is not used in GetMetricData operations.thispublic CfnAnomalyDetector.MetricDataQueryProperty.Builder expression(java.lang.String expression)
CfnAnomalyDetector.MetricDataQueryProperty.getExpression()expression - This field can contain either a Metrics Insights query, or a metric math expression to be performed on the returned data.
For more information about Metrics Insights queries, see Metrics Insights query components and syntax in the Amazon CloudWatch User Guide .
A math expression can use the Id of the other metrics or queries to refer to those metrics, and can also use the Id of other expressions to use the result of those expressions. For more information about metric math expressions, see Metric Math Syntax and Functions in the Amazon CloudWatch User Guide .
Within each MetricDataQuery object, you must specify either Expression or MetricStat but not both.
thispublic CfnAnomalyDetector.MetricDataQueryProperty.Builder label(java.lang.String label)
CfnAnomalyDetector.MetricDataQueryProperty.getLabel()label - A human-readable label for this metric or expression.
This is especially useful if this is an expression, so that you know what the value represents. If the metric or expression is shown in a CloudWatch dashboard widget, the label is shown. If Label is omitted, CloudWatch generates a default.
You can put dynamic expressions into a label, so that it is more descriptive. For more information, see Using Dynamic Labels .
thispublic CfnAnomalyDetector.MetricDataQueryProperty.Builder metricStat(IResolvable metricStat)
CfnAnomalyDetector.MetricDataQueryProperty.getMetricStat()metricStat - The metric to be returned, along with statistics, period, and units.
Use this parameter only if this object is retrieving a metric and not performing a math expression on returned data.
Within one MetricDataQuery object, you must specify either Expression or MetricStat but not both.
thispublic CfnAnomalyDetector.MetricDataQueryProperty.Builder metricStat(CfnAnomalyDetector.MetricStatProperty metricStat)
CfnAnomalyDetector.MetricDataQueryProperty.getMetricStat()metricStat - The metric to be returned, along with statistics, period, and units.
Use this parameter only if this object is retrieving a metric and not performing a math expression on returned data.
Within one MetricDataQuery object, you must specify either Expression or MetricStat but not both.
thispublic CfnAnomalyDetector.MetricDataQueryProperty.Builder period(java.lang.Number period)
CfnAnomalyDetector.MetricDataQueryProperty.getPeriod()period - The granularity, in seconds, of the returned data points.
For metrics with regular resolution, a period can be as short as one minute (60 seconds) and must be a multiple of 60. For high-resolution metrics that are collected at intervals of less than one minute, the period can be 1, 5, 10, 30, 60, or any multiple of 60. High-resolution metrics are those metrics stored by a PutMetricData operation that includes a StorageResolution of 1 second .thispublic CfnAnomalyDetector.MetricDataQueryProperty.Builder returnData(java.lang.Boolean returnData)
CfnAnomalyDetector.MetricDataQueryProperty.getReturnData()returnData - When used in `GetMetricData` , this option indicates whether to return the timestamps and raw data values of this metric.
If you are performing this call just to do math expressions and do not also need the raw data returned, you can specify False . If you omit this, the default of True is used.
When used in PutMetricAlarm , specify True for the one expression result to use as the alarm. For all other metrics and expressions in the same PutMetricAlarm operation, specify ReturnData as False.
thispublic CfnAnomalyDetector.MetricDataQueryProperty.Builder returnData(IResolvable returnData)
CfnAnomalyDetector.MetricDataQueryProperty.getReturnData()returnData - When used in `GetMetricData` , this option indicates whether to return the timestamps and raw data values of this metric.
If you are performing this call just to do math expressions and do not also need the raw data returned, you can specify False . If you omit this, the default of True is used.
When used in PutMetricAlarm , specify True for the one expression result to use as the alarm. For all other metrics and expressions in the same PutMetricAlarm operation, specify ReturnData as False.
thispublic CfnAnomalyDetector.MetricDataQueryProperty build()
CfnAnomalyDetector.MetricDataQueryPropertyjava.lang.NullPointerException - if any required attribute was not provided