Class CfnProject

The AWS IoT SiteWise Monitor feature will no longer be open to new customers starting November 7, 2025 .

Inheritance

object

CfnElement

CfnRefElement

CfnResource

CfnProject

Implements

IInspectable

IProjectRef

IConstruct

IDependable

IEnvironmentAware

ITaggable

Inherited Members

CfnResource.IsCfnResource(object)

CfnResource.AddDeletionOverride(string)

CfnResource.AddDependency(CfnResource)

CfnResource.AddDependsOn(CfnResource)

CfnResource.AddMetadata(string, object)

CfnResource.AddOverride(string, object)

CfnResource.AddPropertyDeletionOverride(string)

CfnResource.AddPropertyOverride(string, object)

CfnResource.ApplyRemovalPolicy(RemovalPolicy?, IRemovalPolicyOptions)

CfnResource.GetAtt(string, ResolutionTypeHint?)

CfnResource.GetMetadata(string)

CfnResource.ObtainDependencies()

CfnResource.ObtainResourceDependencies()

CfnResource.RemoveDependency(CfnResource)

CfnResource.ReplaceDependency(CfnResource, CfnResource)

CfnResource.ShouldSynthesize()

CfnResource.ToString()

CfnResource.ValidateProperties(object)

CfnResource.CfnOptions

CfnResource.CfnResourceType

CfnResource.Env

CfnResource.UpdatedProperites

CfnResource.UpdatedProperties

CfnRefElement.Ref

CfnElement.IsCfnElement(object)

CfnElement.OverrideLogicalId(string)

CfnElement.CreationStack

CfnElement.LogicalId

CfnElement.Stack

Namespace: Amazon.CDK.AWS.IoTSiteWise

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public class CfnProject : CfnResource, IInspectable, IProjectRef, IConstruct, IDependable, IEnvironmentAware, ITaggable

Syntax (vb)

Public Class CfnProject Inherits CfnResource Implements IInspectable, IProjectRef, IConstruct, IDependable, IEnvironmentAware, ITaggable

Remarks

If you would like to use the AWS IoT SiteWise Monitor feature, sign up prior to that date. Existing customers can continue to use the service as normal. For more information, see AWS IoT SiteWise Monitor availability change .

Creates a project in the specified portal.

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

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotsitewise-project.html

CloudformationResource: AWS::IoTSiteWise::Project

ExampleMetadata: fixture=_generated

Examples

// The code below shows an example of how to instantiate this type.
             // The values are placeholders you should change.
             using Amazon.CDK.AWS.IoTSiteWise;

             var cfnProject = new CfnProject(this, "MyCfnProject", new CfnProjectProps {
                 PortalId = "portalId",
                 ProjectName = "projectName",

                 // the properties below are optional
                 AssetIds = new [] { "assetIds" },
                 ProjectDescription = "projectDescription",
                 Tags = new [] { new CfnTag {
                     Key = "key",
                     Value = "value"
                 } }
             });

Synopsis

Constructors

CfnProject(Construct, string, ICfnProjectProps)

Create a new AWS::IoTSiteWise::Project.

Properties

AssetIds	A list that contains the IDs of each asset associated with the project.
AttrProjectArn	The ARN of the project, which has the following format.
AttrProjectId	The ID of the project.
CFN_RESOURCE_TYPE_NAME	The CloudFormation resource type name for this resource class.
CfnProperties	The AWS IoT SiteWise Monitor feature will no longer be open to new customers starting November 7, 2025 .
PortalId	The ID of the portal in which to create the project.
ProjectDescription	A description for the project.
ProjectName	A friendly name for the project.
ProjectRef	A reference to a Project resource.
Tags	Tag Manager which manages the tags for this resource.
TagsRaw	A list of key-value pairs that contain metadata for the project.

Methods

ArnForProject(IProjectRef)	The AWS IoT SiteWise Monitor feature will no longer be open to new customers starting November 7, 2025 .
FromProjectArn(Construct, string, string)	Creates a new IProjectRef from an ARN.
FromProjectId(Construct, string, string)	Creates a new IProjectRef from a projectId.
Inspect(TreeInspector)	Examines the CloudFormation resource and discloses attributes.
IsCfnProject(object)	Checks whether the given object is a CfnProject.
RenderProperties(IDictionary<string, object>)	The AWS IoT SiteWise Monitor feature will no longer be open to new customers starting November 7, 2025 .

Constructors

CfnProject(Construct, string, ICfnProjectProps)

Create a new AWS::IoTSiteWise::Project.

public CfnProject(Construct scope, string id, ICfnProjectProps props)

Parameters

scope Construct

Scope in which this resource is defined.

id string

Construct identifier for this resource (unique in its scope).

props ICfnProjectProps

Resource properties.

Remarks

