Class CfnCustomMetric
- All Implemented Interfaces:
IConstruct
,IDependable
,IInspectable
,software.amazon.jsii.JsiiSerializable
,software.constructs.IConstruct
AWS::IoT::CustomMetric
.
Use the AWS::IoT::CustomMetric
resource to define a custom metric published by your devices to Device Defender. For API reference, see CreateCustomMetric and for general information, see Custom metrics .
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import software.amazon.awscdk.services.iot.*; CfnCustomMetric cfnCustomMetric = CfnCustomMetric.Builder.create(this, "MyCfnCustomMetric") .metricType("metricType") // the properties below are optional .displayName("displayName") .metricName("metricName") .tags(List.of(CfnTag.builder() .key("key") .value("value") .build())) .build();
-
Nested Class Summary
Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject
software.amazon.jsii.JsiiObject.InitializationMode
Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IConstruct
IConstruct.Jsii$Default
Nested classes/interfaces inherited from interface software.constructs.IConstruct
software.constructs.IConstruct.Jsii$Default
Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IInspectable
IInspectable.Jsii$Default, IInspectable.Jsii$Proxy
-
Field Summary
Modifier and TypeFieldDescriptionstatic final String
The CloudFormation resource type name for this resource class. -
Constructor Summary
ModifierConstructorDescriptionCfnCustomMetric
(Construct scope, String id, CfnCustomMetricProps props) Create a newAWS::IoT::CustomMetric
.protected
CfnCustomMetric
(software.amazon.jsii.JsiiObject.InitializationMode initializationMode) protected
CfnCustomMetric
(software.amazon.jsii.JsiiObjectRef objRef) -
Method Summary
Modifier and TypeMethodDescriptionThe Amazon Resource Number (ARN) of the custom metric;The friendly name in the console for the custom metric.The name of the custom metric.The type of the custom metric.getTags()
Metadata that can be used to manage the custom metric.void
inspect
(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.renderProperties
(Map<String, Object> props) void
setDisplayName
(String value) The friendly name in the console for the custom metric.void
setMetricName
(String value) The name of the custom metric.void
setMetricType
(String value) The type of the custom metric.Methods inherited from class software.amazon.awscdk.core.CfnResource
addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, isCfnResource, shouldSynthesize, toString, validateProperties
Methods inherited from class software.amazon.awscdk.core.CfnRefElement
getRef
Methods inherited from class software.amazon.awscdk.core.CfnElement
getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId
Methods inherited from class software.amazon.awscdk.core.Construct
getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate
Methods inherited from class software.amazon.jsii.JsiiObject
jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson
-
Field Details
-
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
-
-
Constructor Details
-
CfnCustomMetric
protected CfnCustomMetric(software.amazon.jsii.JsiiObjectRef objRef) -
CfnCustomMetric
protected CfnCustomMetric(software.amazon.jsii.JsiiObject.InitializationMode initializationMode) -
CfnCustomMetric
@Stability(Stable) public CfnCustomMetric(@NotNull Construct scope, @NotNull String id, @NotNull CfnCustomMetricProps props) Create a newAWS::IoT::CustomMetric
.- Parameters:
scope
-- scope in which this resource is defined.
id
-- scoped id of the resource.
props
-- resource properties.
-
-
Method Details
-
inspect
Examines the CloudFormation resource and discloses attributes.- Specified by:
inspect
in interfaceIInspectable
- Parameters:
inspector
-- tree inspector to collect and process attributes.
-
renderProperties
@Stability(Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String, Object> props) - Overrides:
renderProperties
in classCfnResource
- Parameters:
props
- This parameter is required.
-
getAttrMetricArn
The Amazon Resource Number (ARN) of the custom metric;for example,
arn: *aws-partition* :iot: *region* : *accountId* :custommetric/ *metricName*
. -
getCfnProperties
- Overrides:
getCfnProperties
in classCfnResource
-
getTags
Metadata that can be used to manage the custom metric. -
getMetricType
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. -
setMetricType
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. -
getDisplayName
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.
-
setDisplayName
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.
-
getMetricName
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. -
setMetricName
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.
-