Dashboard class

Resource for managing a QuickSight Dashboard.

Example Usage

From Source Template

import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const example = new aws.quicksight.Dashboard("example", {
    sourceEntity: {
        sourceTemplate: {
            dataSetReferences: [{
                dataSetArn: dataset.arn,
                dataSetPlaceholder: "1",
            }],
            arn: source.arn,
        },
    },
    dashboardId: "example-id",
    name: "example-name",
    versionDescription: "version",
});
import pulumi
import pulumi_aws as aws

example = aws.quicksight.Dashboard("example",
    source_entity={
        "source_template": {
            "data_set_references": [{
                "data_set_arn": dataset["arn"],
                "data_set_placeholder": "1",
            }],
            "arn": source["arn"],
        },
    },
    dashboard_id="example-id",
    name="example-name",
    version_description="version")
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() =>
{
    var example = new Aws.Quicksight.Dashboard("example", new()
    {
        SourceEntity = new Aws.Quicksight.Inputs.DashboardSourceEntityArgs
        {
            SourceTemplate = new Aws.Quicksight.Inputs.DashboardSourceEntitySourceTemplateArgs
            {
                DataSetReferences = new[]
                {
                    new Aws.Quicksight.Inputs.DashboardSourceEntitySourceTemplateDataSetReferenceArgs
                    {
                        DataSetArn = dataset.Arn,
                        DataSetPlaceholder = "1",
                    },
                },
                Arn = source.Arn,
            },
        },
        DashboardId = "example-id",
        Name = "example-name",
        VersionDescription = "version",
    });

});
package main

