You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

Class: Aws::CloudWatch::Types::PutDashboardInput

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-cloudwatch/lib/aws-sdk-cloudwatch/types.rb

Overview

Note:

When making an API call, you may pass PutDashboardInput data as a hash:

{
  dashboard_name: "DashboardName", # required
  dashboard_body: "DashboardBody", # required
}

Instance Attribute Summary collapse

Instance Attribute Details

#dashboard_bodyString

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 CloudWatch-Dashboard-Body-Structure.

Returns:

  • (String)


1392
1393
1394
1395
1396
# File 'gems/aws-sdk-cloudwatch/lib/aws-sdk-cloudwatch/types.rb', line 1392

class PutDashboardInput < Struct.new(
  :dashboard_name,
  :dashboard_body)
  include Aws::Structure
end

#dashboard_nameString

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.

Returns:

  • (String)


1392
1393
1394
1395
1396
# File 'gems/aws-sdk-cloudwatch/lib/aws-sdk-cloudwatch/types.rb', line 1392

class PutDashboardInput < Struct.new(
  :dashboard_name,
  :dashboard_body)
  include Aws::Structure
end