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

Class CfnCustomMetricPropsMixin.Builder

java.lang.Object

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

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnCustomMetricPropsMixin>

Enclosing class:

CfnCustomMetricPropsMixin

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

A fluent builder for CfnCustomMetricPropsMixin.

Method Summary

Modifier and Type	Method	Description
CfnCustomMetricPropsMixin	build()
static CfnCustomMetricPropsMixin.Builder	create()
static CfnCustomMetricPropsMixin.Builder	create(CfnPropertyMixinOptions options)
CfnCustomMetricPropsMixin.Builder	displayName(String displayName)	The friendly name in the console for the custom metric.
CfnCustomMetricPropsMixin.Builder	metricName(String metricName)	The name of the custom metric.
CfnCustomMetricPropsMixin.Builder	metricType(String metricType)	The type of the custom metric.
CfnCustomMetricPropsMixin.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 Details

create

@Stability(Stable)
public static CfnCustomMetricPropsMixin.Builder create(CfnPropertyMixinOptions options)

Parameters:

options - Mixin options.

Returns:

a new instance of CfnCustomMetricPropsMixin.Builder.

create

@Stability(Stable)
public static CfnCustomMetricPropsMixin.Builder create()

Returns:

a new instance of CfnCustomMetricPropsMixin.Builder.

displayName

@Stability(Stable)
public CfnCustomMetricPropsMixin.Builder displayName(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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iot-custommetric.html#cfn-iot-custommetric-displayname

metricName

@Stability(Stable)
public CfnCustomMetricPropsMixin.Builder metricName(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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iot-custommetric.html#cfn-iot-custommetric-metricname

metricType

@Stability(Stable)
public CfnCustomMetricPropsMixin.Builder metricType(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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iot-custommetric.html#cfn-iot-custommetric-metrictype

tags

@Stability(Stable)
public CfnCustomMetricPropsMixin.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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iot-custommetric.html#cfn-iot-custommetric-tags

build

@Stability(Stable)
public CfnCustomMetricPropsMixin build()

Specified by:

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

Returns:

a newly built instance of CfnCustomMetricPropsMixin.