If you would like to use the AWS IoT SiteWise Monitor feature, sign up prior to that date. Existing customers can continue to use the service as normal. For more information, see AWS IoT SiteWise Monitor availability change .

Creates a project in the specified portal.

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

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotsitewise-project.html

CloudformationResource: AWS::IoTSiteWise::Project

ExampleMetadata: fixture=_generated

Properties

AssetIds

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

public virtual string[]? AssetIds { get; set; }

Property Value

string[]

Remarks

If you would like to use the AWS IoT SiteWise Monitor feature, sign up prior to that date. Existing customers can continue to use the service as normal. For more information, see AWS IoT SiteWise Monitor availability change .

Creates a project in the specified portal.

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

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotsitewise-project.html

CloudformationResource: AWS::IoTSiteWise::Project

ExampleMetadata: fixture=_generated

AttrProjectArn

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

public virtual string AttrProjectArn { get; }

Property Value

string

Remarks

arn:\({Partition}:iotsitewise:\){Region}:\({Account}:project/\){ProjectId}

CloudformationAttribute: ProjectArn

AttrProjectId

The ID of the project.

public virtual string AttrProjectId { get; }

Property Value

string

Remarks

CloudformationAttribute: ProjectId

CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

public static string CFN_RESOURCE_TYPE_NAME { get; }

Property Value

string

Remarks

If you would like to use the AWS IoT SiteWise Monitor feature, sign up prior to that date. Existing customers can continue to use the service as normal. For more information, see AWS IoT SiteWise Monitor availability change .

Creates a project in the specified portal.

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

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotsitewise-project.html

CloudformationResource: AWS::IoTSiteWise::Project

ExampleMetadata: fixture=_generated

CfnProperties

The AWS IoT SiteWise Monitor feature will no longer be open to new customers starting November 7, 2025 .

protected override IDictionary<string, object> CfnProperties { get; }

Property Value

IDictionary<string, object>

Overrides

CfnResource.CfnProperties

Remarks

If you would like to use the AWS IoT SiteWise Monitor feature, sign up prior to that date. Existing customers can continue to use the service as normal. For more information, see AWS IoT SiteWise Monitor availability change .

Creates a project in the specified portal.

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

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotsitewise-project.html

CloudformationResource: AWS::IoTSiteWise::Project

ExampleMetadata: fixture=_generated

PortalId

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

public virtual string PortalId { get; set; }

Property Value

string

Remarks

If you would like to use the AWS IoT SiteWise Monitor feature, sign up prior to that date. Existing customers can continue to use the service as normal. For more information, see AWS IoT SiteWise Monitor availability change .

Creates a project in the specified portal.

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

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotsitewise-project.html

CloudformationResource: AWS::IoTSiteWise::Project

ExampleMetadata: fixture=_generated

ProjectDescription

A description for the project.

public virtual string? ProjectDescription { get; set; }

Property Value

string

Remarks

If you would like to use the AWS IoT SiteWise Monitor feature, sign up prior to that date. Existing customers can continue to use the service as normal. For more information, see AWS IoT SiteWise Monitor availability change .

Creates a project in the specified portal.

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

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotsitewise-project.html

CloudformationResource: AWS::IoTSiteWise::Project

ExampleMetadata: fixture=_generated

ProjectName

A friendly name for the project.

public virtual string ProjectName { get; set; }

Property Value

string

Remarks

If you would like to use the AWS IoT SiteWise Monitor feature, sign up prior to that date. Existing customers can continue to use the service as normal. For more information, see AWS IoT SiteWise Monitor availability change .

Creates a project in the specified portal.

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

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotsitewise-project.html

CloudformationResource: AWS::IoTSiteWise::Project

ExampleMetadata: fixture=_generated

ProjectRef

A reference to a Project resource.

public virtual IProjectReference ProjectRef { get; }

Property Value

IProjectReference

Remarks

If you would like to use the AWS IoT SiteWise Monitor feature, sign up prior to that date. Existing customers can continue to use the service as normal. For more information, see AWS IoT SiteWise Monitor availability change .

Creates a project in the specified portal.

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

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotsitewise-project.html

CloudformationResource: AWS::IoTSiteWise::Project

ExampleMetadata: fixture=_generated

Tags

Tag Manager which manages the tags for this resource.

public virtual TagManager Tags { get; }

Property Value

TagManager

Remarks

If you would like to use the AWS IoT SiteWise Monitor feature, sign up prior to that date. Existing customers can continue to use the service as normal. For more information, see AWS IoT SiteWise Monitor availability change .

Creates a project in the specified portal.

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

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotsitewise-project.html

CloudformationResource: AWS::IoTSiteWise::Project

ExampleMetadata: fixture=_generated

TagsRaw

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

