software.amazon.awscdk.services.iot

Interface CfnProvisioningTemplate.ProvisioningHookProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnProvisioningTemplate.ProvisioningHookProperty.Jsii$Proxy

Enclosing class:

CfnProvisioningTemplate

@Stability(value=Stable)
public static interface CfnProvisioningTemplate.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.services.iot.*;
 ProvisioningHookProperty provisioningHookProperty = ProvisioningHookProperty.builder()
         .payloadVersion("payloadVersion")
         .targetArn("targetArn")
         .build();
 

Nested Class Summary

Nested Classes

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

Method Summary

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

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getPayloadVersion

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

The payload that was sent to the target function.

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

getTargetArn

@Stability(value=Stable)
 @Nullable
default String getTargetArn()

The ARN of the target function.

builder

@Stability(value=Stable)
static CfnProvisioningTemplate.ProvisioningHookProperty.Builder builder()

Returns:

a CfnProvisioningTemplate.ProvisioningHookProperty.Builder of CfnProvisioningTemplate.ProvisioningHookProperty