software.amazon.awscdk.services.iot

Class CfnCustomMetricProps.Builder

java.lang.Object

software.amazon.awscdk.services.iot.CfnCustomMetricProps.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnCustomMetricProps>

Enclosing interface:

CfnCustomMetricProps

@Stability(value=Stable)
public static final class CfnCustomMetricProps.Builder
extends Object
implements software.amazon.jsii.Builder<CfnCustomMetricProps>

A builder for CfnCustomMetricProps

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
CfnCustomMetricProps	build() Builds the configured instance.
CfnCustomMetricProps.Builder	displayName(String displayName) Sets the value of CfnCustomMetricProps.getDisplayName()
CfnCustomMetricProps.Builder	metricName(String metricName) Sets the value of CfnCustomMetricProps.getMetricName()
CfnCustomMetricProps.Builder	metricType(String metricType) Sets the value of CfnCustomMetricProps.getMetricType()
CfnCustomMetricProps.Builder	tags(List<? extends CfnTag> tags) Sets the value of CfnCustomMetricProps.getTags()

Methods inherited from class java.lang.Object

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

Constructor Detail

Builder

public Builder()

Method Detail

metricType

@Stability(value=Stable)
public CfnCustomMetricProps.Builder metricType(String metricType)

Sets the value of CfnCustomMetricProps.getMetricType()

Parameters:

metricType - The type of the custom metric. Types include `string-list` , `ip-address-list` , `number-list` , and `number` . This parameter is required.

The type number only takes a single metric value as an input, but when you submit the metrics value in the DeviceMetrics report, you must pass it as an array with a single value.

Returns:

this

displayName

@Stability(value=Stable)
public CfnCustomMetricProps.Builder displayName(String displayName)

Sets the value of CfnCustomMetricProps.getDisplayName()

Parameters:

displayName - The friendly name in the console for the custom metric. This name doesn't have to be unique. Don't use this name as the metric identifier in the device metric report. You can update the friendly name after you define it.

Returns:

this

metricName

@Stability(value=Stable)
public CfnCustomMetricProps.Builder metricName(String metricName)

Sets the value of CfnCustomMetricProps.getMetricName()

Parameters:

metricName - The name of the custom metric. This will be used in the metric report submitted from the device/thing. The name can't begin with aws: . You can’t change the name after you define it.

Returns:

this

tags

@Stability(value=Stable)
public CfnCustomMetricProps.Builder tags(List<? extends CfnTag> tags)

Sets the value of CfnCustomMetricProps.getTags()

Parameters:

tags - Metadata that can be used to manage the custom metric.

Returns:

this

build

@Stability(value=Stable)
public CfnCustomMetricProps build()

Builds the configured instance.

Specified by:

build in interface software.amazon.jsii.Builder<CfnCustomMetricProps>

Returns:

a new instance of CfnCustomMetricProps

Throws:

NullPointerException - if any required attribute was not provided