software.amazon.awscdk.services.quicksight

Interface CfnTemplate.TemplateVersionProperty

All Known Implementing Classes:

CfnTemplate.TemplateVersionProperty.Jsii$Proxy

Enclosing class:

CfnTemplate

public static interface 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 software.amazon.awscdk.services.quicksight.*;
 TemplateVersionProperty templateVersionProperty = TemplateVersionProperty.builder()
         .createdTime("createdTime")
         .dataSetConfigurations(List.of(DataSetConfigurationProperty.builder()
                 .columnGroupSchemaList(List.of(ColumnGroupSchemaProperty.builder()
                         .columnGroupColumnSchemaList(List.of(ColumnGroupColumnSchemaProperty.builder()
                                 .name("name")
                                 .build()))
                         .name("name")
                         .build()))
                 .dataSetSchema(DataSetSchemaProperty.builder()
                         .columnSchemaList(List.of(ColumnSchemaProperty.builder()
                                 .dataType("dataType")
                                 .geographicRole("geographicRole")
                                 .name("name")
                                 .build()))
                         .build())
                 .placeholder("placeholder")
                 .build()))
         .description("description")
         .errors(List.of(TemplateErrorProperty.builder()
                 .message("message")
                 .type("type")
                 .build()))
         .sheets(List.of(SheetProperty.builder()
                 .name("name")
                 .sheetId("sheetId")
                 .build()))
         .sourceEntityArn("sourceEntityArn")
         .status("status")
         .themeArn("themeArn")
         .versionNumber(123)
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	CfnTemplate.TemplateVersionProperty.Builder A builder for CfnTemplate.TemplateVersionProperty
static class	CfnTemplate.TemplateVersionProperty.Jsii$Proxy An implementation for CfnTemplate.TemplateVersionProperty

Method Summary

Modifier and Type	Method and Description
static CfnTemplate.TemplateVersionProperty.Builder	builder()
default java.lang.String	getCreatedTime() The time that this template version was created.
default java.lang.Object	getDataSetConfigurations() Schema of the dataset identified by the placeholder.
default java.lang.String	getDescription() The description of the template.
default java.lang.Object	getErrors() Errors associated with this template version.
default java.lang.Object	getSheets() A list of the associated sheets with the unique identifier and name of each sheet.
default java.lang.String	getSourceEntityArn() The Amazon Resource Name (ARN) of an analysis or template that was used to create this template.
default java.lang.String	getStatus() The status that is associated with the template.
default java.lang.String	getThemeArn() The ARN of the theme associated with this version of the template.
default java.lang.Number	getVersionNumber() The version number of the template version.

Method Detail

getCreatedTime

default java.lang.String getCreatedTime()

The time that this template version was created.

getDataSetConfigurations

default java.lang.Object getDataSetConfigurations()

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.

getDescription

default java.lang.String getDescription()

The description of the template.

getErrors

default java.lang.Object getErrors()

Errors associated with this template version.

getSheets

default java.lang.Object getSheets()

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

getSourceEntityArn

default java.lang.String getSourceEntityArn()

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

getStatus

default java.lang.String getStatus()

The status that is associated with the template.

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

getThemeArn

default java.lang.String getThemeArn()

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

getVersionNumber

default java.lang.Number getVersionNumber()

The version number of the template version.

builder

static CfnTemplate.TemplateVersionProperty.Builder builder()

Returns:

a CfnTemplate.TemplateVersionProperty.Builder of CfnTemplate.TemplateVersionProperty