We recommend new projects start with resources from the AWS provider.
published on Wednesday, Nov 18, 2026 by Pulumi
We recommend new projects start with resources from the AWS provider.
published on Wednesday, Nov 18, 2026 by Pulumi
Resource Type definition for AWS::CloudWatch::OmniDashboard. A dashboard is a saved arrangement of panels that shows your team one agreed view of a system, backed by queries against your space’s telemetry.
Create OmniDashboard Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new OmniDashboard(name: string, args: OmniDashboardArgs, opts?: CustomResourceOptions);@overload
def OmniDashboard(resource_name: str,
args: OmniDashboardArgs,
opts: Optional[ResourceOptions] = None)
@overload
def OmniDashboard(resource_name: str,
opts: Optional[ResourceOptions] = None,
body: Optional[str] = None,
space_id: Optional[str] = None,
description: Optional[str] = None,
name: Optional[str] = None,
tags: Optional[Sequence[_root_inputs.TagArgs]] = None)func NewOmniDashboard(ctx *Context, name string, args OmniDashboardArgs, opts ...ResourceOption) (*OmniDashboard, error)public OmniDashboard(string name, OmniDashboardArgs args, CustomResourceOptions? opts = null)
public OmniDashboard(String name, OmniDashboardArgs args)
public OmniDashboard(String name, OmniDashboardArgs args, CustomResourceOptions options)
type: aws-native:cloudwatch:OmniDashboard
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
resource "aws-native_cloudwatch_omni_dashboard" "name" {
# resource properties
}Parameters
- name string
- The unique name of the resource.
- args OmniDashboardArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name str
- The unique name of the resource.
- args OmniDashboardArgs
- The arguments to resource properties.
- opts ResourceOptions
- Bag of options to control resource's behavior.
- ctx Context
- Context object for the current deployment.
- name string
- The unique name of the resource.
- args OmniDashboardArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args OmniDashboardArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args OmniDashboardArgs
- The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
OmniDashboard 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 OmniDashboard resource accepts the following input properties:
- Body string
- The dashboard definition.
- Space
Id string - The unique ID of the space to create the dashboard in.
- Description string
- An optional description of the dashboard.
- Name string
- A name that identifies the dashboard.
-
List<Pulumi.
Aws Native. Inputs. Tag> - An array of key-value pairs to apply to this resource.
- Body string
- The dashboard definition.
- Space
Id string - The unique ID of the space to create the dashboard in.
- Description string
- An optional description of the dashboard.
- Name string
- A name that identifies the dashboard.
-
Tag
Args - An array of key-value pairs to apply to this resource.
- body string
- The dashboard definition.
- space_
id string - The unique ID of the space to create the dashboard in.
- description string
- An optional description of the dashboard.
- name string
- A name that identifies the dashboard.
- list(object)
- An array of key-value pairs to apply to this resource.
- body String
- The dashboard definition.
- space
Id String - The unique ID of the space to create the dashboard in.
- description String
- An optional description of the dashboard.
- name String
- A name that identifies the dashboard.
- List<Tag>
- An array of key-value pairs to apply to this resource.
- body string
- The dashboard definition.
- space
Id string - The unique ID of the space to create the dashboard in.
- description string
- An optional description of the dashboard.
- name string
- A name that identifies the dashboard.
- Tag[]
- An array of key-value pairs to apply to this resource.
- body str
- The dashboard definition.
- space_
id str - The unique ID of the space to create the dashboard in.
- description str
- An optional description of the dashboard.
- name str
- A name that identifies the dashboard.
-
Sequence[Tag
Args] - An array of key-value pairs to apply to this resource.
- body String
- The dashboard definition.
- space
Id String - The unique ID of the space to create the dashboard in.
- description String
- An optional description of the dashboard.
- name String
- A name that identifies the dashboard.
- List<Property Map>
- An array of key-value pairs to apply to this resource.
Outputs
All input properties are implicitly available as output properties. Additionally, the OmniDashboard resource produces the following output properties:
- Arn string
- The Amazon Resource Name (ARN) of the dashboard.
- Created
At string - The timestamp when the dashboard was created.
- Created
By string - The principal that created the dashboard.
- Dashboard
Id string - The unique ID of the dashboard.
- Id string
- The provider-assigned unique ID for this managed resource.
- Updated
At string - The timestamp when the dashboard was last updated.
- Arn string
- The Amazon Resource Name (ARN) of the dashboard.
- Created
At string - The timestamp when the dashboard was created.
- Created
By string - The principal that created the dashboard.
- Dashboard
Id string - The unique ID of the dashboard.
- Id string
- The provider-assigned unique ID for this managed resource.
- Updated
At string - The timestamp when the dashboard was last updated.
- arn string
- The Amazon Resource Name (ARN) of the dashboard.
- created_
at string - The timestamp when the dashboard was created.
- created_
by string - The principal that created the dashboard.
- dashboard_
id string - The unique ID of the dashboard.
- id string
- The provider-assigned unique ID for this managed resource.
- updated_
at string - The timestamp when the dashboard was last updated.
- arn String
- The Amazon Resource Name (ARN) of the dashboard.
- created
At String - The timestamp when the dashboard was created.
- created
By String - The principal that created the dashboard.
- dashboard
Id String - The unique ID of the dashboard.
- id String
- The provider-assigned unique ID for this managed resource.
- updated
At String - The timestamp when the dashboard was last updated.
- arn string
- The Amazon Resource Name (ARN) of the dashboard.
- created
At string - The timestamp when the dashboard was created.
- created
By string - The principal that created the dashboard.
- dashboard
Id string - The unique ID of the dashboard.
- id string
- The provider-assigned unique ID for this managed resource.
- updated
At string - The timestamp when the dashboard was last updated.
- arn str
- The Amazon Resource Name (ARN) of the dashboard.
- created_
at str - The timestamp when the dashboard was created.
- created_
by str - The principal that created the dashboard.
- dashboard_
id str - The unique ID of the dashboard.
- id str
- The provider-assigned unique ID for this managed resource.
- updated_
at str - The timestamp when the dashboard was last updated.
- arn String
- The Amazon Resource Name (ARN) of the dashboard.
- created
At String - The timestamp when the dashboard was created.
- created
By String - The principal that created the dashboard.
- dashboard
Id String - The unique ID of the dashboard.
- id String
- The provider-assigned unique ID for this managed resource.
- updated
At String - The timestamp when the dashboard was last updated.
Look up Existing OmniDashboard Resource
Get an existing OmniDashboard resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.
public static get(name: string, id: Input<ID>, opts?: CustomResourceOptions): OmniDashboard@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None) -> OmniDashboardfunc GetOmniDashboard(ctx *Context, name string, id IDInput, state *OmniDashboardState, opts ...ResourceOption) (*OmniDashboard, error)public static OmniDashboard Get(string name, Input<string> id, CustomResourceOptions? opts = null)public static OmniDashboard get(String name, Output<String> id, CustomResourceOptions options)resources: existingOmniDashboard: type: aws-native:cloudwatch:OmniDashboard get: id: ${id}import {
to = aws-native_cloudwatch_omni_dashboard.example
id = "${id}"
}
- name string
- The unique name of the resulting resource.
- id Input<ID>
- The unique provider ID of the resource to look up.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name str
- The unique name of the resulting resource.
- id str
- The unique provider ID of the resource to look up.
- opts ResourceOptions
- Bag of options to control resource's behavior.
- ctx Context
- Context object for the current deployment.
- name string
- The unique name of the resulting resource.
- id IDInput
- The unique provider ID of the resource to look up.
- state OmniDashboardState
- Pass nil. This resource has no state arguments.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resulting resource.
- id Input<string>
- The unique provider ID of the resource to look up.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resulting resource.
- id Output<String>
- The unique provider ID of the resource to look up.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
Supporting Types
Tag, TagArgs
A set of tags to apply to the 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.
published on Wednesday, Nov 18, 2026 by Pulumi