CfnProvisioningTemplatePropsMixin

class aws_cdk.cfn_property_mixins.aws_iot.CfnProvisioningTemplatePropsMixin(props, *, strategy=None)

Bases: Mixin

Creates a fleet provisioning template.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iot-provisioningtemplate.html
CloudformationResource:: AWS::IoT::ProvisioningTemplate
Mixin:: true
ExampleMetadata:: fixture=_generated

Example:

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

# merge_strategy: cdk.IMergeStrategy

cfn_provisioning_template_props_mixin = iot.CfnProvisioningTemplatePropsMixin(iot.CfnProvisioningTemplateMixinProps(
    description="description",
    enabled=False,
    pre_provisioning_hook=iot.CfnProvisioningTemplatePropsMixin.ProvisioningHookProperty(
        payload_version="payloadVersion",
        target_arn="targetArn"
    ),
    provisioning_role_arn="provisioningRoleArn",
    tags=[cdk.CfnTag(
        key="key",
        value="value"
    )],
    template_body="templateBody",
    template_name="templateName",
    template_type="templateType"
),
    strategy=merge_strategy
)

Create a mixin to apply properties to AWS::IoT::ProvisioningTemplate.

Parameters:

props (Union[CfnProvisioningTemplateMixinProps, Dict[str, Any]]) – L1 properties to apply.
strategy (Optional[IMergeStrategy]) – Strategy for merging nested properties. Default: - PropertyMergeStrategy.combine()

Methods

apply_to(construct)

Apply the mixin properties to the construct.

Parameters:: construct (IConstruct)
Return type:: None

supports(construct)

Check if this mixin supports the given construct.

Parameters:: construct (IConstruct)
Return type:: bool

Attributes

CFN_PROPERTY_KEYS = ['description', 'enabled', 'preProvisioningHook', 'provisioningRoleArn', 'tags', 'templateBody', 'templateName', 'templateType']

Static Methods

classmethod is_mixin(x)

Checks if x is a Mixin.

Parameters:: x (Any) – Any object.
Return type:: bool
Returns:: true if x is an object created from a class which extends Mixin.

ProvisioningHookProperty

class CfnProvisioningTemplatePropsMixin.ProvisioningHookProperty(*, payload_version=None, target_arn=None)

Bases: object

Structure that contains payloadVersion and targetArn.

Provisioning hooks can be used when fleet provisioning to validate device parameters before allowing the device to be provisioned.

Parameters:

payload_version (Optional[str]) – The payload that was sent to the target function. The valid payload is "2020-04-01" .
target_arn (Union[str, IFunctionRef, None]) – The ARN of the target function.

See:

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

ExampleMetadata:

fixture=_generated

Example:

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

provisioning_hook_property = iot.CfnProvisioningTemplatePropsMixin.ProvisioningHookProperty(
    payload_version="payloadVersion",
    target_arn="targetArn"
)

Attributes

payload_version

The payload that was sent to the target function.

The valid payload is "2020-04-01" .

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-provisioningtemplate-provisioninghook.html#cfn-iot-provisioningtemplate-provisioninghook-payloadversion

target_arn

The ARN of the target function.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-provisioningtemplate-provisioninghook.html#cfn-iot-provisioningtemplate-provisioninghook-targetarn