CfnProvisioningTemplateProps

class aws_cdk.aws_iot.CfnProvisioningTemplateProps(*, provisioning_role_arn, template_body, description=None, enabled=None, pre_provisioning_hook=None, tags=None, template_name=None, template_type=None)

Bases: object

Properties for defining a CfnProvisioningTemplate.

Parameters
  • provisioning_role_arn (str) – The role ARN for the role associated with the fleet provisioning template. This IoT role grants permission to provision a device.

  • template_body (str) – The JSON formatted contents of the fleet provisioning template version.

  • description (Optional[str]) – The description of the fleet provisioning template.

  • enabled (Union[bool, IResolvable, None]) – True to enable the fleet provisioning template, otherwise false.

  • pre_provisioning_hook (Union[IResolvable, ProvisioningHookProperty, Dict[str, Any], None]) – Creates a pre-provisioning hook template.

  • tags (Optional[Sequence[Union[CfnTag, Dict[str, Any]]]]) – Metadata that can be used to manage the fleet provisioning template.

  • template_name (Optional[str]) – The name of the fleet provisioning template.

  • template_type (Optional[str]) – AWS::IoT::ProvisioningTemplate.TemplateType.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iot-provisioningtemplate.html

ExampleMetadata

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
import aws_cdk.aws_iot as iot

cfn_provisioning_template_props = iot.CfnProvisioningTemplateProps(
    provisioning_role_arn="provisioningRoleArn",
    template_body="templateBody",

    # the properties below are optional
    description="description",
    enabled=False,
    pre_provisioning_hook=iot.CfnProvisioningTemplate.ProvisioningHookProperty(
        payload_version="payloadVersion",
        target_arn="targetArn"
    ),
    tags=[CfnTag(
        key="key",
        value="value"
    )],
    template_name="templateName",
    template_type="templateType"
)

Attributes

description

The description of the fleet provisioning template.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iot-provisioningtemplate.html#cfn-iot-provisioningtemplate-description

Return type

Optional[str]

enabled

True to enable the fleet provisioning template, otherwise false.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iot-provisioningtemplate.html#cfn-iot-provisioningtemplate-enabled

Return type

Union[bool, IResolvable, None]

pre_provisioning_hook

Creates a pre-provisioning hook template.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iot-provisioningtemplate.html#cfn-iot-provisioningtemplate-preprovisioninghook

Return type

Union[IResolvable, ProvisioningHookProperty, None]

provisioning_role_arn

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

This IoT role grants permission to provision a device.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iot-provisioningtemplate.html#cfn-iot-provisioningtemplate-provisioningrolearn

Return type

str

tags

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

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iot-provisioningtemplate.html#cfn-iot-provisioningtemplate-tags

Return type

Optional[List[CfnTag]]

template_body

The JSON formatted contents of the fleet provisioning template version.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iot-provisioningtemplate.html#cfn-iot-provisioningtemplate-templatebody

Return type

str

template_name

The name of the fleet provisioning template.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iot-provisioningtemplate.html#cfn-iot-provisioningtemplate-templatename

Return type

Optional[str]

template_type

AWS::IoT::ProvisioningTemplate.TemplateType.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iot-provisioningtemplate.html#cfn-iot-provisioningtemplate-templatetype

Return type

Optional[str]