software.amazon.awscdk.services.iotsitewise

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

All Implemented Interfaces:

IConstruct, IDependable, IInspectable

@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)",
           date="2023-03-22T19:35:37.071Z")
public class CfnProject
extends CfnResource
implements IInspectable

A CloudFormation `AWS::IoTSiteWise::Project`.

Creates a project in the specified portal.

Make sure that the project name and description don't contain confidential information.

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.iotsitewise.*;
 CfnProject cfnProject = CfnProject.Builder.create(this, "MyCfnProject")
         .portalId("portalId")
         .projectName("projectName")
         // the properties below are optional
         .assetIds(List.of("assetIds"))
         .projectDescription("projectDescription")
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CfnProject.Builder A fluent builder for CfnProject.

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::IoTSiteWise::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.util.List<java.lang.String>	getAssetIds() A list that contains the IDs of each asset associated with the project.
java.lang.String	getAttrProjectArn() The [ARN](https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) of the project, which has the following format.
java.lang.String	getAttrProjectId() The ID of the project.
protected java.util.Map<java.lang.String,java.lang.Object>	getCfnProperties()
java.lang.String	getPortalId() The ID of the portal in which to create the project.
java.lang.String	getProjectDescription() A description for the project.
java.lang.String	getProjectName() A friendly name for the project.
TagManager	getTags() A list of key-value pairs that contain metadata for the project.
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	setAssetIds(java.util.List<java.lang.String> value) A list that contains the IDs of each asset associated with the project.
void	setPortalId(java.lang.String value) The ID of the portal in which to create the project.
void	setProjectDescription(java.lang.String value) A description for the project.
void	setProjectName(java.lang.String value) A friendly name for the project.

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::IoTSiteWise::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.

getAttrProjectArn

public java.lang.String getAttrProjectArn()

The [ARN](https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) of the project, which has the following format.

arn:${Partition}:iotsitewise:${Region}:${Account}:project/${ProjectId}

getAttrProjectId

public java.lang.String getAttrProjectId()

The ID of the project.

getCfnProperties

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

Overrides:

getCfnProperties in class CfnResource

getTags

public TagManager getTags()

A list of key-value pairs that contain metadata for the project.

For more information, see Tagging your AWS IoT SiteWise resources in the AWS IoT SiteWise User Guide .

getPortalId

public java.lang.String getPortalId()

The ID of the portal in which to create the project.

setPortalId

public void setPortalId(java.lang.String value)

The ID of the portal in which to create the project.

getProjectName

public java.lang.String getProjectName()

A friendly name for the project.

setProjectName

public void setProjectName(java.lang.String value)

A friendly name for the project.

getAssetIds

public java.util.List<java.lang.String> getAssetIds()

A list that contains the IDs of each asset associated with the project.

setAssetIds

public void setAssetIds(java.util.List<java.lang.String> value)

A list that contains the IDs of each asset associated with the project.

getProjectDescription

public java.lang.String getProjectDescription()

A description for the project.

setProjectDescription

public void setProjectDescription(java.lang.String value)

A description for the project.