Package 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.103.1 (build bef2dea)",
           date="2024-10-05T03:43:44.630Z")
@Stability(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();
 

See Also:

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

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	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()	The type of the provisioning template.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getProvisioningRoleArn

@Stability(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.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iot-provisioningtemplate.html#cfn-iot-provisioningtemplate-provisioningrolearn

getTemplateBody

@Stability(Stable)
@NotNull
String getTemplateBody()

The JSON formatted contents of the fleet provisioning template version.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iot-provisioningtemplate.html#cfn-iot-provisioningtemplate-templatebody

getDescription

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

The description of the fleet provisioning template.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iot-provisioningtemplate.html#cfn-iot-provisioningtemplate-description

getEnabled

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

True to enable the fleet provisioning template, otherwise false.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iot-provisioningtemplate.html#cfn-iot-provisioningtemplate-enabled

getPreProvisioningHook

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

Creates a pre-provisioning hook template.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iot-provisioningtemplate.html#cfn-iot-provisioningtemplate-preprovisioninghook

getTags

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

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iot-provisioningtemplate.html#cfn-iot-provisioningtemplate-tags

getTemplateName

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

The name of the fleet provisioning template.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iot-provisioningtemplate.html#cfn-iot-provisioningtemplate-templatename

getTemplateType

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

The type of the provisioning template.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iot-provisioningtemplate.html#cfn-iot-provisioningtemplate-templatetype

builder

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

Returns:

a CfnProvisioningTemplateProps.Builder of CfnProvisioningTemplateProps