Package software.amazon.awscdk.services.iot

Class CfnDimension

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.CfnDimension
All Implemented Interfaces:
IConstruct, IDependable, IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct
@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)", date="2023-06-19T16:29:57.535Z") @Stability(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();

  • Field Details

    • CFN_RESOURCE_TYPE_NAME

      @Stability(Stable) public static final String CFN_RESOURCE_TYPE_NAME
      The CloudFormation resource type name for this resource class.

  • Constructor Details

    • CfnDimension

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

    • CfnDimension

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

    • CfnDimension

      @Stability(Stable) public CfnDimension(@NotNull 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 Details

    • inspect

      @Stability(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(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(Stable) @NotNull public String getAttrArn()
      The Amazon Resource Name (ARN) of the dimension.

    • getCfnProperties

      @Stability(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class CfnResource

    • getTags

      @Stability(Stable) @NotNull public TagManager getTags()
      Metadata that can be used to manage the dimension.

    • getStringValues

      @Stability(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(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(Stable) @NotNull public String getType()
      Specifies the type of dimension.

      Supported types: TOPIC_FILTER.

    • setType

      @Stability(Stable) public void setType(@NotNull String value)
      Specifies the type of dimension.

      Supported types: TOPIC_FILTER.

    • getName

      @Stability(Stable) @Nullable public String getName()
      A unique identifier for the dimension.

    • setName

      @Stability(Stable) public void setName(@Nullable String value)
      A unique identifier for the dimension.