Class CfnDashboardProps.Builder
java.lang.Object
software.amazon.awscdk.services.quicksight.CfnDashboardProps.Builder
- All Implemented Interfaces:
software.amazon.jsii.Builder<CfnDashboardProps>
- Enclosing interface:
- CfnDashboardProps
@Stability(Stable)
public static final class CfnDashboardProps.Builder
extends Object
implements software.amazon.jsii.Builder<CfnDashboardProps>
A builder for
CfnDashboardProps
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionawsAccountId
(String awsAccountId) Sets the value ofCfnDashboardProps.getAwsAccountId()
build()
Builds the configured instance.dashboardId
(String dashboardId) Sets the value ofCfnDashboardProps.getDashboardId()
dashboardPublishOptions
(IResolvable dashboardPublishOptions) Sets the value ofCfnDashboardProps.getDashboardPublishOptions()
dashboardPublishOptions
(CfnDashboard.DashboardPublishOptionsProperty dashboardPublishOptions) Sets the value ofCfnDashboardProps.getDashboardPublishOptions()
definition
(IResolvable definition) Sets the value ofCfnDashboardProps.getDefinition()
Sets the value ofCfnDashboardProps.getDefinition()
Sets the value ofCfnDashboardProps.getName()
parameters
(IResolvable parameters) Sets the value ofCfnDashboardProps.getParameters()
parameters
(CfnDashboard.ParametersProperty parameters) Sets the value ofCfnDashboardProps.getParameters()
permissions
(List<? extends Object> permissions) Sets the value ofCfnDashboardProps.getPermissions()
permissions
(IResolvable permissions) Sets the value ofCfnDashboardProps.getPermissions()
sourceEntity
(IResolvable sourceEntity) Sets the value ofCfnDashboardProps.getSourceEntity()
sourceEntity
(CfnDashboard.DashboardSourceEntityProperty sourceEntity) Sets the value ofCfnDashboardProps.getSourceEntity()
Sets the value ofCfnDashboardProps.getTags()
Sets the value ofCfnDashboardProps.getThemeArn()
versionDescription
(String versionDescription) Sets the value ofCfnDashboardProps.getVersionDescription()
-
Constructor Details
-
Builder
public Builder()
-
-
Method Details
-
awsAccountId
Sets the value ofCfnDashboardProps.getAwsAccountId()
- Parameters:
awsAccountId
- The ID of the AWS account where you want to create the dashboard. This parameter is required.- Returns:
this
-
dashboardId
Sets the value ofCfnDashboardProps.getDashboardId()
- Parameters:
dashboardId
- The ID for the dashboard, also added to the IAM policy. This parameter is required.- Returns:
this
-
name
Sets the value ofCfnDashboardProps.getName()
- Parameters:
name
- The display name of the dashboard. This parameter is required.- Returns:
this
-
dashboardPublishOptions
@Stability(Stable) public CfnDashboardProps.Builder dashboardPublishOptions(IResolvable dashboardPublishOptions) Sets the value ofCfnDashboardProps.getDashboardPublishOptions()
- Parameters:
dashboardPublishOptions
- Options for publishing the dashboard when you create it:.AvailabilityStatus
forAdHocFilteringOption
- This status can be eitherENABLED
orDISABLED
. When this is set toDISABLED
, Amazon QuickSight disables the left filter pane on the published dashboard, which can be used for ad hoc (one-time) filtering. This option isENABLED
by default.AvailabilityStatus
forExportToCSVOption
- This status can be eitherENABLED
orDISABLED
. The visual option to export data to .CSV format isn't enabled when this is set toDISABLED
. This option isENABLED
by default.VisibilityState
forSheetControlsOption
- This visibility state can be eitherCOLLAPSED
orEXPANDED
. This option isCOLLAPSED
by default.
- Returns:
this
-
dashboardPublishOptions
@Stability(Stable) public CfnDashboardProps.Builder dashboardPublishOptions(CfnDashboard.DashboardPublishOptionsProperty dashboardPublishOptions) Sets the value ofCfnDashboardProps.getDashboardPublishOptions()
- Parameters:
dashboardPublishOptions
- Options for publishing the dashboard when you create it:.AvailabilityStatus
forAdHocFilteringOption
- This status can be eitherENABLED
orDISABLED
. When this is set toDISABLED
, Amazon QuickSight disables the left filter pane on the published dashboard, which can be used for ad hoc (one-time) filtering. This option isENABLED
by default.AvailabilityStatus
forExportToCSVOption
- This status can be eitherENABLED
orDISABLED
. The visual option to export data to .CSV format isn't enabled when this is set toDISABLED
. This option isENABLED
by default.VisibilityState
forSheetControlsOption
- This visibility state can be eitherCOLLAPSED
orEXPANDED
. This option isCOLLAPSED
by default.
- Returns:
this
-
definition
Sets the value ofCfnDashboardProps.getDefinition()
- Parameters:
definition
-AWS::QuickSight::Dashboard.Definition
.- Returns:
this
-
definition
@Stability(Stable) public CfnDashboardProps.Builder definition(CfnDashboard.DashboardVersionDefinitionProperty definition) Sets the value ofCfnDashboardProps.getDefinition()
- Parameters:
definition
-AWS::QuickSight::Dashboard.Definition
.- Returns:
this
-
parameters
Sets the value ofCfnDashboardProps.getParameters()
- Parameters:
parameters
- The parameters for the creation of the dashboard, which you want to use to override the default settings. A dashboard can have any type of parameters, and some parameters might accept multiple values.- Returns:
this
-
parameters
@Stability(Stable) public CfnDashboardProps.Builder parameters(CfnDashboard.ParametersProperty parameters) Sets the value ofCfnDashboardProps.getParameters()
- Parameters:
parameters
- The parameters for the creation of the dashboard, which you want to use to override the default settings. A dashboard can have any type of parameters, and some parameters might accept multiple values.- Returns:
this
-
permissions
Sets the value ofCfnDashboardProps.getPermissions()
- Parameters:
permissions
- A structure that contains the permissions of the dashboard. You can use this structure for granting permissions by providing a list of IAM action information for each principal ARN.To specify no permissions, omit the permissions list.
- Returns:
this
-
permissions
Sets the value ofCfnDashboardProps.getPermissions()
- Parameters:
permissions
- A structure that contains the permissions of the dashboard. You can use this structure for granting permissions by providing a list of IAM action information for each principal ARN.To specify no permissions, omit the permissions list.
- Returns:
this
-
sourceEntity
Sets the value ofCfnDashboardProps.getSourceEntity()
- Parameters:
sourceEntity
- The entity that you are using as a source when you create the dashboard. InSourceEntity
, you specify the type of object that you want to use. You can only create a dashboard from a template, so you use aSourceTemplate
entity. If you need to create a dashboard from an analysis, first convert the analysis to a template by using theCreateTemplate
API operation. ForSourceTemplate
, specify the Amazon Resource Name (ARN) of the source template. TheSourceTemplate
ARN can contain any AWS account; and any QuickSight-supported AWS Region .Use the
DataSetReferences
entity withinSourceTemplate
to list the replacement datasets for the placeholders listed in the original. The schema in each dataset must match its placeholder.- Returns:
this
-
sourceEntity
@Stability(Stable) public CfnDashboardProps.Builder sourceEntity(CfnDashboard.DashboardSourceEntityProperty sourceEntity) Sets the value ofCfnDashboardProps.getSourceEntity()
- Parameters:
sourceEntity
- The entity that you are using as a source when you create the dashboard. InSourceEntity
, you specify the type of object that you want to use. You can only create a dashboard from a template, so you use aSourceTemplate
entity. If you need to create a dashboard from an analysis, first convert the analysis to a template by using theCreateTemplate
API operation. ForSourceTemplate
, specify the Amazon Resource Name (ARN) of the source template. TheSourceTemplate
ARN can contain any AWS account; and any QuickSight-supported AWS Region .Use the
DataSetReferences
entity withinSourceTemplate
to list the replacement datasets for the placeholders listed in the original. The schema in each dataset must match its placeholder.- Returns:
this
-
tags
Sets the value ofCfnDashboardProps.getTags()
- Parameters:
tags
- Contains a map of the key-value pairs for the resource tag or tags assigned to the dashboard.- Returns:
this
-
themeArn
Sets the value ofCfnDashboardProps.getThemeArn()
- Parameters:
themeArn
- The Amazon Resource Name (ARN) of the theme that is being used for this dashboard. If you add a value for this field, it overrides the value that is used in the source entity. The theme ARN must exist in the same AWS account where you create the dashboard.- Returns:
this
-
versionDescription
Sets the value ofCfnDashboardProps.getVersionDescription()
- Parameters:
versionDescription
- A description for the first version of the dashboard being created.- Returns:
this
-
build
Builds the configured instance.- Specified by:
build
in interfacesoftware.amazon.jsii.Builder<CfnDashboardProps>
- Returns:
- a new instance of
CfnDashboardProps
- Throws:
NullPointerException
- if any required attribute was not provided
-