Container for the parameters to the PutDashboard operation. Creates a dashboard if it does not already exist, or updates an existing dashboard. If you update a dashboard, the entire contents are replaced with what you specify here.
All dashboards in your account are global, not region-specific.
A simple way to create a dashboard using PutDashboard is to copy an existing
dashboard. To copy an existing dashboard using the console, you can load the dashboard
and then use the View/edit source command in the Actions menu to display the JSON
block for that dashboard. Another way to copy a dashboard is to use GetDashboard,
and then use the data returned within DashboardBody as the template for the
new dashboard when you call PutDashboard.
When you create a dashboard with PutDashboard, a good practice is to add a
text widget at the top of the dashboard with a message that the dashboard was created
by script and should not be changed in the console. This message could also point
console users to the location of the DashboardBody script or the CloudFormation
template used to create the dashboard.
Inheritance Hierarchy
Amazon.Runtime.AmazonWebServiceRequest
Amazon.CloudWatch.AmazonCloudWatchRequest
Amazon.CloudWatch.Model.PutDashboardRequest
Namespace: Amazon.CloudWatch.Model
Assembly: AWSSDK.CloudWatch.dll
Version: 3.x.y.z
Syntax
public class PutDashboardRequest : AmazonCloudWatchRequest IAmazonWebServiceRequest
The PutDashboardRequest type exposes the following members
Constructors
| Name | Description | |
|---|---|---|
|
PutDashboardRequest() |
Properties
| Name | Type | Description | |
|---|---|---|---|
|
|
DashboardBody | System.String |
Gets and sets the property DashboardBody. 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. |
|
|
DashboardName | System.String |
Gets and sets the property DashboardName. The name of the dashboard. If a dashboard with this name already exists, this call modifies that dashboard, replacing its current contents. Otherwise, a new dashboard is created. The maximum length is 255, and valid characters are A-Z, a-z, 0-9, "-", and "_". This parameter is required. |
Version Information
.NET Core App:
Supported in: 3.1
.NET Standard:
Supported in: 2.0
.NET Framework:
Supported in: 4.5, 4.0, 3.5