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::ProvisioningTemplate
<a name="aws-resource-iot-provisioningtemplate"></a>

Creates a fleet provisioning template.

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

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

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

```
{
  "Type" : "AWS::IoT::ProvisioningTemplate",
  "Properties" : {
      "[Description](#cfn-iot-provisioningtemplate-description)" : String,
      "[Enabled](#cfn-iot-provisioningtemplate-enabled)" : Boolean,
      "[PreProvisioningHook](#cfn-iot-provisioningtemplate-preprovisioninghook)" : ProvisioningHook,
      "[ProvisioningRoleArn](#cfn-iot-provisioningtemplate-provisioningrolearn)" : String,
      "[Tags](#cfn-iot-provisioningtemplate-tags)" : [ Tag, ... ],
      "[TemplateBody](#cfn-iot-provisioningtemplate-templatebody)" : String,
      "[TemplateName](#cfn-iot-provisioningtemplate-templatename)" : String,
      "[TemplateType](#cfn-iot-provisioningtemplate-templatetype)" : String
    }
}
```

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

```
Type: AWS::IoT::ProvisioningTemplate
Properties:
  [Description](#cfn-iot-provisioningtemplate-description): String
  [Enabled](#cfn-iot-provisioningtemplate-enabled): Boolean
  [PreProvisioningHook](#cfn-iot-provisioningtemplate-preprovisioninghook): 
    ProvisioningHook
  [ProvisioningRoleArn](#cfn-iot-provisioningtemplate-provisioningrolearn): String
  [Tags](#cfn-iot-provisioningtemplate-tags): 
    - Tag
  [TemplateBody](#cfn-iot-provisioningtemplate-templatebody): String
  [TemplateName](#cfn-iot-provisioningtemplate-templatename): String
  [TemplateType](#cfn-iot-provisioningtemplate-templatetype): String
```

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

`Description`  <a name="cfn-iot-provisioningtemplate-description"></a>
The description of the fleet provisioning template.  
*Required*: No  
*Type*: String  
*Maximum*: `500`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Enabled`  <a name="cfn-iot-provisioningtemplate-enabled"></a>
True to enable the fleet provisioning template, otherwise false.  
*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)

`PreProvisioningHook`  <a name="cfn-iot-provisioningtemplate-preprovisioninghook"></a>
Creates a pre-provisioning hook template.  
*Required*: No  
*Type*: [ProvisioningHook](aws-properties-iot-provisioningtemplate-provisioninghook.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`ProvisioningRoleArn`  <a name="cfn-iot-provisioningtemplate-provisioningrolearn"></a>
The role ARN for the role associated with the fleet provisioning template. This IoT role grants permission to provision a device.  
*Required*: Yes  
*Type*: String  
*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-provisioningtemplate-tags"></a>
Metadata that can be used to manage the fleet provisioning template.  
*Required*: No  
*Type*: Array of [Tag](aws-properties-iot-provisioningtemplate-tag.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`TemplateBody`  <a name="cfn-iot-provisioningtemplate-templatebody"></a>
The JSON formatted contents of the fleet provisioning template version.  
*Required*: Yes  
*Type*: String  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`TemplateName`  <a name="cfn-iot-provisioningtemplate-templatename"></a>
The name of the fleet provisioning template.  
*Required*: No  
*Type*: String  
*Pattern*: `^[0-9A-Za-z_-]+$`  
*Minimum*: `1`  
*Maximum*: `36`  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`TemplateType`  <a name="cfn-iot-provisioningtemplate-templatetype"></a>
The type of the provisioning template.  
*Required*: No  
*Type*: String  
*Allowed values*: `FLEET_PROVISIONING | JITP`  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

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

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

When you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the template name. For example:

 `{ "Ref": "MyTemplate" }` 

For a stack named MyStack, a value similar to the following is returned:

 `MyStack-MyTemplate-AB1CDEFGHIJK` 

### Fn::GetAtt
<a name="aws-resource-iot-provisioningtemplate-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-provisioningtemplate-return-values-fn--getatt-fn--getatt"></a>

`TemplateArn`  <a name="TemplateArn-fn::getatt"></a>
The ARN that identifies the provisioning template.

# AWS::IoT::ProvisioningTemplate ProvisioningHook
<a name="aws-properties-iot-provisioningtemplate-provisioninghook"></a>

Structure that contains payloadVersion and targetArn. Provisioning hooks can be used when fleet provisioning to validate device parameters before allowing the device to be provisioned.

## Syntax
<a name="aws-properties-iot-provisioningtemplate-provisioninghook-syntax"></a>

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

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

```
{
  "[PayloadVersion](#cfn-iot-provisioningtemplate-provisioninghook-payloadversion)" : String,
  "[TargetArn](#cfn-iot-provisioningtemplate-provisioninghook-targetarn)" : String
}
```

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

```
  [PayloadVersion](#cfn-iot-provisioningtemplate-provisioninghook-payloadversion): String
  [TargetArn](#cfn-iot-provisioningtemplate-provisioninghook-targetarn): String
```

## Properties
<a name="aws-properties-iot-provisioningtemplate-provisioninghook-properties"></a>

`PayloadVersion`  <a name="cfn-iot-provisioningtemplate-provisioninghook-payloadversion"></a>
The payload that was sent to the target function. The valid payload is `"2020-04-01"`.  
*Required*: No  
*Type*: String  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`TargetArn`  <a name="cfn-iot-provisioningtemplate-provisioninghook-targetarn"></a>
The ARN of the target function.  
*Required*: No  
*Type*: String  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

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

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

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

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

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

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

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

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

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

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