software.amazon.awscdk.services.iot

Class CfnProvisioningTemplate

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.CfnElement

software.amazon.awscdk.CfnRefElement

software.amazon.awscdk.CfnResource

software.amazon.awscdk.services.iot.CfnProvisioningTemplate

All Implemented Interfaces:

IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:39.871Z")
 @Stability(value=Stable)
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 class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

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

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default

Field Summary

Fields

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

Constructor Summary

Constructors

Modifier	Constructor and Description
	CfnProvisioningTemplate(software.constructs.Construct scope, 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
String	getAttrTemplateArn() The ARN that identifies the provisioning template.
protected Map<String,Object>	getCfnProperties()
String	getDescription() The description of the fleet provisioning template.
Object	getEnabled() True to enable the fleet provisioning template, otherwise false.
Object	getPreProvisioningHook() Creates a pre-provisioning hook template.
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.
String	getTemplateBody() The JSON formatted contents of the fleet provisioning template version.
String	getTemplateName() The name of the fleet provisioning template.
String	getTemplateType() `AWS::IoT::ProvisioningTemplate.TemplateType`.
void	inspect(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setDescription(String value) The description of the fleet provisioning template.
void	setEnabled(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(String value) The role ARN for the role associated with the fleet provisioning template.
void	setTemplateBody(String value) The JSON formatted contents of the fleet provisioning template version.
void	setTemplateName(String value) The name of the fleet provisioning template.
void	setTemplateType(String value) `AWS::IoT::ProvisioningTemplate.TemplateType`.

Methods inherited from class software.amazon.awscdk.CfnResource

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

Methods inherited from class software.amazon.awscdk.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.constructs.Construct

getNode, isConstruct

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

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

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Detail

CFN_RESOURCE_TYPE_NAME

@Stability(value=Stable)
public static final 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

@Stability(value=Stable)
public CfnProvisioningTemplate(@NotNull
                                                        software.constructs.Construct scope,
                                                        @NotNull
                                                        String id,
                                                        @NotNull
                                                        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

@Stability(value=Stable)
public void inspect(@NotNull
                                             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

@Stability(value=Stable)
 @NotNull
protected Map<String,Object> renderProperties(@NotNull
                                                                                 Map<String,Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getAttrTemplateArn

@Stability(value=Stable)
 @NotNull
public String getAttrTemplateArn()

The ARN that identifies the provisioning template.

getCfnProperties

@Stability(value=Stable)
 @NotNull
protected Map<String,Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getTags

@Stability(value=Stable)
 @NotNull
public TagManager getTags()

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

getProvisioningRoleArn

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

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

This IoT role grants permission to provision a device.

setProvisioningRoleArn

@Stability(value=Stable)
public void setProvisioningRoleArn(@NotNull
                                                            String value)

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
public String getTemplateBody()

The JSON formatted contents of the fleet provisioning template version.

setTemplateBody

@Stability(value=Stable)
public void setTemplateBody(@NotNull
                                                     String value)

The JSON formatted contents of the fleet provisioning template version.

getDescription

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

The description of the fleet provisioning template.

setDescription

@Stability(value=Stable)
public void setDescription(@Nullable
                                                    String value)

The description of the fleet provisioning template.

getEnabled

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

True to enable the fleet provisioning template, otherwise false.

setEnabled

@Stability(value=Stable)
public void setEnabled(@Nullable
                                                Boolean value)

True to enable the fleet provisioning template, otherwise false.

setEnabled

@Stability(value=Stable)
public void setEnabled(@Nullable
                                                IResolvable value)

True to enable the fleet provisioning template, otherwise false.

getPreProvisioningHook

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

Creates a pre-provisioning hook template.

setPreProvisioningHook

@Stability(value=Stable)
public void setPreProvisioningHook(@Nullable
                                                            CfnProvisioningTemplate.ProvisioningHookProperty value)

Creates a pre-provisioning hook template.

setPreProvisioningHook

@Stability(value=Stable)
public void setPreProvisioningHook(@Nullable
                                                            IResolvable value)

Creates a pre-provisioning hook template.

getTemplateName

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

The name of the fleet provisioning template.

setTemplateName

@Stability(value=Stable)
public void setTemplateName(@Nullable
                                                     String value)

The name of the fleet provisioning template.

getTemplateType

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

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

setTemplateType

@Stability(value=Stable)
public void setTemplateType(@Nullable
                                                     String value)

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