AWS::IoTSiteWise::Project

Creates a project in the specified portal.

Note

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

Syntax

To declare this entity in your AWS CloudFormation template, use the following syntax:

JSON

{
  "Type" : "AWS::IoTSiteWise::Project",
  "Properties" : {
      "AssetIds" : [ String, ... ],
      "PortalId" : String,
      "ProjectDescription" : String,
      "ProjectName" : String,
      "Tags" : [ Tag, ... ]
    }
}

YAML

Type: AWS::IoTSiteWise::Project
Properties:
  AssetIds: 
    - String
  PortalId: String
  ProjectDescription: String
  ProjectName: String
  Tags: 
    - Tag

Properties

AssetIds

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

Required: No

Type: Array of String

Update requires: No interruption

PortalId

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

Required: Yes

Type: String

Update requires: Replacement

ProjectDescription

A description for the project.

Required: No

Type: String

Update requires: No interruption

ProjectName

A friendly name for the project.

Required: Yes

Type: String

Update requires: No interruption

Tags

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.

Required: No

Type: Array of Tag

Update requires: No interruption

Return values

Ref

When you pass the logical ID of this resource to the intrinsic Ref function, Ref returns the ProjectId.

Fn::GetAtt

The Fn::GetAtt intrinsic function returns a value for a specified attribute of this type. The following are the available attributes and sample return values.

For more information about using the Fn::GetAtt intrinsic function, see Fn::GetAtt.

ProjectArn

The ARN of the project, which has the following format.

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

For more information about using the Ref function, see Ref.

ProjectId

The ID of the project.

For more information about using the Ref function, see Ref.