AWS::QuickSight::Template - AWS CloudFormation

AWS::QuickSight::Template

Creates a template from an existing QuickSight analysis or template. You can use the resulting template to create a dashboard.

A template is an entity in QuickSight that encapsulates the metadata required to create an analysis and that you can use to create s dashboard. A template adds a layer of abstraction by using placeholders to replace the dataset associated with the analysis. You can use templates to create dashboards by replacing dataset placeholders with datasets that follow the same schema that was used to create the source analysis and template.

Syntax

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

JSON

{ "Type" : "AWS::QuickSight::Template", "Properties" : { "AwsAccountId" : String, "Name" : String, "Permissions" : [ ResourcePermission, ... ], "SourceEntity" : TemplateSourceEntity, "Tags" : [ Tag, ... ], "TemplateId" : String, "VersionDescription" : String } }

YAML

Type: AWS::QuickSight::Template Properties: AwsAccountId: String Name: String Permissions: - ResourcePermission SourceEntity: TemplateSourceEntity Tags: - Tag TemplateId: String VersionDescription: String

Properties

AwsAccountId

Not currently supported by AWS CloudFormation.

Required: Yes

Type: String

Update requires: Replacement

Name

A display name for the template.

Required: No

Type: String

Minimum: 1

Maximum: 2048

Pattern: [\u0020-\u00FF]+

Update requires: No interruption

Permissions

Not currently supported by AWS CloudFormation.

Required: No

Type: List of ResourcePermission

Update requires: No interruption

SourceEntity

Not currently supported by AWS CloudFormation.

Required: No

Type: TemplateSourceEntity

Update requires: No interruption

Tags

Not currently supported by AWS CloudFormation.

Required: No

Type: List of Tag

Update requires: No interruption

TemplateId

The ID of the template. This ID is unique per AWS Region for each AWS account.

Required: Yes

Type: String

Minimum: 1

Maximum: 2048

Pattern: [\w\-]+

Update requires: Replacement

VersionDescription

Not currently supported by AWS CloudFormation.

Required: No

Type: String

Update requires: No interruption

Return values

Ref

Fn::GetAtt

Arn

Not currently supported by AWS CloudFormation.

CreatedTime

Not currently supported by AWS CloudFormation.

LastUpdatedTime

Not currently supported by AWS CloudFormation.