Skip to content
v2.275.0

CfnProvisioningTemplateProps Struct ​

Properties for defining a CfnProvisioningTemplate.

Example ​

ts
// 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 ​

descriptionoptionalstringdescriptionoptionalstrdescriptionoptionalStringDescriptionoptionalstringDescriptionoptional*string#
The description of the fleet provisioning template.
enabledoptionalboolean | IResolvableenabledoptionaltyping.Union[bool, IResolvable]enabledoptionalBooleanEnabledoptionalboolEnabledoptionalinterface{}#
True to enable the fleet provisioning template, otherwise false.
preProvisioningHookoptionalIResolvable | CfnProvisioningTemplate.ProvisioningHookPropertypre_provisioning_hookoptionaltyping.Union[IResolvable, ProvisioningHookProperty]preProvisioningHookoptionalIResolvablePreProvisioningHookoptionalIResolvablePreProvisioningHookoptionalinterface{}#
Creates a pre-provisioning hook template.
provisioningRoleArnstring | IRoleRefprovisioning_role_arntyping.Union[str, IRoleRef]provisioningRoleArnStringProvisioningRoleArnstringProvisioningRoleArninterface{}required#
The role ARN for the role associated with the fleet provisioning template.

This IoT role grants permission to provision a device.

tagsoptionalCfnTag[]tagsoptionaltyping.List[CfnTag]tagsoptionalList<CfnTag>TagsoptionalCfnTag[]Tagsoptional*[]CfnTag#
Metadata that can be used to manage the fleet provisioning template.
templateBodystringtemplate_bodystrtemplateBodyStringTemplateBodystringTemplateBody*stringrequired#
The JSON formatted contents of the fleet provisioning template version.
templateNameoptionalstringtemplate_nameoptionalstrtemplateNameoptionalStringTemplateNameoptionalstringTemplateNameoptional*string#
The name of the fleet provisioning template.
templateTypeoptionalstringtemplate_typeoptionalstrtemplateTypeoptionalStringTemplateTypeoptionalstringTemplateTypeoptional*string#
The type of the provisioning template.