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

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb

Overview

Note:

When making an API call, you may pass CreateDimensionRequest data as a 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
}

Constant Summary collapse

SENSITIVE =
[]

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, Amazon Web Services SDKs will automatically generate a unique client request.

A suitable default value is auto-generated. You should normally not need to pass this option.

Returns:

  • (String)


3197
3198
3199
3200
3201
3202
3203
3204
3205
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb', line 3197

class CreateDimensionRequest < Struct.new(
  :name,
  :type,
  :string_values,
  :tags,
  :client_request_token)
  SENSITIVE = []
  include Aws::Structure
end

#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)


3197
3198
3199
3200
3201
3202
3203
3204
3205
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb', line 3197

class CreateDimensionRequest < Struct.new(
  :name,
  :type,
  :string_values,
  :tags,
  :client_request_token)
  SENSITIVE = []
  include Aws::Structure
end

#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>)


3197
3198
3199
3200
3201
3202
3203
3204
3205
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb', line 3197

class CreateDimensionRequest < Struct.new(
  :name,
  :type,
  :string_values,
  :tags,
  :client_request_token)
  SENSITIVE = []
  include Aws::Structure
end

#tagsArray<Types::Tag>

Metadata that can be used to manage the dimension.

Returns:



3197
3198
3199
3200
3201
3202
3203
3204
3205
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb', line 3197

class CreateDimensionRequest < Struct.new(
  :name,
  :type,
  :string_values,
  :tags,
  :client_request_token)
  SENSITIVE = []
  include Aws::Structure
end

#typeString

Specifies the type of dimension. Supported types: TOPIC_FILTER.

Returns:

  • (String)


3197
3198
3199
3200
3201
3202
3203
3204
3205
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb', line 3197

class CreateDimensionRequest < Struct.new(
  :name,
  :type,
  :string_values,
  :tags,
  :client_request_token)
  SENSITIVE = []
  include Aws::Structure
end