aws-cdk-lib.aws_quicksight.CfnDashboardProps

interface CfnDashboardProps

LanguageType name
.NETAmazon.CDK.AWS.QuickSight.CfnDashboardProps
Gogithub.com/aws/aws-cdk-go/awscdk/v2/awsquicksight#CfnDashboardProps
Javasoftware.amazon.awscdk.services.quicksight.CfnDashboardProps
Pythonaws_cdk.aws_quicksight.CfnDashboardProps
TypeScript aws-cdk-lib » aws_quicksight » CfnDashboardProps

Properties for defining a CfnDashboard.

Example

// The generated example for this type would exceed 500 lines,
// and has been elided for readability.

Properties

NameTypeDescription
awsAccountIdstringThe ID of the AWS account where you want to create the dashboard.
dashboardIdstringThe ID for the dashboard, also added to the IAM policy.
namestringThe display name of the dashboard.
dashboardPublishOptions?IResolvable | DashboardPublishOptionsPropertyOptions for publishing the dashboard when you create it:.
definition?IResolvable | DashboardVersionDefinitionPropertyAWS::QuickSight::Dashboard.Definition.
parameters?IResolvable | ParametersPropertyThe parameters for the creation of the dashboard, which you want to use to override the default settings.
permissions?IResolvable | IResolvable | ResourcePermissionProperty[]A structure that contains the permissions of the dashboard.
sourceEntity?IResolvable | DashboardSourceEntityPropertyThe entity that you are using as a source when you create the dashboard.
tags?CfnTag[]Contains a map of the key-value pairs for the resource tag or tags assigned to the dashboard.
themeArn?stringThe Amazon Resource Name (ARN) of the theme that is being used for this dashboard.
versionDescription?stringA description for the first version of the dashboard being created.

awsAccountId

Type: string

The ID of the AWS account where you want to create the dashboard.


dashboardId

Type: string

The ID for the dashboard, also added to the IAM policy.


name

Type: string

The display name of the dashboard.


dashboardPublishOptions?

Type: IResolvable | DashboardPublishOptionsProperty (optional)

Options for publishing the dashboard when you create it:.

  • AvailabilityStatus for AdHocFilteringOption - This status can be either ENABLED or DISABLED . When this is set to DISABLED , Amazon QuickSight disables the left filter pane on the published dashboard, which can be used for ad hoc (one-time) filtering. This option is ENABLED by default.
  • AvailabilityStatus for ExportToCSVOption - This status can be either ENABLED or DISABLED . The visual option to export data to .CSV format isn't enabled when this is set to DISABLED . This option is ENABLED by default.
  • VisibilityState for SheetControlsOption - This visibility state can be either COLLAPSED or EXPANDED . This option is COLLAPSED by default.

definition?

Type: IResolvable | DashboardVersionDefinitionProperty (optional)

AWS::QuickSight::Dashboard.Definition.


parameters?

Type: IResolvable | ParametersProperty (optional)

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.


permissions?

Type: IResolvable | IResolvable | ResourcePermissionProperty[] (optional)

A structure that contains the permissions of the dashboard.

You can use this structure for granting permissions by providing a list of IAM action information for each principal ARN.

To specify no permissions, omit the permissions list.


sourceEntity?

Type: IResolvable | DashboardSourceEntityProperty (optional)

The entity that you are using as a source when you create the dashboard.

In SourceEntity , you specify the type of object that you want to use. You can only create a dashboard from a template, so you use a SourceTemplate entity. If you need to create a dashboard from an analysis, first convert the analysis to a template by using the CreateTemplate API operation. For SourceTemplate , specify the Amazon Resource Name (ARN) of the source template. The SourceTemplate ARN can contain any AWS account; and any QuickSight-supported AWS Region .

Use the DataSetReferences entity within SourceTemplate to list the replacement datasets for the placeholders listed in the original. The schema in each dataset must match its placeholder.


tags?

Type: CfnTag[] (optional)

Contains a map of the key-value pairs for the resource tag or tags assigned to the dashboard.


themeArn?

Type: string (optional)

The Amazon Resource Name (ARN) of the theme that is being used for this dashboard.

If you add a value for this field, it overrides the value that is used in the source entity. The theme ARN must exist in the same AWS account where you create the dashboard.


versionDescription?

Type: string (optional)

A description for the first version of the dashboard being created.