software.amazon.awscdk.services.iot

Class CfnProvisioningTemplate

java.lang.Object

software.constructs.Construct

software.amazon.awscdk.core.Construct

software.amazon.awscdk.core.CfnElement

software.amazon.awscdk.core.CfnRefElement

software.amazon.awscdk.core.CfnResource

software.amazon.awscdk.services.iot.CfnProvisioningTemplate

All Implemented Interfaces:

IConstruct, IDependable, IInspectable

@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)",
           date="2023-03-22T19:35:36.837Z")
public class CfnProvisioningTemplate
extends CfnResource
implements IInspectable

A CloudFormation `AWS::IoT::ProvisioningTemplate`.

Creates a fleet provisioning template.

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.*;
 CfnProvisioningTemplate cfnProvisioningTemplate = CfnProvisioningTemplate.Builder.create(this, "MyCfnProvisioningTemplate")
         .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	Class and Description
static class	CfnProvisioningTemplate.Builder A fluent builder for CfnProvisioningTemplate.
static interface	CfnProvisioningTemplate.ProvisioningHookProperty Structure that contains payloadVersion and targetArn.

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IConstruct

IConstruct.Jsii$Default

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CFN_RESOURCE_TYPE_NAME The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors

Modifier	Constructor and Description
	CfnProvisioningTemplate(Construct scope, java.lang.String id, CfnProvisioningTemplateProps props) Create a new `AWS::IoT::ProvisioningTemplate`.
protected	CfnProvisioningTemplate(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnProvisioningTemplate(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
java.lang.String	getAttrTemplateArn() The ARN that identifies the provisioning template.
protected java.util.Map<java.lang.String,java.lang.Object>	getCfnProperties()
java.lang.String	getDescription() The description of the fleet provisioning template.
java.lang.Object	getEnabled() True to enable the fleet provisioning template, otherwise false.
java.lang.Object	getPreProvisioningHook() Creates a pre-provisioning hook template.
java.lang.String	getProvisioningRoleArn() The role ARN for the role associated with the fleet provisioning template.
TagManager	getTags() Metadata that can be used to manage the fleet provisioning template.
java.lang.String	getTemplateBody() The JSON formatted contents of the fleet provisioning template version.
java.lang.String	getTemplateName() The name of the fleet provisioning template.
java.lang.String	getTemplateType() The type of the provisioning template.
void	inspect(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.
protected java.util.Map<java.lang.String,java.lang.Object>	renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)
void	setDescription(java.lang.String value) The description of the fleet provisioning template.
void	setEnabled(java.lang.Boolean value) True to enable the fleet provisioning template, otherwise false.
void	setEnabled(IResolvable value) True to enable the fleet provisioning template, otherwise false.
void	setPreProvisioningHook(CfnProvisioningTemplate.ProvisioningHookProperty value) Creates a pre-provisioning hook template.
void	setPreProvisioningHook(IResolvable value) Creates a pre-provisioning hook template.
void	setProvisioningRoleArn(java.lang.String value) The role ARN for the role associated with the fleet provisioning template.
void	setTemplateBody(java.lang.String value) The JSON formatted contents of the fleet provisioning template version.
void	setTemplateName(java.lang.String value) The name of the fleet provisioning template.
void	setTemplateType(java.lang.String value) The type of the provisioning template.

Methods inherited from class software.amazon.awscdk.core.CfnResource

addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, isCfnResource, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.core.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.core.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.amazon.awscdk.core.Construct

getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

CFN_RESOURCE_TYPE_NAME

public static final java.lang.String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Detail

CfnProvisioningTemplate

protected CfnProvisioningTemplate(software.amazon.jsii.JsiiObjectRef objRef)

CfnProvisioningTemplate

protected CfnProvisioningTemplate(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

CfnProvisioningTemplate

public CfnProvisioningTemplate(Construct scope,
                               java.lang.String id,
                               CfnProvisioningTemplateProps props)

Create a new `AWS::IoT::ProvisioningTemplate`.

Parameters:

scope - - scope in which this resource is defined. This parameter is required.

id - - scoped id of the resource. This parameter is required.

props - - resource properties. This parameter is required.

Method Detail

inspect

public void inspect(TreeInspector inspector)

Examines the CloudFormation resource and discloses attributes.

Specified by:

inspect in interface IInspectable

Parameters:

inspector - - tree inspector to collect and process attributes. This parameter is required.

renderProperties

protected java.util.Map<java.lang.String,java.lang.Object> renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getAttrTemplateArn

public java.lang.String getAttrTemplateArn()

The ARN that identifies the provisioning template.

getCfnProperties

protected java.util.Map<java.lang.String,java.lang.Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getTags

public TagManager getTags()

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

getProvisioningRoleArn

public java.lang.String getProvisioningRoleArn()

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

This IoT role grants permission to provision a device.

setProvisioningRoleArn

public void setProvisioningRoleArn(java.lang.String value)

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

This IoT role grants permission to provision a device.

getTemplateBody

public java.lang.String getTemplateBody()

The JSON formatted contents of the fleet provisioning template version.

setTemplateBody

public void setTemplateBody(java.lang.String value)

The JSON formatted contents of the fleet provisioning template version.

getDescription

public java.lang.String getDescription()

The description of the fleet provisioning template.

setDescription

public void setDescription(java.lang.String value)

The description of the fleet provisioning template.

getEnabled

public java.lang.Object getEnabled()

True to enable the fleet provisioning template, otherwise false.

setEnabled

public void setEnabled(java.lang.Boolean value)

True to enable the fleet provisioning template, otherwise false.

setEnabled

public void setEnabled(IResolvable value)

True to enable the fleet provisioning template, otherwise false.

getPreProvisioningHook

public java.lang.Object getPreProvisioningHook()

Creates a pre-provisioning hook template.

setPreProvisioningHook

public void setPreProvisioningHook(IResolvable value)

Creates a pre-provisioning hook template.

setPreProvisioningHook

public void setPreProvisioningHook(CfnProvisioningTemplate.ProvisioningHookProperty value)

Creates a pre-provisioning hook template.

getTemplateName

public java.lang.String getTemplateName()

The name of the fleet provisioning template.

setTemplateName

public void setTemplateName(java.lang.String value)

The name of the fleet provisioning template.

getTemplateType

public java.lang.String getTemplateType()

The type of the provisioning template.

setTemplateType

public void setTemplateType(java.lang.String value)

The type of the provisioning template.