Package software.amazon.awscdk.cfnpropertymixins.services.iot

Class CfnCustomMetricMixinProps.Builder

java.lang.Object

software.amazon.awscdk.cfnpropertymixins.services.iot.CfnCustomMetricMixinProps.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnCustomMetricMixinProps>

Enclosing interface:

CfnCustomMetricMixinProps

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

A builder for CfnCustomMetricMixinProps

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

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

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

displayName

@Stability(Stable)
public CfnCustomMetricMixinProps.Builder displayName(String displayName)

Sets the value of CfnCustomMetricMixinProps.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(Stable)
public CfnCustomMetricMixinProps.Builder metricName(String metricName)

Sets the value of CfnCustomMetricMixinProps.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

metricType

@Stability(Stable)
public CfnCustomMetricMixinProps.Builder metricType(String metricType)

Sets the value of CfnCustomMetricMixinProps.getMetricType()

Parameters:

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.

Returns:

this

tags

@Stability(Stable)
public CfnCustomMetricMixinProps.Builder tags(List<? extends CfnTag> tags)

Sets the value of CfnCustomMetricMixinProps.getTags()

Parameters:

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

Returns:

this

build

@Stability(Stable)
public CfnCustomMetricMixinProps build()

Builds the configured instance.

Specified by:

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

Returns:

a new instance of CfnCustomMetricMixinProps

Throws:

NullPointerException - if any required attribute was not provided