--- # generated by https://github.com/hashicorp/terraform-plugin-docs page_title: "awscc_quicksight_theme Resource - terraform-provider-awscc" subcategory: "" description: |- Definition of the AWS::QuickSight::Theme Resource Type. --- # awscc_quicksight_theme (Resource) Definition of the AWS::QuickSight::Theme Resource Type. ## Schema ### Required - `aws_account_id` (String) - `theme_id` (String) ### Optional - `base_theme_id` (String)

The ID of the theme that a custom theme will inherit from. All themes inherit from one of the starting themes defined by Amazon QuickSight. For a list of the starting themes, use ListThemes or choose Themes from within a QuickSight analysis.

- `configuration` (Attributes)

The theme configuration. This configuration contains all of the display properties for a theme.

(see [below for nested schema](#nestedatt--configuration)) - `name` (String)

A display name for the theme.

- `permissions` (Attributes List)

A valid grouping of resource permissions to apply to the new theme.

(see [below for nested schema](#nestedatt--permissions)) - `tags` (Attributes List)

A map of the key-value pairs for the resource tag or tags that you want to add to the resource.

(see [below for nested schema](#nestedatt--tags)) - `version_description` (String)

A description of the first version of the theme that you're creating. Every time UpdateTheme is called, a new version is created. Each version of the theme has a description of the version in the VersionDescription field.

### Read-Only - `arn` (String)

The Amazon Resource Name (ARN) of the theme.

- `created_time` (String)

The date and time that the theme was created.

- `id` (String) Uniquely identifies the resource. - `last_updated_time` (String)

The date and time that the theme was last updated.

- `type` (String) - `version` (Attributes)

A version of a theme.

(see [below for nested schema](#nestedatt--version)) ### Nested Schema for `configuration` Optional: - `data_color_palette` (Attributes)

The theme colors that are used for data colors in charts. The colors description is a hexadecimal color code that consists of six alphanumerical characters, prefixed with #, for example #37BFF5.

(see [below for nested schema](#nestedatt--configuration--data_color_palette)) - `sheet` (Attributes)

The theme display options for sheets.

(see [below for nested schema](#nestedatt--configuration--sheet)) - `typography` (Attributes)

The typeface for the theme.

(see [below for nested schema](#nestedatt--configuration--typography)) - `ui_color_palette` (Attributes)

The theme colors that apply to UI and to charts, excluding data colors. The colors description is a hexadecimal color code that consists of six alphanumerical characters, prefixed with #, for example #37BFF5. For more information, see Using Themes in Amazon QuickSight in the Amazon QuickSight User Guide.

(see [below for nested schema](#nestedatt--configuration--ui_color_palette)) ### Nested Schema for `configuration.data_color_palette` Optional: - `colors` (List of String)

The hexadecimal codes for the colors.

- `empty_fill_color` (String)

The hexadecimal code of a color that applies to charts where a lack of data is highlighted.

- `min_max_gradient` (List of String)

The minimum and maximum hexadecimal codes that describe a color gradient.

### Nested Schema for `configuration.sheet` Optional: - `tile` (Attributes)

Display options related to tiles on a sheet.

(see [below for nested schema](#nestedatt--configuration--sheet--tile)) - `tile_layout` (Attributes)

The display options for the layout of tiles on a sheet.

(see [below for nested schema](#nestedatt--configuration--sheet--tile_layout)) ### Nested Schema for `configuration.sheet.tile` Optional: - `border` (Attributes)

The display options for tile borders for visuals.

(see [below for nested schema](#nestedatt--configuration--sheet--tile--border)) ### Nested Schema for `configuration.sheet.tile.border` Optional: - `show` (Boolean)

The option to enable display of borders for visuals.

### Nested Schema for `configuration.sheet.tile_layout` Optional: - `gutter` (Attributes)

The display options for gutter spacing between tiles on a sheet.

(see [below for nested schema](#nestedatt--configuration--sheet--tile_layout--gutter)) - `margin` (Attributes)

The display options for margins around the outside edge of sheets.

(see [below for nested schema](#nestedatt--configuration--sheet--tile_layout--margin)) ### Nested Schema for `configuration.sheet.tile_layout.margin` Optional: - `show` (Boolean)

This Boolean value controls whether to display a gutter space between sheet tiles.

### Nested Schema for `configuration.sheet.tile_layout.margin` Optional: - `show` (Boolean)

This Boolean value controls whether to display sheet margins.

### Nested Schema for `configuration.typography` Optional: - `font_families` (Attributes List) (see [below for nested schema](#nestedatt--configuration--typography--font_families)) ### Nested Schema for `configuration.typography.font_families` Optional: - `font_family` (String) ### Nested Schema for `configuration.ui_color_palette` Optional: - `accent` (String)

This color is that applies to selected states and buttons.

- `accent_foreground` (String)

The foreground color that applies to any text or other elements that appear over the accent color.

- `danger` (String)

The color that applies to error messages.

- `danger_foreground` (String)

The foreground color that applies to any text or other elements that appear over the error color.

- `dimension` (String)

The color that applies to the names of fields that are identified as dimensions.

- `dimension_foreground` (String)

The foreground color that applies to any text or other elements that appear over the dimension color.

- `measure` (String)

The color that applies to the names of fields that are identified as measures.

- `measure_foreground` (String)

The foreground color that applies to any text or other elements that appear over the measure color.

- `primary_background` (String)

The background color that applies to visuals and other high emphasis UI.

- `primary_foreground` (String)

The color of text and other foreground elements that appear over the primary background regions, such as grid lines, borders, table banding, icons, and so on.

- `secondary_background` (String)

The background color that applies to the sheet background and sheet controls.

- `secondary_foreground` (String)

The foreground color that applies to any sheet title, sheet control text, or UI that appears over the secondary background.

- `success` (String)

The color that applies to success messages, for example the check mark for a successful download.

- `success_foreground` (String)

The foreground color that applies to any text or other elements that appear over the success color.

- `warning` (String)

This color that applies to warning and informational messages.

- `warning_foreground` (String)

The foreground color that applies to any text or other elements that appear over the warning color.

### 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:

### Nested Schema for `tags` Optional: - `key` (String)

Tag key.

- `value` (String)

Tag value.

### Nested Schema for `version` Read-Only: - `arn` (String)

The Amazon Resource Name (ARN) of the resource.

- `base_theme_id` (String)

The Amazon QuickSight-defined ID of the theme that a custom theme inherits from. All themes initially inherit from a default QuickSight theme.

- `configuration` (Attributes)

The theme configuration. This configuration contains all of the display properties for a theme.

(see [below for nested schema](#nestedatt--version--configuration)) - `created_time` (String)

The date and time that this theme version was created.

- `description` (String)

The description of the theme.

- `errors` (Attributes List)

Errors associated with the theme.

(see [below for nested schema](#nestedatt--version--errors)) - `status` (String) - `version_number` (Number)

The version number of the theme.

### Nested Schema for `version.configuration` Read-Only: - `data_color_palette` (Attributes)

The theme colors that are used for data colors in charts. The colors description is a hexadecimal color code that consists of six alphanumerical characters, prefixed with #, for example #37BFF5.

(see [below for nested schema](#nestedatt--version--configuration--data_color_palette)) - `sheet` (Attributes)

The theme display options for sheets.

(see [below for nested schema](#nestedatt--version--configuration--sheet)) - `typography` (Attributes)

The typeface for the theme.

(see [below for nested schema](#nestedatt--version--configuration--typography)) - `ui_color_palette` (Attributes)

The theme colors that apply to UI and to charts, excluding data colors. The colors description is a hexadecimal color code that consists of six alphanumerical characters, prefixed with #, for example #37BFF5. For more information, see Using Themes in Amazon QuickSight in the Amazon QuickSight User Guide.

(see [below for nested schema](#nestedatt--version--configuration--ui_color_palette)) ### Nested Schema for `version.configuration.data_color_palette` Read-Only: - `colors` (List of String)

The hexadecimal codes for the colors.

- `empty_fill_color` (String)

The hexadecimal code of a color that applies to charts where a lack of data is highlighted.

- `min_max_gradient` (List of String)

The minimum and maximum hexadecimal codes that describe a color gradient.

### Nested Schema for `version.configuration.sheet` Read-Only: - `tile` (Attributes)

Display options related to tiles on a sheet.

(see [below for nested schema](#nestedatt--version--configuration--sheet--tile)) - `tile_layout` (Attributes)

The display options for the layout of tiles on a sheet.

(see [below for nested schema](#nestedatt--version--configuration--sheet--tile_layout)) ### Nested Schema for `version.configuration.sheet.tile_layout` Read-Only: - `border` (Attributes)

The display options for tile borders for visuals.

(see [below for nested schema](#nestedatt--version--configuration--sheet--tile_layout--border)) ### Nested Schema for `version.configuration.sheet.tile_layout.border` Read-Only: - `show` (Boolean)

The option to enable display of borders for visuals.

### Nested Schema for `version.configuration.sheet.tile_layout` Read-Only: - `gutter` (Attributes)

The display options for gutter spacing between tiles on a sheet.

(see [below for nested schema](#nestedatt--version--configuration--sheet--tile_layout--gutter)) - `margin` (Attributes)

The display options for margins around the outside edge of sheets.

(see [below for nested schema](#nestedatt--version--configuration--sheet--tile_layout--margin)) ### Nested Schema for `version.configuration.sheet.tile_layout.gutter` Read-Only: - `show` (Boolean)

This Boolean value controls whether to display a gutter space between sheet tiles.

### Nested Schema for `version.configuration.sheet.tile_layout.margin` Read-Only: - `show` (Boolean)

This Boolean value controls whether to display sheet margins.

### Nested Schema for `version.configuration.typography` Read-Only: - `font_families` (Attributes List) (see [below for nested schema](#nestedatt--version--configuration--typography--font_families)) ### Nested Schema for `version.configuration.typography.font_families` Read-Only: - `font_family` (String) ### Nested Schema for `version.configuration.ui_color_palette` Read-Only: - `accent` (String)

This color is that applies to selected states and buttons.

- `accent_foreground` (String)

The foreground color that applies to any text or other elements that appear over the accent color.

- `danger` (String)

The color that applies to error messages.

- `danger_foreground` (String)

The foreground color that applies to any text or other elements that appear over the error color.

- `dimension` (String)

The color that applies to the names of fields that are identified as dimensions.

- `dimension_foreground` (String)

The foreground color that applies to any text or other elements that appear over the dimension color.

- `measure` (String)

The color that applies to the names of fields that are identified as measures.

- `measure_foreground` (String)

The foreground color that applies to any text or other elements that appear over the measure color.

- `primary_background` (String)

The background color that applies to visuals and other high emphasis UI.

- `primary_foreground` (String)

The color of text and other foreground elements that appear over the primary background regions, such as grid lines, borders, table banding, icons, and so on.

- `secondary_background` (String)

The background color that applies to the sheet background and sheet controls.

- `secondary_foreground` (String)

The foreground color that applies to any sheet title, sheet control text, or UI that appears over the secondary background.

- `success` (String)

The color that applies to success messages, for example the check mark for a successful download.

- `success_foreground` (String)

The foreground color that applies to any text or other elements that appear over the success color.

- `warning` (String)

This color that applies to warning and informational messages.

- `warning_foreground` (String)

The foreground color that applies to any text or other elements that appear over the warning color.

### Nested Schema for `version.errors` Read-Only: - `message` (String)

The error message.

- `type` (String) ## Import Import is supported using the following syntax: ```shell $ terraform import awscc_quicksight_theme.example ```