Class CfnDashboard

Creates a dashboard in an AWS IoT SiteWise Monitor project.

Inheritance

object

CfnElement

CfnRefElement

CfnResource

CfnDashboard

Implements

IInspectable

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.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 CfnDashboard : CfnResource, IInspectable, ITaggable

Syntax (vb)

Public Class CfnDashboard Inherits CfnResource Implements IInspectable, ITaggable

Remarks

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

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(Construct, string, ICfnDashboardProps)

Creates a dashboard in an AWS IoT SiteWise Monitor project.

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	Creates a dashboard in an AWS IoT SiteWise Monitor project.
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>)	Creates a dashboard in an AWS IoT SiteWise Monitor project.

Constructors

CfnDashboard(Construct, string, ICfnDashboardProps)

Creates a dashboard in an AWS IoT SiteWise Monitor project.

public CfnDashboard(Construct scope, string id, ICfnDashboardProps props)

Parameters

scope Construct: Scope in which this resource is defined.
id string: Construct identifier for this resource (unique in its scope).
props ICfnDashboardProps: Resource properties.

Remarks

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

CloudformationResource: AWS::IoTSiteWise::Dashboard

ExampleMetadata: fixture=_generated

Properties

AttrDashboardArn

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

public virtual string AttrDashboardArn { get; }

Property Value

string

Remarks

arn:\({Partition}:iotsitewise:\){Region}:\({Account}:dashboard/\){DashboardId}

CloudformationAttribute: DashboardArn

AttrDashboardId

The ID of the dashboard.

public virtual string AttrDashboardId { get; }

Property Value

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

string

Remarks

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

CloudformationResource: AWS::IoTSiteWise::Dashboard

ExampleMetadata: fixture=_generated

CfnProperties

Creates a dashboard in an AWS IoT SiteWise Monitor project.

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

CloudformationResource: AWS::IoTSiteWise::Dashboard

ExampleMetadata: fixture=_generated

DashboardDefinition

The dashboard definition specified in a JSON literal.

public virtual string DashboardDefinition { get; set; }

Property Value

string

Remarks

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

CloudformationResource: AWS::IoTSiteWise::Dashboard

ExampleMetadata: fixture=_generated

DashboardDescription

A description for the dashboard.

public virtual string DashboardDescription { get; set; }

Property Value

string

Remarks

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

CloudformationResource: AWS::IoTSiteWise::Dashboard

ExampleMetadata: fixture=_generated

DashboardName

A friendly name for the dashboard.

public virtual string DashboardName { get; set; }

Property Value

string

Remarks

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

CloudformationResource: AWS::IoTSiteWise::Dashboard

ExampleMetadata: fixture=_generated

ProjectId

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

public virtual string? ProjectId { get; set; }

Property Value

string

Remarks

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

CloudformationResource: AWS::IoTSiteWise::Dashboard

ExampleMetadata: fixture=_generated

TagsRaw

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

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

Property Value

ICfnTag[]

Remarks

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

CloudformationResource: AWS::IoTSiteWise::Dashboard

ExampleMetadata: fixture=_generated

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.

Remarks

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

CloudformationResource: AWS::IoTSiteWise::Dashboard

ExampleMetadata: fixture=_generated

RenderProperties(IDictionary<string, object>)

Creates a dashboard in an AWS IoT SiteWise Monitor project.

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

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

CloudformationResource: AWS::IoTSiteWise::Dashboard

ExampleMetadata: fixture=_generated

Implements

IInspectable

ITaggable