Class CfnProject
A CloudFormation AWS::IoTSiteWise::Project
.
Inherited Members
Namespace: Amazon.CDK.AWS.IoTSiteWise
Assembly: Amazon.CDK.AWS.IoTSiteWise.dll
Syntax (csharp)
public class CfnProject : CfnResource, IConstruct, IDependable, IInspectable
Syntax (vb)
Public Class CfnProject
Inherits CfnResource
Implements IConstruct, IDependable, IInspectable
Remarks
Creates a project in the specified portal.
Make sure that the project name and description don't contain confidential information.
CloudformationResource: AWS::IoTSiteWise::Project
Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotsitewise-project.html
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 |
CfnProject(ByRefValue) | Used by jsii to construct an instance of this class from a Javascript-owned object reference |
CfnProject(DeputyBase.DeputyProps) | Used by jsii to construct an instance of this class from DeputyProps |
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 | |
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. |
Tags | A list of key-value pairs that contain metadata for the project. |
Methods
Inspect(TreeInspector) | Examines the CloudFormation resource and discloses attributes. |
RenderProperties(IDictionary<String, Object>) |
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 System.String
- scoped id of the resource.
- props ICfnProjectProps
- resource properties.
CfnProject(ByRefValue)
Used by jsii to construct an instance of this class from a Javascript-owned object reference
protected CfnProject(ByRefValue reference)
Parameters
- reference Amazon.JSII.Runtime.Deputy.ByRefValue
The Javascript-owned object reference
CfnProject(DeputyBase.DeputyProps)
Used by jsii to construct an instance of this class from DeputyProps
protected CfnProject(DeputyBase.DeputyProps props)
Parameters
- props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps
The deputy props
Properties
AssetIds
A list that contains the IDs of each asset associated with the project.
public virtual string[] AssetIds { get; set; }
Property Value
System.String[]
Remarks
AttrProjectArn
The ARN of the project, which has the following format.
public virtual string AttrProjectArn { get; }
Property Value
System.String
Remarks
arn:${Partition}:iotsitewise:${Region}:${Account}:project/${ProjectId}
CloudformationAttribute: ProjectArn
AttrProjectId
The ID of the project.
public virtual string AttrProjectId { get; }
Property Value
System.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
System.String
CfnProperties
protected override IDictionary<string, object> CfnProperties { get; }
Property Value
System.Collections.Generic.IDictionary<System.String, System.Object>
Overrides
PortalId
The ID of the portal in which to create the project.
public virtual string PortalId { get; set; }
Property Value
System.String
Remarks
ProjectDescription
A description for the project.
public virtual string ProjectDescription { get; set; }
Property Value
System.String
Remarks
ProjectName
A friendly name for the project.
public virtual string ProjectName { get; set; }
Property Value
System.String
Remarks
Tags
A list of key-value pairs that contain metadata for the project.
public virtual TagManager Tags { get; }
Property Value
Remarks
For more information, see Tagging your AWS IoT SiteWise resources in the AWS IoT SiteWise User Guide .
Methods
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.
RenderProperties(IDictionary<String, Object>)
protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)
Parameters
- props System.Collections.Generic.IDictionary<System.String, System.Object>
Returns
System.Collections.Generic.IDictionary<System.String, System.Object>