AWS::QuickSight::Template
Creates a template from an existing Amazon QuickSight analysis or template. You can use the resulting template to create a dashboard.
A template is an entity in Amazon 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
, "Definition" :TemplateVersionDefinition
, "Name" :String
, "Permissions" :[ ResourcePermission, ... ]
, "SourceEntity" :TemplateSourceEntity
, "Tags" :[ Tag, ... ]
, "TemplateId" :String
, "VersionDescription" :String
} }
YAML
Type: AWS::QuickSight::Template Properties: AwsAccountId:
String
Definition:TemplateVersionDefinition
Name:String
Permissions:- ResourcePermission
SourceEntity:TemplateSourceEntity
Tags:- Tag
TemplateId:String
VersionDescription:String
Properties
AwsAccountId
-
The ID for the AWS account that the group is in. You use the ID for the AWS account that contains your Amazon QuickSight account.
Required: Yes
Type: String
Minimum:
12
Maximum:
12
Pattern:
^[0-9]{12}$
Update requires: Replacement
Definition
Property description not available.
Required: No
Type: TemplateVersionDefinition
Update requires: No interruption
Name
-
A display name for the template.
Required: No
Type: String
Minimum:
1
Maximum:
2048
Update requires: No interruption
Permissions
-
A list of resource permissions to be set on the template.
Required: No
Type: List of ResourcePermission
Maximum:
64
Update requires: No interruption
SourceEntity
-
The entity that you are using as a source when you create the template. In
SourceEntity
, you specify the type of object you're using as source:SourceTemplate
for a template orSourceAnalysis
for an analysis. Both of these require an Amazon Resource Name (ARN). ForSourceTemplate
, specify the ARN of the source template. ForSourceAnalysis
, specify the ARN of the source analysis. TheSourceTemplate
ARN can contain any AWS account and any Amazon QuickSight-supported AWS Region.Use the
DataSetReferences
entity withinSourceTemplate
orSourceAnalysis
to list the replacement datasets for the placeholders listed in the original. The schema in each dataset must match its placeholder.Either a
SourceEntity
or aDefinition
must be provided in order for the request to be valid.Required: No
Type: TemplateSourceEntity
Update requires: No interruption
Tags
-
Contains a map of the key-value pairs for the resource tag or tags assigned to the resource.
Required: No
Type: List of Tag
Maximum:
200
Update requires: No interruption
TemplateId
-
An ID for the template that you want to create. This template is unique per AWS Region; in each AWS account.
Required: Yes
Type: String
Minimum:
1
Maximum:
512
Pattern:
[\w\-]+
Update requires: Replacement
VersionDescription
-
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 theVersionDescription
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 template.
CreatedTime
-
The time this template was created.
LastUpdatedTime
-
The time this template was last updated.
Version
-
The version of the template.
Version.CreatedTime
Property description not available.
Version.DataSetConfigurations
Property description not available.
Version.Description
Property description not available.
Version.Errors
Property description not available.
Version.Sheets
Property description not available.
Version.SourceEntityArn
Property description not available.
Version.Status
Property description not available.
Version.ThemeArn
Property description not available.
Version.VersionNumber
Property description not available.