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
,ITaggable
,software.amazon.jsii.JsiiSerializable
,software.constructs.IConstruct
,software.constructs.IDependable
@Generated(value="jsii-pacmak/1.103.1 (build bef2dea)",
date="2024-10-05T03:43:44.628Z")
@Stability(Stable)
public class CfnProvisioningTemplate
extends CfnResource
implements IInspectable, ITaggable
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();
- See Also:
-
Nested Class Summary
Modifier and TypeClassDescriptionstatic final class
A fluent builder forCfnProvisioningTemplate
.static interface
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.constructs.IConstruct
software.constructs.IConstruct.Jsii$Default
Nested classes/interfaces inherited from interface software.amazon.awscdk.IInspectable
IInspectable.Jsii$Default, IInspectable.Jsii$Proxy
Nested classes/interfaces inherited from interface software.amazon.awscdk.ITaggable
ITaggable.Jsii$Default, ITaggable.Jsii$Proxy
-
Field Summary
Modifier and TypeFieldDescriptionstatic final String
The CloudFormation resource type name for this resource class. -
Constructor Summary
ModifierConstructorDescriptionprotected
CfnProvisioningTemplate
(software.amazon.jsii.JsiiObject.InitializationMode initializationMode) protected
CfnProvisioningTemplate
(software.amazon.jsii.JsiiObjectRef objRef) CfnProvisioningTemplate
(software.constructs.Construct scope, String id, CfnProvisioningTemplateProps props) -
Method Summary
Modifier and TypeMethodDescriptionThe ARN that identifies the provisioning template.The description of the fleet provisioning template.True to enable the fleet provisioning template, otherwise false.Creates a pre-provisioning hook template.The role ARN for the role associated with the fleet provisioning template.getTags()
Tag Manager which manages the tags for this resource.Metadata that can be used to manage the fleet provisioning template.The JSON formatted contents of the fleet provisioning template version.The name of the fleet provisioning template.The type of the provisioning template.void
inspect
(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.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
Creates a pre-provisioning hook template.void
Creates a pre-provisioning hook template.void
setProvisioningRoleArn
(String value) The role ARN for the role associated with the fleet provisioning template.void
setTagsRaw
(List<CfnTag> value) Metadata that can be used to manage 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) The type of the provisioning template.Methods inherited from class software.amazon.awscdk.CfnResource
addDeletionOverride, addDependency, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, getUpdatedProperties, isCfnResource, obtainDependencies, obtainResourceDependencies, removeDependency, replaceDependency, 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 Details
-
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 software.constructs.Construct scope, @NotNull String id, @NotNull CfnProvisioningTemplateProps props) - Parameters:
scope
- Scope in which this resource is defined. This parameter is required.id
- Construct identifier for this resource (unique in its scope). This parameter is required.props
- Resource properties. This parameter is required.
-
-
Method Details
-
inspect
Examines the CloudFormation resource and discloses attributes.- Specified by:
inspect
in interfaceIInspectable
- 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 classCfnResource
- Parameters:
props
- This parameter is required.
-
getAttrTemplateArn
The ARN that identifies the provisioning template. -
getCfnProperties
- Overrides:
getCfnProperties
in classCfnResource
-
getTags
Tag Manager which manages the tags for this resource. -
getProvisioningRoleArn
The role ARN for the role associated with the fleet provisioning template. -
setProvisioningRoleArn
The role ARN for the role associated with the fleet provisioning template. -
getTemplateBody
The JSON formatted contents of the fleet provisioning template version. -
setTemplateBody
The JSON formatted contents of the fleet provisioning template version. -
getDescription
The description of the fleet provisioning template. -
setDescription
The description of the fleet provisioning template. -
getEnabled
True to enable the fleet provisioning template, otherwise false. -
setEnabled
True to enable the fleet provisioning template, otherwise false. -
setEnabled
True to enable the fleet provisioning template, otherwise false. -
getPreProvisioningHook
Creates a pre-provisioning hook template. -
setPreProvisioningHook
Creates a pre-provisioning hook template. -
setPreProvisioningHook
@Stability(Stable) public void setPreProvisioningHook(@Nullable CfnProvisioningTemplate.ProvisioningHookProperty value) Creates a pre-provisioning hook template. -
getTagsRaw
Metadata that can be used to manage the fleet provisioning template. -
setTagsRaw
Metadata that can be used to manage the fleet provisioning template. -
getTemplateName
The name of the fleet provisioning template. -
setTemplateName
The name of the fleet provisioning template. -
getTemplateType
The type of the provisioning template. -
setTemplateType
The type of the provisioning template.
-