interface CfnTemplateProps
| Language | Type name |
|---|---|
 .NET | Amazon.CDK.AWS.QuickSight.CfnTemplateProps |
 Go | github.com/aws/aws-cdk-go/awscdk/v2/awsquicksight#CfnTemplateProps |
 Java | software.amazon.awscdk.services.quicksight.CfnTemplateProps |
 Python | aws_cdk.aws_quicksight.CfnTemplateProps |
 TypeScript | aws-cdk-lib » aws_quicksight » CfnTemplateProps |
Properties for defining a CfnTemplate.
See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-quicksight-template.html
Example
// The generated example for this type would exceed 500 lines,
// and has been elided for readability.
Properties
| Name | Type | Description |
|---|---|---|
| aws | string | The ID for the AWS account that the group is in. |
| template | string | An ID for the template that you want to create. |
| definition? | IResolvable | Template | |
| name? | string | A display name for the template. |
| permissions? | IResolvable | (IResolvable | Resource)[] | A list of resource permissions to be set on the template. |
| source | IResolvable | Template | The entity that you are using as a source when you create the template. |
| tags? | Cfn[] | Contains a map of the key-value pairs for the resource tag or tags assigned to the resource. |
| validation | IResolvable | Validation | The option to relax the validation that is required to create and update analyses, dashboards, and templates with definition objects. |
| version | string | A description of the current template version being created. |
awsAccountId
Type:
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.
templateId
Type:
string
An ID for the template that you want to create.
This template is unique per AWS Region ; in each AWS account.
definition?
Type:
IResolvable | Template
(optional)
name?
Type:
string
(optional)
A display name for the template.
permissions?
Type:
IResolvable | (IResolvable | Resource)[]
(optional)
A list of resource permissions to be set on the template.
sourceEntity?
Type:
IResolvable | Template
(optional)
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.
tags?
Type:
Cfn[]
(optional)
Contains a map of the key-value pairs for the resource tag or tags assigned to the resource.
validationStrategy?
Type:
IResolvable | Validation
(optional)
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.
versionDescription?
Type:
string
(optional)
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.