aws-cdk-lib.aws_iot.CfnProvisioningTemplateProps

interface CfnProvisioningTemplateProps

LanguageType name
.NETAmazon.CDK.AWS.IoT.CfnProvisioningTemplateProps
Gogithub.com/aws/aws-cdk-go/awscdk/v2/awsiot#CfnProvisioningTemplateProps
Javasoftware.amazon.awscdk.services.iot.CfnProvisioningTemplateProps
Pythonaws_cdk.aws_iot.CfnProvisioningTemplateProps
TypeScript aws-cdk-lib » aws_iot » CfnProvisioningTemplateProps

Properties for defining a CfnProvisioningTemplate.

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_iot as iot } from 'aws-cdk-lib';
const cfnProvisioningTemplateProps: iot.CfnProvisioningTemplateProps = {
  provisioningRoleArn: 'provisioningRoleArn',
  templateBody: 'templateBody',

  // the properties below are optional
  description: 'description',
  enabled: false,
  preProvisioningHook: {
    payloadVersion: 'payloadVersion',
    targetArn: 'targetArn',
  },
  tags: [{
    key: 'key',
    value: 'value',
  }],
  templateName: 'templateName',
  templateType: 'templateType',
};

Properties

NameTypeDescription
provisioningRoleArnstringThe role ARN for the role associated with the fleet provisioning template.
templateBodystringThe JSON formatted contents of the fleet provisioning template version.
description?stringThe description of the fleet provisioning template.
enabled?boolean | IResolvableTrue to enable the fleet provisioning template, otherwise false.
preProvisioningHook?IResolvable | ProvisioningHookPropertyCreates a pre-provisioning hook template.
tags?CfnTag[]Metadata that can be used to manage the fleet provisioning template.
templateName?stringThe name of the fleet provisioning template.
templateType?stringThe type of the provisioning template.

provisioningRoleArn

Type: string

The role ARN for the role associated with the fleet provisioning template.

This IoT role grants permission to provision a device.


templateBody

Type: string

The JSON formatted contents of the fleet provisioning template version.


description?

Type: string (optional)

The description of the fleet provisioning template.


enabled?

Type: boolean | IResolvable (optional)

True to enable the fleet provisioning template, otherwise false.


preProvisioningHook?

Type: IResolvable | ProvisioningHookProperty (optional)

Creates a pre-provisioning hook template.


tags?

Type: CfnTag[] (optional)

Metadata that can be used to manage the fleet provisioning template.


templateName?

Type: string (optional)

The name of the fleet provisioning template.


templateType?

Type: string (optional)

The type of the provisioning template.