CfnDimensionProps

class aws_cdk.aws_iot.CfnDimensionProps(*, string_values, type, name=None, tags=None)

Bases: object

Properties for defining a CfnDimension.

Parameters
  • string_values (Sequence[str]) – 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/#”).

  • type (str) – Specifies the type of dimension. Supported types: TOPIC_FILTER.

  • name (Optional[str]) – A unique identifier for the dimension.

  • tags (Optional[Sequence[Union[CfnTag, Dict[str, Any]]]]) – Metadata that can be used to manage the dimension.

Link

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

ExampleMetadata

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
import aws_cdk.aws_iot as iot

cfn_dimension_props = iot.CfnDimensionProps(
    string_values=["stringValues"],
    type="type",

    # the properties below are optional
    name="name",
    tags=[CfnTag(
        key="key",
        value="value"
    )]
)

Attributes

name

A unique identifier for the dimension.

Link

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

Return type

Optional[str]

string_values

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/#”).

Link

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

Return type

List[str]

tags

Metadata that can be used to manage the dimension.

Link

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

Return type

Optional[List[CfnTag]]

type

Specifies the type of dimension.

Supported types: TOPIC_FILTER.

Link

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

Return type

str