Package software.amazon.awscdk.services.iot

Class CfnProvisioningTemplate

java.lang.Object
software.amazon.jsii.JsiiObject
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, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct
@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)", date="2023-06-19T16:29:57.589Z") @Stability(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();

  • Field Details

    • CFN_RESOURCE_TYPE_NAME

      @Stability(Stable) public static final String CFN_RESOURCE_TYPE_NAME
      The CloudFormation resource type name for this resource class.

  • Constructor Details

    • CfnProvisioningTemplate

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

    • CfnProvisioningTemplate

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

    • CfnProvisioningTemplate

      @Stability(Stable) public CfnProvisioningTemplate(@NotNull 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 Details

    • inspect

      @Stability(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(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(Stable) @NotNull public String getAttrTemplateArn()
      The ARN that identifies the provisioning template.

    • getCfnProperties

      @Stability(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class CfnResource

    • getTags

      @Stability(Stable) @NotNull public TagManager getTags()
      Metadata that can be used to manage the fleet provisioning template.

    • getProvisioningRoleArn

      @Stability(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(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(Stable) @NotNull public String getTemplateBody()
      The JSON formatted contents of the fleet provisioning template version.

    • setTemplateBody

      @Stability(Stable) public void setTemplateBody(@NotNull String value)
      The JSON formatted contents of the fleet provisioning template version.

    • getDescription

      @Stability(Stable) @Nullable public String getDescription()
      The description of the fleet provisioning template.

    • setDescription

      @Stability(Stable) public void setDescription(@Nullable String value)
      The description of the fleet provisioning template.

    • getEnabled

      @Stability(Stable) @Nullable public Object getEnabled()
      True to enable the fleet provisioning template, otherwise false.

    • setEnabled

      @Stability(Stable) public void setEnabled(@Nullable Boolean value)
      True to enable the fleet provisioning template, otherwise false.

    • setEnabled

      @Stability(Stable) public void setEnabled(@Nullable IResolvable value)
      True to enable the fleet provisioning template, otherwise false.

    • getPreProvisioningHook

      @Stability(Stable) @Nullable public Object getPreProvisioningHook()
      Creates a pre-provisioning hook template.

    • setPreProvisioningHook

      @Stability(Stable) public void setPreProvisioningHook(@Nullable IResolvable value)
      Creates a pre-provisioning hook template.

    • setPreProvisioningHook

      @Stability(Stable) public void setPreProvisioningHook(@Nullable CfnProvisioningTemplate.ProvisioningHookProperty value)
      Creates a pre-provisioning hook template.

    • getTemplateName

      @Stability(Stable) @Nullable public String getTemplateName()
      The name of the fleet provisioning template.

    • setTemplateName

      @Stability(Stable) public void setTemplateName(@Nullable String value)
      The name of the fleet provisioning template.

    • getTemplateType

      @Stability(Stable) @Nullable public String getTemplateType()
      The type of the provisioning template.

    • setTemplateType

      @Stability(Stable) public void setTemplateType(@Nullable String value)
      The type of the provisioning template.