software.amazon.awscdk.services.iot

Class CfnCustomMetric.Builder

java.lang.Object

software.amazon.awscdk.services.iot.CfnCustomMetric.Builder

Enclosing class:

CfnCustomMetric

public static final class CfnCustomMetric.Builder
extends java.lang.Object

A fluent builder for CfnCustomMetric.

Method Summary

Modifier and Type	Method and Description
CfnCustomMetric	build()
static CfnCustomMetric.Builder	create(Construct scope, java.lang.String id)
CfnCustomMetric.Builder	displayName(java.lang.String displayName) The friendly name in the console for the custom metric.
CfnCustomMetric.Builder	metricName(java.lang.String metricName) The name of the custom metric.
CfnCustomMetric.Builder	metricType(java.lang.String metricType) The type of the custom metric.
CfnCustomMetric.Builder	tags(java.util.List<? extends CfnTag> tags) Metadata that can be used to manage the custom metric.

Methods inherited from class java.lang.Object

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

Method Detail

create

public static CfnCustomMetric.Builder create(Construct scope,
                                             java.lang.String id)

Parameters:

scope - - scope in which this resource is defined. This parameter is required.

id - - scoped id of the resource. This parameter is required.

Returns:

a new instance of CfnCustomMetric.Builder.

metricType

public CfnCustomMetric.Builder metricType(java.lang.String metricType)

The type of the custom metric. Types include `string-list` , `ip-address-list` , `number-list` , and `number` .

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.

Parameters:

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

Returns:

this

displayName

public CfnCustomMetric.Builder displayName(java.lang.String 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.

Parameters:

displayName - The friendly name in the console for the custom metric. This parameter is required.

Returns:

this

metricName

public CfnCustomMetric.Builder metricName(java.lang.String 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.

Parameters:

metricName - The name of the custom metric. This parameter is required.

Returns:

this

tags

public CfnCustomMetric.Builder tags(java.util.List<? extends CfnTag> tags)

Metadata that can be used to manage the custom metric.

Parameters:

tags - Metadata that can be used to manage the custom metric. This parameter is required.

Returns:

this

build

public CfnCustomMetric build()