Class CfnProject
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.iot1click.CfnProject
- 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.731Z")
@Stability(Stable)
public class CfnProject
extends CfnResource
implements IInspectable
A CloudFormation
AWS::IoT1Click::Project
.
The AWS::IoT1Click::Project
resource creates an empty project with a placement template. A project contains zero or more placements that adhere to the placement template defined in the project. For more information, see CreateProject in the AWS IoT 1-Click Projects API Reference .
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.iot1click.*; Object callbackOverrides; Object defaultAttributes; CfnProject cfnProject = CfnProject.Builder.create(this, "MyCfnProject") .placementTemplate(PlacementTemplateProperty.builder() .defaultAttributes(defaultAttributes) .deviceTemplates(Map.of( "deviceTemplatesKey", DeviceTemplateProperty.builder() .callbackOverrides(callbackOverrides) .deviceType("deviceType") .build())) .build()) // the properties below are optional .description("description") .projectName("projectName") .build();
-
Nested Class Summary
Modifier and TypeClassDescriptionstatic final class
A fluent builder forCfnProject
.static interface
In AWS CloudFormation , use theDeviceTemplate
property type to define the template for an AWS IoT 1-Click project.static interface
In AWS CloudFormation , use thePlacementTemplate
property type to define the template for an AWS IoT 1-Click project.Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject
software.amazon.jsii.JsiiObject.InitializationMode
Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IConstruct
IConstruct.Jsii$Default
Nested classes/interfaces inherited from interface software.constructs.IConstruct
software.constructs.IConstruct.Jsii$Default
Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IInspectable
IInspectable.Jsii$Default, IInspectable.Jsii$Proxy
-
Field Summary
Modifier and TypeFieldDescriptionstatic final String
The CloudFormation resource type name for this resource class. -
Constructor Summary
ModifierConstructorDescriptionCfnProject
(Construct scope, String id, CfnProjectProps props) Create a newAWS::IoT1Click::Project
.protected
CfnProject
(software.amazon.jsii.JsiiObject.InitializationMode initializationMode) protected
CfnProject
(software.amazon.jsii.JsiiObjectRef objRef) -
Method Summary
Modifier and TypeMethodDescriptionThe Amazon Resource Name (ARN) of the project, such asarn:aws:iot1click:us-east-1:123456789012:projects/project-a1bzhi
.The name of the project, such asproject-a1bzhi
.The description of the project.An object describing the project's placement specifications.The name of the project from which to obtain information.void
inspect
(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.renderProperties
(Map<String, Object> props) void
setDescription
(String value) The description of the project.void
setPlacementTemplate
(IResolvable value) An object describing the project's placement specifications.void
An object describing the project's placement specifications.void
setProjectName
(String value) The name of the project from which to obtain information.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 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
-
CfnProject
protected CfnProject(software.amazon.jsii.JsiiObjectRef objRef) -
CfnProject
protected CfnProject(software.amazon.jsii.JsiiObject.InitializationMode initializationMode) -
CfnProject
@Stability(Stable) public CfnProject(@NotNull Construct scope, @NotNull String id, @NotNull CfnProjectProps props) Create a newAWS::IoT1Click::Project
.- Parameters:
scope
-- scope in which this resource is defined.
id
-- scoped id of the resource.
props
-- resource properties.
-
-
Method Details
-
inspect
Examines the CloudFormation resource and discloses attributes.- Specified by:
inspect
in interfaceIInspectable
- Parameters:
inspector
-- tree inspector to collect and process attributes.
-
renderProperties
@Stability(Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String, Object> props) - Overrides:
renderProperties
in classCfnResource
- Parameters:
props
- This parameter is required.
-
getAttrArn
The Amazon Resource Name (ARN) of the project, such asarn:aws:iot1click:us-east-1:123456789012:projects/project-a1bzhi
. -
getAttrProjectName
The name of the project, such asproject-a1bzhi
. -
getCfnProperties
- Overrides:
getCfnProperties
in classCfnResource
-
getPlacementTemplate
An object describing the project's placement specifications. -
setPlacementTemplate
An object describing the project's placement specifications. -
setPlacementTemplate
@Stability(Stable) public void setPlacementTemplate(@NotNull CfnProject.PlacementTemplateProperty value) An object describing the project's placement specifications. -
getDescription
The description of the project. -
setDescription
The description of the project. -
getProjectName
The name of the project from which to obtain information. -
setProjectName
The name of the project from which to obtain information.
-