interface CfnProjectProps

Language	Type name
.NET	Amazon.CDK.AWS.IoTSiteWise.CfnProjectProps
Java	software.amazon.awscdk.services.iotsitewise.CfnProjectProps
Python	aws_cdk.aws_iotsitewise.CfnProjectProps
TypeScript	@aws-cdk/aws-iotsitewise » CfnProjectProps

Properties for defining a CfnProject.

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import * as iotsitewise from '@aws-cdk/aws-iotsitewise';
const cfnProjectProps: iotsitewise.CfnProjectProps = {
  portalId: 'portalId',
  projectName: 'projectName',

  // the properties below are optional
  assetIds: ['assetIds'],
  projectDescription: 'projectDescription',
  tags: [{
    key: 'key',
    value: 'value',
  }],
};

Properties

Name	Type	Description
portalId	string	The ID of the portal in which to create the project.
projectName	string	A friendly name for the project.
assetIds?	string[]	A list that contains the IDs of each asset associated with the project.
projectDescription?	string	A description for the project.
tags?	CfnTag[]	A list of key-value pairs that contain metadata for the project.

---

portalId

Type: string

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

---

projectName

Type: string

A friendly name for the project.

---

assetIds?

Type: string[] (optional)

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

---

projectDescription?

Type: string (optional)

A description for the project.

---

tags?

Type: CfnTag[] (optional)

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 .