--- # generated by https://github.com/hashicorp/terraform-plugin-docs page_title: "awscc_quicksight_template Resource - terraform-provider-awscc" subcategory: "" description: |- Definition of the AWS::QuickSight::Template Resource Type. --- # awscc_quicksight_template (Resource) Definition of the AWS::QuickSight::Template Resource Type. ## Schema ### Required - `aws_account_id` (String) - `source_entity` (Attributes)
The source entity of the template.
(see [below for nested schema](#nestedatt--source_entity)) - `template_id` (String) ### Optional - `name` (String)A display name for the template.
- `permissions` (Attributes List)A list of resource permissions to be set on the template.
(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 resource.
(see [below for nested schema](#nestedatt--tags)) - `version_description` (String)A description of the current template version being created. This API operation creates the
first version of the template. Every time UpdateTemplate
is called, a new
version is created. Each version of the template maintains a description of the version
in the VersionDescription
field.
The Amazon Resource Name (ARN) of the template.
- `created_time` (String)Time when this was created.
- `id` (String) Uniquely identifies the resource. - `last_updated_time` (String)Time when this was last updated.
- `version` (Attributes)A version of a template.
(see [below for nested schema](#nestedatt--version)) ### Nested Schema for `source_entity` Required: - `source_analysis` (Attributes)The source analysis of the template.
(see [below for nested schema](#nestedatt--source_entity--source_analysis)) - `source_template` (Attributes)The source template of the template.
(see [below for nested schema](#nestedatt--source_entity--source_template)) ### Nested Schema for `source_entity.source_analysis` Required: - `arn` (String)The Amazon Resource Name (ARN) of the resource.
- `data_set_references` (Attributes List)A structure containing information about the dataset references used as placeholders in the template.
(see [below for nested schema](#nestedatt--source_entity--source_analysis--data_set_references)) ### Nested Schema for `source_entity.source_analysis.data_set_references` Required: - `data_set_arn` (String)Dataset Amazon Resource Name (ARN).
- `data_set_placeholder` (String)Dataset placeholder.
### Nested Schema for `source_entity.source_template` Required: - `arn` (String)The Amazon Resource Name (ARN) of the resource.
### Nested Schema for `permissions` Optional: - `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.)
Tag key.
- `value` (String)Tag value.
### Nested Schema for `version` Read-Only: - `created_time` (String)The time that this template version was created.
- `data_set_configurations` (Attributes List)Schema of the dataset identified by the placeholder. Any dashboard created from this template should be bound to new datasets matching the same schema described through this API operation.
(see [below for nested schema](#nestedatt--version--data_set_configurations)) - `description` (String)The description of the template.
- `errors` (Attributes List)Errors associated with this template version.
(see [below for nested schema](#nestedatt--version--errors)) - `sheets` (Attributes List)A list of the associated sheets with the unique identifier and name of each sheet.
(see [below for nested schema](#nestedatt--version--sheets)) - `source_entity_arn` (String)The Amazon Resource Name (ARN) of an analysis or template that was used to create this template.
- `status` (String) - `theme_arn` (String)The ARN of the theme associated with this version of the template.
- `version_number` (Number)The version number of the template version.
### Nested Schema for `version.data_set_configurations` Read-Only: - `column_group_schema_list` (Attributes List)A structure containing the list of column group schemas.
(see [below for nested schema](#nestedatt--version--data_set_configurations--column_group_schema_list)) - `data_set_schema` (Attributes)Dataset schema.
(see [below for nested schema](#nestedatt--version--data_set_configurations--data_set_schema)) - `placeholder` (String)Placeholder.
### Nested Schema for `version.data_set_configurations.column_group_schema_list` Read-Only: - `column_group_column_schema_list` (Attributes List)A structure containing the list of schemas for column group columns.
(see [below for nested schema](#nestedatt--version--data_set_configurations--column_group_schema_list--column_group_column_schema_list)) - `name` (String)The name of the column group schema.
### Nested Schema for `version.data_set_configurations.column_group_schema_list.name` Read-Only: - `name` (String)The name of the column group's column schema.
### Nested Schema for `version.data_set_configurations.data_set_schema` Read-Only: - `column_schema_list` (Attributes List)A structure containing the list of column schemas.
(see [below for nested schema](#nestedatt--version--data_set_configurations--data_set_schema--column_schema_list)) ### Nested Schema for `version.data_set_configurations.data_set_schema.column_schema_list` Read-Only: - `data_type` (String)The data type of the column schema.
- `geographic_role` (String)The geographic role of the column schema.
- `name` (String)The name of the column schema.
### Nested Schema for `version.errors` Read-Only: - `message` (String)Description of the error type.
- `type` (String) ### Nested Schema for `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 Import is supported using the following syntax: ```shell $ terraform import awscc_quicksight_template.example