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.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:41.284Z")
 @Stability(value=Stable)
public interface CfnDashboardProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a `CfnDashboard`.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.quicksight.*;
 CfnDashboardProps cfnDashboardProps = CfnDashboardProps.builder()
         .awsAccountId("awsAccountId")
         .dashboardId("dashboardId")
         .sourceEntity(DashboardSourceEntityProperty.builder()
                 .sourceTemplate(DashboardSourceTemplateProperty.builder()
                         .arn("arn")
                         .dataSetReferences(List.of(DataSetReferenceProperty.builder()
                                 .dataSetArn("dataSetArn")
                                 .dataSetPlaceholder("dataSetPlaceholder")
                                 .build()))
                         .build())
                 .build())
         // the properties below are optional
         .dashboardPublishOptions(DashboardPublishOptionsProperty.builder()
                 .adHocFilteringOption(AdHocFilteringOptionProperty.builder()
                         .availabilityStatus("availabilityStatus")
                         .build())
                 .exportToCsvOption(ExportToCSVOptionProperty.builder()
                         .availabilityStatus("availabilityStatus")
                         .build())
                 .sheetControlsOption(SheetControlsOptionProperty.builder()
                         .visibilityState("visibilityState")
                         .build())
                 .build())
         .name("name")
         .parameters(ParametersProperty.builder()
                 .dateTimeParameters(List.of(DateTimeParameterProperty.builder()
                         .name("name")
                         .values(List.of("values"))
                         .build()))
                 .decimalParameters(List.of(DecimalParameterProperty.builder()
                         .name("name")
                         .values(List.of(123))
                         .build()))
                 .integerParameters(List.of(IntegerParameterProperty.builder()
                         .name("name")
                         .values(List.of(123))
                         .build()))
                 .stringParameters(List.of(StringParameterProperty.builder()
                         .name("name")
                         .values(List.of("values"))
                         .build()))
                 .build())
         .permissions(List.of(ResourcePermissionProperty.builder()
                 .actions(List.of("actions"))
                 .principal("principal")
                 .build()))
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .themeArn("themeArn")
         .versionDescription("versionDescription")
         .build();
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and 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 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.
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 String	getVersionDescription() A description for the first version of the dashboard being created.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getAwsAccountId

@Stability(value=Stable)
 @NotNull
String getAwsAccountId()

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

getDashboardId

@Stability(value=Stable)
 @NotNull
String getDashboardId()

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

getSourceEntity

@Stability(value=Stable)
 @NotNull
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.

getDashboardPublishOptions

@Stability(value=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.

getName

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

The display name of the dashboard.

getParameters

@Stability(value=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.

getPermissions

@Stability(value=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.

getTags

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

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

getThemeArn

@Stability(value=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.

getVersionDescription

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

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

builder

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

Returns:

a CfnDashboardProps.Builder of CfnDashboardProps