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(Stable)
public static final class CfnCustomMetric.Builder
extends Object
implements software.amazon.jsii.Builder<CfnCustomMetric>
A fluent builder for
CfnCustomMetric
.-
Method Summary
Modifier and TypeMethodDescriptionbuild()
static CfnCustomMetric.Builder
displayName
(String displayName) The friendly name in the console for the custom metric.metricName
(String metricName) The name of the custom metric.metricType
(String metricType) The type of the custom metric.Metadata that can be used to manage the custom metric.
-
Method Details
-
create
@Stability(Stable) public static CfnCustomMetric.Builder create(software.constructs.Construct scope, String id) - Parameters:
scope
- Scope in which this resource is defined. This parameter is required.id
- Construct identifier for this resource (unique in its scope). This parameter is required.- Returns:
- a new instance of
CfnCustomMetric.Builder
.
-
metricType
The type of the custom metric. Types includestring-list
,ip-address-list
,number-list
, andnumber
.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 includestring-list
,ip-address-list
,number-list
, andnumber
. This parameter is required.- Returns:
this
- See Also:
-
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:
-
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:
-
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:
-
build
- Specified by:
build
in interfacesoftware.amazon.jsii.Builder<CfnCustomMetric>
- Returns:
- a newly built instance of
CfnCustomMetric
.
-