1. Packages
  2. AWS Cloud Control
  3. API Docs
  4. cloudwatch
  5. Dashboard

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.26.0 published on Wednesday, Mar 12, 2025 by Pulumi

aws-native.cloudwatch.Dashboard

Explore with Pulumi AI

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.26.0 published on Wednesday, Mar 12, 2025 by Pulumi

Resource Type definition for AWS::CloudWatch::Dashboard

Create Dashboard Resource

Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

Constructor syntax

new Dashboard(name: string, args: DashboardArgs, opts?: CustomResourceOptions);
@overload
def Dashboard(resource_name: str,
              args: DashboardArgs,
              opts: Optional[ResourceOptions] = None)

@overload
def Dashboard(resource_name: str,
              opts: Optional[ResourceOptions] = None,
              dashboard_body: Optional[str] = None,
              dashboard_name: Optional[str] = None)
func NewDashboard(ctx *Context, name string, args DashboardArgs, opts ...ResourceOption) (*Dashboard, error)
public Dashboard(string name, DashboardArgs args, CustomResourceOptions? opts = null)
public Dashboard(String name, DashboardArgs args)
public Dashboard(String name, DashboardArgs args, CustomResourceOptions options)
type: aws-native:cloudwatch:Dashboard
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. DashboardArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. DashboardArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args This property is required. DashboardArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. DashboardArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. DashboardArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

Dashboard Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

The Dashboard resource accepts the following input properties:

DashboardBody This property is required. string
The detailed information about the dashboard in JSON format, including the widgets to include and their location on the dashboard
DashboardName string
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.
DashboardBody This property is required. string
The detailed information about the dashboard in JSON format, including the widgets to include and their location on the dashboard
DashboardName string
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.
dashboardBody This property is required. String
The detailed information about the dashboard in JSON format, including the widgets to include and their location on the dashboard
dashboardName String
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.
dashboardBody This property is required. string
The detailed information about the dashboard in JSON format, including the widgets to include and their location on the dashboard
dashboardName string
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.
dashboard_body This property is required. str
The detailed information about the dashboard in JSON format, including the widgets to include and their location on the dashboard
dashboard_name 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.
dashboardBody This property is required. String
The detailed information about the dashboard in JSON format, including the widgets to include and their location on the dashboard
dashboardName String
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.

Outputs

All input properties are implicitly available as output properties. Additionally, the Dashboard resource produces the following output properties:

Id string
The provider-assigned unique ID for this managed resource.
Id string
The provider-assigned unique ID for this managed resource.
id String
The provider-assigned unique ID for this managed resource.
id string
The provider-assigned unique ID for this managed resource.
id str
The provider-assigned unique ID for this managed resource.
id String
The provider-assigned unique ID for this managed resource.

Package Details

Repository
AWS Native pulumi/pulumi-aws-native
License
Apache-2.0

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.26.0 published on Wednesday, Mar 12, 2025 by Pulumi