Class CfnTemplate.SheetDefinitionProperty.Builder
java.lang.Object
software.amazon.awscdk.services.quicksight.CfnTemplate.SheetDefinitionProperty.Builder
- All Implemented Interfaces:
software.amazon.jsii.Builder<CfnTemplate.SheetDefinitionProperty>
- Enclosing interface:
CfnTemplate.SheetDefinitionProperty
@Stability(Stable)
public static final class CfnTemplate.SheetDefinitionProperty.Builder
extends Object
implements software.amazon.jsii.Builder<CfnTemplate.SheetDefinitionProperty>
A builder for
CfnTemplate.SheetDefinitionProperty
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionbuild()
Builds the configured instance.contentType
(String contentType) Sets the value ofCfnTemplate.SheetDefinitionProperty.getContentType()
description
(String description) Sets the value ofCfnTemplate.SheetDefinitionProperty.getDescription()
filterControls
(List<? extends Object> filterControls) Sets the value ofCfnTemplate.SheetDefinitionProperty.getFilterControls()
filterControls
(IResolvable filterControls) Sets the value ofCfnTemplate.SheetDefinitionProperty.getFilterControls()
Sets the value ofCfnTemplate.SheetDefinitionProperty.getLayouts()
layouts
(IResolvable layouts) Sets the value ofCfnTemplate.SheetDefinitionProperty.getLayouts()
Sets the value ofCfnTemplate.SheetDefinitionProperty.getName()
parameterControls
(List<? extends Object> parameterControls) Sets the value ofCfnTemplate.SheetDefinitionProperty.getParameterControls()
parameterControls
(IResolvable parameterControls) Sets the value ofCfnTemplate.SheetDefinitionProperty.getParameterControls()
sheetControlLayouts
(List<? extends Object> sheetControlLayouts) Sets the value ofCfnTemplate.SheetDefinitionProperty.getSheetControlLayouts()
sheetControlLayouts
(IResolvable sheetControlLayouts) Sets the value ofCfnTemplate.SheetDefinitionProperty.getSheetControlLayouts()
Sets the value ofCfnTemplate.SheetDefinitionProperty.getSheetId()
Sets the value ofCfnTemplate.SheetDefinitionProperty.getTextBoxes()
textBoxes
(IResolvable textBoxes) Sets the value ofCfnTemplate.SheetDefinitionProperty.getTextBoxes()
Sets the value ofCfnTemplate.SheetDefinitionProperty.getTitle()
Sets the value ofCfnTemplate.SheetDefinitionProperty.getVisuals()
visuals
(IResolvable visuals) Sets the value ofCfnTemplate.SheetDefinitionProperty.getVisuals()
-
Constructor Details
-
Builder
public Builder()
-
-
Method Details
-
sheetId
Sets the value ofCfnTemplate.SheetDefinitionProperty.getSheetId()
- Parameters:
sheetId
- The unique identifier of a sheet. This parameter is required.- Returns:
this
-
contentType
@Stability(Stable) public CfnTemplate.SheetDefinitionProperty.Builder contentType(String contentType) Sets the value ofCfnTemplate.SheetDefinitionProperty.getContentType()
- Parameters:
contentType
- 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.
- Returns:
this
-
description
@Stability(Stable) public CfnTemplate.SheetDefinitionProperty.Builder description(String description) Sets the value ofCfnTemplate.SheetDefinitionProperty.getDescription()
- Parameters:
description
- A description of the sheet.- Returns:
this
-
filterControls
@Stability(Stable) public CfnTemplate.SheetDefinitionProperty.Builder filterControls(IResolvable filterControls) Sets the value ofCfnTemplate.SheetDefinitionProperty.getFilterControls()
- Parameters:
filterControls
- 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 .- Returns:
this
-
filterControls
@Stability(Stable) public CfnTemplate.SheetDefinitionProperty.Builder filterControls(List<? extends Object> filterControls) Sets the value ofCfnTemplate.SheetDefinitionProperty.getFilterControls()
- Parameters:
filterControls
- 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 .- Returns:
this
-
layouts
Sets the value ofCfnTemplate.SheetDefinitionProperty.getLayouts()
- Parameters:
layouts
- Layouts define how the components of a sheet are arranged. For more information, see Types of layout in the Amazon QuickSight User Guide .- Returns:
this
-
layouts
@Stability(Stable) public CfnTemplate.SheetDefinitionProperty.Builder layouts(List<? extends Object> layouts) Sets the value ofCfnTemplate.SheetDefinitionProperty.getLayouts()
- Parameters:
layouts
- Layouts define how the components of a sheet are arranged. For more information, see Types of layout in the Amazon QuickSight User Guide .- Returns:
this
-
name
Sets the value ofCfnTemplate.SheetDefinitionProperty.getName()
- Parameters:
name
- The name of the sheet. This name is displayed on the sheet's tab in the Amazon QuickSight console.- Returns:
this
-
parameterControls
@Stability(Stable) public CfnTemplate.SheetDefinitionProperty.Builder parameterControls(IResolvable parameterControls) Sets the value ofCfnTemplate.SheetDefinitionProperty.getParameterControls()
- Parameters:
parameterControls
- 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 .- Returns:
this
-
parameterControls
@Stability(Stable) public CfnTemplate.SheetDefinitionProperty.Builder parameterControls(List<? extends Object> parameterControls) Sets the value ofCfnTemplate.SheetDefinitionProperty.getParameterControls()
- Parameters:
parameterControls
- 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 .- Returns:
this
-
sheetControlLayouts
@Stability(Stable) public CfnTemplate.SheetDefinitionProperty.Builder sheetControlLayouts(IResolvable sheetControlLayouts) Sets the value ofCfnTemplate.SheetDefinitionProperty.getSheetControlLayouts()
- Parameters:
sheetControlLayouts
- The control layouts of the sheet.- Returns:
this
-
sheetControlLayouts
@Stability(Stable) public CfnTemplate.SheetDefinitionProperty.Builder sheetControlLayouts(List<? extends Object> sheetControlLayouts) Sets the value ofCfnTemplate.SheetDefinitionProperty.getSheetControlLayouts()
- Parameters:
sheetControlLayouts
- The control layouts of the sheet.- Returns:
this
-
textBoxes
@Stability(Stable) public CfnTemplate.SheetDefinitionProperty.Builder textBoxes(IResolvable textBoxes) Sets the value ofCfnTemplate.SheetDefinitionProperty.getTextBoxes()
- Parameters:
textBoxes
- The text boxes that are on a sheet.- Returns:
this
-
textBoxes
@Stability(Stable) public CfnTemplate.SheetDefinitionProperty.Builder textBoxes(List<? extends Object> textBoxes) Sets the value ofCfnTemplate.SheetDefinitionProperty.getTextBoxes()
- Parameters:
textBoxes
- The text boxes that are on a sheet.- Returns:
this
-
title
Sets the value ofCfnTemplate.SheetDefinitionProperty.getTitle()
- Parameters:
title
- The title of the sheet.- Returns:
this
-
visuals
Sets the value ofCfnTemplate.SheetDefinitionProperty.getVisuals()
- Parameters:
visuals
- A list of the visuals that are on a sheet. Visual placement is determined by the layout of the sheet.- Returns:
this
-
visuals
@Stability(Stable) public CfnTemplate.SheetDefinitionProperty.Builder visuals(List<? extends Object> visuals) Sets the value ofCfnTemplate.SheetDefinitionProperty.getVisuals()
- Parameters:
visuals
- A list of the visuals that are on a sheet. Visual placement is determined by the layout of the sheet.- Returns:
this
-
build
Builds the configured instance.- Specified by:
build
in interfacesoftware.amazon.jsii.Builder<CfnTemplate.SheetDefinitionProperty>
- Returns:
- a new instance of
CfnTemplate.SheetDefinitionProperty
- Throws:
NullPointerException
- if any required attribute was not provided
-