software.amazon.awscdk.services.quicksight

Class CfnDashboard.Builder

java.lang.Object

software.amazon.awscdk.services.quicksight.CfnDashboard.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnDashboard>

Enclosing class:

CfnDashboard

@Stability(value=Stable)
public static final class CfnDashboard.Builder
extends Object
implements software.amazon.jsii.Builder<CfnDashboard>

A fluent builder for CfnDashboard.

Method Summary

Modifier and Type	Method and Description
CfnDashboard.Builder	awsAccountId(String awsAccountId) The ID of the AWS account where you want to create the dashboard.
CfnDashboard	build()
static CfnDashboard.Builder	create(software.constructs.Construct scope, String id)
CfnDashboard.Builder	dashboardId(String dashboardId) The ID for the dashboard, also added to the IAM policy.
CfnDashboard.Builder	dashboardPublishOptions(CfnDashboard.DashboardPublishOptionsProperty dashboardPublishOptions) Options for publishing the dashboard when you create it:.
CfnDashboard.Builder	dashboardPublishOptions(IResolvable dashboardPublishOptions) Options for publishing the dashboard when you create it:.
CfnDashboard.Builder	name(String name) The display name of the dashboard.
CfnDashboard.Builder	parameters(CfnDashboard.ParametersProperty parameters) The parameters for the creation of the dashboard, which you want to use to override the default settings.
CfnDashboard.Builder	parameters(IResolvable parameters) The parameters for the creation of the dashboard, which you want to use to override the default settings.
CfnDashboard.Builder	permissions(IResolvable permissions) A structure that contains the permissions of the dashboard.
CfnDashboard.Builder	permissions(List<? extends Object> permissions) A structure that contains the permissions of the dashboard.
CfnDashboard.Builder	sourceEntity(CfnDashboard.DashboardSourceEntityProperty sourceEntity) The entity that you are using as a source when you create the dashboard.
CfnDashboard.Builder	sourceEntity(IResolvable sourceEntity) The entity that you are using as a source when you create the dashboard.
CfnDashboard.Builder	tags(List<? extends CfnTag> tags) Contains a map of the key-value pairs for the resource tag or tags assigned to the dashboard.
CfnDashboard.Builder	themeArn(String themeArn) The Amazon Resource Name (ARN) of the theme that is being used for this dashboard.
CfnDashboard.Builder	versionDescription(String versionDescription) A description for the first version of the dashboard being created.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

create

@Stability(value=Stable)
public static CfnDashboard.Builder create(software.constructs.Construct scope,
                                                                   String id)

Parameters:

scope - - scope in which this resource is defined. This parameter is required.

id - - scoped id of the resource. This parameter is required.

Returns:

a new instance of CfnDashboard.AdHocFilteringOptionProperty.Builder.

awsAccountId

@Stability(value=Stable)
public CfnDashboard.Builder awsAccountId(String awsAccountId)

The ID of the AWS account where you want to create the dashboard.

Parameters:

awsAccountId - The ID of the AWS account where you want to create the dashboard. This parameter is required.

Returns:

this

dashboardId

@Stability(value=Stable)
public CfnDashboard.Builder dashboardId(String dashboardId)

The ID for the dashboard, also added to the IAM policy.

Parameters:

dashboardId - The ID for the dashboard, also added to the IAM policy. This parameter is required.

Returns:

this

sourceEntity

@Stability(value=Stable)
public CfnDashboard.Builder sourceEntity(CfnDashboard.DashboardSourceEntityProperty sourceEntity)

The entity that you are using as a source when you create the dashboard.

In SourceEntity , you specify the type of object that you want to use. You can only create a dashboard from a template, so you use a SourceTemplate entity. If you need to create a dashboard from an analysis, first convert the analysis to a template by using the CreateTemplate API operation. For SourceTemplate , specify the Amazon Resource Name (ARN) of the source template. The SourceTemplate ARN can contain any AWS account; and any QuickSight-supported AWS Region .

Use the DataSetReferences entity within SourceTemplate to list the replacement datasets for the placeholders listed in the original. The schema in each dataset must match its placeholder.

Parameters:

sourceEntity - The entity that you are using as a source when you create the dashboard. This parameter is required.

Returns:

this

sourceEntity

@Stability(value=Stable)
public CfnDashboard.Builder sourceEntity(IResolvable sourceEntity)

The entity that you are using as a source when you create the dashboard.

