software.amazon.awscdk.services.iot1click

Class CfnProject

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.iot1click.CfnProject

All Implemented Interfaces:

IConstruct, IDependable, IInspectable

@Generated(value="jsii-pacmak/1.73.0 (build 6faeda3)",
           date="2023-01-25T18:28:58.104Z")
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

Nested Classes

Modifier and Type	Class and Description
static class	CfnProject.Builder A fluent builder for CfnProject.
static interface	CfnProject.DeviceTemplateProperty In AWS CloudFormation , use the `DeviceTemplate` property type to define the template for an AWS IoT 1-Click project.
static interface	CfnProject.PlacementTemplateProperty In AWS CloudFormation , use the `PlacementTemplate` property type to define the template for an AWS IoT 1-Click project.

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
	CfnProject(Construct scope, java.lang.String id, CfnProjectProps props) Create a new `AWS::IoT1Click::Project`.
protected	CfnProject(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnProject(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
java.lang.String	getAttrArn() The Amazon Resource Name (ARN) of the project, such as `arn:aws:iot1click:us-east-1:123456789012:projects/project-a1bzhi` .
java.lang.String	getAttrProjectName() The name of the project, such as `project-a1bzhi` .
protected java.util.Map<java.lang.String,java.lang.Object>	getCfnProperties()
java.lang.String	getDescription() The description of the project.
java.lang.Object	getPlacementTemplate() An object describing the project's placement specifications.
java.lang.String	getProjectName() The name of the project from which to obtain information.
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 project.
void	setPlacementTemplate(CfnProject.PlacementTemplateProperty value) An object describing the project's placement specifications.
void	setPlacementTemplate(IResolvable value) An object describing the project's placement specifications.
void	setProjectName(java.lang.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 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

CfnProject

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

CfnProject

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

CfnProject

public CfnProject(Construct scope,
                  java.lang.String id,
                  CfnProjectProps props)

Create a new `AWS::IoT1Click::Project`.

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.

getAttrArn

public java.lang.String getAttrArn()

The Amazon Resource Name (ARN) of the project, such as `arn:aws:iot1click:us-east-1:123456789012:projects/project-a1bzhi` .

getAttrProjectName

public java.lang.String getAttrProjectName()

The name of the project, such as `project-a1bzhi` .

getCfnProperties

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

Overrides:

getCfnProperties in class CfnResource

getPlacementTemplate

public java.lang.Object getPlacementTemplate()

An object describing the project's placement specifications.

setPlacementTemplate

public void setPlacementTemplate(IResolvable value)

An object describing the project's placement specifications.

setPlacementTemplate

public void setPlacementTemplate(CfnProject.PlacementTemplateProperty value)

An object describing the project's placement specifications.

getDescription

public java.lang.String getDescription()

The description of the project.

setDescription

public void setDescription(java.lang.String value)

The description of the project.

getProjectName

public java.lang.String getProjectName()

The name of the project from which to obtain information.

setProjectName

public void setProjectName(java.lang.String value)

The name of the project from which to obtain information.