Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. AWS
  3. API Docs
  4. quicksight
  5. Dashboard
AWS v6.60.0 published on Tuesday, Nov 19, 2024 by Pulumi
pulumi/pulumi-aws

aws.quicksight.Dashboard

Explore with Pulumi AI

aws logo
AWS v6.60.0 published on Tuesday, Nov 19, 2024 by Pulumi
pulumi/pulumi-aws

    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",
            }],
        },
    },
});

    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",
            }],
        },
    })

    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
	})
}

    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",
                    },
                },
            },
        },
    });

});

    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());

    }
}

    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'

    With Definition

    Coming soon!

    Coming soon!

    Coming soon!

    Coming soon!

    Coming soon!

    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

    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_id: Optional[str] = None,
              version_description: Optional[str] = None,
              aws_account_id: Optional[str] = None,
              dashboard_publish_options: Optional[DashboardDashboardPublishOptionsArgs] = None,
              name: Optional[str] = None,
              parameters: Optional[DashboardParametersArgs] = None,
              permissions: Optional[Sequence[DashboardPermissionArgs]] = None,
              source_entity: Optional[DashboardSourceEntityArgs] = None,
              tags: Optional[Mapping[str, str]] = None,
              theme_arn: 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:quicksight:Dashboard
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

    Parameters

    name string
    The unique name of the resource.
    args DashboardArgs
    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 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 string
    The unique name of the resource.
    args DashboardArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args DashboardArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args DashboardArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var awsDashboardResource = new Aws.Quicksight.Dashboard("awsDashboardResource", new()
{
    DashboardId = "string",
    VersionDescription = "string",
    AwsAccountId = "string",
    DashboardPublishOptions = new Aws.Quicksight.Inputs.DashboardDashboardPublishOptionsArgs
    {
        AdHocFilteringOption = new Aws.Quicksight.Inputs.DashboardDashboardPublishOptionsAdHocFilteringOptionArgs
        {
            AvailabilityStatus = "string",
        },
        DataPointDrillUpDownOption = new Aws.Quicksight.Inputs.DashboardDashboardPublishOptionsDataPointDrillUpDownOptionArgs
        {
            AvailabilityStatus = "string",
        },
        DataPointMenuLabelOption = new Aws.Quicksight.Inputs.DashboardDashboardPublishOptionsDataPointMenuLabelOptionArgs
        {
            AvailabilityStatus = "string",
        },
        DataPointTooltipOption = new Aws.Quicksight.Inputs.DashboardDashboardPublishOptionsDataPointTooltipOptionArgs
        {
            AvailabilityStatus = "string",
        },
        ExportToCsvOption = new Aws.Quicksight.Inputs.DashboardDashboardPublishOptionsExportToCsvOptionArgs
        {
            AvailabilityStatus = "string",
        },
        ExportWithHiddenFieldsOption = new Aws.Quicksight.Inputs.DashboardDashboardPublishOptionsExportWithHiddenFieldsOptionArgs
        {
            AvailabilityStatus = "string",
        },
        SheetControlsOption = new Aws.Quicksight.Inputs.DashboardDashboardPublishOptionsSheetControlsOptionArgs
        {
            VisibilityState = "string",
        },
        SheetLayoutElementMaximizationOption = new Aws.Quicksight.Inputs.DashboardDashboardPublishOptionsSheetLayoutElementMaximizationOptionArgs
        {
            AvailabilityStatus = "string",
        },
        VisualAxisSortOption = new Aws.Quicksight.Inputs.DashboardDashboardPublishOptionsVisualAxisSortOptionArgs
        {
            AvailabilityStatus = "string",
        },
        VisualMenuOption = new Aws.Quicksight.Inputs.DashboardDashboardPublishOptionsVisualMenuOptionArgs
        {
            AvailabilityStatus = "string",
        },
    },
    Name = "string",
    Parameters = new Aws.Quicksight.Inputs.DashboardParametersArgs
    {
        DateTimeParameters = new[]
        {
            new Aws.Quicksight.Inputs.DashboardParametersDateTimeParameterArgs
            {
                Name = "string",
                Values = new[]
                {
                    "string",
                },
            },
        },
        DecimalParameters = new[]
        {
            new Aws.Quicksight.Inputs.DashboardParametersDecimalParameterArgs
            {
                Name = "string",
                Values = new[]
                {
                    0,
                },
            },
        },
        IntegerParameters = new[]
        {
            new Aws.Quicksight.Inputs.DashboardParametersIntegerParameterArgs
            {
                Name = "string",
                Values = new[]
                {
                    0,
                },
            },
        },
        StringParameters = new[]
        {
            new Aws.Quicksight.Inputs.DashboardParametersStringParameterArgs
            {
                Name = "string",
                Values = new[]
                {
                    "string",
                },
            },
        },
    },
    Permissions = new[]
    {
        new Aws.Quicksight.Inputs.DashboardPermissionArgs
        {
            Actions = new[]
            {
                "string",
            },
            Principal = "string",
        },
    },
    SourceEntity = new Aws.Quicksight.Inputs.DashboardSourceEntityArgs
    {
        SourceTemplate = new Aws.Quicksight.Inputs.DashboardSourceEntitySourceTemplateArgs
        {
            Arn = "string",
            DataSetReferences = new[]
            {
                new Aws.Quicksight.Inputs.DashboardSourceEntitySourceTemplateDataSetReferenceArgs
                {
                    DataSetArn = "string",
                    DataSetPlaceholder = "string",
                },
            },
        },
    },
    Tags = 
    {
        { "string", "string" },
    },
    ThemeArn = "string",
});

    example, err := quicksight.NewDashboard(ctx, "awsDashboardResource", &quicksight.DashboardArgs{
	DashboardId:        pulumi.String("string"),
	VersionDescription: pulumi.String("string"),
	AwsAccountId:       pulumi.String("string"),
	DashboardPublishOptions: &quicksight.DashboardDashboardPublishOptionsArgs{
		AdHocFilteringOption: &quicksight.DashboardDashboardPublishOptionsAdHocFilteringOptionArgs{
			AvailabilityStatus: pulumi.String("string"),
		},
		DataPointDrillUpDownOption: &quicksight.DashboardDashboardPublishOptionsDataPointDrillUpDownOptionArgs{
			AvailabilityStatus: pulumi.String("string"),
		},
		DataPointMenuLabelOption: &quicksight.DashboardDashboardPublishOptionsDataPointMenuLabelOptionArgs{
			AvailabilityStatus: pulumi.String("string"),
		},
		DataPointTooltipOption: &quicksight.DashboardDashboardPublishOptionsDataPointTooltipOptionArgs{
			AvailabilityStatus: pulumi.String("string"),
		},
		ExportToCsvOption: &quicksight.DashboardDashboardPublishOptionsExportToCsvOptionArgs{
			AvailabilityStatus: pulumi.String("string"),
		},
		ExportWithHiddenFieldsOption: &quicksight.DashboardDashboardPublishOptionsExportWithHiddenFieldsOptionArgs{
			AvailabilityStatus: pulumi.String("string"),
		},
		SheetControlsOption: &quicksight.DashboardDashboardPublishOptionsSheetControlsOptionArgs{
			VisibilityState: pulumi.String("string"),
		},
		SheetLayoutElementMaximizationOption: &quicksight.DashboardDashboardPublishOptionsSheetLayoutElementMaximizationOptionArgs{
			AvailabilityStatus: pulumi.String("string"),
		},
		VisualAxisSortOption: &quicksight.DashboardDashboardPublishOptionsVisualAxisSortOptionArgs{
			AvailabilityStatus: pulumi.String("string"),
		},
		VisualMenuOption: &quicksight.DashboardDashboardPublishOptionsVisualMenuOptionArgs{
			AvailabilityStatus: pulumi.String("string"),
		},
	},
	Name: pulumi.String("string"),
	Parameters: &quicksight.DashboardParametersArgs{
		DateTimeParameters: quicksight.DashboardParametersDateTimeParameterArray{
			&quicksight.DashboardParametersDateTimeParameterArgs{
				Name: pulumi.String("string"),
				Values: pulumi.StringArray{
					pulumi.String("string"),
				},
			},
		},
		DecimalParameters: quicksight.DashboardParametersDecimalParameterArray{
			&quicksight.DashboardParametersDecimalParameterArgs{
				Name: pulumi.String("string"),
				Values: pulumi.Float64Array{
					pulumi.Float64(0),
				},
			},
		},
		IntegerParameters: quicksight.DashboardParametersIntegerParameterArray{
			&quicksight.DashboardParametersIntegerParameterArgs{
				Name: pulumi.String("string"),
				Values: pulumi.IntArray{
					pulumi.Int(0),
				},
			},
		},
		StringParameters: quicksight.DashboardParametersStringParameterArray{
			&quicksight.DashboardParametersStringParameterArgs{
				Name: pulumi.String("string"),
				Values: pulumi.StringArray{
					pulumi.String("string"),
				},
			},
		},
	},
	Permissions: quicksight.DashboardPermissionArray{
		&quicksight.DashboardPermissionArgs{
			Actions: pulumi.StringArray{
				pulumi.String("string"),
			},
			Principal: pulumi.String("string"),
		},
	},
	SourceEntity: &quicksight.DashboardSourceEntityArgs{
		SourceTemplate: &quicksight.DashboardSourceEntitySourceTemplateArgs{
			Arn: pulumi.String("string"),
			DataSetReferences: quicksight.DashboardSourceEntitySourceTemplateDataSetReferenceArray{
				&quicksight.DashboardSourceEntitySourceTemplateDataSetReferenceArgs{
					DataSetArn:         pulumi.String("string"),
					DataSetPlaceholder: pulumi.String("string"),
				},
			},
		},
	},
	Tags: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	ThemeArn: pulumi.String("string"),
})

    var awsDashboardResource = new Dashboard("awsDashboardResource", DashboardArgs.builder()
    .dashboardId("string")
    .versionDescription("string")
    .awsAccountId("string")
    .dashboardPublishOptions(DashboardDashboardPublishOptionsArgs.builder()
        .adHocFilteringOption(DashboardDashboardPublishOptionsAdHocFilteringOptionArgs.builder()
            .availabilityStatus("string")
            .build())
        .dataPointDrillUpDownOption(DashboardDashboardPublishOptionsDataPointDrillUpDownOptionArgs.builder()
            .availabilityStatus("string")
            .build())
        .dataPointMenuLabelOption(DashboardDashboardPublishOptionsDataPointMenuLabelOptionArgs.builder()
            .availabilityStatus("string")
            .build())
        .dataPointTooltipOption(DashboardDashboardPublishOptionsDataPointTooltipOptionArgs.builder()
            .availabilityStatus("string")
            .build())
        .exportToCsvOption(DashboardDashboardPublishOptionsExportToCsvOptionArgs.builder()
            .availabilityStatus("string")
            .build())
        .exportWithHiddenFieldsOption(DashboardDashboardPublishOptionsExportWithHiddenFieldsOptionArgs.builder()
            .availabilityStatus("string")
            .build())
        .sheetControlsOption(DashboardDashboardPublishOptionsSheetControlsOptionArgs.builder()
            .visibilityState("string")
            .build())
        .sheetLayoutElementMaximizationOption(DashboardDashboardPublishOptionsSheetLayoutElementMaximizationOptionArgs.builder()
            .availabilityStatus("string")
            .build())
        .visualAxisSortOption(DashboardDashboardPublishOptionsVisualAxisSortOptionArgs.builder()
            .availabilityStatus("string")
            .build())
        .visualMenuOption(DashboardDashboardPublishOptionsVisualMenuOptionArgs.builder()
            .availabilityStatus("string")
            .build())
        .build())
    .name("string")
    .parameters(DashboardParametersArgs.builder()
        .dateTimeParameters(DashboardParametersDateTimeParameterArgs.builder()
            .name("string")
            .values("string")
            .build())
        .decimalParameters(DashboardParametersDecimalParameterArgs.builder()
            .name("string")
            .values(0)
            .build())
        .integerParameters(DashboardParametersIntegerParameterArgs.builder()
            .name("string")
            .values(0)
            .build())
        .stringParameters(DashboardParametersStringParameterArgs.builder()
            .name("string")
            .values("string")
            .build())
        .build())
    .permissions(DashboardPermissionArgs.builder()
        .actions("string")
        .principal("string")
        .build())
    .sourceEntity(DashboardSourceEntityArgs.builder()
        .sourceTemplate(DashboardSourceEntitySourceTemplateArgs.builder()
            .arn("string")
            .dataSetReferences(DashboardSourceEntitySourceTemplateDataSetReferenceArgs.builder()
                .dataSetArn("string")
                .dataSetPlaceholder("string")
                .build())
            .build())
        .build())
    .tags(Map.of("string", "string"))
    .themeArn("string")
    .build());

    aws_dashboard_resource = aws.quicksight.Dashboard("awsDashboardResource",
    dashboard_id="string",
    version_description="string",
    aws_account_id="string",
    dashboard_publish_options={
        "ad_hoc_filtering_option": {
            "availability_status": "string",
        },
        "data_point_drill_up_down_option": {
            "availability_status": "string",
        },
        "data_point_menu_label_option": {
            "availability_status": "string",
        },
        "data_point_tooltip_option": {
            "availability_status": "string",
        },
        "export_to_csv_option": {
            "availability_status": "string",
        },
        "export_with_hidden_fields_option": {
            "availability_status": "string",
        },
        "sheet_controls_option": {
            "visibility_state": "string",
        },
        "sheet_layout_element_maximization_option": {
            "availability_status": "string",
        },
        "visual_axis_sort_option": {
            "availability_status": "string",
        },
        "visual_menu_option": {
            "availability_status": "string",
        },
    },
    name="string",
    parameters={
        "date_time_parameters": [{
            "name": "string",
            "values": ["string"],
        }],
        "decimal_parameters": [{
            "name": "string",
            "values": [0],
        }],
        "integer_parameters": [{
            "name": "string",
            "values": [0],
        }],
        "string_parameters": [{
            "name": "string",
            "values": ["string"],
        }],
    },
    permissions=[{
        "actions": ["string"],
        "principal": "string",
    }],
    source_entity={
        "source_template": {
            "arn": "string",
            "data_set_references": [{
                "data_set_arn": "string",
                "data_set_placeholder": "string",
            }],
        },
    },
    tags={
        "string": "string",
    },
    theme_arn="string")

    const awsDashboardResource = new aws.quicksight.Dashboard("awsDashboardResource", {
    dashboardId: "string",
    versionDescription: "string",
    awsAccountId: "string",
    dashboardPublishOptions: {
        adHocFilteringOption: {
            availabilityStatus: "string",
        },
        dataPointDrillUpDownOption: {
            availabilityStatus: "string",
        },
        dataPointMenuLabelOption: {
            availabilityStatus: "string",
        },
        dataPointTooltipOption: {
            availabilityStatus: "string",
        },
        exportToCsvOption: {
            availabilityStatus: "string",
        },
        exportWithHiddenFieldsOption: {
            availabilityStatus: "string",
        },
        sheetControlsOption: {
            visibilityState: "string",
        },
        sheetLayoutElementMaximizationOption: {
            availabilityStatus: "string",
        },
        visualAxisSortOption: {
            availabilityStatus: "string",
        },
        visualMenuOption: {
            availabilityStatus: "string",
        },
    },
    name: "string",
    parameters: {
        dateTimeParameters: [{
            name: "string",
            values: ["string"],
        }],
        decimalParameters: [{
            name: "string",
            values: [0],
        }],
        integerParameters: [{
            name: "string",
            values: [0],
        }],
        stringParameters: [{
            name: "string",
            values: ["string"],
        }],
    },
    permissions: [{
        actions: ["string"],
        principal: "string",
    }],
    sourceEntity: {
        sourceTemplate: {
            arn: "string",
            dataSetReferences: [{
                dataSetArn: "string",
                dataSetPlaceholder: "string",
            }],
        },
    },
    tags: {
        string: "string",
    },
    themeArn: "string",
});

    type: aws:quicksight:Dashboard
