1. Packages
  2. AWS Native
  3. API Docs
  4. iot
  5. ThingType

AWS Native is in preview. AWS Classic is fully supported.

AWS Native v0.108.3 published on Wednesday, Jun 12, 2024 by Pulumi

aws-native.iot.ThingType

Explore with Pulumi AI

aws-native logo

AWS Native is in preview. AWS Classic is fully supported.

AWS Native v0.108.3 published on Wednesday, Jun 12, 2024 by Pulumi

    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.

    Example

    The following reference example uses placeholder values for all input properties.

    Coming soon!
    
    Coming soon!
    
    Coming soon!
    
    Coming soon!
    
    const thingTypeResource = new aws_native.iot.ThingType("thingTypeResource", {
        deprecateThingType: false,
        tags: [{
            key: "string",
            value: "string",
        }],
        thingTypeName: "string",
        thingTypeProperties: {
            searchableAttributes: ["string"],
            thingTypeDescription: "string",
        },
    });
    
    Coming soon!
    

    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

    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, and a list of searchable thing attribute names. ThingTypeProperties can't be updated after the initial creation of the ThingType .
    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, and a list of searchable thing attribute names. ThingTypeProperties can't be updated after the initial creation of the ThingType .
    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, and a list of searchable thing attribute names. ThingTypeProperties can't be updated after the initial creation of the ThingType .
    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, and a list of searchable thing attribute names. ThingTypeProperties can't be updated after the initial creation of the ThingType .
    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, and a list of searchable thing attribute names. ThingTypeProperties can't be updated after the initial creation of the ThingType .
    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, and a list of searchable thing attribute names. ThingTypeProperties can't be updated after the initial creation of the ThingType .

    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

    ThingTypePropertiesProperties, ThingTypePropertiesPropertiesArgs

    SearchableAttributes List<string>
    A list of searchable thing attribute names.
    ThingTypeDescription string
    The description of the thing type.
    SearchableAttributes []string
    A list of searchable thing attribute names.
    ThingTypeDescription string
    The description of the thing type.
    searchableAttributes List<String>
    A list of searchable thing attribute names.
    thingTypeDescription String
    The description of the thing type.
    searchableAttributes string[]
    A list of searchable thing attribute names.
    thingTypeDescription string
    The description of the thing type.
    searchable_attributes Sequence[str]
    A list of searchable thing attribute names.
    thing_type_description str
    The description of the thing type.
    searchableAttributes List<String>
    A list of searchable thing attribute names.
    thingTypeDescription String
    The description of the thing type.

    Package Details

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

    AWS Native is in preview. AWS Classic is fully supported.

    AWS Native v0.108.3 published on Wednesday, Jun 12, 2024 by Pulumi