software.amazon.awscdk.services.iot

Class CfnDimension

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.CfnElement

software.amazon.awscdk.CfnRefElement

software.amazon.awscdk.CfnResource

software.amazon.awscdk.services.iot.CfnDimension

All Implemented Interfaces:

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

@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:39.854Z")
 @Stability(value=Stable)
public class CfnDimension
extends CfnResource
implements IInspectable

A CloudFormation `AWS::IoT::Dimension`.

Use the AWS::IoT::Dimension to limit the scope of a metric used in a security profile for AWS IoT Device Defender . For example, using a TOPIC_FILTER dimension, you can narrow down the scope of the metric to only MQTT topics where the name matches the pattern specified in the dimension. For API reference, see CreateDimension and for general information, see Scoping metrics in security profiles using dimensions .

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.*;
 CfnDimension cfnDimension = CfnDimension.Builder.create(this, "MyCfnDimension")
         .stringValues(List.of("stringValues"))
         .type("type")
         // the properties below are optional
         .name("name")
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();
 

Nested Class Summary

Nested Classes

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

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.amazon.awscdk.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.constructs.IConstruct

software.constructs.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
	CfnDimension(software.constructs.Construct scope, String id, CfnDimensionProps props) Create a new `AWS::IoT::Dimension`.
protected	CfnDimension(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnDimension(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
String	getAttrArn() The Amazon Resource Name (ARN) of the dimension.
protected Map<String,Object>	getCfnProperties()
String	getName() A unique identifier for the dimension.
List<String>	getStringValues() Specifies the value or list of values for the dimension.
TagManager	getTags() Metadata that can be used to manage the dimension.
String	getType() Specifies the type of dimension.
void	inspect(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setName(String value) A unique identifier for the dimension.
void	setStringValues(List<String> value) Specifies the value or list of values for the dimension.
void	setType(String value) Specifies the type of dimension.

Methods inherited from class software.amazon.awscdk.CfnResource

addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, getUpdatedProperties, isCfnResource, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.constructs.Construct

getNode, isConstruct

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

CfnDimension

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

CfnDimension

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

CfnDimension

@Stability(value=Stable)
public CfnDimension(@NotNull
                                             software.constructs.Construct scope,
                                             @NotNull
                                             String id,
                                             @NotNull
                                             CfnDimensionProps props)

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

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.

getAttrArn

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

The Amazon Resource Name (ARN) of the dimension.

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

getStringValues

@Stability(value=Stable)
 @NotNull
public List<String> getStringValues()

Specifies the value or list of values for the dimension.

For TOPIC_FILTER dimensions, this is a pattern used to match the MQTT topic (for example, "admin/#").

setStringValues

@Stability(value=Stable)
public void setStringValues(@NotNull
                                                     List<String> value)

Specifies the value or list of values for the dimension.

For TOPIC_FILTER dimensions, this is a pattern used to match the MQTT topic (for example, "admin/#").

getType

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

Specifies the type of dimension.

Supported types: TOPIC_FILTER.

setType

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

Specifies the type of dimension.

Supported types: TOPIC_FILTER.

getName

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

A unique identifier for the dimension.

setName

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

A unique identifier for the dimension.