In SourceEntity , you specify the type of object that you want to use. You can only create a dashboard from a template, so you use a SourceTemplate entity. If you need to create a dashboard from an analysis, first convert the analysis to a template by using the CreateTemplate API operation. For SourceTemplate , specify the Amazon Resource Name (ARN) of the source template. The SourceTemplate ARN can contain any AWS account; and any QuickSight-supported AWS Region .

Use the DataSetReferences entity within SourceTemplate to list the replacement datasets for the placeholders listed in the original. The schema in each dataset must match its placeholder.

Parameters:

sourceEntity - The entity that you are using as a source when you create the dashboard. This parameter is required.

Returns:

this

dashboardPublishOptions

@Stability(value=Stable)
public CfnDashboard.Builder dashboardPublishOptions(CfnDashboard.DashboardPublishOptionsProperty dashboardPublishOptions)

Options for publishing the dashboard when you create it:.

• AvailabilityStatus for AdHocFilteringOption - This status can be either ENABLED or DISABLED . When this is set to DISABLED , Amazon QuickSight disables the left filter pane on the published dashboard, which can be used for ad hoc (one-time) filtering. This option is ENABLED by default.
• AvailabilityStatus for ExportToCSVOption - This status can be either ENABLED or DISABLED . The visual option to export data to .CSV format isn't enabled when this is set to DISABLED . This option is ENABLED by default.
• VisibilityState for SheetControlsOption - This visibility state can be either COLLAPSED or EXPANDED . This option is COLLAPSED by default.

Parameters:

dashboardPublishOptions - Options for publishing the dashboard when you create it:. This parameter is required.

Returns:

this

dashboardPublishOptions

@Stability(value=Stable)
public CfnDashboard.Builder dashboardPublishOptions(IResolvable dashboardPublishOptions)

Options for publishing the dashboard when you create it:.

• AvailabilityStatus for AdHocFilteringOption - This status can be either ENABLED or DISABLED . When this is set to DISABLED , Amazon QuickSight disables the left filter pane on the published dashboard, which can be used for ad hoc (one-time) filtering. This option is ENABLED by default.
• AvailabilityStatus for ExportToCSVOption - This status can be either ENABLED or DISABLED . The visual option to export data to .CSV format isn't enabled when this is set to DISABLED . This option is ENABLED by default.
• VisibilityState for SheetControlsOption - This visibility state can be either COLLAPSED or EXPANDED . This option is COLLAPSED by default.

Parameters:

dashboardPublishOptions - Options for publishing the dashboard when you create it:. This parameter is required.

Returns:

this

name

@Stability(value=Stable)
public CfnDashboard.Builder name(String name)

The display name of the dashboard.

Parameters:

name - The display name of the dashboard. This parameter is required.

Returns:

this

parameters

@Stability(value=Stable)
public CfnDashboard.Builder parameters(CfnDashboard.ParametersProperty 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.

Parameters:

parameters - The parameters for the creation of the dashboard, which you want to use to override the default settings. This parameter is required.

Returns:

this

parameters

@Stability(value=Stable)
public CfnDashboard.Builder parameters(IResolvable 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.

Parameters:

parameters - The parameters for the creation of the dashboard, which you want to use to override the default settings. This parameter is required.

Returns:

this

permissions

@Stability(value=Stable)
public CfnDashboard.Builder permissions(IResolvable 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.

Parameters:

permissions - A structure that contains the permissions of the dashboard. This parameter is required.

Returns:

this

permissions

@Stability(value=Stable)
public CfnDashboard.Builder permissions(List<? extends Object> 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.

Parameters:

permissions - A structure that contains the permissions of the dashboard. This parameter is required.

Returns:

this

tags

@Stability(value=Stable)
public CfnDashboard.Builder tags(List<? extends CfnTag> tags)

Contains a map of the key-value pairs for the resource tag or tags assigned to the dashboard.

Parameters:

tags - Contains a map of the key-value pairs for the resource tag or tags assigned to the dashboard. This parameter is required.

Returns:

this

themeArn

@Stability(value=Stable)
public CfnDashboard.Builder themeArn(String 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.

Parameters:

themeArn - The Amazon Resource Name (ARN) of the theme that is being used for this dashboard. This parameter is required.

Returns:

this

versionDescription

@Stability(value=Stable)
public CfnDashboard.Builder versionDescription(String versionDescription)

A description for the first version of the dashboard being created.

Parameters:

versionDescription - A description for the first version of the dashboard being created. This parameter is required.

Returns:

this

build

@Stability(value=Stable)
public CfnDashboard build()

Specified by:

build in interface software.amazon.jsii.Builder<CfnDashboard>