public virtual ICfnTag[]? TagsRaw { get; set; }

Property Value

ICfnTag[]

Remarks

If you would like to use the AWS IoT SiteWise Monitor feature, sign up prior to that date. Existing customers can continue to use the service as normal. For more information, see AWS IoT SiteWise Monitor availability change .

Creates a project in the specified portal.

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

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotsitewise-project.html

CloudformationResource: AWS::IoTSiteWise::Project

ExampleMetadata: fixture=_generated

Methods

ArnForProject(IProjectRef)

The AWS IoT SiteWise Monitor feature will no longer be open to new customers starting November 7, 2025 .

public static string ArnForProject(IProjectRef resource)

Parameters

resource IProjectRef

Returns

string

Remarks

If you would like to use the AWS IoT SiteWise Monitor feature, sign up prior to that date. Existing customers can continue to use the service as normal. For more information, see AWS IoT SiteWise Monitor availability change .

Creates a project in the specified portal.

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

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotsitewise-project.html

CloudformationResource: AWS::IoTSiteWise::Project

ExampleMetadata: fixture=_generated

Examples

// The code below shows an example of how to instantiate this type.
             // The values are placeholders you should change.
             using Amazon.CDK.AWS.IoTSiteWise;

             var cfnProject = new CfnProject(this, "MyCfnProject", new CfnProjectProps {
                 PortalId = "portalId",
                 ProjectName = "projectName",

                 // the properties below are optional
                 AssetIds = new [] { "assetIds" },
                 ProjectDescription = "projectDescription",
                 Tags = new [] { new CfnTag {
                     Key = "key",
                     Value = "value"
                 } }
             });

FromProjectArn(Construct, string, string)

Creates a new IProjectRef from an ARN.

public static IProjectRef FromProjectArn(Construct scope, string id, string arn)

Parameters

scope Construct

id string

arn string

Returns

IProjectRef

Remarks

If you would like to use the AWS IoT SiteWise Monitor feature, sign up prior to that date. Existing customers can continue to use the service as normal. For more information, see AWS IoT SiteWise Monitor availability change .

Creates a project in the specified portal.

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

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotsitewise-project.html

CloudformationResource: AWS::IoTSiteWise::Project

ExampleMetadata: fixture=_generated

FromProjectId(Construct, string, string)

Creates a new IProjectRef from a projectId.

public static IProjectRef FromProjectId(Construct scope, string id, string projectId)

Parameters

scope Construct

id string

projectId string

Returns

IProjectRef

Remarks

If you would like to use the AWS IoT SiteWise Monitor feature, sign up prior to that date. Existing customers can continue to use the service as normal. For more information, see AWS IoT SiteWise Monitor availability change .

Creates a project in the specified portal.

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

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotsitewise-project.html

CloudformationResource: AWS::IoTSiteWise::Project

ExampleMetadata: fixture=_generated

Inspect(TreeInspector)

Examines the CloudFormation resource and discloses attributes.

public virtual void Inspect(TreeInspector inspector)

Parameters

inspector TreeInspector

tree inspector to collect and process attributes.

Remarks

If you would like to use the AWS IoT SiteWise Monitor feature, sign up prior to that date. Existing customers can continue to use the service as normal. For more information, see AWS IoT SiteWise Monitor availability change .

Creates a project in the specified portal.

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

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotsitewise-project.html

CloudformationResource: AWS::IoTSiteWise::Project

ExampleMetadata: fixture=_generated

IsCfnProject(object)

Checks whether the given object is a CfnProject.

public static bool IsCfnProject(object x)

Parameters

x object

Returns

bool

Remarks

If you would like to use the AWS IoT SiteWise Monitor feature, sign up prior to that date. Existing customers can continue to use the service as normal. For more information, see AWS IoT SiteWise Monitor availability change .

Creates a project in the specified portal.

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

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotsitewise-project.html

CloudformationResource: AWS::IoTSiteWise::Project

ExampleMetadata: fixture=_generated

RenderProperties(IDictionary<string, object>)

The AWS IoT SiteWise Monitor feature will no longer be open to new customers starting November 7, 2025 .

protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)

Parameters

props IDictionary<string, object>

Returns

IDictionary<string, object>

Overrides

CfnResource.RenderProperties(IDictionary<string, object>)

Remarks

If you would like to use the AWS IoT SiteWise Monitor feature, sign up prior to that date. Existing customers can continue to use the service as normal. For more information, see AWS IoT SiteWise Monitor availability change .

Creates a project in the specified portal.

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

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotsitewise-project.html

CloudformationResource: AWS::IoTSiteWise::Project

ExampleMetadata: fixture=_generated

Implements

IInspectable

IProjectRef

Constructs.IConstruct

Constructs.IDependable

IEnvironmentAware

ITaggable