import (
	"github.com/pulumi/pulumi-aws/sdk/v7/go/aws/quicksight"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := quicksight.NewDashboard(ctx, "example", &quicksight.DashboardArgs{
			SourceEntity: &quicksight.DashboardSourceEntityArgs{
				SourceTemplate: &quicksight.DashboardSourceEntitySourceTemplateArgs{
					DataSetReferences: quicksight.DashboardSourceEntitySourceTemplateDataSetReferenceArray{
						&quicksight.DashboardSourceEntitySourceTemplateDataSetReferenceArgs{
							DataSetArn:         pulumi.Any(dataset.Arn),
							DataSetPlaceholder: pulumi.String("1"),
						},
					},
					Arn: pulumi.Any(source.Arn),
				},
			},
			DashboardId:        pulumi.String("example-id"),
			Name:               pulumi.String("example-name"),
			VersionDescription: pulumi.String("version"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
pulumi {
  required_providers {
    aws = {
      source = "pulumi/aws"
    }
  }
}

resource "aws_quicksight_dashboard" "example" {
  source_entity = {
    source_template = {
      data_set_references = [{
        "dataSetArn"         = dataset.arn
        "dataSetPlaceholder" = "1"
      }]
      arn = source.arn
    }
  }
  dashboard_id        = "example-id"
  name                = "example-name"
  version_description = "version"
}
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.quicksight.Dashboard;
import com.pulumi.aws.quicksight.DashboardArgs;
import com.pulumi.aws.quicksight.inputs.DashboardSourceEntityArgs;
import com.pulumi.aws.quicksight.inputs.DashboardSourceEntitySourceTemplateArgs;
import com.pulumi.aws.quicksight.inputs.DashboardSourceEntitySourceTemplateDataSetReferenceArgs;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var example = new Dashboard("example", DashboardArgs.builder()
            .sourceEntity(DashboardSourceEntityArgs.builder()
                .sourceTemplate(DashboardSourceEntitySourceTemplateArgs.builder()
                    .dataSetReferences(DashboardSourceEntitySourceTemplateDataSetReferenceArgs.builder()
                        .dataSetArn(dataset.arn())
                        .dataSetPlaceholder("1")
                        .build())
                    .arn(source.arn())
                    .build())
                .build())
            .dashboardId("example-id")
            .name("example-name")
            .versionDescription("version")
            .build());

    }
}
resources:
  example:
    type: aws:quicksight:Dashboard
    properties:
      sourceEntity:
        sourceTemplate:
          dataSetReferences:
            - dataSetArn: ${dataset.arn}
              dataSetPlaceholder: '1'
          arn: ${source.arn}
      dashboardId: example-id
      name: example-name
      versionDescription: version

With Definition

import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const example = new aws.quicksight.Dashboard("example", {
    definition: {
        dataSetIdentifiersDeclarations: [{
            dataSetArn: dataset.arn,
            identifier: "1",
        }],
        sheets: [{
            visuals: [{
                lineChartVisual: {
                    title: {
                        formatText: {
                            plainText: "Line Chart Example",
                        },
                    },
                    chartConfiguration: {
                        fieldWells: {
                            lineChartAggregatedFieldWells: {
                                categories: [{
                                    categoricalDimensionField: {
                                        column: {
                                            dataSetIdentifier: "1",
                                            columnName: "Column1",
                                        },
                                        fieldId: "1",
                                    },
                                }],
                                values: [{
                                    categoricalMeasureField: {
                                        column: {
                                            dataSetIdentifier: "1",
                                            columnName: "Column1",
                                        },
                                        fieldId: "2",
                                        aggregationFunction: "COUNT",
                                    },
                                }],
                            },
                        },
                    },
                    visualId: "LineChart",
                },
            }],
            title: "Example",
            sheetId: "Example1",
        }],
    },
    dashboardId: "example-id",
    name: "example-name",
    versionDescription: "version",
});
import pulumi
import pulumi_aws as aws

example = aws.quicksight.Dashboard("example",
    definition={
        "dataSetIdentifiersDeclarations": [{
            "dataSetArn": dataset["arn"],
            "identifier": "1",
        }],
        "sheets": [{
            "visuals": [{
                "lineChartVisual": {
                    "title": {
                        "formatText": {
                            "plainText": "Line Chart Example",
                        },
                    },
                    "chartConfiguration": {
                        "fieldWells": {
                            "lineChartAggregatedFieldWells": {
                                "categories": [{
                                    "categoricalDimensionField": {
                                        "column": {
                                            "dataSetIdentifier": "1",
                                            "columnName": "Column1",
                                        },
                                        "fieldId": "1",
                                    },
                                }],
                                "values": [{
                                    "categoricalMeasureField": {
                                        "column": {
                                            "dataSetIdentifier": "1",
                                            "columnName": "Column1",
                                        },
                                        "fieldId": "2",
                                        "aggregationFunction": "COUNT",
                                    },
                                }],
                            },
                        },
                    },
                    "visualId": "LineChart",
                },
            }],
            "title": "Example",
            "sheetId": "Example1",
        }],
    },
    dashboard_id="example-id",
    name="example-name",
    version_description="version")
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() =>
{
    var example = new Aws.Quicksight.Dashboard("example", new()
    {
        Definition =
        {
            { "dataSetIdentifiersDeclarations", new[]
            {

                {
                    { "dataSetArn", dataset.Arn },
                    { "identifier", "1" },
                },
            } },
            { "sheets", new[]
            {

                {
                    { "visuals", new[]
                    {

                        {
                            { "lineChartVisual",
                            {
                                { "title",
                                {
                                    { "formatText",
                                    {
                                        { "plainText", "Line Chart Example" },
                                    } },
                                } },
                                { "chartConfiguration",
                                {
                                    { "fieldWells",
                                    {
                                        { "lineChartAggregatedFieldWells",
                                        {
                                            { "categories", new[]
                                            {

                                                {
                                                    { "categoricalDimensionField",
                                                    {
                                                        { "column",
                                                        {
                                                            { "dataSetIdentifier", "1" },
                                                            { "columnName", "Column1" },
                                                        } },
                                                        { "fieldId", "1" },
                                                    } },
                                                },
                                            } },
                                            { "values", new[]
                                            {

                                                {
                                                    { "categoricalMeasureField",
                                                    {
                                                        { "column",
                                                        {
                                                            { "dataSetIdentifier", "1" },
                                                            { "columnName", "Column1" },
                                                        } },
                                                        { "fieldId", "2" },
                                                        { "aggregationFunction", "COUNT" },
                                                    } },
                                                },
                                            } },
                                        } },
                                    } },
                                } },
                                { "visualId", "LineChart" },
                            } },
                        },
                    } },
                    { "title", "Example" },
                    { "sheetId", "Example1" },
                },
            } },
        },
        DashboardId = "example-id",
        Name = "example-name",
        VersionDescription = "version",
    });

});
package main

import (
	"github.com/pulumi/pulumi-aws/sdk/v7/go/aws/quicksight"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := quicksight.NewDashboard(ctx, "example", &quicksight.DashboardArgs{
			Definition: map[string][]map[string]interface{}{
				"dataSetIdentifiersDeclarations": []map[string]interface{}{
					map[string]interface{}{
						"dataSetArn": dataset.Arn,
						"identifier": "1",
					},
				},
				"sheets": []map[string]interface{}{
					map[string]interface{}{
						"visuals": []map[string]map[string]interface{}{
							map[string]map[string]interface{}{
								"lineChartVisual": map[string]interface{}{
									"title": map[string]map[string]string{
										"formatText": map[string]string{
											"plainText": "Line Chart Example",
										},
									},
									"chartConfiguration": map[string]map[string]map[string][]map[string]map[string]interface{}{
										"fieldWells": map[string]map[string][]map[string]map[string]interface{}{
											"lineChartAggregatedFieldWells": map[string][]map[string]map[string]interface{}{
												"categories": []map[string]map[string]interface{}{
													map[string]map[string]interface{}{
														"categoricalDimensionField": map[string]interface{}{
															"column": map[string]string{
																"dataSetIdentifier": "1",
																"columnName":        "Column1",
															},
															"fieldId": "1",
														},
													},
												},
												"values": []map[string]map[string]interface{}{
													map[string]map[string]interface{}{
														"categoricalMeasureField": map[string]interface{}{
															"column": map[string]string{
																"dataSetIdentifier": "1",
																"columnName":        "Column1",
															},
															"fieldId":             "2",
															"aggregationFunction": "COUNT",
														},
													},
												},
											},
										},
									},
									"visualId": "LineChart",
								},
							},
						},
						"title":   "Example",
						"sheetId": "Example1",
					},
				},
			},
			DashboardId:        pulumi.String("example-id"),
			Name:               pulumi.String("example-name"),
			VersionDescription: pulumi.String("version"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
pulumi {
  required_providers {
    aws = {
      source = "pulumi/aws"
    }
  }
}

resource "aws_quicksight_dashboard" "example" {
  definition = {
    "dataSetIdentifiersDeclarations" = [{
      "dataSetArn" = dataset.arn
      "identifier" = "1"
    }]
    "sheets" = [{
      "visuals" = [{
        "lineChartVisual" = {
          "title" = {
            "formatText" = {
              "plainText" = "Line Chart Example"
            }
          }
          "chartConfiguration" = {
            "fieldWells" = {
              "lineChartAggregatedFieldWells" = {
                "categories" = [{
                  "categoricalDimensionField" = {
                    "column" = {
                      "dataSetIdentifier" = "1"
                      "columnName"        = "Column1"
                    }
                    "fieldId" = "1"
                  }
                }]
                "values" = [{
                  "categoricalMeasureField" = {
                    "column" = {
                      "dataSetIdentifier" = "1"
                      "columnName"        = "Column1"
                    }
                    "fieldId"             = "2"
                    "aggregationFunction" = "COUNT"
                  }
                }]
              }
            }
          }
          "visualId" = "LineChart"
        }
      }]
      "title"   = "Example"
      "sheetId" = "Example1"
    }]
  }
  dashboard_id        = "example-id"
  name                = "example-name"
  version_description = "version"
}
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.quicksight.Dashboard;
import com.pulumi.aws.quicksight.DashboardArgs;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var example = new Dashboard("example", DashboardArgs.builder()
            .definition(Map.ofEntries(
                Map.entry("dataSetIdentifiersDeclarations", Arrays.asList(Map.ofEntries(
                    Map.entry("dataSetArn", dataset.arn()),
                    Map.entry("identifier", "1")
                ))),
                Map.entry("sheets", Arrays.asList(Map.ofEntries(
                    Map.entry("visuals", Arrays.asList(Map.of("lineChartVisual", Map.ofEntries(
                        Map.entry("title", Map.of("formatText", Map.of("plainText", "Line Chart Example"))),
                        Map.entry("chartConfiguration", Map.of("fieldWells", Map.of("lineChartAggregatedFieldWells", Map.ofEntries(
                            Map.entry("categories", Arrays.asList(Map.of("categoricalDimensionField", Map.ofEntries(
                                Map.entry("column", Map.ofEntries(
                                    Map.entry("dataSetIdentifier", "1"),
                                    Map.entry("columnName", "Column1")
                                )),
                                Map.entry("fieldId", "1")
                            )))),
                            Map.entry("values", Arrays.asList(Map.of("categoricalMeasureField", Map.ofEntries(
                                Map.entry("column", Map.ofEntries(
                                    Map.entry("dataSetIdentifier", "1"),
                                    Map.entry("columnName", "Column1")
                                )),
                                Map.entry("fieldId", "2"),
                                Map.entry("aggregationFunction", "COUNT")
                            ))))
                        )))),
                        Map.entry("visualId", "LineChart")
                    )))),
                    Map.entry("title", "Example"),
                    Map.entry("sheetId", "Example1")
                )))
            ))
            .dashboardId("example-id")
            .name("example-name")
            .versionDescription("version")
            .build());

    }
}
resources:
  example:
    type: aws:quicksight:Dashboard
    properties:
      definition:
        dataSetIdentifiersDeclarations:
          - dataSetArn: ${dataset.arn}
            identifier: '1'
        sheets:
          - visuals:
              - lineChartVisual:
                  title:
                    formatText:
                      plainText: Line Chart Example
                  chartConfiguration:
                    fieldWells:
                      lineChartAggregatedFieldWells:
                        categories:
                          - categoricalDimensionField:
                              column:
                                dataSetIdentifier: '1'
                                columnName: Column1
                              fieldId: '1'
                        values:
                          - categoricalMeasureField:
                              column:
                                dataSetIdentifier: '1'
                                columnName: Column1
                              fieldId: '2'
                              aggregationFunction: COUNT
                  visualId: LineChart
            title: Example
            sheetId: Example1
      dashboardId: example-id
      name: example-name
      versionDescription: version

Import

Using pulumi import, import a QuickSight Dashboard using the AWS account ID and dashboard ID separated by a comma (,). For example:

$ pulumi import aws:quicksight/dashboard:Dashboard example 123456789012,example-id

Constructors

Dashboard(String name, {DashboardArgs? args, CustomResourceOptions? options})
Creates a new Dashboard. name The Pulumi resource name. args Arguments used to configure this Dashboard. The set of arguments for Dashboard. options Resource options controlling this resource's behavior.
Dashboard.reference(String urn)
Creates a typed reference to an existing Dashboard resource.

Properties

arn ↔ Output<String>
ARN of the dashboard.
latefinal
awsAccountId ↔ Output<String>
AWS account ID. Defaults to automatically determined account ID of the Terraform AWS provider.
latefinal
childResources → Set<Resource>
finalinherited
completionSources ↔ Map<String, IOutputCompletionSource>
latefinalinherited
createdTime ↔ Output<String>
The time that the dashboard was created.
latefinal
dashboardId ↔ Output<String>
Identifier for the dashboard.
latefinal
dashboardPublishOptions ↔ Output<DashboardDashboardPublishOptions>
Options for publishing the dashboard. See dashboard_publish_options.
latefinal
hashCode → int
The hash code for this object.
no setterinherited
id ↔ Output<String>
getter/setter pairinherited
isCustom → bool
Returns whether this resource is provider-managed.
no setterinherited
isProtected → bool
Returns whether this resource is protected from deletion.
no setterinherited
isRemote → bool
Whether this resource is registered as remote.
no setterinherited
isResourceReference → bool
Whether this instance represents a resource value returned over RPC.
finalinherited
lastPublishedTime ↔ Output<String>
latefinal
lastUpdatedTime ↔ Output<String>
The time that the dashboard was last updated.
latefinal
name ↔ Output<String>
Display name for the dashboard.
latefinal
parameters ↔ Output<DashboardParameters>
The parameters for the creation of the dashboard, which you want to use to override the default settings. A dashboard can have any type of parameters, and some parameters might accept multiple values. See parameters.
latefinal
permissions ↔ Output<List<DashboardPermission>?>
A set of resource permissions on the dashboard. Maximum of 64 items. See permissions.
latefinal
region ↔ Output<String>
Region where this resource will be managed. Defaults to the Region set in the provider configuration.
latefinal
resourceTransforms → List<ResourceTransform>
Inherited/explicit async transforms.
no setterinherited
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
sourceEntity ↔ Output<DashboardSourceEntity?>
The entity that you are using as a source when you create the dashboard (template). Only one of definition or sourceEntity should be configured. See source_entity.
latefinal
sourceEntityArn ↔ Output<String>
ARN of a template that was used to create this dashboard.
latefinal
status ↔ Output<String>
The dashboard creation status.
latefinal
tags ↔ Output<Map<String, String>?>
Key-value map of resource tags. If configured with a provider defaultTags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
latefinal
tagsAll ↔ Output<Map<String, String>>
A map of tags assigned to the resource, including those inherited from the provider defaultTags configuration block.
latefinal
themeArn ↔ Output<String?>
ARN of the theme that is being used for this dashboard. The theme ARN must exist in the same AWS account where you create the dashboard.
latefinal
transformations → List<ResourceTransformation>
Inherited/explicit legacy transformations.
no setterinherited
urn ↔ Output<String>
latefinalinherited
versionDescription ↔ Output<String>
A description of the current dashboard version being created/updated.
latefinal
versionNumber ↔ Output<int>
The version number of the dashboard version.
latefinal

Methods

failId(Object error) → void
Completes this resource ID with an error when registration fails.
inherited
failOutputs(Object error) → void
Completes all output properties with error.
inherited
failUrn(Object error) → void
Completes this resource URN with an error when registration fails.
inherited
getProvider(String moduleMember) → ProviderResource?
Returns provider for moduleMember's package, if configured.
inherited
getResourceName() → String
Returns this resource's logical name.
inherited
getResourceType() → String
Returns this resource's Pulumi type token.
inherited
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
registerOutput<T>(String propertyName, {Object? decoder(Object?)?, bool isSecret = false}) → Output<T>
Registers a dynamic output property for this resource.
inherited
resolveId(String? value, {required bool isKnown}) → void
Resolves the provider-assigned ID for this resource.
inherited
resolveOutputs(Struct outputs) → void
Resolves all output properties from a monitor response payload.
inherited
resolveUrn(String value) → void
Resolves this resource's URN once assigned by the engine.
inherited
serializeProperties(Map<String, dynamic> properties) → Future<Struct>
Serializes resource properties for RPC transmission.
inherited
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited

Static Methods

get(String name, Input<String> id, {DashboardState? state, CustomResourceOptions? options}) → Dashboard
Gets an existing Dashboard resource's state with the given name and id.