software.amazon.awscdk.services.iot1click

Class CfnProject

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

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.921Z")
 @Stability(value=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

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 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
	CfnProject(software.constructs.Construct scope, 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
String	getAttrArn() The Amazon Resource Name (ARN) of the project, such as `arn:aws:iot1click:us-east-1:123456789012:projects/project-a1bzhi` .
String	getAttrProjectName() The name of the project, such as `project-a1bzhi` .
protected Map<String,Object>	getCfnProperties()
String	getDescription() The description of the project.
Object	getPlacementTemplate() An object describing the project's placement specifications.
String	getProjectName() The name of the project from which to obtain information.
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 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(String value) The name of the project from which to obtain information.

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

CfnProject

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

CfnProject

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

CfnProject

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

@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.

getAttrArn

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

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

getAttrProjectName

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

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

getCfnProperties

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

Overrides:

getCfnProperties in class CfnResource

getPlacementTemplate

@Stability(value=Stable)
 @NotNull
public Object getPlacementTemplate()

An object describing the project's placement specifications.

setPlacementTemplate

@Stability(value=Stable)
public void setPlacementTemplate(@NotNull
                                                          CfnProject.PlacementTemplateProperty value)

An object describing the project's placement specifications.

setPlacementTemplate

@Stability(value=Stable)
public void setPlacementTemplate(@NotNull
                                                          IResolvable value)

An object describing the project's placement specifications.

getDescription

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

The description of the project.

setDescription

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

The description of the project.

getProjectName

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

The name of the project from which to obtain information.

setProjectName

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

The name of the project from which to obtain information.