aws-cdk-lib.aws_quicksight.CfnTemplate.TemplateVersionProperty

interface TemplateVersionProperty

LanguageType name
.NETAmazon.CDK.AWS.QuickSight.CfnTemplate.TemplateVersionProperty
Gogithub.com/aws/aws-cdk-go/awscdk/v2/awsquicksight#CfnTemplate_TemplateVersionProperty
Javasoftware.amazon.awscdk.services.quicksight.CfnTemplate.TemplateVersionProperty
Pythonaws_cdk.aws_quicksight.CfnTemplate.TemplateVersionProperty
TypeScript aws-cdk-lib » aws_quicksight » CfnTemplate » TemplateVersionProperty

A version of a template.

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_quicksight as quicksight } from 'aws-cdk-lib';
const templateVersionProperty: quicksight.CfnTemplate.TemplateVersionProperty = {
  createdTime: 'createdTime',
  dataSetConfigurations: [{
    columnGroupSchemaList: [{
      columnGroupColumnSchemaList: [{
        name: 'name',
      }],
      name: 'name',
    }],
    dataSetSchema: {
      columnSchemaList: [{
        dataType: 'dataType',
        geographicRole: 'geographicRole',
        name: 'name',
      }],
    },
    placeholder: 'placeholder',
  }],
  description: 'description',
  errors: [{
    message: 'message',
    type: 'type',
    violatedEntities: [{
      path: 'path',
    }],
  }],
  sheets: [{
    name: 'name',
    sheetId: 'sheetId',
  }],
  sourceEntityArn: 'sourceEntityArn',
  status: 'status',
  themeArn: 'themeArn',
  versionNumber: 123,
};

Properties

NameTypeDescription
createdTime?stringThe time that this template version was created.
dataSetConfigurations?IResolvable | IResolvable | DataSetConfigurationProperty[]Schema of the dataset identified by the placeholder.
description?stringThe description of the template.
errors?IResolvable | IResolvable | TemplateErrorProperty[]Errors associated with this template version.
sheets?IResolvable | IResolvable | SheetProperty[]A list of the associated sheets with the unique identifier and name of each sheet.
sourceEntityArn?stringThe Amazon Resource Name (ARN) of an analysis or template that was used to create this template.
status?stringThe status that is associated with the template.
themeArn?stringThe ARN of the theme associated with this version of the template.
versionNumber?numberThe version number of the template version.

createdTime?

Type: string (optional)

The time that this template version was created.


dataSetConfigurations?

Type: IResolvable | IResolvable | DataSetConfigurationProperty[] (optional)

Schema of the dataset identified by the placeholder.

Any dashboard created from this template should be bound to new datasets matching the same schema described through this API operation.


description?

Type: string (optional)

The description of the template.


errors?

Type: IResolvable | IResolvable | TemplateErrorProperty[] (optional)

Errors associated with this template version.


sheets?

Type: IResolvable | IResolvable | SheetProperty[] (optional)

A list of the associated sheets with the unique identifier and name of each sheet.


sourceEntityArn?

Type: string (optional)

The Amazon Resource Name (ARN) of an analysis or template that was used to create this template.


status?

Type: string (optional)

The status that is associated with the template.

  • CREATION_IN_PROGRESS
  • CREATION_SUCCESSFUL
  • CREATION_FAILED
  • UPDATE_IN_PROGRESS
  • UPDATE_SUCCESSFUL
  • UPDATE_FAILED
  • DELETED

themeArn?

Type: string (optional)

The ARN of the theme associated with this version of the template.


versionNumber?

Type: number (optional)

The version number of the template version.