AWS Fundamentals Logo
AWS Fundamentals
L1 ConstructAWS::QuickSight::Template

CfnTemplate

Creates a template from an existing Quick analysis or template. You can use the resulting template to create a dashboard. A *template* is an entity in Quick 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.

Import

import { CfnTemplate } from 'aws-cdk-lib/aws-quicksight';

Or use the module namespace:

import * as quicksight from 'aws-cdk-lib/aws-quicksight';
// quicksight.CfnTemplate

Properties

Configuration passed to the constructor as CfnTemplateProps.

awsAccountIdRequired
string

The ID for the AWS account that the group is in. You use the ID for the AWS account that contains your Amazon Quick Sight account.

templateIdRequired
string

An ID for the template that you want to create. This template is unique per AWS Region ; in each AWS account.

definitionOptional
IResolvable | TemplateVersionDefinitionProperty
nameOptional
string

A display name for the template.

permissionsOptional
IResolvable | IResolvable | ResourcePermissionProperty[]

A list of resource permissions to be set on the template.

sourceEntityOptional
IResolvable | TemplateSourceEntityProperty

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 or `SourceAnalysis` for an analysis. Both of these require an Amazon Resource Name (ARN). For `SourceTemplate` , specify the ARN of the source template. For `SourceAnalysis` , specify the ARN of the source analysis. The `SourceTemplate` ARN can contain any AWS account and any Quick Sight-supported AWS Region . Use the `DataSetReferences` entity within `SourceTemplate` or `SourceAnalysis` 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 a `Definition` must be provided in order for the request to be valid.

tagsOptional
CfnTag[]

Contains a map of the key-value pairs for the resource tag or tags assigned to the resource.

validationStrategyOptional
IResolvable | ValidationStrategyProperty

The option to relax the validation that is required to create and update analyses, dashboards, and templates with definition objects. When you set this value to `LENIENT` , validation is skipped for specific errors.

versionDescriptionOptional
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.

CloudFormation Resource

This L1 construct maps directly to the following CloudFormation resource type.

AWS::QuickSight::TemplateView in CloudFormation Explorer

Learn AWS the Practical Way

Our bi-weekly newsletter teaches hands-on AWS fundamentals. No certification fluff - just practical knowledge.

Subscribe to Newsletter

Quick Facts

LevelL1 (CloudFormation)
Moduleaws-quicksight
CFN TypeAWS::QuickSight::Template
Properties9

Related Constructs

Explore This Service

External Links