CfnDashboard

java.lang.Object
- 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:: IConstruct, IDependable, IInspectable

@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)",
           date="2023-03-22T19:35:39.384Z")
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.DashboardErrorProperty` Dashboard error.
`static interface`	`CfnDashboard.DashboardPublishOptionsProperty` Dashboard publish options.
`static interface`	`CfnDashboard.DashboardSourceEntityProperty` Dashboard source entity.
`static interface`	`CfnDashboard.DashboardSourceTemplateProperty` Dashboard source template.
`static interface`	`CfnDashboard.DashboardVersionProperty` Dashboard version.
`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.SheetProperty` A sheet , which is an object that contains a set of visuals that are viewed together on one page in Amazon QuickSight.
`static interface`	`CfnDashboard.StringParameterProperty` A string parameter.

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 java.lang.String CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.

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

Constructor Summary

Constructors
Modifier	Constructor and Description
	`CfnDashboard(Construct scope, java.lang.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

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`java.lang.String`	`getAttrArn()` The Amazon Resource Name (ARN) of the dashboard.
`java.lang.String`	`getAttrCreatedTime()` The time this dashboard version was created.
`java.lang.String`	`getAttrLastPublishedTime()` The time that the dashboard was last published.
`java.lang.String`	`getAttrLastUpdatedTime()` The time that the dashboard was last updated.
`java.lang.String`	`getAttrVersionArn()`
`java.lang.String`	`getAttrVersionCreatedTime()`
`java.util.List<java.lang.String>`	`getAttrVersionDataSetArns()`
`java.lang.String`	`getAttrVersionDescription()`
`IResolvable`	`getAttrVersionErrors()`
`IResolvable`	`getAttrVersionSheets()`
`java.lang.String`	`getAttrVersionSourceEntityArn()`
`java.lang.String`	`getAttrVersionStatus()`
`java.lang.String`	`getAttrVersionThemeArn()`
`IResolvable`	`getAttrVersionVersionNumber()`
`java.lang.String`	`getAwsAccountId()` The ID of the AWS account where you want to create the dashboard.
`protected java.util.Map<java.lang.String,java.lang.Object>`	`getCfnProperties()`
`java.lang.String`	`getDashboardId()` The ID for the dashboard, also added to the IAM policy.
`java.lang.Object`	`getDashboardPublishOptions()` Options for publishing the dashboard when you create it:.
`java.lang.String`	`getName()` The display name of the dashboard.
`java.lang.Object`	`getParameters()` The parameters for the creation of the dashboard, which you want to use to override the default settings.
`java.lang.Object`	`getPermissions()` A structure that contains the permissions of the dashboard.
`java.lang.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.
`java.lang.String`	`getThemeArn()` The Amazon Resource Name (ARN) of the theme that is being used for this dashboard.
`java.lang.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 java.util.Map<java.lang.String,java.lang.Object>`	`renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)`
`void`	`setAwsAccountId(java.lang.String value)` The ID of the AWS account where you want to create the dashboard.
`void`	`setDashboardId(java.lang.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(java.lang.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(java.util.List<java.lang.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(java.lang.String value)` The Amazon Resource Name (ARN) of the theme that is being used for this dashboard.
`void`	`setVersionDescription(java.lang.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 java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - CFN_RESOURCE_TYPE_NAME
```
public static final java.lang.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
```
public CfnDashboard(Construct scope,
                    java.lang.String id,
                    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
```
public void inspect(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
```
protected java.util.Map<java.lang.String,java.lang.Object> renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)
```
    Overrides:
    
    renderProperties in class CfnResource
    
    Parameters:
    
    props - This parameter is required.
  - getAttrArn
```
public java.lang.String getAttrArn()
```
    The Amazon Resource Name (ARN) of the dashboard.
  - getAttrCreatedTime
```
public java.lang.String getAttrCreatedTime()
```
    The time this dashboard version was created.
  - getAttrLastPublishedTime
```
public java.lang.String getAttrLastPublishedTime()
```
    The time that the dashboard was last published.
  - getAttrLastUpdatedTime
```
public java.lang.String getAttrLastUpdatedTime()
```
    The time that the dashboard was last updated.
  - getAttrVersionArn
```
public java.lang.String getAttrVersionArn()
```
  - getAttrVersionCreatedTime
```
public java.lang.String getAttrVersionCreatedTime()
```
  - getAttrVersionDataSetArns
```
public java.util.List<java.lang.String> getAttrVersionDataSetArns()
```
  - getAttrVersionDescription
```
public java.lang.String getAttrVersionDescription()
```
  - getAttrVersionErrors
```
public IResolvable getAttrVersionErrors()
```
  - getAttrVersionSheets
```
public IResolvable getAttrVersionSheets()
```
  - getAttrVersionSourceEntityArn
```
public java.lang.String getAttrVersionSourceEntityArn()
```
  - getAttrVersionStatus
```
public java.lang.String getAttrVersionStatus()
```
  - getAttrVersionThemeArn
```
public java.lang.String getAttrVersionThemeArn()
```
  - getAttrVersionVersionNumber
```
public IResolvable getAttrVersionVersionNumber()
```
  - getCfnProperties
```
protected java.util.Map<java.lang.String,java.lang.Object> getCfnProperties()
```
    Overrides:
    
    getCfnProperties in class CfnResource
  - getTags
```
public TagManager getTags()
```
    Contains a map of the key-value pairs for the resource tag or tags assigned to the dashboard.
  - getAwsAccountId
```
public java.lang.String getAwsAccountId()
```
    The ID of the AWS account where you want to create the dashboard.
  - setAwsAccountId
```
public void setAwsAccountId(java.lang.String value)
```
    The ID of the AWS account where you want to create the dashboard.
  - getDashboardId
```
public java.lang.String getDashboardId()
```
    The ID for the dashboard, also added to the IAM policy.
  - setDashboardId
```
public void setDashboardId(java.lang.String value)
```
    The ID for the dashboard, also added to the IAM policy.
  - getSourceEntity
```
public java.lang.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
```
public void setSourceEntity(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
```
public void setSourceEntity(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
```
public java.lang.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
```
public void setDashboardPublishOptions(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
```
public void setDashboardPublishOptions(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
```
public java.lang.String getName()
```
    The display name of the dashboard.
  - setName
```
public void setName(java.lang.String value)
```
    The display name of the dashboard.
  - getParameters
```
public java.lang.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
```
public void setParameters(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
```
public void setParameters(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
```
public java.lang.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
```
public void setPermissions(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
```
public void setPermissions(java.util.List<java.lang.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
```
public java.lang.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
```
public void setThemeArn(java.lang.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
```
public java.lang.String getVersionDescription()
```
    A description for the first version of the dashboard being created.
  - setVersionDescription
```
public void setVersionDescription(java.lang.String value)
```
    A description for the first version of the dashboard being created.

Class CfnDashboard

Nested Class Summary

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

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

Field Summary

Constructor Summary

Method Summary

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

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

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

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

Methods inherited from class java.lang.Object

Field Detail

CFN_RESOURCE_TYPE_NAME

Constructor Detail

CfnDashboard

CfnDashboard

CfnDashboard

Method Detail

inspect

renderProperties

getAttrArn

getAttrCreatedTime

getAttrLastPublishedTime

getAttrLastUpdatedTime

getAttrVersionArn

getAttrVersionCreatedTime

getAttrVersionDataSetArns

getAttrVersionDescription

getAttrVersionErrors

getAttrVersionSheets

getAttrVersionSourceEntityArn

getAttrVersionStatus

getAttrVersionThemeArn

getAttrVersionVersionNumber

getCfnProperties

getTags

getAwsAccountId

setAwsAccountId

getDashboardId

setDashboardId

getSourceEntity

setSourceEntity

setSourceEntity

getDashboardPublishOptions

setDashboardPublishOptions

setDashboardPublishOptions

getName

setName

getParameters

setParameters

setParameters

getPermissions

setPermissions

setPermissions

getThemeArn

setThemeArn

getVersionDescription

setVersionDescription