software.amazon.awscdk.services.quicksight

Class CfnDashboard

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.core.Construct

software.amazon.awscdk.core.CfnElement

software.amazon.awscdk.core.CfnRefElement

software.amazon.awscdk.core.CfnResource

software.amazon.awscdk.services.quicksight.CfnDashboard

All Implemented Interfaces:

IDependable, IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct

@Generated(value="jsii-pacmak/1.71.0 (build f1f58ae)",
           date="2022-12-07T17:24:37.698Z")
 @Stability(value=Stable)
public class CfnDashboard
extends CfnResource
implements IInspectable

A CloudFormation `AWS::QuickSight::Dashboard`.

Creates a dashboard from a template. To first create a template, see the CreateTemplate API operation.

A dashboard is an entity in Amazon QuickSight that identifies Amazon QuickSight reports, created from analyses. You can share Amazon QuickSight dashboards. With the right permissions, you can create scheduled email reports from them. If you have the correct permissions, you can create a dashboard from a template that exists in a different AWS account .

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.*;
 CfnDashboard cfnDashboard = CfnDashboard.Builder.create(this, "MyCfnDashboard")
         .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	Class and Description
static interface	CfnDashboard.AdHocFilteringOptionProperty An ad hoc (one-time) filtering option.
static class	CfnDashboard.Builder A fluent builder for CfnDashboard.
static interface	CfnDashboard.DashboardPublishOptionsProperty Dashboard publish options.
static interface	CfnDashboard.DashboardSourceEntityProperty Dashboard source entity.
static interface	CfnDashboard.DashboardSourceTemplateProperty Dashboard source template.
static interface	CfnDashboard.DataSetReferenceProperty Dataset reference.
static interface	CfnDashboard.DateTimeParameterProperty A date-time parameter.
static interface	CfnDashboard.DecimalParameterProperty A decimal parameter.
static interface	CfnDashboard.ExportToCSVOptionProperty Export to .csv option.
static interface	CfnDashboard.IntegerParameterProperty An integer parameter.
static interface	CfnDashboard.ParametersProperty A list of Amazon QuickSight parameters and the list's override values.
static interface	CfnDashboard.ResourcePermissionProperty Permission for the resource.
static interface	CfnDashboard.SheetControlsOptionProperty Sheet controls option.
static interface	CfnDashboard.StringParameterProperty A string parameter.

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IConstruct

IConstruct.Jsii$Default

Field Summary

Fields

Modifier and Type	Field and Description
static String	CFN_RESOURCE_TYPE_NAME The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors

Modifier	Constructor and Description
	CfnDashboard(Construct scope, String id, CfnDashboardProps props) Create a new `AWS::QuickSight::Dashboard`.
