Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. AWS Cloud Control
  3. API Docs
  4. iot
  5. ThingType

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.26.0 published on Wednesday, Mar 12, 2025 by Pulumi
pulumi/pulumi-aws-native

aws-native.iot.ThingType

Explore with Pulumi AI

aws-native logo

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.26.0 published on Wednesday, Mar 12, 2025 by Pulumi
pulumi/pulumi-aws-native

    Resource Type definition for AWS::IoT::ThingType

    Create ThingType Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new ThingType(name: string, args?: ThingTypeArgs, opts?: CustomResourceOptions);
    @overload
def ThingType(resource_name: str,
              args: Optional[ThingTypeArgs] = None,
              opts: Optional[ResourceOptions] = None)

@overload
def ThingType(resource_name: str,
              opts: Optional[ResourceOptions] = None,
              deprecate_thing_type: Optional[bool] = None,
              tags: Optional[Sequence[_root_inputs.TagArgs]] = None,
              thing_type_name: Optional[str] = None,
              thing_type_properties: Optional[ThingTypePropertiesPropertiesArgs] = None)
    func NewThingType(ctx *Context, name string, args *ThingTypeArgs, opts ...ResourceOption) (*ThingType, error)
    public ThingType(string name, ThingTypeArgs? args = null, CustomResourceOptions? opts = null)
    public ThingType(String name, ThingTypeArgs args)
