Package software.amazon.awscdk.services.quicksight

Interface CfnTemplate.SheetDefinitionProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnTemplate.SheetDefinitionProperty.Jsii$Proxy

Enclosing class:

CfnTemplate

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

A sheet is an object that contains a set of visuals that are viewed together on one page in a paginated report.

Every analysis and dashboard must contain at least one sheet.

Example:

See Also:

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

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnTemplate.SheetDefinitionProperty.Builder	builder()
default String	getContentType()	The layout content type of the sheet.
default String	getDescription()	A description of the sheet.
default Object	getFilterControls()	The list of filter controls that are on a sheet.
default Object	getLayouts()	Layouts define how the components of a sheet are arranged.
default String	getName()	The name of the sheet.
default Object	getParameterControls()	The list of parameter controls that are on a sheet.
default Object	getSheetControlLayouts()	The control layouts of the sheet.
String	getSheetId()	The unique identifier of a sheet.
default Object	getTextBoxes()	The text boxes that are on a sheet.
default String	getTitle()	The title of the sheet.
default Object	getVisuals()	A list of the visuals that are on a sheet.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getSheetId

@Stability(Stable)
@NotNull
String getSheetId()

The unique identifier of a sheet.

See Also:

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

getContentType

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

The layout content type of the sheet. Choose one of the following options:.

• PAGINATED : Creates a sheet for a paginated report.
• INTERACTIVE : Creates a sheet for an interactive dashboard.

See Also:

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

getDescription

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

A description of the sheet.

See Also:

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

getFilterControls

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

The list of filter controls that are on a sheet.

For more information, see Adding filter controls to analysis sheets in the Amazon QuickSight User Guide .

See Also:

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

getLayouts

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

Layouts define how the components of a sheet are arranged.

For more information, see Types of layout in the Amazon QuickSight User Guide .

See Also:

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

getName

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

The name of the sheet.

This name is displayed on the sheet's tab in the Amazon QuickSight console.

See Also:

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

getParameterControls

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

The list of parameter controls that are on a sheet.

For more information, see Using a Control with a Parameter in Amazon QuickSight in the Amazon QuickSight User Guide .

See Also:

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

getSheetControlLayouts

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

The control layouts of the sheet.

See Also:

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

getTextBoxes

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

The text boxes that are on a sheet.

See Also:

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

getTitle

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

The title of the sheet.

See Also:

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

getVisuals

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

A list of the visuals that are on a sheet.

Visual placement is determined by the layout of the sheet.

See Also:

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

builder

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

Returns:

a CfnTemplate.SheetDefinitionProperty.Builder of CfnTemplate.SheetDefinitionProperty