Class Dashboard
A CloudWatch dashboard.
Inherited Members
Namespace: Amazon.CDK.AWS.CloudWatch
Assembly: Amazon.CDK.AWS.CloudWatch.dll
Syntax (csharp)
public class Dashboard : Resource, IResource, IConstruct, IDependable
Syntax (vb)
Public Class Dashboard
Inherits Resource
Implements IResource, IConstruct, IDependable
Remarks
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.CloudWatch;
IWidget widget;
var dashboard = new Dashboard(this, "MyDashboard", new DashboardProps {
DashboardName = "dashboardName",
End = "end",
PeriodOverride = PeriodOverride.AUTO,
Start = "start",
Widgets = new [] { new [] { widget } }
});
Synopsis
Constructors
Dashboard(ByRefValue) | Used by jsii to construct an instance of this class from a Javascript-owned object reference |
Dashboard(DeputyBase.DeputyProps) | Used by jsii to construct an instance of this class from DeputyProps |
Dashboard(Construct, String, IDashboardProps) |
Properties
DashboardArn | ARN of this dashboard. |
DashboardName | The name of this dashboard. |
Methods
AddWidgets(IWidget[]) | Add a widget to the dashboard. |
Constructors
Dashboard(ByRefValue)
Used by jsii to construct an instance of this class from a Javascript-owned object reference
protected Dashboard(ByRefValue reference)
Parameters
- reference Amazon.JSII.Runtime.Deputy.ByRefValue
The Javascript-owned object reference
Dashboard(DeputyBase.DeputyProps)
Used by jsii to construct an instance of this class from DeputyProps
protected Dashboard(DeputyBase.DeputyProps props)
Parameters
- props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps
The deputy props
Dashboard(Construct, String, IDashboardProps)
public Dashboard(Construct scope, string id, IDashboardProps props = null)
Parameters
- scope Constructs.Construct
- id System.String
- props IDashboardProps
Properties
DashboardArn
ARN of this dashboard.
public virtual string DashboardArn { get; }
Property Value
System.String
Remarks
Attribute: true
DashboardName
The name of this dashboard.
public virtual string DashboardName { get; }
Property Value
System.String
Remarks
Attribute: true
Methods
AddWidgets(IWidget[])
Add a widget to the dashboard.
public virtual void AddWidgets(params IWidget[] widgets)
Parameters
- widgets IWidget[]
Remarks
Widgets given in multiple calls to add() will be laid out stacked on top of each other.
Multiple widgets added in the same call to add() will be laid out next to each other.