Package software.amazon.awscdk.cfnpropertymixins.services.iot

Interface CfnProvisioningTemplatePropsMixin.ProvisioningHookProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnProvisioningTemplatePropsMixin.ProvisioningHookProperty.Jsii$Proxy

Enclosing class:

CfnProvisioningTemplatePropsMixin

@Stability(Stable)
public static interface CfnProvisioningTemplatePropsMixin.ProvisioningHookProperty
extends software.amazon.jsii.JsiiSerializable

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.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.cfnpropertymixins.services.iot.*;
 ProvisioningHookProperty provisioningHookProperty = ProvisioningHookProperty.builder()
         .payloadVersion("payloadVersion")
         .targetArn("targetArn")
         .build();
 

See Also:

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

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnProvisioningTemplatePropsMixin.ProvisioningHookProperty.Builder	A builder for CfnProvisioningTemplatePropsMixin.ProvisioningHookProperty
static final class	CfnProvisioningTemplatePropsMixin.ProvisioningHookProperty.Jsii$Proxy	An implementation for CfnProvisioningTemplatePropsMixin.ProvisioningHookProperty

Method Summary

Modifier and Type	Method	Description
static CfnProvisioningTemplatePropsMixin.ProvisioningHookProperty.Builder	builder()
default String	getPayloadVersion()	The payload that was sent to the target function.
default Object	getTargetArn()	The ARN of the target function.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getPayloadVersion

@Stability(Stable)
@Nullable
default String getPayloadVersion()

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

getTargetArn

@Stability(Stable)
@Nullable
default Object getTargetArn()

The ARN of the target function.

Returns union: either String or IFunctionRef

See Also:

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

builder

@Stability(Stable)
static CfnProvisioningTemplatePropsMixin.ProvisioningHookProperty.Builder builder()

Returns:

a CfnProvisioningTemplatePropsMixin.ProvisioningHookProperty.Builder of CfnProvisioningTemplatePropsMixin.ProvisioningHookProperty