Package software.amazon.awscdk.services.iot

Interface CfnDimensionProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnDimensionProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.98.0 (build 00b106d)",
           date="2024-05-24T02:42:39.278Z")
@Stability(Stable)
public interface CfnDimensionProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a CfnDimension.

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.*;
 CfnDimensionProps cfnDimensionProps = CfnDimensionProps.builder()
         .stringValues(List.of("stringValues"))
         .type("type")
         // the properties below are optional
         .name("name")
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iot-dimension.html

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnDimensionProps.Builder	A builder for CfnDimensionProps
static final class	CfnDimensionProps.Jsii$Proxy	An implementation for CfnDimensionProps

Method Summary

Modifier and Type	Method	Description
static CfnDimensionProps.Builder	builder()
default String	getName()	A unique identifier for the dimension.
List<String>	getStringValues()	Specifies the value or list of values for the dimension.
default List<CfnTag>	getTags()	Metadata that can be used to manage the dimension.
String	getType()	Specifies the type of dimension.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getStringValues

@Stability(Stable)
@NotNull
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/#").

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iot-dimension.html#cfn-iot-dimension-stringvalues

getType

@Stability(Stable)
@NotNull
String getType()

Specifies the type of dimension.

Supported types: TOPIC_FILTER.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iot-dimension.html#cfn-iot-dimension-type

getName

@Stability(Stable)
@Nullable
default String getName()

A unique identifier for the dimension.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iot-dimension.html#cfn-iot-dimension-name

getTags

@Stability(Stable)
@Nullable
default List<CfnTag> getTags()

Metadata that can be used to manage the dimension.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iot-dimension.html#cfn-iot-dimension-tags

builder

@Stability(Stable)
static CfnDimensionProps.Builder builder()

Returns:

a CfnDimensionProps.Builder of CfnDimensionProps