software.amazon.awscdk.services.iot

Class CfnCustomMetric

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.core.Construct

software.amazon.awscdk.core.CfnElement

software.amazon.awscdk.core.CfnRefElement

software.amazon.awscdk.core.CfnResource

software.amazon.awscdk.services.iot.CfnCustomMetric

All Implemented Interfaces:

IDependable, IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct

@Generated(value="jsii-pacmak/1.50.0 (build d1830a4)",
           date="2022-01-04T15:39:10.168Z")
 @Stability(value=Stable)
public class CfnCustomMetric
extends CfnResource
implements IInspectable

A CloudFormation `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

Modifier and Type	Class and Description
static class	CfnCustomMetric.Builder A fluent builder for CfnCustomMetric.

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.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IConstruct

IConstruct.Jsii$Default

Field Summary

Fields

Modifier and Type	Field and Description
static String	CFN_RESOURCE_TYPE_NAME The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors

Modifier	Constructor and Description
	CfnCustomMetric(Construct scope, String id, CfnCustomMetricProps props) Create a new `AWS::IoT::CustomMetric`.
protected	CfnCustomMetric(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnCustomMetric(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
String	getAttrMetricArn() The Amazon Resource Number (ARN) of the custom metric;
protected Map<String,Object>	getCfnProperties()
String	getDisplayName() Field that represents a friendly name in the console for the custom metric;
String	getMetricName() The name of the custom metric.
String	getMetricType() The type of the custom metric.
TagManager	getTags() Metadata that can be used to manage the custom metric.
void	inspect(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setDisplayName(String value) Field that represents a 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 Detail

CFN_RESOURCE_TYPE_NAME

@Stability(value=Stable)
public static final String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Detail

CfnCustomMetric

protected CfnCustomMetric(software.amazon.jsii.JsiiObjectRef objRef)

CfnCustomMetric

protected CfnCustomMetric(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

CfnCustomMetric

@Stability(value=Stable)
public CfnCustomMetric(@NotNull
                                                Construct scope,
                                                @NotNull
                                                String id,
                                                @NotNull
                                                CfnCustomMetricProps props)

Create a new `AWS::IoT::CustomMetric`.

Parameters:

scope - - scope in which this resource is defined. This parameter is required.

id - - scoped id of the resource. This parameter is required.

props - - resource properties. This parameter is required.

Method Detail

inspect

@Stability(value=Stable)
public void inspect(@NotNull
                                             TreeInspector inspector)

Examines the CloudFormation resource and discloses attributes.

Specified by:

inspect in interface IInspectable

Parameters:

inspector - - tree inspector to collect and process attributes. This parameter is required.

renderProperties

@Stability(value=Stable)
 @NotNull
protected Map<String,Object> renderProperties(@NotNull
                                                                                 Map<String,Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getAttrMetricArn

@Stability(value=Stable)
 @NotNull
public String getAttrMetricArn()

The Amazon Resource Number (ARN) of the custom metric;

for example, arn: *aws-partition* :iot: *region* : *accountId* :custommetric/ *metricName* .

getCfnProperties

@Stability(value=Stable)
 @NotNull
protected Map<String,Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getTags

@Stability(value=Stable)
 @NotNull
public TagManager getTags()

Metadata that can be used to manage the custom metric.

getMetricType

@Stability(value=Stable)
 @NotNull
public String getMetricType()

The type of the custom metric.

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

setMetricType

@Stability(value=Stable)
public void setMetricType(@NotNull
                                                   String value)

The type of the custom metric.

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

getDisplayName

@Stability(value=Stable)
 @Nullable
public String getDisplayName()

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.

setDisplayName

@Stability(value=Stable)
public void setDisplayName(@Nullable
                                                    String value)

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.

getMetricName

@Stability(value=Stable)
 @Nullable
public String getMetricName()

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.

setMetricName

@Stability(value=Stable)
public void setMetricName(@Nullable
                                                   String value)

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.