interface ProvisioningHookProperty

Language	Type name
.NET	Amazon.CDK.CfnPropertyMixins.AWS.IoT.CfnProvisioningTemplatePropsMixin.ProvisioningHookProperty
Go	github.com/aws/aws-cdk-go/awscdkcfnpropertymixins/v2/awsiot#CfnProvisioningTemplatePropsMixin_ProvisioningHookProperty
Java	software.amazon.awscdk.cfnpropertymixins.services.iot.CfnProvisioningTemplatePropsMixin.ProvisioningHookProperty
Python	aws_cdk.cfn_property_mixins.aws_iot.CfnProvisioningTemplatePropsMixin.ProvisioningHookProperty
TypeScript	@aws-cdk/cfn-property-mixins » aws_iot » CfnProvisioningTemplatePropsMixin » ProvisioningHookProperty

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.

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

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/cfn-property-mixins';
const provisioningHookProperty: iot.CfnProvisioningTemplatePropsMixin.ProvisioningHookProperty = {
  payloadVersion: 'payloadVersion',
  targetArn: 'targetArn',
};

Properties

Name	Type	Description
payloadVersion?	string	The payload that was sent to the target function.
targetArn?	string | IFunctionRef	The ARN of the target function.

---

payloadVersion?

Type: string (optional)

The payload that was sent to the target function.

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

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

---

targetArn?

Type: string | IFunctionRef (optional)

The ARN of the target function.

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