AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

Class: Aws::IoT::Types::CreateDimensionRequest

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing CreateDimensionRequest as input to an Aws::Client method, you can use a vanilla Hash:

{
  name: "DimensionName", # required
  type: "TOPIC_FILTER", # required, accepts TOPIC_FILTER
  string_values: ["DimensionStringValue"], # required
  tags: [
    {
      key: "TagKey", # required
      value: "TagValue",
    },
  ],
  client_request_token: "ClientRequestToken", # required
}

Instance Attribute Summary collapse

Instance Attribute Details

#client_request_tokenString

Each dimension must have a unique client request token. If you try to create a new dimension with the same token as a dimension that already exists, an exception occurs. If you omit this value, AWS SDKs will automatically generate a unique client request.

Returns:

  • (String)

    Each dimension must have a unique client request token.

#nameString

A unique identifier for the dimension. Choose something that describes the type and value to make it easy to remember what it does.

Returns:

  • (String)

    A unique identifier for the dimension.

#string_valuesArray<String>

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

Returns:

  • (Array<String>)

    Specifies the value or list of values for the dimension.

#tagsArray<Types::Tag>

Metadata that can be used to manage the dimension.

Returns:

  • (Array<Types::Tag>)

    Metadata that can be used to manage the dimension.

#typeString

Specifies the type of dimension. Supported types: TOPIC_FILTER.

Possible values:

  • TOPIC_FILTER

Returns:

  • (String)

    Specifies the type of dimension.