Package software.amazon.awscdk.services.quicksight

Interface CfnDashboardProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnDashboardProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.94.0 (build b380f01)",
           date="2024-03-14T22:21:59.862Z")
@Stability(Stable)
public interface CfnDashboardProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a CfnDashboard.

Example:

See Also:

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

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnDashboardProps.Builder	builder()
String	getAwsAccountId()	The ID of the AWS account where you want to create the dashboard.
String	getDashboardId()	The ID for the dashboard, also added to the IAM policy.
default Object	getDashboardPublishOptions()	Options for publishing the dashboard when you create it:.
default Object	getDefinition()
default List<String>	getLinkEntities()	A list of analysis Amazon Resource Names (ARNs) to be linked to the dashboard.
default Object	getLinkSharingConfiguration()	A structure that contains the link sharing configurations that you want to apply overrides to.
String	getName()	The display name of the dashboard.
default Object	getParameters()	The parameters for the creation of the dashboard, which you want to use to override the default settings.
default Object	getPermissions()	A structure that contains the permissions of the dashboard.
default Object	getSourceEntity()	The entity that you are using as a source when you create the dashboard.
default List<CfnTag>	getTags()	Contains a map of the key-value pairs for the resource tag or tags assigned to the dashboard.
default String	getThemeArn()	The Amazon Resource Name (ARN) of the theme that is being used for this dashboard.
default Object	getValidationStrategy()	The option to relax the validation that is required to create and update analyses, dashboards, and templates with definition objects.
default String	getVersionDescription()	A description for the first version of the dashboard being created.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getAwsAccountId

@Stability(Stable)
@NotNull
String getAwsAccountId()

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-quicksight-dashboard.html#cfn-quicksight-dashboard-awsaccountid

getDashboardId

@Stability(Stable)
@NotNull
String getDashboardId()

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-quicksight-dashboard.html#cfn-quicksight-dashboard-dashboardid

getName

@Stability(Stable)
@NotNull
String getName()

The display name of the dashboard.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-quicksight-dashboard.html#cfn-quicksight-dashboard-name

getDashboardPublishOptions

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

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.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-quicksight-dashboard.html#cfn-quicksight-dashboard-dashboardpublishoptions

getDefinition

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-quicksight-dashboard.html#cfn-quicksight-dashboard-definition

getLinkEntities

@Stability(Stable)
@Nullable
default List<String> getLinkEntities()

A list of analysis Amazon Resource Names (ARNs) to be linked to the dashboard.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-quicksight-dashboard.html#cfn-quicksight-dashboard-linkentities

getLinkSharingConfiguration

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

A structure that contains the link sharing configurations that you want to apply overrides to.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-quicksight-dashboard.html#cfn-quicksight-dashboard-linksharingconfiguration

getParameters

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

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.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-quicksight-dashboard.html#cfn-quicksight-dashboard-parameters

getPermissions

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

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.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-quicksight-dashboard.html#cfn-quicksight-dashboard-permissions

getSourceEntity

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

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.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-quicksight-dashboard.html#cfn-quicksight-dashboard-sourceentity

getTags

@Stability(Stable)
@Nullable
default List<CfnTag> getTags()

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-quicksight-dashboard.html#cfn-quicksight-dashboard-tags

getThemeArn

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

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.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-quicksight-dashboard.html#cfn-quicksight-dashboard-themearn

getValidationStrategy

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

The option to relax the validation that is required to create and update analyses, dashboards, and templates with definition objects.

When you set this value to LENIENT , validation is skipped for specific errors.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-quicksight-dashboard.html#cfn-quicksight-dashboard-validationstrategy

getVersionDescription

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

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-quicksight-dashboard.html#cfn-quicksight-dashboard-versiondescription

builder

@Stability(Stable)
static CfnDashboardProps.Builder builder()

Returns:

a CfnDashboardProps.Builder of CfnDashboardProps