This is the new *CloudFormation Template Reference Guide*. Please update your bookmarks and links. For help getting started with CloudFormation, see the [AWS CloudFormation User Guide](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/Welcome.html).

# AWS::IoT::ThingType
<a name="aws-resource-iot-thingtype"></a>

Creates a new thing type.

## Syntax
<a name="aws-resource-iot-thingtype-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-resource-iot-thingtype-syntax.json"></a>

```
{
  "Type" : "AWS::IoT::ThingType",
  "Properties" : {
      "[DeprecateThingType](#cfn-iot-thingtype-deprecatethingtype)" : Boolean,
      "[Tags](#cfn-iot-thingtype-tags)" : [ Tag, ... ],
      "[ThingTypeName](#cfn-iot-thingtype-thingtypename)" : String,
      "[ThingTypeProperties](#cfn-iot-thingtype-thingtypeproperties)" : ThingTypeProperties
    }
}
```

### YAML
<a name="aws-resource-iot-thingtype-syntax.yaml"></a>

```
Type: AWS::IoT::ThingType
Properties:
  [DeprecateThingType](#cfn-iot-thingtype-deprecatethingtype): Boolean
  [Tags](#cfn-iot-thingtype-tags): 
    - Tag
  [ThingTypeName](#cfn-iot-thingtype-thingtypename): String
  [ThingTypeProperties](#cfn-iot-thingtype-thingtypeproperties): 
    ThingTypeProperties
```

## Properties
<a name="aws-resource-iot-thingtype-properties"></a>

