software.amazon.awscdk.services.iot

Interface CfnProvisioningTemplateProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnProvisioningTemplateProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:39.872Z")
 @Stability(value=Stable)
public interface CfnProvisioningTemplateProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a `CfnProvisioningTemplate`.

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.*;
 CfnProvisioningTemplateProps cfnProvisioningTemplateProps = CfnProvisioningTemplateProps.builder()
         .provisioningRoleArn("provisioningRoleArn")
         .templateBody("templateBody")
         // the properties below are optional
         .description("description")
         .enabled(false)
         .preProvisioningHook(ProvisioningHookProperty.builder()
                 .payloadVersion("payloadVersion")
                 .targetArn("targetArn")
                 .build())
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .templateName("templateName")
         .templateType("templateType")
         .build();
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and Description
static CfnProvisioningTemplateProps.Builder	builder()
default String	getDescription() The description of the fleet provisioning template.
default Object	getEnabled() True to enable the fleet provisioning template, otherwise false.
default Object	getPreProvisioningHook() Creates a pre-provisioning hook template.
String	getProvisioningRoleArn() The role ARN for the role associated with the fleet provisioning template.
default List<CfnTag>	getTags() Metadata that can be used to manage the fleet provisioning template.
String	getTemplateBody() The JSON formatted contents of the fleet provisioning template version.
default String	getTemplateName() The name of the fleet provisioning template.
default String	getTemplateType() `AWS::IoT::ProvisioningTemplate.TemplateType`.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getProvisioningRoleArn

@Stability(value=Stable)
 @NotNull
String getProvisioningRoleArn()

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

This IoT role grants permission to provision a device.

getTemplateBody

@Stability(value=Stable)
 @NotNull
String getTemplateBody()

The JSON formatted contents of the fleet provisioning template version.

getDescription

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

The description of the fleet provisioning template.

getEnabled

@Stability(value=Stable)
 @Nullable
default Object getEnabled()

True to enable the fleet provisioning template, otherwise false.

getPreProvisioningHook

@Stability(value=Stable)
 @Nullable
default Object getPreProvisioningHook()

Creates a pre-provisioning hook template.

getTags

@Stability(value=Stable)
 @Nullable
default List<CfnTag> getTags()

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

getTemplateName

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

The name of the fleet provisioning template.

getTemplateType

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

`AWS::IoT::ProvisioningTemplate.TemplateType`.

builder

@Stability(value=Stable)
static CfnProvisioningTemplateProps.Builder builder()

Returns:

a CfnProvisioningTemplateProps.Builder of CfnProvisioningTemplateProps