There are more AWS SDK examples available in the [AWS Doc SDK Examples](https://github.com/awsdocs/aws-doc-sdk-examples) GitHub repo.
# Use `PutDashboard` with an AWS SDK or CLI
The following code examples show how to use `PutDashboard`.
Action examples are code excerpts from larger programs and must be run in context. You can see this action in context in the following code examples:
+ [Learn the basics](cloudwatch_example_cloudwatch_GetStartedMetricsDashboardsAlarms_section.md)
+ [Creating a CloudWatch dashboard with function name as a variable](cloudwatch_example_cloudwatch_GettingStarted_031_section.md)
+ [Using property variables in CloudWatch dashboards to monitor multiple Lambda functions](cloudwatch_example_iam_GettingStarted_032_section.md)
------
#### [ .NET ]
**SDK for .NET (v4)**
There's more on GitHub. Find the complete example and learn how to set up and run in the [AWS Code Examples Repository](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/dotnetv4/CloudWatch#code-examples).
```
///
/// Set up a dashboard using a call to the wrapper class.
///
/// The metric namespace.
/// The metric name.
/// The name of the dashboard.
/// A list of validation messages.
private static async Task> SetupDashboard(
string customMetricNamespace, string customMetricName, string dashboardName)
{
// Get the dashboard model from configuration.
var newDashboard = new DashboardModel();
_configuration.GetSection("dashboardExampleBody").Bind(newDashboard);
// Add a new metric to the dashboard.
newDashboard.Widgets.Add(new Widget
{
Height = 8,
Width = 8,
Y = 8,
X = 0,
Type = "metric",
Properties = new Properties
{
Metrics = new List>
{ new() { customMetricNamespace, customMetricName } },
View = "timeSeries",
Region = "us-east-1",
Stat = "Sum",
Period = 86400,
YAxis = new YAxis { Left = new Left { Min = 0, Max = 100 } },
Title = "Custom Metric Widget",
LiveData = true,
Sparkline = true,
Trend = true,
Stacked = false,
SetPeriodToTimeRange = false
}
});
var newDashboardString = JsonSerializer.Serialize(newDashboard,
new JsonSerializerOptions
{ DefaultIgnoreCondition = JsonIgnoreCondition.WhenWritingNull });
var validationMessages =
await _cloudWatchWrapper.PutDashboard(dashboardName, newDashboardString);
return validationMessages;
}
///
/// Wrapper to create or add to a dashboard with metrics.
///
/// The name for the dashboard.
/// The metric data in JSON for the dashboard.
/// A list of validation messages for the dashboard.
public async Task> PutDashboard(string dashboardName,
string dashboardBody)
{
// Updating a dashboard replaces all contents.
// Best practice is to include a text widget indicating this dashboard was created programmatically.
var dashboardResponse = await _amazonCloudWatch.PutDashboardAsync(
new PutDashboardRequest()
{
DashboardName = dashboardName,
DashboardBody = dashboardBody
});
return dashboardResponse.DashboardValidationMessages ?? new List();
}
```
+ For API details, see [PutDashboard](https://docs.aws.amazon.com/goto/DotNetSDKV4/monitoring-2010-08-01/PutDashboard) in *AWS SDK for .NET API Reference*.
------
#### [ CLI ]
**AWS CLI**
**To create a dashboard**
The following `put-dashboard` example creates a dashboard named `Dashboard-A` in the specified account.
```
aws cloudwatch put-dashboard \
--dashboard-name Dashboard-A \
--dashboard-body '{"widgets":[{"height":6,"width":6,"y":0,"x":0,"type":"metric","properties":{"view":"timeSeries","stacked":false,"metrics":[["Namespace","CPUUtilization","Environment","Prod","Type","App"]],"region":"us-east-1"}}]}'
```
Output:
```
{
"DashboardValidationMessages": []
}
```
For more information, see [Creating a CloudWatch dashboard](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/create_dashboard.html) in the *Amazon CloudWatch User Guide*.
+ For API details, see [PutDashboard](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cloudwatch/put-dashboard.html) in *AWS CLI Command Reference*.
------
#### [ Java ]
**SDK for Java 2.x**
There's more on GitHub. Find the complete example and learn how to set up and run in the [AWS Code Examples Repository](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/javav2/example_code/cloudwatch#code-examples).
```
/**
* Creates a new dashboard with the specified name and metrics from the given file.
*
* @param dashboardName the name of the dashboard to be created
* @param fileName the name of the file containing the dashboard body
* @return a {@link CompletableFuture} representing the asynchronous operation of creating the dashboard
* @throws IOException if there is an error reading the dashboard body from the file
*/
public CompletableFuture createDashboardWithMetricsAsync(String dashboardName, String fileName) throws IOException {
String dashboardBody = readFileAsString(fileName);
PutDashboardRequest dashboardRequest = PutDashboardRequest.builder()
.dashboardName(dashboardName)
.dashboardBody(dashboardBody)
.build();
return getAsyncClient().putDashboard(dashboardRequest)
.handle((response, ex) -> {
if (ex != null) {
logger.info("Failed to create dashboard: {}", ex.getMessage());
throw new RuntimeException("Dashboard creation failed", ex);
} else {
// Handle the normal response case
logger.info("{} was successfully created.", dashboardName);
List messages = response.dashboardValidationMessages();
if (messages.isEmpty()) {
logger.info("There are no messages in the new Dashboard.");
} else {
for (DashboardValidationMessage message : messages) {
logger.info("Message: {}", message.message());
}
}
return response; // Return the response for further use
}
});
}
```
+ For API details, see [PutDashboard](https://docs.aws.amazon.com/goto/SdkForJavaV2/monitoring-2010-08-01/PutDashboard) in *AWS SDK for Java 2.x API Reference*.
------
#### [ Kotlin ]
**SDK for Kotlin**
There's more on GitHub. Find the complete example and learn how to set up and run in the [AWS Code Examples Repository](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/kotlin/services/cloudwatch#code-examples).
```
suspend fun createDashboardWithMetrics(
dashboardNameVal: String,
fileNameVal: String,
) {
val dashboardRequest =
PutDashboardRequest {
dashboardName = dashboardNameVal
dashboardBody = readFileAsString(fileNameVal)
}
CloudWatchClient.fromEnvironment { region = "us-east-1" }.use { cwClient ->
val response = cwClient.putDashboard(dashboardRequest)
println("$dashboardNameVal was successfully created.")
val messages = response.dashboardValidationMessages
if (messages != null) {
if (messages.isEmpty()) {
println("There are no messages in the new Dashboard")
} else {
for (message in messages) {
println("Message is: ${message.message}")
}
}
}
}
}
```
+ For API details, see [PutDashboard](https://sdk.amazonaws.com/kotlin/api/latest/index.html) in *AWS SDK for Kotlin API reference*.
------
#### [ PowerShell ]
**Tools for PowerShell V4**
**Example 1: Creates or updates the dashboard named 'Dashboard1' to include two metric widgets side by side.**
```
$dashBody = @"
{
"widgets":[
{
"type":"metric",
"x":0,
"y":0,
"width":12,
"height":6,
"properties":{
"metrics":[
[
"AWS/EC2",
"CPUUtilization",
"InstanceId",
"i-012345"
]
],
"period":300,
"stat":"Average",
"region":"us-east-1",
"title":"EC2 Instance CPU"
}
},
{
"type":"metric",
"x":12,
"y":0,
"width":12,
"height":6,
"properties":{
"metrics":[
[
"AWS/S3",
"BucketSizeBytes",
"BucketName",
"amzn-s3-demo-bucket"
]
],
"period":86400,
"stat":"Maximum",
"region":"us-east-1",
"title":"amzn-s3-demo-bucket bytes"
}
}
]
}
"@
Write-CWDashboard -DashboardName Dashboard1 -DashboardBody $dashBody
```
**Example 2: Creates or updates the dashboard, piping the content describing the dashboard into the cmdlet.**
```
$dashBody = @"
{
...
}
"@
$dashBody | Write-CWDashboard -DashboardName Dashboard1
```
+ For API details, see [PutDashboard](https://docs.aws.amazon.com/powershell/v4/reference) in *AWS Tools for PowerShell Cmdlet Reference (V4)*.
**Tools for PowerShell V5**
**Example 1: Creates or updates the dashboard named 'Dashboard1' to include two metric widgets side by side.**
```
$dashBody = @"
{
"widgets":[
{
"type":"metric",
"x":0,
"y":0,
"width":12,
"height":6,
"properties":{
"metrics":[
[
"AWS/EC2",
"CPUUtilization",
"InstanceId",
"i-012345"
]
],
"period":300,
"stat":"Average",
"region":"us-east-1",
"title":"EC2 Instance CPU"
}
},
{
"type":"metric",
"x":12,
"y":0,
"width":12,
"height":6,
"properties":{
"metrics":[
[
"AWS/S3",
"BucketSizeBytes",
"BucketName",
"amzn-s3-demo-bucket"
]
],
"period":86400,
"stat":"Maximum",
"region":"us-east-1",
"title":"amzn-s3-demo-bucket bytes"
}
}
]
}
"@
Write-CWDashboard -DashboardName Dashboard1 -DashboardBody $dashBody
```
**Example 2: Creates or updates the dashboard, piping the content describing the dashboard into the cmdlet.**
```
$dashBody = @"
{
...
}
"@
$dashBody | Write-CWDashboard -DashboardName Dashboard1
```
+ For API details, see [PutDashboard](https://docs.aws.amazon.com/powershell/v5/reference) in *AWS Tools for PowerShell Cmdlet Reference (V5)*.
------