provisioning_template_versions

Creates, updates, deletes, gets or lists a provisioning_template_versions resource.

Overview

Name	provisioning_template_versions
Type	Resource
Id	aws.iot.provisioning_template_versions

Fields

The following fields are returned by SELECT queries:

describe_provisioning_template_version

Name	Datatype	Description
creation_date	string (date-time)	The date when the provisioning template version was created.
is_default_version	boolean	True if the provisioning template version is the default version.
template_body	string	The JSON formatted contents of the provisioning template version. (pattern: <code>[\s\S]*</code>)
version_id	integer	The provisioning template version ID.

list_provisioning_template_versions

Name	Datatype	Description
creation_date	string (date-time)	The date when the provisioning template version was created
is_default_version	boolean	True if the provisioning template version is the default version, otherwise false.
version_id	integer	The ID of the fleet provisioning template version.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
describe_provisioning_template_version	select	template_name, version_id, region		Returns information about a provisioning template version. Requires permission to access the DescribeProvisioningTemplateVersion action.
list_provisioning_template_versions	select	template_name, region	maxResults, nextToken	A list of provisioning template versions. Requires permission to access the ListProvisioningTemplateVersions action.
create_provisioning_template_version	insert	template_name, region, templateBody	setAsDefault	Creates a new version of a provisioning template. Requires permission to access the CreateProvisioningTemplateVersion action.
delete_provisioning_template_version	delete	template_name, version_id, region		Deletes a provisioning template version. Requires permission to access the DeleteProvisioningTemplateVersion action.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
region	string	AWS region (default: us-east-1)
template_name	string	The name of the provisioning template version to delete.
version_id	integer	The provisioning template version ID to delete.
maxResults	integer	The maximum number of results to return at one time.
nextToken	string	A token to retrieve the next set of results.
setAsDefault	boolean	Sets a fleet provision template version as the default version.

SELECT examples

describe_provisioning_template_version

Returns information about a provisioning template version. Requires permission to access the DescribeProvisioningTemplateVersion action.

SELECT
creation_date,
is_default_version,
template_body,
version_id
FROM aws.iot.provisioning_template_versions
WHERE template_name = '{{ template_name }}' -- required
AND version_id = '{{ version_id }}' -- required
AND region = '{{ region }}' -- required
;

list_provisioning_template_versions

A list of provisioning template versions. Requires permission to access the ListProvisioningTemplateVersions action.

SELECT
creation_date,
is_default_version,
version_id
FROM aws.iot.provisioning_template_versions
WHERE template_name = '{{ template_name }}' -- required
AND region = '{{ region }}' -- required
AND maxResults = '{{ maxResults }}'
AND nextToken = '{{ nextToken }}'
;

INSERT examples

create_provisioning_template_version

Creates a new version of a provisioning template. Requires permission to access the CreateProvisioningTemplateVersion action.

INSERT INTO aws.iot.provisioning_template_versions (
templateBody,
template_name,
region,
setAsDefault
)
SELECT 
'{{ templateBody }}' /* required */,
'{{ template_name }}',
'{{ region }}',
'{{ setAsDefault }}'
RETURNING
is_default_version,
template_arn,
template_name,
version_id
;

Manifest

# Description fields are for documentation purposes
- name: provisioning_template_versions
props:
  - name: template_name
    value: "{{ template_name }}"
    description: Required parameter for the provisioning_template_versions resource.
  - name: region
    value: "{{ region }}"
    description: Required parameter for the provisioning_template_versions resource.
  - name: templateBody
    value: "{{ templateBody }}"
  - name: setAsDefault
    value: {{ setAsDefault }}
    description: Sets a fleet provision template version as the default version.
    description: Sets a fleet provision template version as the default version.

DELETE examples

delete_provisioning_template_version

Deletes a provisioning template version. Requires permission to access the DeleteProvisioningTemplateVersion action.

DELETE FROM aws.iot.provisioning_template_versions
WHERE template_name = '{{ template_name }}' --required
AND version_id = '{{ version_id }}' --required
AND region = '{{ region }}' --required
;