`DeprecateThingType`  <a name="cfn-iot-thingtype-deprecatethingtype"></a>
Deprecates a thing type. You can not associate new things with deprecated thing type.  
Requires permission to access the [DeprecateThingType](https://docs.aws.amazon.com//service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) action.  
*Required*: No  
*Type*: Boolean  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Tags`  <a name="cfn-iot-thingtype-tags"></a>
Metadata which can be used to manage the thing type.  
*Required*: No  
*Type*: Array of [Tag](aws-properties-iot-thingtype-tag.md)  
*Maximum*: `50`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`ThingTypeName`  <a name="cfn-iot-thingtype-thingtypename"></a>
The name of the thing type.  
*Required*: No  
*Type*: String  
*Pattern*: `[a-zA-Z0-9:_-]+`  
*Minimum*: `1`  
*Maximum*: `128`  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`ThingTypeProperties`  <a name="cfn-iot-thingtype-thingtypeproperties"></a>
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`.   
*Required*: No  
*Type*: [ThingTypeProperties](aws-properties-iot-thingtype-thingtypeproperties.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

## Return values
<a name="aws-resource-iot-thingtype-return-values"></a>

### Ref
<a name="aws-resource-iot-thingtype-return-values-ref"></a>

When you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the thing type id.

For more information about using the `Ref` function, see [https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).

### Fn::GetAtt
<a name="aws-resource-iot-thingtype-return-values-fn--getatt"></a>

The `Fn::GetAtt` intrinsic function returns a value for a specified attribute of this type. The following are the available attributes and sample return values.

For more information about using the `Fn::GetAtt` intrinsic function, see [https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-getatt.html](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-getatt.html).

#### 
<a name="aws-resource-iot-thingtype-return-values-fn--getatt-fn--getatt"></a>

`Arn`  <a name="Arn-fn::getatt"></a>
The thing type arn.

`Id`  <a name="Id-fn::getatt"></a>
The thing type id.

# AWS::IoT::ThingType Mqtt5Configuration
<a name="aws-properties-iot-thingtype-mqtt5configuration"></a>

The configuration to add user-defined properties to enrich MQTT 5 messages.

## Syntax
<a name="aws-properties-iot-thingtype-mqtt5configuration-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-iot-thingtype-mqtt5configuration-syntax.json"></a>

```
{
  "[PropagatingAttributes](#cfn-iot-thingtype-mqtt5configuration-propagatingattributes)" : [ PropagatingAttribute, ... ]
}
```

### YAML
<a name="aws-properties-iot-thingtype-mqtt5configuration-syntax.yaml"></a>

```
  [PropagatingAttributes](#cfn-iot-thingtype-mqtt5configuration-propagatingattributes): 
    - PropagatingAttribute
```

## Properties
<a name="aws-properties-iot-thingtype-mqtt5configuration-properties"></a>

`PropagatingAttributes`  <a name="cfn-iot-thingtype-mqtt5configuration-propagatingattributes"></a>
An object that represents the connection attribute, the thing attribute, and the MQTT 5 user property key.  
*Required*: No  
*Type*: Array of [PropagatingAttribute](aws-properties-iot-thingtype-propagatingattribute.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::IoT::ThingType PropagatingAttribute
<a name="aws-properties-iot-thingtype-propagatingattribute"></a>

An object that represents the connection attribute, the thing attribute, and the MQTT 5 user property key.

## Syntax
<a name="aws-properties-iot-thingtype-propagatingattribute-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-iot-thingtype-propagatingattribute-syntax.json"></a>

```
{
  "[ConnectionAttribute](#cfn-iot-thingtype-propagatingattribute-connectionattribute)" : String,
  "[ThingAttribute](#cfn-iot-thingtype-propagatingattribute-thingattribute)" : String,
  "[UserPropertyKey](#cfn-iot-thingtype-propagatingattribute-userpropertykey)" : String
}
```

### YAML
<a name="aws-properties-iot-thingtype-propagatingattribute-syntax.yaml"></a>

```
  [ConnectionAttribute](#cfn-iot-thingtype-propagatingattribute-connectionattribute): String
  [ThingAttribute](#cfn-iot-thingtype-propagatingattribute-thingattribute): String
  [UserPropertyKey](#cfn-iot-thingtype-propagatingattribute-userpropertykey): String
```

## Properties
<a name="aws-properties-iot-thingtype-propagatingattribute-properties"></a>

`ConnectionAttribute`  <a name="cfn-iot-thingtype-propagatingattribute-connectionattribute"></a>
The attribute associated with the connection details.  
*Required*: No  
*Type*: String  
*Allowed values*: `iot:ClientId | iot:Thing.ThingName`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`ThingAttribute`  <a name="cfn-iot-thingtype-propagatingattribute-thingattribute"></a>
The thing attribute that is propagating for MQTT 5 message enrichment.  
*Required*: No  
*Type*: String  
*Pattern*: `[a-zA-Z0-9_.,@/:#-]+`  
*Maximum*: `128`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`UserPropertyKey`  <a name="cfn-iot-thingtype-propagatingattribute-userpropertykey"></a>
The key of the MQTT 5 user property, which is a key-value pair.  
*Required*: Yes  
*Type*: String  
*Pattern*: `[a-zA-Z0-9:$.]+`  
*Maximum*: `128`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::IoT::ThingType Tag
<a name="aws-properties-iot-thingtype-tag"></a>

A set of key/value pairs that are used to manage the resource.

## Syntax
<a name="aws-properties-iot-thingtype-tag-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-iot-thingtype-tag-syntax.json"></a>

```
{
  "[Key](#cfn-iot-thingtype-tag-key)" : String,
  "[Value](#cfn-iot-thingtype-tag-value)" : String
}
```

### YAML
<a name="aws-properties-iot-thingtype-tag-syntax.yaml"></a>

```
  [Key](#cfn-iot-thingtype-tag-key): String
  [Value](#cfn-iot-thingtype-tag-value): String
```

## Properties
<a name="aws-properties-iot-thingtype-tag-properties"></a>

`Key`  <a name="cfn-iot-thingtype-tag-key"></a>
The tag's key.  
*Required*: Yes  
*Type*: String  
*Pattern*: `^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$`  
*Minimum*: `1`  
*Maximum*: `128`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Value`  <a name="cfn-iot-thingtype-tag-value"></a>
The tag's value.  
*Required*: Yes  
*Type*: String  
*Minimum*: `1`  
*Maximum*: `256`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::IoT::ThingType ThingTypeProperties
<a name="aws-properties-iot-thingtype-thingtypeproperties"></a>

The ThingTypeProperties contains information about the thing type including: a thing type description, and a list of searchable thing attribute names.

## Syntax
<a name="aws-properties-iot-thingtype-thingtypeproperties-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-iot-thingtype-thingtypeproperties-syntax.json"></a>

```
{
  "[Mqtt5Configuration](#cfn-iot-thingtype-thingtypeproperties-mqtt5configuration)" : Mqtt5Configuration,
  "[SearchableAttributes](#cfn-iot-thingtype-thingtypeproperties-searchableattributes)" : [ String, ... ],
  "[ThingTypeDescription](#cfn-iot-thingtype-thingtypeproperties-thingtypedescription)" : String
}
```

### YAML
<a name="aws-properties-iot-thingtype-thingtypeproperties-syntax.yaml"></a>

```
  [Mqtt5Configuration](#cfn-iot-thingtype-thingtypeproperties-mqtt5configuration): 
    Mqtt5Configuration
  [SearchableAttributes](#cfn-iot-thingtype-thingtypeproperties-searchableattributes): 
    - String
  [ThingTypeDescription](#cfn-iot-thingtype-thingtypeproperties-thingtypedescription): String
```

## Properties
<a name="aws-properties-iot-thingtype-thingtypeproperties-properties"></a>

`Mqtt5Configuration`  <a name="cfn-iot-thingtype-thingtypeproperties-mqtt5configuration"></a>
The configuration to add user-defined properties to enrich MQTT 5 messages.  
*Required*: No  
*Type*: [Mqtt5Configuration](aws-properties-iot-thingtype-mqtt5configuration.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`SearchableAttributes`  <a name="cfn-iot-thingtype-thingtypeproperties-searchableattributes"></a>
A list of searchable thing attribute names.  
*Required*: No  
*Type*: Array of String  
*Maximum*: `128 | 3`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`ThingTypeDescription`  <a name="cfn-iot-thingtype-thingtypeproperties-thingtypedescription"></a>
The description of the thing type.  
*Required*: No  
*Type*: String  
*Pattern*: `[\p{Graph}\x20]*`  
*Maximum*: `2028`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)