Package software.amazon.awscdk.mixins.preview.services.quicksight.mixins

Interface CfnDashboardPropsMixin.DashboardVersionDefinitionProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnDashboardPropsMixin.DashboardVersionDefinitionProperty.Jsii$Proxy

Enclosing class:

CfnDashboardPropsMixin

@Stability(Stable)
public static interface CfnDashboardPropsMixin.DashboardVersionDefinitionProperty
extends software.amazon.jsii.JsiiSerializable

The contents of a dashboard.

Example:

See Also:

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

Nested Class Summary

Nested Classes

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

Method Summary

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

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getAnalysisDefaults

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

Returns union: either IResolvable or CfnDashboardPropsMixin.AnalysisDefaultsProperty

See Also:

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

getCalculatedFields

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

An array of calculated field definitions for the dashboard.

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

See Also:

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

getColumnConfigurations

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

An array of dashboard-level column configurations.

Column configurations are used to set the default formatting for a column that is used throughout a dashboard.

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

See Also:

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

getDataSetIdentifierDeclarations

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

An array of dataset identifier declarations.

With this mapping,you can use dataset identifiers instead of dataset Amazon Resource Names (ARNs) throughout the dashboard's sub-structures.

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

See Also:

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

getFilterGroups

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

The filter definitions for a dashboard.

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 CfnDashboardPropsMixin.FilterGroupProperty>

See Also:

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

getOptions

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

An array of option definitions for a dashboard.

Returns union: either IResolvable or CfnDashboardPropsMixin.AssetOptionsProperty

See Also:

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

getParameterDeclarations

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

The parameter declarations for a dashboard.

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

See Also:

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

getSheets

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

An array of sheet definitions for a dashboard.

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

See Also:

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

getStaticFiles

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

The static files for the definition.

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

See Also:

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

builder

@Stability(Stable)
static CfnDashboardPropsMixin.DashboardVersionDefinitionProperty.Builder builder()

Returns:

a CfnDashboardPropsMixin.DashboardVersionDefinitionProperty.Builder of CfnDashboardPropsMixin.DashboardVersionDefinitionProperty