software.amazon.awscdk.services.iot

Class CfnCustomMetric.Builder

java.lang.Object

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

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnCustomMetric>

Enclosing class:

CfnCustomMetric

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

A fluent builder for CfnCustomMetric.

Method Summary

Modifier and Type	Method and Description
CfnCustomMetric	build()
static CfnCustomMetric.Builder	create(Construct scope, String id)
CfnCustomMetric.Builder	displayName(String displayName) Field that represents a friendly name in the console for the custom metric;
CfnCustomMetric.Builder	metricName(String metricName) The name of the custom metric.
CfnCustomMetric.Builder	metricType(String metricType) The type of the custom metric.
CfnCustomMetric.Builder	tags(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

@Stability(value=Stable)
public static CfnCustomMetric.Builder create(Construct scope,
                                                                      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

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

The type of the custom metric.

Types include string-list , ip-address-list , number-list , and number .

Parameters:

metricType - The type of the custom metric. This parameter is required.

Returns:

this

displayName

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

Field that represents a friendly name in the console for the custom metric;

it doesn't have to be unique. Don't use this name as the metric identifier in the device metric report. Can be updated.

Parameters:

displayName - Field that represents a friendly name in the console for the custom metric;. This parameter is required.

Returns:

this

metricName

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

The name of the custom metric.

This will be used in the metric report submitted from the device/thing. It shouldn't begin with aws: . Cannot be updated once it's defined.

Parameters:

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

Returns:

this

tags

@Stability(value=Stable)
public CfnCustomMetric.Builder tags(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

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

Specified by:

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