CfnDashboardProps

class aws_cdk.aws_cloudwatch.CfnDashboardProps(*, dashboard_body, dashboard_name=None)

Bases: object

Properties for defining a CfnDashboard.

Parameters
  • dashboard_body (str) – The detailed information about the dashboard in JSON format, including the widgets to include and their location on the dashboard. This parameter is required. For more information about the syntax, see Dashboard Body Structure and Syntax .

  • dashboard_name (Optional[str]) – The name of the dashboard. The name must be between 1 and 255 characters. If you do not specify a name, one will be generated automatically.

Link

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

ExampleMetadata

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
import aws_cdk.aws_cloudwatch as cloudwatch

cfn_dashboard_props = cloudwatch.CfnDashboardProps(
    dashboard_body="dashboardBody",

    # the properties below are optional
    dashboard_name="dashboardName"
)

Attributes

dashboard_body

The detailed information about the dashboard in JSON format, including the widgets to include and their location on the dashboard.

This parameter is required.

For more information about the syntax, see Dashboard Body Structure and Syntax .

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudwatch-dashboard.html#cfn-cloudwatch-dashboard-dashboardbody

Return type

str

dashboard_name

The name of the dashboard.

The name must be between 1 and 255 characters. If you do not specify a name, one will be generated automatically.

Link

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

Return type

Optional[str]