Class Dashboard
A CloudWatch dashboard.
Inherited Members
Namespace: Amazon.CDK.AWS.CloudWatch
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class Dashboard : Resource, IResource
Syntax (vb)
Public Class Dashboard
Inherits Resource
Implements IResource
Remarks
ExampleMetadata: infused
Examples
using Amazon.CDK.AWS.CloudWatch;
var dashboard = new Dashboard(this, "Dash", new DashboardProps {
DefaultInterval = Duration.Days(7),
Variables = new [] { new DashboardVariable(new DashboardVariableOptions {
Id = "region2",
Type = VariableType.PATTERN,
Label = "RegionPattern",
InputType = VariableInputType.INPUT,
Value = "us-east-1",
DefaultValue = DefaultValue.Value("us-east-1"),
Visible = true
}) }
});
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
AddVariable(IVariable) | Add a variable to the dashboard. |
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
AddVariable(IVariable)
Add a variable to the dashboard.
public virtual void AddVariable(IVariable variable)
Parameters
- variable IVariable
Remarks
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.