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.46.0 (build cd08c55)",
           date="2021-11-25T20:11:07.518Z")
 @Stability(value=Stable)
public interface CfnDashboardProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a `AWS::QuickSight::Dashboard`.

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() `AWS::QuickSight::Dashboard.AwsAccountId`.
String	getDashboardId() `AWS::QuickSight::Dashboard.DashboardId`.
default Object	getDashboardPublishOptions() `AWS::QuickSight::Dashboard.DashboardPublishOptions`.
default String	getName() `AWS::QuickSight::Dashboard.Name`.
default Object	getParameters() `AWS::QuickSight::Dashboard.Parameters`.
default Object	getPermissions() `AWS::QuickSight::Dashboard.Permissions`.
Object	getSourceEntity() `AWS::QuickSight::Dashboard.SourceEntity`.
default List<CfnTag>	getTags() `AWS::QuickSight::Dashboard.Tags`.
default String	getThemeArn() `AWS::QuickSight::Dashboard.ThemeArn`.
default String	getVersionDescription() `AWS::QuickSight::Dashboard.VersionDescription`.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getAwsAccountId

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

`AWS::QuickSight::Dashboard.AwsAccountId`.

getDashboardId

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

`AWS::QuickSight::Dashboard.DashboardId`.

getDashboardPublishOptions

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

`AWS::QuickSight::Dashboard.DashboardPublishOptions`.

getName

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

`AWS::QuickSight::Dashboard.Name`.

getParameters

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

`AWS::QuickSight::Dashboard.Parameters`.

getPermissions

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

`AWS::QuickSight::Dashboard.Permissions`.

getSourceEntity

@Stability(value=Stable)
 @NotNull
Object getSourceEntity()

`AWS::QuickSight::Dashboard.SourceEntity`.

getTags

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

`AWS::QuickSight::Dashboard.Tags`.

getThemeArn

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

`AWS::QuickSight::Dashboard.ThemeArn`.

getVersionDescription

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

`AWS::QuickSight::Dashboard.VersionDescription`.

builder

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

Returns:

a CfnDashboardProps.Builder of CfnDashboardProps