public ThingType(String name, ThingTypeArgs args, CustomResourceOptions options)

    type: aws-native:iot:ThingType
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

    Parameters

    name string
    The unique name of the resource.
    args ThingTypeArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args ThingTypeArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args ThingTypeArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args ThingTypeArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args ThingTypeArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    ThingType Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The ThingType resource accepts the following input properties:

    DeprecateThingType bool

    Deprecates a thing type. You can not associate new things with deprecated thing type.

    Requires permission to access the DeprecateThingType action.

    Tags List<Pulumi.AwsNative.Inputs.Tag>
    An array of key-value pairs to apply to this resource.
    ThingTypeName string
    The name of the thing type.
    ThingTypeProperties Pulumi.AwsNative.IoT.Inputs.ThingTypePropertiesProperties
    The thing type properties for the thing type to create. It contains information about the new thing type including a description, a list of searchable thing attribute names, and a list of propagating attributes. After a thing type is created, you can only update Mqtt5Configuration .
    DeprecateThingType bool

    Deprecates a thing type. You can not associate new things with deprecated thing type.

    Requires permission to access the DeprecateThingType action.

    Tags TagArgs
    An array of key-value pairs to apply to this resource.
    ThingTypeName string
    The name of the thing type.
    ThingTypeProperties ThingTypePropertiesPropertiesArgs
    The thing type properties for the thing type to create. It contains information about the new thing type including a description, a list of searchable thing attribute names, and a list of propagating attributes. After a thing type is created, you can only update Mqtt5Configuration .
    deprecateThingType Boolean

    Deprecates a thing type. You can not associate new things with deprecated thing type.

    Requires permission to access the DeprecateThingType action.

    tags List<Tag>
    An array of key-value pairs to apply to this resource.
    thingTypeName String
    The name of the thing type.
    thingTypeProperties ThingTypePropertiesProperties
    The thing type properties for the thing type to create. It contains information about the new thing type including a description, a list of searchable thing attribute names, and a list of propagating attributes. After a thing type is created, you can only update Mqtt5Configuration .
    deprecateThingType boolean

    Deprecates a thing type. You can not associate new things with deprecated thing type.

    Requires permission to access the DeprecateThingType action.

    tags Tag[]
    An array of key-value pairs to apply to this resource.
    thingTypeName string
    The name of the thing type.
    thingTypeProperties ThingTypePropertiesProperties
    The thing type properties for the thing type to create. It contains information about the new thing type including a description, a list of searchable thing attribute names, and a list of propagating attributes. After a thing type is created, you can only update Mqtt5Configuration .
    deprecate_thing_type bool

    Deprecates a thing type. You can not associate new things with deprecated thing type.

    Requires permission to access the DeprecateThingType action.

    tags Sequence[TagArgs]
    An array of key-value pairs to apply to this resource.
    thing_type_name str
    The name of the thing type.
    thing_type_properties ThingTypePropertiesPropertiesArgs
    The thing type properties for the thing type to create. It contains information about the new thing type including a description, a list of searchable thing attribute names, and a list of propagating attributes. After a thing type is created, you can only update Mqtt5Configuration .
    deprecateThingType Boolean

    Deprecates a thing type. You can not associate new things with deprecated thing type.

    Requires permission to access the DeprecateThingType action.

    tags List<Property Map>
    An array of key-value pairs to apply to this resource.
    thingTypeName String
    The name of the thing type.
    thingTypeProperties Property Map
    The thing type properties for the thing type to create. It contains information about the new thing type including a description, a list of searchable thing attribute names, and a list of propagating attributes. After a thing type is created, you can only update Mqtt5Configuration .

    Outputs

    All input properties are implicitly available as output properties. Additionally, the ThingType resource produces the following output properties:

    Arn string
    The thing type arn.
    AwsId string
    The thing type id.
    Id string
    The provider-assigned unique ID for this managed resource.
    Arn string
    The thing type arn.
    AwsId string
    The thing type id.
    Id string
    The provider-assigned unique ID for this managed resource.
    arn String
    The thing type arn.
    awsId String
    The thing type id.
    id String
    The provider-assigned unique ID for this managed resource.
    arn string
    The thing type arn.
    awsId string
    The thing type id.
    id string
    The provider-assigned unique ID for this managed resource.
    arn str
    The thing type arn.
    aws_id str
    The thing type id.
    id str
    The provider-assigned unique ID for this managed resource.
    arn String
    The thing type arn.
    awsId String
    The thing type id.
    id String
    The provider-assigned unique ID for this managed resource.

    Supporting Types

    Tag, TagArgs

    Key string
    The key name of the tag
    Value string
    The value of the tag
    Key string
    The key name of the tag
    Value string
    The value of the tag
    key String
    The key name of the tag
    value String
    The value of the tag
    key string
    The key name of the tag
    value string
    The value of the tag
    key str
    The key name of the tag
    value str
    The value of the tag
    key String
    The key name of the tag
    value String
    The value of the tag

    ThingTypePropagatingAttribute, ThingTypePropagatingAttributeArgs

    UserPropertyKey string
    The key of the MQTT 5 user property, which is a key-value pair.
    ConnectionAttribute Pulumi.AwsNative.IoT.ThingTypePropagatingAttributeConnectionAttribute
    The attribute associated with the connection details.
    ThingAttribute string
    The thing attribute that is propagating for MQTT 5 message enrichment.
    UserPropertyKey string
    The key of the MQTT 5 user property, which is a key-value pair.
    ConnectionAttribute ThingTypePropagatingAttributeConnectionAttribute
    The attribute associated with the connection details.
    ThingAttribute string
    The thing attribute that is propagating for MQTT 5 message enrichment.
    userPropertyKey String
    The key of the MQTT 5 user property, which is a key-value pair.
    connectionAttribute ThingTypePropagatingAttributeConnectionAttribute
    The attribute associated with the connection details.
    thingAttribute String
    The thing attribute that is propagating for MQTT 5 message enrichment.
    userPropertyKey string
    The key of the MQTT 5 user property, which is a key-value pair.
    connectionAttribute ThingTypePropagatingAttributeConnectionAttribute
    The attribute associated with the connection details.
    thingAttribute string
    The thing attribute that is propagating for MQTT 5 message enrichment.
    user_property_key str
    The key of the MQTT 5 user property, which is a key-value pair.
    connection_attribute ThingTypePropagatingAttributeConnectionAttribute
    The attribute associated with the connection details.
    thing_attribute str
    The thing attribute that is propagating for MQTT 5 message enrichment.
    userPropertyKey String
    The key of the MQTT 5 user property, which is a key-value pair.
    connectionAttribute ":ClientId" | ":Thing.ThingName"
    The attribute associated with the connection details.
    thingAttribute String
    The thing attribute that is propagating for MQTT 5 message enrichment.

    ThingTypePropagatingAttributeConnectionAttribute, ThingTypePropagatingAttributeConnectionAttributeArgs

    IotClientId
    iot:ClientId
    IotThingThingName
    iot:Thing.ThingName
    ThingTypePropagatingAttributeConnectionAttributeIotClientId
    iot:ClientId
    ThingTypePropagatingAttributeConnectionAttributeIotThingThingName
    iot:Thing.ThingName
    IotClientId
    iot:ClientId
    IotThingThingName
    iot:Thing.ThingName
    IotClientId
    iot:ClientId
    IotThingThingName
    iot:Thing.ThingName
    IOT_CLIENT_ID
    iot:ClientId
    IOT_THING_THING_NAME
    iot:Thing.ThingName
    "iot:ClientId"
    iot:ClientId
    "iot:Thing.ThingName"
    iot:Thing.ThingName

    ThingTypePropertiesProperties, ThingTypePropertiesPropertiesArgs

    Mqtt5Configuration Pulumi.AwsNative.IoT.Inputs.ThingTypePropertiesPropertiesMqtt5ConfigurationProperties
    The configuration to add user-defined properties to enrich MQTT 5 messages.
    SearchableAttributes List<string>
    A list of searchable thing attribute names.
    ThingTypeDescription string
    The description of the thing type.
    Mqtt5Configuration ThingTypePropertiesPropertiesMqtt5ConfigurationProperties
    The configuration to add user-defined properties to enrich MQTT 5 messages.
    SearchableAttributes []string
    A list of searchable thing attribute names.
    ThingTypeDescription string
    The description of the thing type.
    mqtt5Configuration ThingTypePropertiesPropertiesMqtt5ConfigurationProperties
    The configuration to add user-defined properties to enrich MQTT 5 messages.
    searchableAttributes List<String>
    A list of searchable thing attribute names.
    thingTypeDescription String
    The description of the thing type.
    mqtt5Configuration ThingTypePropertiesPropertiesMqtt5ConfigurationProperties
    The configuration to add user-defined properties to enrich MQTT 5 messages.
    searchableAttributes string[]
    A list of searchable thing attribute names.
    thingTypeDescription string
    The description of the thing type.
    mqtt5_configuration ThingTypePropertiesPropertiesMqtt5ConfigurationProperties
    The configuration to add user-defined properties to enrich MQTT 5 messages.
    searchable_attributes Sequence[str]
    A list of searchable thing attribute names.
    thing_type_description str
    The description of the thing type.
    mqtt5Configuration Property Map
    The configuration to add user-defined properties to enrich MQTT 5 messages.
    searchableAttributes List<String>
    A list of searchable thing attribute names.
    thingTypeDescription String
    The description of the thing type.

    ThingTypePropertiesPropertiesMqtt5ConfigurationProperties, ThingTypePropertiesPropertiesMqtt5ConfigurationPropertiesArgs

    Package Details

    Repository
    AWS Native pulumi/pulumi-aws-native
    License
    Apache-2.0
    aws-native logo

    We recommend new projects start with resources from the AWS provider.

    AWS Cloud Control v1.26.0 published on Wednesday, Mar 12, 2025 by Pulumi
    pulumi/pulumi-aws-native