Class CfnDashboard
A CloudFormation AWS::CloudWatch::Dashboard
.
Inherited Members
Namespace: Amazon.CDK.AWS.CloudWatch
Assembly: Amazon.CDK.AWS.CloudWatch.dll
Syntax (csharp)
public class CfnDashboard : CfnResource, IConstruct, IDependable, IInspectable
Syntax (vb)
Public Class CfnDashboard
Inherits CfnResource
Implements IConstruct, IDependable, IInspectable
Remarks
The AWS::CloudWatch::Dashboard
resource specifies an Amazon CloudWatch dashboard. A dashboard is a customizable home page in the CloudWatch console that you can use to monitor your AWS resources in a single view.
All dashboards in your account are global, not region-specific.
CloudformationResource: AWS::CloudWatch::Dashboard
Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudwatch-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.CloudWatch;
var cfnDashboard = new CfnDashboard(this, "MyCfnDashboard", new CfnDashboardProps {
DashboardBody = "dashboardBody",
// the properties below are optional
DashboardName = "dashboardName"
});
Synopsis
Constructors
CfnDashboard(Construct, String, ICfnDashboardProps) | Create a new |
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 |
Properties
CFN_RESOURCE_TYPE_NAME | The CloudFormation resource type name for this resource class. |
CfnProperties | |
DashboardBody | The detailed information about the dashboard in JSON format, including the widgets to include and their location on the dashboard. |
DashboardName | The name of the dashboard. |
Methods
Inspect(TreeInspector) | Examines the CloudFormation resource and discloses attributes. |
RenderProperties(IDictionary<String, Object>) |
Constructors
CfnDashboard(Construct, String, ICfnDashboardProps)
Create a new AWS::CloudWatch::Dashboard
.
public CfnDashboard(Construct scope, string id, ICfnDashboardProps props)
Parameters
- scope Construct
- scope in which this resource is defined.
- id System.String
- scoped id of the resource.
- props ICfnDashboardProps
- resource properties.
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
Properties
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
DashboardBody
The detailed information about the dashboard in JSON format, including the widgets to include and their location on the dashboard.
public virtual string DashboardBody { get; set; }
Property Value
System.String
Remarks
This parameter is required.
For more information about the syntax, see Dashboard Body Structure and Syntax .
DashboardName
The name of the dashboard.
public virtual string DashboardName { get; set; }
Property Value
System.String
Remarks
The name must be between 1 and 255 characters. If you do not specify a name, one will be generated automatically.
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>