Package software.amazon.awscdk.services.quicksight

Interface CfnAnalysis.AnalysisDefinitionProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnAnalysis.AnalysisDefinitionProperty.Jsii$Proxy

Enclosing class:

CfnAnalysis

@Stability(Stable)
public static interface CfnAnalysis.AnalysisDefinitionProperty
extends software.amazon.jsii.JsiiSerializable

The definition of an analysis.

Example:

See Also:

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

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnAnalysis.AnalysisDefinitionProperty.Builder	builder()
default Object	getAnalysisDefaults()	Returns union: either IResolvable or CfnAnalysis.AnalysisDefaultsProperty
default Object	getCalculatedFields()	An array of calculated field definitions for the analysis.
default Object	getColumnConfigurations()	An array of analysis-level column configurations.
Object	getDataSetIdentifierDeclarations()	An array of dataset identifier declarations.
default Object	getFilterGroups()	Filter definitions for an analysis.
default Object	getOptions()	An array of option definitions for an analysis.
default Object	getParameterDeclarations()	An array of parameter declarations for an analysis.
default Object	getQueryExecutionOptions()	Returns union: either IResolvable or CfnAnalysis.QueryExecutionOptionsProperty
default Object	getSheets()	An array of sheet definitions for an analysis.
default Object	getStaticFiles()	The static files for the definition.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getDataSetIdentifierDeclarations

@Stability(Stable)
@NotNull
Object getDataSetIdentifierDeclarations()

An array of dataset identifier declarations.

This mapping allows the usage of dataset identifiers instead of dataset ARNs throughout analysis sub-structures.

Returns union: either IResolvable or Listinvalid input: '<'either IResolvable or CfnAnalysis.DataSetIdentifierDeclarationProperty>

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-analysisdefinition.html#cfn-quicksight-analysis-analysisdefinition-datasetidentifierdeclarations

getAnalysisDefaults

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

Returns union: either IResolvable or CfnAnalysis.AnalysisDefaultsProperty

See Also:

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

getCalculatedFields

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

An array of calculated field definitions for the analysis.

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

See Also:

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

getColumnConfigurations

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

An array of analysis-level column configurations.

Column configurations can be used to set default formatting for a column to be used throughout an analysis.

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

See Also:

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

getFilterGroups

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

Filter definitions for an analysis.

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

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

See Also:

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

getOptions

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

An array of option definitions for an analysis.

Returns union: either IResolvable or CfnAnalysis.AssetOptionsProperty

See Also:

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

getParameterDeclarations

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

An array of parameter declarations for an analysis.

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 CfnAnalysis.ParameterDeclarationProperty>

See Also:

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

getQueryExecutionOptions

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

Returns union: either IResolvable or CfnAnalysis.QueryExecutionOptionsProperty

See Also:

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

getSheets

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

An array of sheet definitions for an analysis.

Each SheetDefinition provides detailed information about a sheet within this analysis.

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

See Also:

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

getStaticFiles

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

The static files for the definition.

Returns union: either IResolvable or Listinvalid input: '<'either IResolvable or CfnAnalysis.StaticFileProperty>

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-analysisdefinition.html#cfn-quicksight-analysis-analysisdefinition-staticfiles

builder

@Stability(Stable)
static CfnAnalysis.AnalysisDefinitionProperty.Builder builder()

Returns:

a CfnAnalysis.AnalysisDefinitionProperty.Builder of CfnAnalysis.AnalysisDefinitionProperty