Show / Hide Table of Contents

Class CfnDashboardProps

Properties for defining a CfnDashboard.

Inheritance
object
CfnDashboardProps
Implements
ICfnDashboardProps
Inherited Members
object.GetType()
object.MemberwiseClone()
object.ToString()
object.Equals(object)
object.Equals(object, object)
object.ReferenceEquals(object, object)
object.GetHashCode()
Namespace: Amazon.CDK.AWS.IoTSiteWise
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class CfnDashboardProps : ICfnDashboardProps
Syntax (vb)
Public Class CfnDashboardProps Implements ICfnDashboardProps
Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotsitewise-dashboard.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 cfnDashboardProps = 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

CfnDashboardProps()

Properties for defining a CfnDashboard.

Properties

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

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

Constructors

CfnDashboardProps()

Properties for defining a CfnDashboard.

public CfnDashboardProps()
Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotsitewise-dashboard.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 cfnDashboardProps = new CfnDashboardProps {
                 DashboardDefinition = "dashboardDefinition",
                 DashboardDescription = "dashboardDescription",
                 DashboardName = "dashboardName",

                 // the properties below are optional
                 ProjectId = "projectId",
                 Tags = new [] { new CfnTag {
                     Key = "key",
                     Value = "value"
                 } }
             };

Properties

DashboardDefinition

The dashboard definition specified in a JSON literal.

public string DashboardDefinition { get; set; }
Property Value

string

Remarks

    in the AWS IoT SiteWise User Guide

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

    DashboardDescription

    A description for the dashboard.

    public string DashboardDescription { get; set; }
    Property Value

    string

    Remarks

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

    DashboardName

    A friendly name for the dashboard.

    public string DashboardName { get; set; }
    Property Value

    string

    Remarks

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

    ProjectId

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

    public string? ProjectId { get; set; }
    Property Value

    string

    Remarks

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

    Tags

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

    public ICfnTag[]? Tags { get; set; }
    Property Value

    ICfnTag[]

    Remarks

    For more information, see Tagging your AWS IoT SiteWise resources in the AWS IoT SiteWise User Guide .

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

    Implements

    ICfnDashboardProps
    Back to top Generated by DocFX