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

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

AWS Cloud Control v1.37.0 published on Wednesday, Oct 15, 2025 by Pulumi
pulumi/pulumi-aws-native

aws-native.cloudwatch.getDashboard

Get Started
aws-native logo

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

AWS Cloud Control v1.37.0 published on Wednesday, Oct 15, 2025 by Pulumi
pulumi/pulumi-aws-native

    Resource Type definition for AWS::CloudWatch::Dashboard

    Using getDashboard

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getDashboard(args: GetDashboardArgs, opts?: InvokeOptions): Promise<GetDashboardResult>
function getDashboardOutput(args: GetDashboardOutputArgs, opts?: InvokeOptions): Output<GetDashboardResult>
    def get_dashboard(dashboard_name: Optional[str] = None,
                  opts: Optional[InvokeOptions] = None) -> GetDashboardResult
def get_dashboard_output(dashboard_name: Optional[pulumi.Input[str]] = None,
                  opts: Optional[InvokeOptions] = None) -> Output[GetDashboardResult]
    func LookupDashboard(ctx *Context, args *LookupDashboardArgs, opts ...InvokeOption) (*LookupDashboardResult, error)
func LookupDashboardOutput(ctx *Context, args *LookupDashboardOutputArgs, opts ...InvokeOption) LookupDashboardResultOutput

    > Note: This function is named LookupDashboard in the Go SDK.

    public static class GetDashboard 
{
    public static Task<GetDashboardResult> InvokeAsync(GetDashboardArgs args, InvokeOptions? opts = null)
    public static Output<GetDashboardResult> Invoke(GetDashboardInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetDashboardResult> getDashboard(GetDashboardArgs args, InvokeOptions options)
public static Output<GetDashboardResult> getDashboard(GetDashboardArgs args, InvokeOptions options)

    fn::invoke:
  function: aws-native:cloudwatch:getDashboard
  arguments:
    # arguments dictionary

    The following arguments are supported:

    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.
    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.
    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.
    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_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.
    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.

    getDashboard Result

    The following output properties are available:

    DashboardBody string
    The detailed information about the dashboard in JSON format, including the widgets to include and their location on the dashboard
    DashboardBody string
    The detailed information about the dashboard in JSON format, including the widgets to include and their location on the dashboard
    dashboardBody String
    The detailed information about the dashboard in JSON format, including the widgets to include and their location on the dashboard
    dashboardBody string
    The detailed information about the dashboard in JSON format, including the widgets to include and their location on the dashboard
    dashboard_body str
    The detailed information about the dashboard in JSON format, including the widgets to include and their location on the dashboard
    dashboardBody String
    The detailed information about the dashboard in JSON format, including the widgets to include and their location on the dashboard

    Package Details

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

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

    AWS Cloud Control v1.37.0 published on Wednesday, Oct 15, 2025 by Pulumi
    pulumi/pulumi-aws-native
      Meet Neo: Your AI Platform Teammate