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

Interface CfnProvisioningTemplateMixinProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnProvisioningTemplateMixinProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.127.0 (build 2117ad5)",
           date="2026-03-11T13:20:00.190Z")
@Stability(Stable)
public interface CfnProvisioningTemplateMixinProps
extends software.amazon.jsii.JsiiSerializable

Properties for CfnProvisioningTemplatePropsMixin.

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.*;
 CfnProvisioningTemplateMixinProps cfnProvisioningTemplateMixinProps = CfnProvisioningTemplateMixinProps.builder()
         .description("description")
         .enabled(false)
         .preProvisioningHook(ProvisioningHookProperty.builder()
                 .payloadVersion("payloadVersion")
                 .targetArn("targetArn")
                 .build())
         .provisioningRoleArn("provisioningRoleArn")
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .templateBody("templateBody")
         .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	CfnProvisioningTemplateMixinProps.Builder	A builder for CfnProvisioningTemplateMixinProps
static final class	CfnProvisioningTemplateMixinProps.Jsii$Proxy	An implementation for CfnProvisioningTemplateMixinProps

Method Summary

Modifier and Type	Method	Description
static CfnProvisioningTemplateMixinProps.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.
default Object	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.
default 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

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.

Returns union: either Boolean or IResolvable

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.

Returns union: either IResolvable or CfnProvisioningTemplatePropsMixin.ProvisioningHookProperty

See Also:

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

getProvisioningRoleArn

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

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

This IoT role grants permission to provision a device.

Returns union: either String or IRoleRef

See Also:

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

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

getTemplateBody

@Stability(Stable)
@Nullable
default 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

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 CfnProvisioningTemplateMixinProps.Builder builder()

Returns:

a CfnProvisioningTemplateMixinProps.Builder of CfnProvisioningTemplateMixinProps