Package software.amazon.awscdk.services.quicksight

Interface CfnTemplate.TemplateVersionDefinitionProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnTemplate.TemplateVersionDefinitionProperty.Jsii$Proxy

Enclosing class:

CfnTemplate

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

The detailed definition of a template.

Example:

See Also:

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

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnTemplate.TemplateVersionDefinitionProperty.Builder	builder()
default Object	getAnalysisDefaults()	Returns union: either IResolvable or CfnTemplate.AnalysisDefaultsProperty
default Object	getCalculatedFields()	An array of calculated field definitions for the template.
default Object	getColumnConfigurations()	An array of template-level column configurations.
Object	getDataSetConfigurations()	An array of dataset configurations.
default Object	getFilterGroups()	Filter definitions for a template.
default Object	getOptions()	An array of option definitions for a template.
default Object	getParameterDeclarations()	An array of parameter declarations for a template.
default Object	getQueryExecutionOptions()	Returns union: either IResolvable or CfnTemplate.QueryExecutionOptionsProperty
default Object	getSheets()	An array of sheet definitions for a template.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getDataSetConfigurations

@Stability(Stable)
@NotNull
Object getDataSetConfigurations()

An array of dataset configurations.

These configurations define the required columns for each dataset used within a template.

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-templateversiondefinition.html#cfn-quicksight-template-templateversiondefinition-datasetconfigurations

getAnalysisDefaults

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

Returns union: either IResolvable or CfnTemplate.AnalysisDefaultsProperty

See Also:

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

getCalculatedFields

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

An array of calculated field definitions for the template.

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

See Also:

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

getColumnConfigurations

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

An array of template-level column configurations.

Column configurations are used to set default formatting for a column that's used throughout a template.

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

See Also:

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

getFilterGroups

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

Filter definitions for a template.

For more information, see Filtering Data in the Amazon Quick Suite User Guide .

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

See Also:

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

getOptions

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

An array of option definitions for a template.

Returns union: either IResolvable or CfnTemplate.AssetOptionsProperty

See Also:

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

getParameterDeclarations

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

An array of parameter declarations for a template.

Parameters are named variables that can transfer a value for use by an action or an object.

For more information, see Parameters in Amazon Quick Sight in the Amazon Quick Suite User Guide .

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

See Also:

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

getQueryExecutionOptions

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

Returns union: either IResolvable or CfnTemplate.QueryExecutionOptionsProperty

See Also:

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

getSheets

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

An array of sheet definitions for a template.

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

See Also:

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

builder

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

Returns:

a CfnTemplate.TemplateVersionDefinitionProperty.Builder of CfnTemplate.TemplateVersionDefinitionProperty