AWS::QuickSight::Theme

Creates a theme.

A theme is set of configuration options for color and layout. Themes apply to analyses and dashboards. For more information, see Using Themes in Amazon QuickSight in the Amazon QuickSight User Guide.

Syntax

To declare this entity in your AWS CloudFormation template, use the following syntax:

JSON

{
  "Type" : "AWS::QuickSight::Theme",
  "Properties" : {
      "AwsAccountId" : String,
      "BaseThemeId" : String,
      "Configuration" : ThemeConfiguration,
      "Name" : String,
      "Permissions" : [ ResourcePermission, ... ],
      "Tags" : [ Tag, ... ],
      "ThemeId" : String,
      "VersionDescription" : String
    }
}

YAML

Type: AWS::QuickSight::Theme
Properties: 
  AwsAccountId: String
  BaseThemeId: String
  Configuration: 
    ThemeConfiguration
  Name: String
  Permissions: 
    - ResourcePermission
  Tags: 
    - Tag
  ThemeId: String
  VersionDescription: String

Properties

AwsAccountId

The ID of the AWS account where you want to store the new theme.

Required: Yes

Type: String

Minimum: 12

Maximum: 12

Pattern: ^[0-9]{12}$

Update requires: Replacement

BaseThemeId

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.

Required: No

Type: String

Minimum: 1

Maximum: 2048

Pattern: [\w\-]+

Update requires: No interruption

Configuration

The theme configuration, which contains the theme display properties.

Required: No

Type: ThemeConfiguration

Update requires: No interruption

Name

A display name for the theme.

Required: No

Type: String

Minimum: 1

Maximum: 2048

Update requires: No interruption

Permissions

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

Required: No

Type: List of ResourcePermission

Maximum: 64

Update requires: No interruption

Tags

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

Required: No

Type: List of Tag

Maximum: 200

Update requires: No interruption

ThemeId

An ID for the theme that you want to create. The theme ID is unique per AWS Region in each AWS account.

Required: Yes

Type: String

Minimum: 1

Maximum: 2048

Pattern: [\w\-]+

Update requires: Replacement

VersionDescription

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.

Required: No

Type: String

Minimum: 1

Maximum: 512

Update requires: No interruption

Return values

Fn::GetAtt

Arn

The Amazon Resource Name (ARN) of the theme.

CreatedTime

The time the theme was created.

LastUpdatedTime

The time the theme was last updated.

Type

Theme type.