properties:
    awsAccountId: string
    dashboardId: string
    dashboardPublishOptions:
        adHocFilteringOption:
            availabilityStatus: string
        dataPointDrillUpDownOption:
            availabilityStatus: string
        dataPointMenuLabelOption:
            availabilityStatus: string
        dataPointTooltipOption:
            availabilityStatus: string
        exportToCsvOption:
            availabilityStatus: string
        exportWithHiddenFieldsOption:
            availabilityStatus: string
        sheetControlsOption:
            visibilityState: string
        sheetLayoutElementMaximizationOption:
            availabilityStatus: string
        visualAxisSortOption:
            availabilityStatus: string
        visualMenuOption:
            availabilityStatus: string
    name: string
    parameters:
        dateTimeParameters:
            - name: string
              values:
                - string
        decimalParameters:
            - name: string
              values:
                - 0
        integerParameters:
            - name: string
              values:
                - 0
        stringParameters:
            - name: string
              values:
                - string
    permissions:
        - actions:
            - string
          principal: string
    sourceEntity:
        sourceTemplate:
            arn: string
            dataSetReferences:
                - dataSetArn: string
                  dataSetPlaceholder: string
    tags:
        string: string
    themeArn: string
    versionDescription: string

    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:

    DashboardId string
    Identifier for the dashboard.
    VersionDescription string

    A description of the current dashboard version being created/updated.

    The following arguments are optional:

    AwsAccountId string
    AWS account ID.
    DashboardPublishOptions DashboardDashboardPublishOptions
    Options for publishing the dashboard. See dashboard_publish_options.
    Name string
    Display name for the dashboard.
    Parameters 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.
    Permissions List<DashboardPermission>
    A set of resource permissions on the dashboard. Maximum of 64 items. See permissions.
    SourceEntity DashboardSourceEntity
    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.
    Tags Dictionary<string, string>
    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.
    ThemeArn string
    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.
    DashboardId string
    Identifier for the dashboard.
    VersionDescription string

    A description of the current dashboard version being created/updated.

    The following arguments are optional:

    AwsAccountId string
    AWS account ID.
    DashboardPublishOptions DashboardDashboardPublishOptionsArgs
    Options for publishing the dashboard. See dashboard_publish_options.
    Name string
    Display name for the dashboard.
    Parameters DashboardParametersArgs
    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.
    Permissions []DashboardPermissionArgs
    A set of resource permissions on the dashboard. Maximum of 64 items. See permissions.
    SourceEntity DashboardSourceEntityArgs
    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.
    Tags map[string]string
    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.
    ThemeArn string
    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.
    dashboardId String
    Identifier for the dashboard.
    versionDescription String

    A description of the current dashboard version being created/updated.

    The following arguments are optional:

    awsAccountId String
    AWS account ID.
    dashboardPublishOptions DashboardDashboardPublishOptions
    Options for publishing the dashboard. See dashboard_publish_options.
    name String
    Display name for the dashboard.
    parameters 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.
    permissions List<DashboardPermission>
    A set of resource permissions on the dashboard. Maximum of 64 items. See permissions.
    sourceEntity DashboardSourceEntity
    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.
    tags Map<String,String>
    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.
    themeArn String
    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.
    dashboardId string
    Identifier for the dashboard.
    versionDescription string

    A description of the current dashboard version being created/updated.

    The following arguments are optional:

    awsAccountId string
    AWS account ID.
    dashboardPublishOptions DashboardDashboardPublishOptions
    Options for publishing the dashboard. See dashboard_publish_options.
    name string
    Display name for the dashboard.
    parameters 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.
    permissions DashboardPermission[]
    A set of resource permissions on the dashboard. Maximum of 64 items. See permissions.
    sourceEntity DashboardSourceEntity
    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.
    tags {[key: string]: string}
    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.
    themeArn string
    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.
    dashboard_id str
    Identifier for the dashboard.
    version_description str

    A description of the current dashboard version being created/updated.

    The following arguments are optional:

    aws_account_id str
    AWS account ID.
    dashboard_publish_options DashboardDashboardPublishOptionsArgs
    Options for publishing the dashboard. See dashboard_publish_options.
    name str
    Display name for the dashboard.
    parameters DashboardParametersArgs
    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.
    permissions Sequence[DashboardPermissionArgs]
    A set of resource permissions on the dashboard. Maximum of 64 items. See permissions.
    source_entity DashboardSourceEntityArgs
    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.
    tags Mapping[str, str]
    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.
    theme_arn str
    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.
    dashboardId String
    Identifier for the dashboard.
    versionDescription String

    A description of the current dashboard version being created/updated.

    The following arguments are optional:

    awsAccountId String
    AWS account ID.
    dashboardPublishOptions Property Map
    Options for publishing the dashboard. See dashboard_publish_options.
    name String
    Display name for the dashboard.
    parameters Property Map
    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.
    permissions List<Property Map>
    A set of resource permissions on the dashboard. Maximum of 64 items. See permissions.
    sourceEntity Property Map
    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.
    tags Map<String>
    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.
    themeArn String
    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.

    Outputs

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

    Arn string
    ARN of the dashboard.
    CreatedTime string
    The time that the dashboard was created.
    Id string
    The provider-assigned unique ID for this managed resource.
    LastPublishedTime string
    LastUpdatedTime string
    The time that the dashboard was last updated.
    SourceEntityArn string
    Amazon Resource Name (ARN) of a template that was used to create this dashboard.
    Status string
    The dashboard creation status.
    TagsAll Dictionary<string, string>
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    VersionNumber int
    The version number of the dashboard version.
    Arn string
    ARN of the dashboard.
    CreatedTime string
    The time that the dashboard was created.
    Id string
    The provider-assigned unique ID for this managed resource.
    LastPublishedTime string
    LastUpdatedTime string
    The time that the dashboard was last updated.
    SourceEntityArn string
    Amazon Resource Name (ARN) of a template that was used to create this dashboard.
    Status string
    The dashboard creation status.
    TagsAll map[string]string
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    VersionNumber int
    The version number of the dashboard version.
    arn String
    ARN of the dashboard.
    createdTime String
    The time that the dashboard was created.
    id String
    The provider-assigned unique ID for this managed resource.
    lastPublishedTime String
    lastUpdatedTime String
    The time that the dashboard was last updated.
    sourceEntityArn String
    Amazon Resource Name (ARN) of a template that was used to create this dashboard.
    status String
    The dashboard creation status.
    tagsAll Map<String,String>
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    versionNumber Integer
    The version number of the dashboard version.
    arn string
    ARN of the dashboard.
    createdTime string
    The time that the dashboard was created.
    id string
    The provider-assigned unique ID for this managed resource.
    lastPublishedTime string
    lastUpdatedTime string
    The time that the dashboard was last updated.
    sourceEntityArn string
    Amazon Resource Name (ARN) of a template that was used to create this dashboard.
    status string
    The dashboard creation status.
    tagsAll {[key: string]: string}
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    versionNumber number
    The version number of the dashboard version.
    arn str
    ARN of the dashboard.
    created_time str
    The time that the dashboard was created.
    id str
    The provider-assigned unique ID for this managed resource.
    last_published_time str
    last_updated_time str
    The time that the dashboard was last updated.
    source_entity_arn str
    Amazon Resource Name (ARN) of a template that was used to create this dashboard.
    status str
    The dashboard creation status.
    tags_all Mapping[str, str]
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    version_number int
    The version number of the dashboard version.
    arn String
    ARN of the dashboard.
    createdTime String
    The time that the dashboard was created.
    id String
    The provider-assigned unique ID for this managed resource.
    lastPublishedTime String
    lastUpdatedTime String
    The time that the dashboard was last updated.
    sourceEntityArn String
    Amazon Resource Name (ARN) of a template that was used to create this dashboard.
    status String
    The dashboard creation status.
    tagsAll Map<String>
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    versionNumber Number
    The version number of the dashboard version.

    Look up Existing Dashboard Resource

    Get an existing Dashboard 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>, state?: DashboardState, opts?: CustomResourceOptions): Dashboard
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        arn: Optional[str] = None,
        aws_account_id: Optional[str] = None,
        created_time: Optional[str] = None,
        dashboard_id: Optional[str] = None,
        dashboard_publish_options: Optional[DashboardDashboardPublishOptionsArgs] = None,
        last_published_time: Optional[str] = None,
        last_updated_time: Optional[str] = None,
        name: Optional[str] = None,
        parameters: Optional[DashboardParametersArgs] = None,
        permissions: Optional[Sequence[DashboardPermissionArgs]] = None,
        source_entity: Optional[DashboardSourceEntityArgs] = None,
        source_entity_arn: Optional[str] = None,
        status: Optional[str] = None,
        tags: Optional[Mapping[str, str]] = None,
        tags_all: Optional[Mapping[str, str]] = None,
        theme_arn: Optional[str] = None,
        version_description: Optional[str] = None,
        version_number: Optional[int] = None) -> Dashboard
    func GetDashboard(ctx *Context, name string, id IDInput, state *DashboardState, opts ...ResourceOption) (*Dashboard, error)
    public static Dashboard Get(string name, Input<string> id, DashboardState? state, CustomResourceOptions? opts = null)
    public static Dashboard get(String name, Output<String> id, DashboardState state, CustomResourceOptions options)
    Resource lookup is not supported in YAML
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    Arn string
    ARN of the dashboard.
    AwsAccountId string
    AWS account ID.
    CreatedTime string
    The time that the dashboard was created.
    DashboardId string
    Identifier for the dashboard.
    DashboardPublishOptions DashboardDashboardPublishOptions
    Options for publishing the dashboard. See dashboard_publish_options.
    LastPublishedTime string
    LastUpdatedTime string
    The time that the dashboard was last updated.
    Name string
    Display name for the dashboard.
    Parameters 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.
    Permissions List<DashboardPermission>
    A set of resource permissions on the dashboard. Maximum of 64 items. See permissions.
    SourceEntity DashboardSourceEntity
    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.
    SourceEntityArn string
    Amazon Resource Name (ARN) of a template that was used to create this dashboard.
    Status string
    The dashboard creation status.
    Tags Dictionary<string, string>
    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.
    TagsAll Dictionary<string, string>
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    ThemeArn string
    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.
    VersionDescription string

    A description of the current dashboard version being created/updated.

    The following arguments are optional:

    VersionNumber int
    The version number of the dashboard version.
    Arn string
    ARN of the dashboard.
    AwsAccountId string
    AWS account ID.
    CreatedTime string
    The time that the dashboard was created.
    DashboardId string
    Identifier for the dashboard.
    DashboardPublishOptions DashboardDashboardPublishOptionsArgs
    Options for publishing the dashboard. See dashboard_publish_options.
    LastPublishedTime string
    LastUpdatedTime string
    The time that the dashboard was last updated.
    Name string
    Display name for the dashboard.
    Parameters DashboardParametersArgs
    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.
    Permissions []DashboardPermissionArgs
    A set of resource permissions on the dashboard. Maximum of 64 items. See permissions.
    SourceEntity DashboardSourceEntityArgs
    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.
    SourceEntityArn string
    Amazon Resource Name (ARN) of a template that was used to create this dashboard.
    Status string
    The dashboard creation status.
    Tags map[string]string
    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.
    TagsAll map[string]string
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    ThemeArn string
    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.
    VersionDescription string

    A description of the current dashboard version being created/updated.

    The following arguments are optional:

    VersionNumber int
    The version number of the dashboard version.
    arn String
    ARN of the dashboard.
    awsAccountId String
    AWS account ID.
    createdTime String
    The time that the dashboard was created.
    dashboardId String
    Identifier for the dashboard.
    dashboardPublishOptions DashboardDashboardPublishOptions
    Options for publishing the dashboard. See dashboard_publish_options.
    lastPublishedTime String
    lastUpdatedTime String
    The time that the dashboard was last updated.
    name String
    Display name for the dashboard.
    parameters 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.
    permissions List<DashboardPermission>
    A set of resource permissions on the dashboard. Maximum of 64 items. See permissions.
    sourceEntity DashboardSourceEntity
    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.
    sourceEntityArn String
    Amazon Resource Name (ARN) of a template that was used to create this dashboard.
    status String
    The dashboard creation status.
    tags Map<String,String>
    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.
    tagsAll Map<String,String>
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    themeArn String
    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.
    versionDescription String

    A description of the current dashboard version being created/updated.

    The following arguments are optional:

    versionNumber Integer
    The version number of the dashboard version.
    arn string
    ARN of the dashboard.
    awsAccountId string
    AWS account ID.
    createdTime string
    The time that the dashboard was created.
    dashboardId string
    Identifier for the dashboard.
    dashboardPublishOptions DashboardDashboardPublishOptions
    Options for publishing the dashboard. See dashboard_publish_options.
    lastPublishedTime string
    lastUpdatedTime string
    The time that the dashboard was last updated.
    name string
    Display name for the dashboard.
    parameters 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.
    permissions DashboardPermission[]
    A set of resource permissions on the dashboard. Maximum of 64 items. See permissions.
    sourceEntity DashboardSourceEntity
    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.
    sourceEntityArn string
    Amazon Resource Name (ARN) of a template that was used to create this dashboard.
    status string
    The dashboard creation status.
    tags {[key: string]: string}
    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.
    tagsAll {[key: string]: string}
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    themeArn string
    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.
    versionDescription string

    A description of the current dashboard version being created/updated.

    The following arguments are optional:

    versionNumber number
    The version number of the dashboard version.
    arn str
    ARN of the dashboard.
    aws_account_id str
    AWS account ID.
    created_time str
    The time that the dashboard was created.
    dashboard_id str
    Identifier for the dashboard.
    dashboard_publish_options DashboardDashboardPublishOptionsArgs
    Options for publishing the dashboard. See dashboard_publish_options.
    last_published_time str
    last_updated_time str
    The time that the dashboard was last updated.
    name str
    Display name for the dashboard.
    parameters DashboardParametersArgs
    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.
    permissions Sequence[DashboardPermissionArgs]
    A set of resource permissions on the dashboard. Maximum of 64 items. See permissions.
    source_entity DashboardSourceEntityArgs
    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.
    source_entity_arn str
    Amazon Resource Name (ARN) of a template that was used to create this dashboard.
    status str
    The dashboard creation status.
    tags Mapping[str, str]
    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.
    tags_all Mapping[str, str]
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    theme_arn str
    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.
    version_description str

    A description of the current dashboard version being created/updated.

    The following arguments are optional:

    version_number int
    The version number of the dashboard version.
    arn String
    ARN of the dashboard.
    awsAccountId String
    AWS account ID.
    createdTime String
    The time that the dashboard was created.
    dashboardId String
    Identifier for the dashboard.
    dashboardPublishOptions Property Map
    Options for publishing the dashboard. See dashboard_publish_options.
    lastPublishedTime String
    lastUpdatedTime String
    The time that the dashboard was last updated.
    name String
    Display name for the dashboard.
    parameters Property Map
    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.
    permissions List<Property Map>
    A set of resource permissions on the dashboard. Maximum of 64 items. See permissions.
    sourceEntity Property Map
    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.
    sourceEntityArn String
    Amazon Resource Name (ARN) of a template that was used to create this dashboard.
    status String
    The dashboard creation status.
    tags Map<String>
    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.
    tagsAll Map<String>
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    themeArn String
    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.
    versionDescription String

    A description of the current dashboard version being created/updated.

    The following arguments are optional:

    versionNumber Number
    The version number of the dashboard version.

    Supporting Types

    DashboardDashboardPublishOptions, DashboardDashboardPublishOptionsArgs

    AdHocFilteringOption DashboardDashboardPublishOptionsAdHocFilteringOption
    Ad hoc (one-time) filtering option. See ad_hoc_filtering_option.
    DataPointDrillUpDownOption DashboardDashboardPublishOptionsDataPointDrillUpDownOption
    The drill-down options of data points in a dashboard. See data_point_drill_up_down_option.
    DataPointMenuLabelOption DashboardDashboardPublishOptionsDataPointMenuLabelOption
    The data point menu label options of a dashboard. See data_point_menu_label_option.
    DataPointTooltipOption DashboardDashboardPublishOptionsDataPointTooltipOption
    The data point tool tip options of a dashboard. See data_point_tooltip_option.
    ExportToCsvOption DashboardDashboardPublishOptionsExportToCsvOption
    Export to .csv option. See export_to_csv_option.
    ExportWithHiddenFieldsOption DashboardDashboardPublishOptionsExportWithHiddenFieldsOption
    Determines if hidden fields are exported with a dashboard. See export_with_hidden_fields_option.
    SheetControlsOption DashboardDashboardPublishOptionsSheetControlsOption
    Sheet controls option. See sheet_controls_option.
    SheetLayoutElementMaximizationOption DashboardDashboardPublishOptionsSheetLayoutElementMaximizationOption
    The sheet layout maximization options of a dashboard. See sheet_layout_element_maximization_option.
    VisualAxisSortOption DashboardDashboardPublishOptionsVisualAxisSortOption
    The axis sort options of a dashboard. See visual_axis_sort_option.
    VisualMenuOption DashboardDashboardPublishOptionsVisualMenuOption
    The menu options of a visual in a dashboard. See visual_menu_option.
    AdHocFilteringOption DashboardDashboardPublishOptionsAdHocFilteringOption
    Ad hoc (one-time) filtering option. See ad_hoc_filtering_option.
    DataPointDrillUpDownOption DashboardDashboardPublishOptionsDataPointDrillUpDownOption
    The drill-down options of data points in a dashboard. See data_point_drill_up_down_option.
    DataPointMenuLabelOption DashboardDashboardPublishOptionsDataPointMenuLabelOption
    The data point menu label options of a dashboard. See data_point_menu_label_option.
    DataPointTooltipOption DashboardDashboardPublishOptionsDataPointTooltipOption
    The data point tool tip options of a dashboard. See data_point_tooltip_option.
    ExportToCsvOption DashboardDashboardPublishOptionsExportToCsvOption
    Export to .csv option. See export_to_csv_option.
    ExportWithHiddenFieldsOption DashboardDashboardPublishOptionsExportWithHiddenFieldsOption
    Determines if hidden fields are exported with a dashboard. See export_with_hidden_fields_option.
    SheetControlsOption DashboardDashboardPublishOptionsSheetControlsOption
    Sheet controls option. See sheet_controls_option.
    SheetLayoutElementMaximizationOption DashboardDashboardPublishOptionsSheetLayoutElementMaximizationOption
    The sheet layout maximization options of a dashboard. See sheet_layout_element_maximization_option.
    VisualAxisSortOption DashboardDashboardPublishOptionsVisualAxisSortOption
    The axis sort options of a dashboard. See visual_axis_sort_option.
    VisualMenuOption DashboardDashboardPublishOptionsVisualMenuOption
    The menu options of a visual in a dashboard. See visual_menu_option.
    adHocFilteringOption DashboardDashboardPublishOptionsAdHocFilteringOption
    Ad hoc (one-time) filtering option. See ad_hoc_filtering_option.
    dataPointDrillUpDownOption DashboardDashboardPublishOptionsDataPointDrillUpDownOption
    The drill-down options of data points in a dashboard. See data_point_drill_up_down_option.
    dataPointMenuLabelOption DashboardDashboardPublishOptionsDataPointMenuLabelOption
    The data point menu label options of a dashboard. See data_point_menu_label_option.
    dataPointTooltipOption DashboardDashboardPublishOptionsDataPointTooltipOption
    The data point tool tip options of a dashboard. See data_point_tooltip_option.
    exportToCsvOption DashboardDashboardPublishOptionsExportToCsvOption
    Export to .csv option. See export_to_csv_option.
    exportWithHiddenFieldsOption DashboardDashboardPublishOptionsExportWithHiddenFieldsOption
    Determines if hidden fields are exported with a dashboard. See export_with_hidden_fields_option.
    sheetControlsOption DashboardDashboardPublishOptionsSheetControlsOption
    Sheet controls option. See sheet_controls_option.
    sheetLayoutElementMaximizationOption DashboardDashboardPublishOptionsSheetLayoutElementMaximizationOption
    The sheet layout maximization options of a dashboard. See sheet_layout_element_maximization_option.
    visualAxisSortOption DashboardDashboardPublishOptionsVisualAxisSortOption
    The axis sort options of a dashboard. See visual_axis_sort_option.
    visualMenuOption DashboardDashboardPublishOptionsVisualMenuOption
    The menu options of a visual in a dashboard. See visual_menu_option.
    adHocFilteringOption DashboardDashboardPublishOptionsAdHocFilteringOption
    Ad hoc (one-time) filtering option. See ad_hoc_filtering_option.
    dataPointDrillUpDownOption DashboardDashboardPublishOptionsDataPointDrillUpDownOption
    The drill-down options of data points in a dashboard. See data_point_drill_up_down_option.
    dataPointMenuLabelOption DashboardDashboardPublishOptionsDataPointMenuLabelOption
    The data point menu label options of a dashboard. See data_point_menu_label_option.
    dataPointTooltipOption DashboardDashboardPublishOptionsDataPointTooltipOption
    The data point tool tip options of a dashboard. See data_point_tooltip_option.
    exportToCsvOption DashboardDashboardPublishOptionsExportToCsvOption
    Export to .csv option. See export_to_csv_option.
    exportWithHiddenFieldsOption DashboardDashboardPublishOptionsExportWithHiddenFieldsOption
    Determines if hidden fields are exported with a dashboard. See export_with_hidden_fields_option.
    sheetControlsOption DashboardDashboardPublishOptionsSheetControlsOption
    Sheet controls option. See sheet_controls_option.
    sheetLayoutElementMaximizationOption DashboardDashboardPublishOptionsSheetLayoutElementMaximizationOption
    The sheet layout maximization options of a dashboard. See sheet_layout_element_maximization_option.
    visualAxisSortOption DashboardDashboardPublishOptionsVisualAxisSortOption
    The axis sort options of a dashboard. See visual_axis_sort_option.
    visualMenuOption DashboardDashboardPublishOptionsVisualMenuOption
    The menu options of a visual in a dashboard. See visual_menu_option.
    ad_hoc_filtering_option DashboardDashboardPublishOptionsAdHocFilteringOption
    Ad hoc (one-time) filtering option. See ad_hoc_filtering_option.
    data_point_drill_up_down_option DashboardDashboardPublishOptionsDataPointDrillUpDownOption
    The drill-down options of data points in a dashboard. See data_point_drill_up_down_option.
    data_point_menu_label_option DashboardDashboardPublishOptionsDataPointMenuLabelOption
    The data point menu label options of a dashboard. See data_point_menu_label_option.
    data_point_tooltip_option DashboardDashboardPublishOptionsDataPointTooltipOption
    The data point tool tip options of a dashboard. See data_point_tooltip_option.
    export_to_csv_option DashboardDashboardPublishOptionsExportToCsvOption
    Export to .csv option. See export_to_csv_option.
    export_with_hidden_fields_option DashboardDashboardPublishOptionsExportWithHiddenFieldsOption
    Determines if hidden fields are exported with a dashboard. See export_with_hidden_fields_option.
    sheet_controls_option DashboardDashboardPublishOptionsSheetControlsOption
    Sheet controls option. See sheet_controls_option.
    sheet_layout_element_maximization_option DashboardDashboardPublishOptionsSheetLayoutElementMaximizationOption
    The sheet layout maximization options of a dashboard. See sheet_layout_element_maximization_option.
    visual_axis_sort_option DashboardDashboardPublishOptionsVisualAxisSortOption
    The axis sort options of a dashboard. See visual_axis_sort_option.
    visual_menu_option DashboardDashboardPublishOptionsVisualMenuOption
    The menu options of a visual in a dashboard. See visual_menu_option.
    adHocFilteringOption Property Map
    Ad hoc (one-time) filtering option. See ad_hoc_filtering_option.
    dataPointDrillUpDownOption Property Map
    The drill-down options of data points in a dashboard. See data_point_drill_up_down_option.
    dataPointMenuLabelOption Property Map
    The data point menu label options of a dashboard. See data_point_menu_label_option.
    dataPointTooltipOption Property Map
    The data point tool tip options of a dashboard. See data_point_tooltip_option.
    exportToCsvOption Property Map
    Export to .csv option. See export_to_csv_option.
    exportWithHiddenFieldsOption Property Map
    Determines if hidden fields are exported with a dashboard. See export_with_hidden_fields_option.
    sheetControlsOption Property Map
    Sheet controls option. See sheet_controls_option.
    sheetLayoutElementMaximizationOption Property Map
    The sheet layout maximization options of a dashboard. See sheet_layout_element_maximization_option.
    visualAxisSortOption Property Map
    The axis sort options of a dashboard. See visual_axis_sort_option.
    visualMenuOption Property Map
    The menu options of a visual in a dashboard. See visual_menu_option.

    DashboardDashboardPublishOptionsAdHocFilteringOption, DashboardDashboardPublishOptionsAdHocFilteringOptionArgs

    AvailabilityStatus string
    Availability status. Possibles values: ENABLED, DISABLED.
    AvailabilityStatus string
    Availability status. Possibles values: ENABLED, DISABLED.
    availabilityStatus String
    Availability status. Possibles values: ENABLED, DISABLED.
    availabilityStatus string
    Availability status. Possibles values: ENABLED, DISABLED.
    availability_status str
    Availability status. Possibles values: ENABLED, DISABLED.
    availabilityStatus String
    Availability status. Possibles values: ENABLED, DISABLED.

    DashboardDashboardPublishOptionsDataPointDrillUpDownOption, DashboardDashboardPublishOptionsDataPointDrillUpDownOptionArgs

    AvailabilityStatus string
    Availability status. Possibles values: ENABLED, DISABLED.
    AvailabilityStatus string
    Availability status. Possibles values: ENABLED, DISABLED.
    availabilityStatus String
    Availability status. Possibles values: ENABLED, DISABLED.
    availabilityStatus string
    Availability status. Possibles values: ENABLED, DISABLED.
    availability_status str
    Availability status. Possibles values: ENABLED, DISABLED.
    availabilityStatus String
    Availability status. Possibles values: ENABLED, DISABLED.

    DashboardDashboardPublishOptionsDataPointMenuLabelOption, DashboardDashboardPublishOptionsDataPointMenuLabelOptionArgs

    AvailabilityStatus string
    Availability status. Possibles values: ENABLED, DISABLED.
    AvailabilityStatus string
    Availability status. Possibles values: ENABLED, DISABLED.
    availabilityStatus String
    Availability status. Possibles values: ENABLED, DISABLED.
    availabilityStatus string
    Availability status. Possibles values: ENABLED, DISABLED.
    availability_status str
    Availability status. Possibles values: ENABLED, DISABLED.
    availabilityStatus String
    Availability status. Possibles values: ENABLED, DISABLED.

    DashboardDashboardPublishOptionsDataPointTooltipOption, DashboardDashboardPublishOptionsDataPointTooltipOptionArgs

    AvailabilityStatus string
    Availability status. Possibles values: ENABLED, DISABLED.
    AvailabilityStatus string
    Availability status. Possibles values: ENABLED, DISABLED.
    availabilityStatus String
    Availability status. Possibles values: ENABLED, DISABLED.
    availabilityStatus string
    Availability status. Possibles values: ENABLED, DISABLED.
    availability_status str
    Availability status. Possibles values: ENABLED, DISABLED.
    availabilityStatus String
    Availability status. Possibles values: ENABLED, DISABLED.

    DashboardDashboardPublishOptionsExportToCsvOption, DashboardDashboardPublishOptionsExportToCsvOptionArgs

    AvailabilityStatus string
    Availability status. Possibles values: ENABLED, DISABLED.
    AvailabilityStatus string
    Availability status. Possibles values: ENABLED, DISABLED.
    availabilityStatus String
    Availability status. Possibles values: ENABLED, DISABLED.
    availabilityStatus string
    Availability status. Possibles values: ENABLED, DISABLED.
    availability_status str
    Availability status. Possibles values: ENABLED, DISABLED.
    availabilityStatus String
    Availability status. Possibles values: ENABLED, DISABLED.

    DashboardDashboardPublishOptionsExportWithHiddenFieldsOption, DashboardDashboardPublishOptionsExportWithHiddenFieldsOptionArgs

    AvailabilityStatus string
    Availability status. Possibles values: ENABLED, DISABLED.
    AvailabilityStatus string
    Availability status. Possibles values: ENABLED, DISABLED.
    availabilityStatus String
    Availability status. Possibles values: ENABLED, DISABLED.
    availabilityStatus string
    Availability status. Possibles values: ENABLED, DISABLED.
    availability_status str
    Availability status. Possibles values: ENABLED, DISABLED.
    availabilityStatus String
    Availability status. Possibles values: ENABLED, DISABLED.

    DashboardDashboardPublishOptionsSheetControlsOption, DashboardDashboardPublishOptionsSheetControlsOptionArgs

    VisibilityState string
    Visibility state. Possibles values: EXPANDED, COLLAPSED.
    VisibilityState string
    Visibility state. Possibles values: EXPANDED, COLLAPSED.
    visibilityState String
    Visibility state. Possibles values: EXPANDED, COLLAPSED.
    visibilityState string
    Visibility state. Possibles values: EXPANDED, COLLAPSED.
    visibility_state str
    Visibility state. Possibles values: EXPANDED, COLLAPSED.
    visibilityState String
    Visibility state. Possibles values: EXPANDED, COLLAPSED.

    DashboardDashboardPublishOptionsSheetLayoutElementMaximizationOption, DashboardDashboardPublishOptionsSheetLayoutElementMaximizationOptionArgs

    AvailabilityStatus string
    Availability status. Possibles values: ENABLED, DISABLED.
    AvailabilityStatus string
    Availability status. Possibles values: ENABLED, DISABLED.
    availabilityStatus String
    Availability status. Possibles values: ENABLED, DISABLED.
    availabilityStatus string
    Availability status. Possibles values: ENABLED, DISABLED.
    availability_status str
    Availability status. Possibles values: ENABLED, DISABLED.
    availabilityStatus String
    Availability status. Possibles values: ENABLED, DISABLED.

    DashboardDashboardPublishOptionsVisualAxisSortOption, DashboardDashboardPublishOptionsVisualAxisSortOptionArgs

    AvailabilityStatus string
    Availability status. Possibles values: ENABLED, DISABLED.
    AvailabilityStatus string
    Availability status. Possibles values: ENABLED, DISABLED.
    availabilityStatus String
    Availability status. Possibles values: ENABLED, DISABLED.
    availabilityStatus string
    Availability status. Possibles values: ENABLED, DISABLED.
    availability_status str
    Availability status. Possibles values: ENABLED, DISABLED.
    availabilityStatus String
    Availability status. Possibles values: ENABLED, DISABLED.

    DashboardDashboardPublishOptionsVisualMenuOption, DashboardDashboardPublishOptionsVisualMenuOptionArgs

    AvailabilityStatus string
    Availability status. Possibles values: ENABLED, DISABLED.
    AvailabilityStatus string
    Availability status. Possibles values: ENABLED, DISABLED.
    availabilityStatus String
    Availability status. Possibles values: ENABLED, DISABLED.
    availabilityStatus string
    Availability status. Possibles values: ENABLED, DISABLED.
    availability_status str
    Availability status. Possibles values: ENABLED, DISABLED.
    availabilityStatus String
    Availability status. Possibles values: ENABLED, DISABLED.

    DashboardParameters, DashboardParametersArgs

    dateTimeParameters List<Property Map>
    A list of parameters that have a data type of date-time. See AWS API Documentation for complete description.
    decimalParameters List<Property Map>
    A list of parameters that have a data type of decimal. See AWS API Documentation for complete description.
    integerParameters List<Property Map>
    A list of parameters that have a data type of integer. See AWS API Documentation for complete description.
    stringParameters List<Property Map>
    A list of parameters that have a data type of string. See AWS API Documentation for complete description.

    DashboardParametersDateTimeParameter, DashboardParametersDateTimeParameterArgs

    Name string
    Display name for the dashboard.
    Values List<string>
    Name string
    Display name for the dashboard.
    Values []string
    name String
    Display name for the dashboard.
    values List<String>
    name string
    Display name for the dashboard.
    values string[]
    name str
    Display name for the dashboard.
    values Sequence[str]
    name String
    Display name for the dashboard.
    values List<String>

    DashboardParametersDecimalParameter, DashboardParametersDecimalParameterArgs

    Name string
    Display name for the dashboard.
    Values List<double>
    Name string
    Display name for the dashboard.
    Values []float64
    name String
    Display name for the dashboard.
    values List<Double>
    name string
    Display name for the dashboard.
    values number[]
    name str
    Display name for the dashboard.
    values Sequence[float]
    name String
    Display name for the dashboard.
    values List<Number>

    DashboardParametersIntegerParameter, DashboardParametersIntegerParameterArgs

    Name string
    Display name for the dashboard.
    Values List<int>
    Name string
    Display name for the dashboard.
    Values []int
    name String
    Display name for the dashboard.
    values List<Integer>
    name string
    Display name for the dashboard.
    values number[]
    name str
    Display name for the dashboard.
    values Sequence[int]
    name String
    Display name for the dashboard.
    values List<Number>

    DashboardParametersStringParameter, DashboardParametersStringParameterArgs

    Name string
    Display name for the dashboard.
    Values List<string>
    Name string
    Display name for the dashboard.
    Values []string
    name String
    Display name for the dashboard.
    values List<String>
    name string
    Display name for the dashboard.
    values string[]
    name str
    Display name for the dashboard.
    values Sequence[str]
    name String
    Display name for the dashboard.
    values List<String>

    DashboardPermission, DashboardPermissionArgs

    Actions List<string>
    List of IAM actions to grant or revoke permissions on.
    Principal string
    ARN of the principal. See the ResourcePermission documentation for the applicable ARN values.
    Actions []string
    List of IAM actions to grant or revoke permissions on.
    Principal string
    ARN of the principal. See the ResourcePermission documentation for the applicable ARN values.
    actions List<String>
    List of IAM actions to grant or revoke permissions on.
    principal String
    ARN of the principal. See the ResourcePermission documentation for the applicable ARN values.
    actions string[]
    List of IAM actions to grant or revoke permissions on.
    principal string
    ARN of the principal. See the ResourcePermission documentation for the applicable ARN values.
    actions Sequence[str]
    List of IAM actions to grant or revoke permissions on.
    principal str
    ARN of the principal. See the ResourcePermission documentation for the applicable ARN values.
    actions List<String>
    List of IAM actions to grant or revoke permissions on.
    principal String
    ARN of the principal. See the ResourcePermission documentation for the applicable ARN values.

    DashboardSourceEntity, DashboardSourceEntityArgs

    SourceTemplate DashboardSourceEntitySourceTemplate
    The source template. See source_template.
    SourceTemplate DashboardSourceEntitySourceTemplate
    The source template. See source_template.
    sourceTemplate DashboardSourceEntitySourceTemplate
    The source template. See source_template.
    sourceTemplate DashboardSourceEntitySourceTemplate
    The source template. See source_template.
    source_template DashboardSourceEntitySourceTemplate
    The source template. See source_template.
    sourceTemplate Property Map
    The source template. See source_template.

    DashboardSourceEntitySourceTemplate, DashboardSourceEntitySourceTemplateArgs

    Arn string
    The Amazon Resource Name (ARN) of the resource.
    DataSetReferences List<DashboardSourceEntitySourceTemplateDataSetReference>
    List of dataset references. See data_set_references.
    Arn string
    The Amazon Resource Name (ARN) of the resource.
    DataSetReferences []DashboardSourceEntitySourceTemplateDataSetReference
    List of dataset references. See data_set_references.
    arn String
    The Amazon Resource Name (ARN) of the resource.
    dataSetReferences List<DashboardSourceEntitySourceTemplateDataSetReference>
    List of dataset references. See data_set_references.
    arn string
    The Amazon Resource Name (ARN) of the resource.
    dataSetReferences DashboardSourceEntitySourceTemplateDataSetReference[]
    List of dataset references. See data_set_references.
    arn str
    The Amazon Resource Name (ARN) of the resource.
    data_set_references Sequence[DashboardSourceEntitySourceTemplateDataSetReference]
    List of dataset references. See data_set_references.
    arn String
    The Amazon Resource Name (ARN) of the resource.
    dataSetReferences List<Property Map>
    List of dataset references. See data_set_references.

    DashboardSourceEntitySourceTemplateDataSetReference, DashboardSourceEntitySourceTemplateDataSetReferenceArgs

    DataSetArn string
    Dataset Amazon Resource Name (ARN).
    DataSetPlaceholder string
    Dataset placeholder.
    DataSetArn string
    Dataset Amazon Resource Name (ARN).
    DataSetPlaceholder string
    Dataset placeholder.
    dataSetArn String
    Dataset Amazon Resource Name (ARN).
    dataSetPlaceholder String
    Dataset placeholder.
    dataSetArn string
    Dataset Amazon Resource Name (ARN).
    dataSetPlaceholder string
    Dataset placeholder.
    data_set_arn str
    Dataset Amazon Resource Name (ARN).
    data_set_placeholder str
    Dataset placeholder.
    dataSetArn String
    Dataset Amazon Resource Name (ARN).
    dataSetPlaceholder String
    Dataset placeholder.

    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

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    AWS Classic pulumi/pulumi-aws
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the aws Terraform Provider.
    aws logo
    AWS v6.60.0 published on Tuesday, Nov 19, 2024 by Pulumi
    pulumi/pulumi-aws