Package software.amazon.awscdk.services.quicksight

Interface CfnTemplate.TemplateVersionProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnTemplate.TemplateVersionProperty.Jsii$Proxy

Enclosing class:

CfnTemplate

@Stability(Stable)
public static interface CfnTemplate.TemplateVersionProperty
extends software.amazon.jsii.JsiiSerializable

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")
                 .violatedEntities(List.of(EntityProperty.builder()
                         .path("path")
                         .build()))
                 .build()))
         .sheets(List.of(SheetProperty.builder()
                 .name("name")
                 .sheetId("sheetId")
                 .build()))
         .sourceEntityArn("sourceEntityArn")
         .status("status")
         .themeArn("themeArn")
         .versionNumber(123)
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-templateversion.html

Nested Class Summary

Nested Classes

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

Method Summary

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

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getCreatedTime

@Stability(Stable)
@Nullable
default String getCreatedTime()

The time that this template version was created.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-templateversion.html#cfn-quicksight-template-templateversion-createdtime

getDataSetConfigurations

@Stability(Stable)
@Nullable
default 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.

Returns union: either IResolvable or Listinvalid input: '<'either IResolvable or CfnTemplate.DataSetConfigurationProperty>

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-templateversion.html#cfn-quicksight-template-templateversion-datasetconfigurations

getDescription

@Stability(Stable)
@Nullable
default String getDescription()

The description of the template.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-templateversion.html#cfn-quicksight-template-templateversion-description

getErrors

@Stability(Stable)
@Nullable
default Object getErrors()

Errors associated with this template version.

Returns union: either IResolvable or Listinvalid input: '<'either IResolvable or CfnTemplate.TemplateErrorProperty>

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-templateversion.html#cfn-quicksight-template-templateversion-errors

getSheets

@Stability(Stable)
@Nullable
default Object getSheets()

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

Returns union: either IResolvable or Listinvalid input: '<'either IResolvable or CfnTemplate.SheetProperty>

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-templateversion.html#cfn-quicksight-template-templateversion-sheets

getSourceEntityArn

@Stability(Stable)
@Nullable
default String getSourceEntityArn()

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-templateversion.html#cfn-quicksight-template-templateversion-sourceentityarn

getStatus

@Stability(Stable)
@Nullable
default 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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-templateversion.html#cfn-quicksight-template-templateversion-status

getThemeArn

@Stability(Stable)
@Nullable
default String getThemeArn()

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-templateversion.html#cfn-quicksight-template-templateversion-themearn

getVersionNumber

@Stability(Stable)
@Nullable
default Number getVersionNumber()

The version number of the template version.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-templateversion.html#cfn-quicksight-template-templateversion-versionnumber

builder

@Stability(Stable)
static CfnTemplate.TemplateVersionProperty.Builder builder()

Returns:

a CfnTemplate.TemplateVersionProperty.Builder of CfnTemplate.TemplateVersionProperty