pulumi-aws-kotlin/com.pulumi.aws.quicksight.kotlin/DashboardArgs

DashboardArgs

data class DashboardArgs(val awsAccountId: Output<String>? = null, val dashboardId: Output<String>? = null, val dashboardPublishOptions: Output<DashboardDashboardPublishOptionsArgs>? = null, val name: Output<String>? = null, val parameters: Output<DashboardParametersArgs>? = null, val permissions: Output<List<DashboardPermissionArgs>>? = null, val sourceEntity: Output<DashboardSourceEntityArgs>? = null, val tags: Output<Map<String, String>>? = null, val themeArn: Output<String>? = null, val versionDescription: Output<String>? = null) : ConvertibleToJava<DashboardArgs>

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", {
    dashboardId: "example-id",
    name: "example-name",
    versionDescription: "version",
    sourceEntity: {
        sourceTemplate: {
            arn: source.arn,
            dataSetReferences: [{
                dataSetArn: dataset.arn,
                dataSetPlaceholder: "1",
            }],
        },
    },
});
Content copied to clipboard
import pulumi
import pulumi_aws as aws
example = aws.quicksight.Dashboard("example",
    dashboard_id="example-id",
    name="example-name",
    version_description="version",
    source_entity={
        "source_template": {
            "arn": source["arn"],
            "data_set_references": [{
                "data_set_arn": dataset["arn"],
                "data_set_placeholder": "1",
            }],
        },
    })
Content copied to clipboard
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()
    {
        DashboardId = "example-id",
        Name = "example-name",
        VersionDescription = "version",
        SourceEntity = new Aws.Quicksight.Inputs.DashboardSourceEntityArgs
        {
            SourceTemplate = new Aws.Quicksight.Inputs.DashboardSourceEntitySourceTemplateArgs
            {
                Arn = source.Arn,
                DataSetReferences = new[]
                {
                    new Aws.Quicksight.Inputs.DashboardSourceEntitySourceTemplateDataSetReferenceArgs
                    {
                        DataSetArn = dataset.Arn,
                        DataSetPlaceholder = "1",
                    },
                },
            },
        },
    });
});
Content copied to clipboard
package main
import (
	"github.com/pulumi/pulumi-aws/sdk/v6/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{
			DashboardId:        pulumi.String("example-id"),
			Name:               pulumi.String("example-name"),
			VersionDescription: pulumi.String("version"),
			SourceEntity: &quicksight.DashboardSourceEntityArgs{
				SourceTemplate: &quicksight.DashboardSourceEntitySourceTemplateArgs{
					Arn: pulumi.Any(source.Arn),
					DataSetReferences: quicksight.DashboardSourceEntitySourceTemplateDataSetReferenceArray{
						&quicksight.DashboardSourceEntitySourceTemplateDataSetReferenceArgs{
							DataSetArn:         pulumi.Any(dataset.Arn),
							DataSetPlaceholder: pulumi.String("1"),
						},
					},
				},
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Content copied to clipboard
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 java.util.List;
import java.util.ArrayList;
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()
            .dashboardId("example-id")
            .name("example-name")
            .versionDescription("version")
            .sourceEntity(DashboardSourceEntityArgs.builder()
                .sourceTemplate(DashboardSourceEntitySourceTemplateArgs.builder()
                    .arn(source.arn())
                    .dataSetReferences(DashboardSourceEntitySourceTemplateDataSetReferenceArgs.builder()
                        .dataSetArn(dataset.arn())
                        .dataSetPlaceholder("1")
                        .build())
                    .build())
                .build())
            .build());
    }
}
Content copied to clipboard
resources:
  example:
    type: aws:quicksight:Dashboard
    properties:
      dashboardId: example-id
      name: example-name
      versionDescription: version
      sourceEntity:
        sourceTemplate:
          arn: ${source.arn}
          dataSetReferences:
            - dataSetArn: ${dataset.arn}
              dataSetPlaceholder: '1'
Content copied to clipboard

With Definition

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

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
Content copied to clipboard

Constructors

Link copied to clipboard
constructor(awsAccountId: Output<String>? = null, dashboardId: Output<String>? = null, dashboardPublishOptions: Output<DashboardDashboardPublishOptionsArgs>? = null, name: Output<String>? = null, parameters: Output<DashboardParametersArgs>? = null, permissions: Output<List<DashboardPermissionArgs>>? = null, sourceEntity: Output<DashboardSourceEntityArgs>? = null, tags: Output<Map<String, String>>? = null, themeArn: Output<String>? = null, versionDescription: Output<String>? = null)

Properties

Link copied to clipboard
val awsAccountId: Output<String>? = null

AWS account ID.

Link copied to clipboard
val dashboardId: Output<String>? = null

Identifier for the dashboard.

Link copied to clipboard
val dashboardPublishOptions: Output<DashboardDashboardPublishOptionsArgs>? = null

Options for publishing the dashboard. See dashboard_publish_options.

Link copied to clipboard
val name: Output<String>? = null

Display name for the dashboard.

Link copied to clipboard
val parameters: Output<DashboardParametersArgs>? = null

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.

Link copied to clipboard
val permissions: Output<List<DashboardPermissionArgs>>? = null

A set of resource permissions on the dashboard. Maximum of 64 items. See permissions.

Link copied to clipboard
val sourceEntity: Output<DashboardSourceEntityArgs>? = null

The entity that you are using as a source when you create the dashboard (template). Only one of definition or source_entity should be configured. See source_entity.

Link copied to clipboard
val tags: Output<Map<String, String>>? = null

Key-value map of resource tags. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.

Link copied to clipboard
val themeArn: Output<String>? = null

The Amazon Resource Name (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.

Link copied to clipboard
val versionDescription: Output<String>? = null

A description of the current dashboard version being created/updated. The following arguments are optional:

Functions

Link copied to clipboard
open override fun toJava(): DashboardArgs