Package software.amazon.awscdk.services.cloudwatch

Interface CfnDashboardProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnDashboardProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.97.0 (build 729de35)",
           date="2024-04-18T17:54:13.917Z")
@Stability(Stable)
public interface CfnDashboardProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a CfnDashboard.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.cloudwatch.*;
 CfnDashboardProps cfnDashboardProps = CfnDashboardProps.builder()
         .dashboardBody("dashboardBody")
         // the properties below are optional
         .dashboardName("dashboardName")
         .build();
 

See Also:

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

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnDashboardProps.Builder	A builder for CfnDashboardProps
static final class	CfnDashboardProps.Jsii$Proxy	An implementation for CfnDashboardProps

Method Summary

Modifier and Type	Method	Description
static CfnDashboardProps.Builder	builder()
String	getDashboardBody()	The detailed information about the dashboard in JSON format, including the widgets to include and their location on the dashboard.
default String	getDashboardName()	The name of the dashboard.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getDashboardBody

@Stability(Stable)
@NotNull
String getDashboardBody()

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 .

See Also:

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

getDashboardName

@Stability(Stable)
@Nullable
default String getDashboardName()

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.

See Also:

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

builder

@Stability(Stable)
static CfnDashboardProps.Builder builder()

Returns:

a CfnDashboardProps.Builder of CfnDashboardProps