Package software.amazon.awscdk.services.cloudwatch

Class CfnAnomalyDetector.MetricDataQueryProperty.Builder

java.lang.Object

software.amazon.awscdk.services.cloudwatch.CfnAnomalyDetector.MetricDataQueryProperty.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnAnomalyDetector.MetricDataQueryProperty>

Enclosing interface:

CfnAnomalyDetector.MetricDataQueryProperty

@Stability(Stable)
public static final class CfnAnomalyDetector.MetricDataQueryProperty.Builder
extends Object
implements software.amazon.jsii.Builder<CfnAnomalyDetector.MetricDataQueryProperty>

A builder for CfnAnomalyDetector.MetricDataQueryProperty

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
CfnAnomalyDetector.MetricDataQueryProperty.Builder	accountId(String accountId)	Sets the value of CfnAnomalyDetector.MetricDataQueryProperty.getAccountId()
CfnAnomalyDetector.MetricDataQueryProperty	build()	Builds the configured instance.
CfnAnomalyDetector.MetricDataQueryProperty.Builder	expression(String expression)	Sets the value of CfnAnomalyDetector.MetricDataQueryProperty.getExpression()
CfnAnomalyDetector.MetricDataQueryProperty.Builder	id(String id)	Sets the value of CfnAnomalyDetector.MetricDataQueryProperty.getId()
CfnAnomalyDetector.MetricDataQueryProperty.Builder	label(String label)	Sets the value of CfnAnomalyDetector.MetricDataQueryProperty.getLabel()
CfnAnomalyDetector.MetricDataQueryProperty.Builder	metricStat(IResolvable metricStat)	Sets the value of CfnAnomalyDetector.MetricDataQueryProperty.getMetricStat()
CfnAnomalyDetector.MetricDataQueryProperty.Builder	metricStat(CfnAnomalyDetector.MetricStatProperty metricStat)	Sets the value of CfnAnomalyDetector.MetricDataQueryProperty.getMetricStat()
CfnAnomalyDetector.MetricDataQueryProperty.Builder	period(Number period)	Sets the value of CfnAnomalyDetector.MetricDataQueryProperty.getPeriod()
CfnAnomalyDetector.MetricDataQueryProperty.Builder	returnData(Boolean returnData)	Sets the value of CfnAnomalyDetector.MetricDataQueryProperty.getReturnData()
CfnAnomalyDetector.MetricDataQueryProperty.Builder	returnData(IResolvable returnData)	Sets the value of CfnAnomalyDetector.MetricDataQueryProperty.getReturnData()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

Builder

public Builder()

Method Details

id

@Stability(Stable)
public CfnAnomalyDetector.MetricDataQueryProperty.Builder id(String id)

Sets the value of CfnAnomalyDetector.MetricDataQueryProperty.getId()

Parameters:

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.

Returns:

this

accountId

@Stability(Stable)
public CfnAnomalyDetector.MetricDataQueryProperty.Builder accountId(String accountId)

Sets the value of CfnAnomalyDetector.MetricDataQueryProperty.getAccountId()

Parameters:

accountId - The ID of the account where the metrics are located. If you are performing a GetMetricData operation in a monitoring account, use this to specify which account to retrieve this metric from.

If you are performing a PutMetricAlarm operation, use this to specify which account contains the metric that the alarm is watching.

Returns:

this

expression

@Stability(Stable)
public CfnAnomalyDetector.MetricDataQueryProperty.Builder expression(String expression)

Sets the value of CfnAnomalyDetector.MetricDataQueryProperty.getExpression()

Parameters:

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.

Returns:

this

label

@Stability(Stable)
public CfnAnomalyDetector.MetricDataQueryProperty.Builder label(String label)

Sets the value of CfnAnomalyDetector.MetricDataQueryProperty.getLabel()

Parameters:

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 .

Returns:

this

metricStat

@Stability(Stable)
public CfnAnomalyDetector.MetricDataQueryProperty.Builder metricStat(IResolvable metricStat)

Sets the value of CfnAnomalyDetector.MetricDataQueryProperty.getMetricStat()

Parameters:

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.

Returns:

this

metricStat

@Stability(Stable)
public CfnAnomalyDetector.MetricDataQueryProperty.Builder metricStat(CfnAnomalyDetector.MetricStatProperty metricStat)

Sets the value of CfnAnomalyDetector.MetricDataQueryProperty.getMetricStat()

Parameters:

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.

Returns:

this

period

@Stability(Stable)
public CfnAnomalyDetector.MetricDataQueryProperty.Builder period(Number period)

Sets the value of CfnAnomalyDetector.MetricDataQueryProperty.getPeriod()

Parameters:

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 .

Returns:

this

returnData

@Stability(Stable)
public CfnAnomalyDetector.MetricDataQueryProperty.Builder returnData(Boolean returnData)

Sets the value of CfnAnomalyDetector.MetricDataQueryProperty.getReturnData()

Parameters:

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.

Returns:

this

returnData

@Stability(Stable)
public CfnAnomalyDetector.MetricDataQueryProperty.Builder returnData(IResolvable returnData)

Sets the value of CfnAnomalyDetector.MetricDataQueryProperty.getReturnData()

Parameters:

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.

Returns:

this

build

@Stability(Stable)
public CfnAnomalyDetector.MetricDataQueryProperty build()

Builds the configured instance.

Specified by:

build in interface software.amazon.jsii.Builder<CfnAnomalyDetector.MetricDataQueryProperty>

Returns:

a new instance of CfnAnomalyDetector.MetricDataQueryProperty

Throws:

NullPointerException - if any required attribute was not provided