Class CfnDashboard
Creates a dashboard in an AWS IoT SiteWise Monitor project.
Inherited Members
Namespace: Amazon.CDK.AWS.IoTSiteWise
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class CfnDashboard : CfnResource, IInspectable, ITaggable
Syntax (vb)
Public Class CfnDashboard
Inherits CfnResource
Implements IInspectable, ITaggable
Remarks
CloudformationResource: AWS::IoTSiteWise::Dashboard
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 cfnDashboard = new CfnDashboard(this, "MyCfnDashboard", new CfnDashboardProps {
DashboardDefinition = "dashboardDefinition",
DashboardDescription = "dashboardDescription",
DashboardName = "dashboardName",
// the properties below are optional
ProjectId = "projectId",
Tags = new [] { new CfnTag {
Key = "key",
Value = "value"
} }
});
Synopsis
Constructors
CfnDashboard(ByRefValue) | Used by jsii to construct an instance of this class from a Javascript-owned object reference |
CfnDashboard(DeputyBase.DeputyProps) | Used by jsii to construct an instance of this class from DeputyProps |
CfnDashboard(Construct, String, ICfnDashboardProps) |
Properties
AttrDashboardArn | The ARN of the dashboard, which has the following format. |
AttrDashboardId | The ID of the dashboard. |
CFN_RESOURCE_TYPE_NAME | The CloudFormation resource type name for this resource class. |
CfnProperties | |
DashboardDefinition | The dashboard definition specified in a JSON literal. |
DashboardDescription | A description for the dashboard. |
DashboardName | A friendly name for the dashboard. |
ProjectId | The ID of the project in which to create the dashboard. |
Tags | Tag Manager which manages the tags for this resource. |
TagsRaw | A list of key-value pairs that contain metadata for the dashboard. |
Methods
Inspect(TreeInspector) | Examines the CloudFormation resource and discloses attributes. |
RenderProperties(IDictionary<String, Object>) |
Constructors
CfnDashboard(ByRefValue)
Used by jsii to construct an instance of this class from a Javascript-owned object reference
protected CfnDashboard(ByRefValue reference)
Parameters
- reference Amazon.JSII.Runtime.Deputy.ByRefValue
The Javascript-owned object reference
CfnDashboard(DeputyBase.DeputyProps)
Used by jsii to construct an instance of this class from DeputyProps
protected CfnDashboard(DeputyBase.DeputyProps props)
Parameters
- props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps
The deputy props
CfnDashboard(Construct, String, ICfnDashboardProps)
public CfnDashboard(Construct scope, string id, ICfnDashboardProps props)
Parameters
- scope Constructs.Construct
Scope in which this resource is defined.
- id System.String
Construct identifier for this resource (unique in its scope).
- props ICfnDashboardProps
Resource properties.
Properties
AttrDashboardArn
The ARN of the dashboard, which has the following format.
public virtual string AttrDashboardArn { get; }
Property Value
System.String
Remarks
arn:${Partition}:iotsitewise:${Region}:${Account}:dashboard/${DashboardId}
CloudformationAttribute: DashboardArn
AttrDashboardId
The ID of the dashboard.
public virtual string AttrDashboardId { get; }
Property Value
System.String
Remarks
CloudformationAttribute: DashboardId
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
DashboardDefinition
The dashboard definition specified in a JSON literal.
public virtual string DashboardDefinition { get; set; }
Property Value
System.String
DashboardDescription
A description for the dashboard.
public virtual string DashboardDescription { get; set; }
Property Value
System.String
DashboardName
A friendly name for the dashboard.
public virtual string DashboardName { get; set; }
Property Value
System.String
ProjectId
The ID of the project in which to create the dashboard.
public virtual string ProjectId { get; set; }
Property Value
System.String
Tags
Tag Manager which manages the tags for this resource.
public virtual TagManager Tags { get; }
Property Value
TagsRaw
A list of key-value pairs that contain metadata for the dashboard.
public virtual ICfnTag[] TagsRaw { get; set; }
Property Value
ICfnTag[]
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>