Definition of the AWS::QuickSight::Dashboard Resource Type.
aws_account_id
(String)dashboard_id
(String)source_entity
(Attributes) Dashboard source entity.
(see below for nested schema)dashboard_publish_options
(Attributes) Dashboard publish options.
(see below for nested schema)name
(String) The display name of the dashboard.
parameters
(Attributes) A list of QuickSight parameters and the list's override values.
(see below for nested schema)permissions
(Attributes List)
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.
<p>To specify no permissions, omit the permissions list.</p> (see [below for nested schema](#nestedatt--permissions))
tags
(Attributes List) Contains a map of the key-value pairs for the resource tag or tags assigned to the dashboard.
(see below for nested schema)theme_arn
(String) 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.
version_description
(String) A description for the first version of the dashboard being created.
arn
(String) The Amazon Resource Name (ARN) of the resource.
created_time
(String) The time that this dataset was created.
id
(String) Uniquely identifies the resource.last_published_time
(String) The last time that this dataset was published.
last_updated_time
(String) The last time that this dataset was updated.
version
(Attributes) Dashboard version.
(see below for nested schema)source_entity
Optional:
source_template
(Attributes) Dashboard source template.
(see below for nested schema)source_entity.source_template
Required:
arn
(String) The Amazon Resource Name (ARN) of the resource.
data_set_references
(Attributes List) Dataset references.
(see below for nested schema)source_entity.source_template.data_set_references
Required:
data_set_arn
(String) Dataset Amazon Resource Name (ARN).
data_set_placeholder
(String) Dataset placeholder.
dashboard_publish_options
Optional:
ad_hoc_filtering_option
(Attributes) Ad hoc (one-time) filtering option.
(see below for nested schema)export_to_csv_option
(Attributes) Export to .csv option.
(see below for nested schema)sheet_controls_option
(Attributes) Sheet controls option.
(see below for nested schema)dashboard_publish_options.ad_hoc_filtering_option
Optional:
availability_status
(String)dashboard_publish_options.export_to_csv_option
Optional:
availability_status
(String)dashboard_publish_options.sheet_controls_option
Optional:
visibility_state
(String)parameters
Optional:
date_time_parameters
(Attributes List) Date-time parameters.
(see below for nested schema)decimal_parameters
(Attributes List) Decimal parameters.
(see below for nested schema)integer_parameters
(Attributes List) Integer parameters.
(see below for nested schema)string_parameters
(Attributes List) String parameters.
(see below for nested schema)parameters.date_time_parameters
Required:
name
(String) A display name for the date-time parameter.
values
(List of String) The values for the date-time parameter.
parameters.decimal_parameters
Required:
name
(String) A display name for the decimal parameter.
values
(List of Number) The values for the decimal parameter.
parameters.integer_parameters
Required:
name
(String) The name of the integer parameter.
values
(List of Number) The values for the integer parameter.
parameters.string_parameters
Required:
name
(String) A display name for a string parameter.
values
(List of String) The values of a string parameter.
permissions
Required:
actions
(List of String) The IAM action to grant or revoke permissions on.
principal
(String) The Amazon Resource Name (ARN) of the principal. This can be one of the following:
The ARN of an Amazon QuickSight user or group associated with a data source or dataset. (This is common.)
The ARN of an Amazon QuickSight user, group, or namespace associated with an analysis, dashboard, template, or theme. (This is common.)
The ARN of an AWS account root: This is an IAM ARN rather than a QuickSight ARN. Use this option only to share resources (templates) across AWS accounts. (This is less common.)
tags
Required:
key
(String) Tag key.
value
(String) Tag value.
version
Read-Only:
arn
(String) The Amazon Resource Name (ARN) of the resource.
created_time
(String) The time that this dashboard version was created.
data_set_arns
(List of String) The Amazon Resource Numbers (ARNs) for the datasets that are associated with this version of the dashboard.
description
(String) Description.
errors
(Attributes List) Errors associated with this dashboard version.
(see below for nested schema)sheets
(Attributes List) A list of the associated sheets with the unique identifier and name of each sheet.
(see below for nested schema)source_entity_arn
(String) Source entity ARN.
status
(String)theme_arn
(String) The ARN of the theme associated with a version of the dashboard.
version_number
(Number) Version number for this version of the dashboard.
version.errors
Read-Only:
message
(String) Message.
type
(String)version.sheets
Read-Only:
name
(String) The name of a sheet. This name is displayed on the sheet's tab in the QuickSight console.
sheet_id
(String) The unique identifier associated with a sheet.
Import is supported using the following syntax:
$ terraform import awscc_quicksight_dashboard.example <resource ID>