protected	CfnDashboard(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnDashboard(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
String	getAttrArn() The Amazon Resource Name (ARN) of the dashboard.
String	getAttrCreatedTime() The time this dashboard version was created.
String	getAttrLastPublishedTime() The time that the dashboard was last published.
String	getAttrLastUpdatedTime() The time that the dashboard was last updated.
String	getAwsAccountId() The ID of the AWS account where you want to create the dashboard.
protected Map<String,Object>	getCfnProperties()
String	getDashboardId() The ID for the dashboard, also added to the IAM policy.
Object	getDashboardPublishOptions() Options for publishing the dashboard when you create it:.
String	getName() The display name of the dashboard.
Object	getParameters() The parameters for the creation of the dashboard, which you want to use to override the default settings.
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.
TagManager	getTags() Contains a map of the key-value pairs for the resource tag or tags assigned to the dashboard.
String	getThemeArn() The Amazon Resource Name (ARN) of the theme that is being used for this dashboard.
String	getVersionDescription() A description for the first version of the dashboard being created.
void	inspect(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setAwsAccountId(String value) The ID of the AWS account where you want to create the dashboard.
void	setDashboardId(String value) The ID for the dashboard, also added to the IAM policy.
void	setDashboardPublishOptions(CfnDashboard.DashboardPublishOptionsProperty value) Options for publishing the dashboard when you create it:.
void	setDashboardPublishOptions(IResolvable value) Options for publishing the dashboard when you create it:.
void	setName(String value) The display name of the dashboard.
void	setParameters(CfnDashboard.ParametersProperty value) The parameters for the creation of the dashboard, which you want to use to override the default settings.
void	setParameters(IResolvable value) The parameters for the creation of the dashboard, which you want to use to override the default settings.
void	setPermissions(IResolvable value) A structure that contains the permissions of the dashboard.
void	setPermissions(List<Object> value) A structure that contains the permissions of the dashboard.
void	setSourceEntity(CfnDashboard.DashboardSourceEntityProperty value) The entity that you are using as a source when you create the dashboard.
void	setSourceEntity(IResolvable value) The entity that you are using as a source when you create the dashboard.
void	setThemeArn(String value) The Amazon Resource Name (ARN) of the theme that is being used for this dashboard.
void	setVersionDescription(String value) A description for the first version of the dashboard being created.

Methods inherited from class software.amazon.awscdk.core.CfnResource

addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, isCfnResource, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.core.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.core.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.amazon.awscdk.core.Construct

getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

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

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Detail

CFN_RESOURCE_TYPE_NAME

@Stability(value=Stable)
public static final String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Detail

CfnDashboard

protected CfnDashboard(software.amazon.jsii.JsiiObjectRef objRef)

CfnDashboard

protected CfnDashboard(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

CfnDashboard

@Stability(value=Stable)
public CfnDashboard(@NotNull
                                             Construct scope,
                                             @NotNull
                                             String id,
                                             @NotNull
                                             CfnDashboardProps props)

Create a new `AWS::QuickSight::Dashboard`.

Parameters:

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

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

props - - resource properties. This parameter is required.

Method Detail

inspect

@Stability(value=Stable)
public void inspect(@NotNull
                                             TreeInspector inspector)

Examines the CloudFormation resource and discloses attributes.

Specified by:

inspect in interface IInspectable

Parameters:

inspector - - tree inspector to collect and process attributes. This parameter is required.

renderProperties

@Stability(value=Stable)
 @NotNull
protected Map<String,Object> renderProperties(@NotNull
                                                                                 Map<String,Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getAttrArn

@Stability(value=Stable)
 @NotNull
public String getAttrArn()

The Amazon Resource Name (ARN) of the dashboard.

getAttrCreatedTime

@Stability(value=Stable)
 @NotNull
public String getAttrCreatedTime()

The time this dashboard version was created.

getAttrLastPublishedTime

@Stability(value=Stable)
 @NotNull
public String getAttrLastPublishedTime()

The time that the dashboard was last published.

getAttrLastUpdatedTime

@Stability(value=Stable)
 @NotNull
public String getAttrLastUpdatedTime()

The time that the dashboard was last updated.

getCfnProperties

@Stability(value=Stable)
 @NotNull
protected Map<String,Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getTags

@Stability(value=Stable)
 @NotNull
public TagManager getTags()

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

getAwsAccountId

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

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

setAwsAccountId

@Stability(value=Stable)
public void setAwsAccountId(@NotNull
                                                     String value)

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

getDashboardId

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

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

setDashboardId

@Stability(value=Stable)
public void setDashboardId(@NotNull
                                                    String value)

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

getSourceEntity

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

setSourceEntity

@Stability(value=Stable)
public void setSourceEntity(@NotNull
                                                     IResolvable value)

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.

setSourceEntity

@Stability(value=Stable)
public void setSourceEntity(@NotNull
                                                     CfnDashboard.DashboardSourceEntityProperty value)

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
public 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.

setDashboardPublishOptions

@Stability(value=Stable)
public void setDashboardPublishOptions(@Nullable
                                                                IResolvable value)

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.

setDashboardPublishOptions

@Stability(value=Stable)
public void setDashboardPublishOptions(@Nullable
                                                                CfnDashboard.DashboardPublishOptionsProperty value)

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
public String getName()

The display name of the dashboard.

setName

@Stability(value=Stable)
public void setName(@Nullable
                                             String value)

The display name of the dashboard.

getParameters

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

setParameters

@Stability(value=Stable)
public void setParameters(@Nullable
                                                   IResolvable value)

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.

setParameters

@Stability(value=Stable)
public void setParameters(@Nullable
                                                   CfnDashboard.ParametersProperty value)

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
public 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.

setPermissions

@Stability(value=Stable)
public void setPermissions(@Nullable
                                                    IResolvable value)

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.

setPermissions

@Stability(value=Stable)
public void setPermissions(@Nullable
                                                    List<Object> value)

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.

getThemeArn

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

setThemeArn

@Stability(value=Stable)
public void setThemeArn(@Nullable
                                                 String value)

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
public String getVersionDescription()

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

setVersionDescription

@Stability(value=Stable)
public void setVersionDescription(@Nullable
                                                           String value)

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