Creates a fleet provisioning template.
Syntax
To declare this entity in your AWS CloudFormation template, use the following syntax:
JSON
{
"Type" : "AWS::IoT::ProvisioningTemplate",
"Properties" : {
"Description" : String,
"Enabled" : Boolean,
"PreProvisioningHook" : ProvisioningHook,
"ProvisioningRoleArn" : String,
"Tags" : [ Tag, ... ],
"TemplateBody" : String,
"TemplateName" : String,
"TemplateType" : String
}
}
YAML
Type: AWS::IoT::ProvisioningTemplate
Properties:
Description: String
Enabled: Boolean
PreProvisioningHook:
ProvisioningHook
ProvisioningRoleArn: String
Tags:
- Tag
TemplateBody: String
TemplateName: String
TemplateType: String
Properties
Description-
The description of the fleet provisioning template.
Required: No
Type: String
Maximum:
500Update requires: No interruption
Enabled-
True to enable the fleet provisioning template, otherwise false.
Required: No
Type: Boolean
Update requires: No interruption
PreProvisioningHook-
Creates a pre-provisioning hook template.
Required: No
Type: ProvisioningHook
Update requires: No interruption
ProvisioningRoleArn-
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
-
Metadata that can be used to manage the fleet provisioning template.
Required: No
Type: Array of Tag
Update requires: No interruption
TemplateBody-
The JSON formatted contents of the fleet provisioning template version.
Required: Yes
Type: String
Update requires: No interruption
TemplateName-
The name of the fleet provisioning template.
Required: No
Type: String
Pattern:
^[0-9A-Za-z_-]+$Minimum:
1Maximum:
36Update requires: Replacement
TemplateType-
The type of the provisioning template.
Required: No
Type: String
Allowed values:
FLEET_PROVISIONING | JITPUpdate requires: Replacement
Return values
Ref
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
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 Fn::GetAtt.
TemplateArn-
The ARN that identifies the provisioning template.
