Package software.amazon.awscdk.services.quicksight

Class CfnDashboard

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.CfnElement
software.amazon.awscdk.CfnRefElement
software.amazon.awscdk.CfnResource
software.amazon.awscdk.services.quicksight.CfnDashboard
All Implemented Interfaces:
IInspectable, ITaggable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.104.0 (build e79254c)", date="2024-11-22T02:24:06.022Z") @Stability(Stable) public class CfnDashboard extends CfnResource implements IInspectable, ITaggable
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:

See Also:

  • Field Details

    • CFN_RESOURCE_TYPE_NAME

      @Stability(Stable) public static final String CFN_RESOURCE_TYPE_NAME
      The CloudFormation resource type name for this resource class.

  • Constructor Details

    • CfnDashboard

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

    • CfnDashboard

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

    • CfnDashboard

      @Stability(Stable) public CfnDashboard(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull CfnDashboardProps props)
      Parameters:
      scope - Scope in which this resource is defined. This parameter is required.
      id - Construct identifier for this resource (unique in its scope). This parameter is required.
      props - Resource properties. This parameter is required.

  • Method Details

    • inspect

      @Stability(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(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(Stable) @NotNull public String getAttrArn()
      The Amazon Resource Name (ARN) of the dashboard.

    • getAttrCreatedTime

      @Stability(Stable) @NotNull public String getAttrCreatedTime()
      The time this dashboard version was created.

    • getAttrLastPublishedTime

      @Stability(Stable) @NotNull public String getAttrLastPublishedTime()
      The time that the dashboard was last published.

    • getAttrLastUpdatedTime

      @Stability(Stable) @NotNull public String getAttrLastUpdatedTime()
      The time that the dashboard was last updated.

    • getAttrVersion

      @Stability(Stable) @NotNull public IResolvable getAttrVersion()

      Dashboard version.

      .

    • getAttrVersionArn

      @Stability(Stable) @NotNull public String getAttrVersionArn()

    • getAttrVersionCreatedTime

      @Stability(Stable) @NotNull public String getAttrVersionCreatedTime()

    • getAttrVersionDataSetArns

      @Stability(Stable) @NotNull public List<String> getAttrVersionDataSetArns()

    • getAttrVersionDescription

      @Stability(Stable) @NotNull public String getAttrVersionDescription()

    • getAttrVersionErrors

      @Stability(Stable) @NotNull public IResolvable getAttrVersionErrors()

    • getAttrVersionSheets

      @Stability(Stable) @NotNull public IResolvable getAttrVersionSheets()

    • getAttrVersionSourceEntityArn

      @Stability(Stable) @NotNull public String getAttrVersionSourceEntityArn()

    • getAttrVersionStatus

      @Stability(Stable) @NotNull public String getAttrVersionStatus()

    • getAttrVersionThemeArn

      @Stability(Stable) @NotNull public String getAttrVersionThemeArn()

    • getAttrVersionVersionNumber

      @Stability(Stable) @NotNull public IResolvable getAttrVersionVersionNumber()

    • getCfnProperties

      @Stability(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class CfnResource

    • getTags

      @Stability(Stable) @NotNull public TagManager getTags()
      Tag Manager which manages the tags for this resource.
      Specified by:
      getTags in interface ITaggable

    • getAwsAccountId

      @Stability(Stable) @NotNull public String getAwsAccountId()
      The ID of the AWS account where you want to create the dashboard.

    • setAwsAccountId

      @Stability(Stable) public void setAwsAccountId(@NotNull String value)
      The ID of the AWS account where you want to create the dashboard.

    • getDashboardId

      @Stability(Stable) @NotNull public String getDashboardId()
      The ID for the dashboard, also added to the IAM policy.

    • setDashboardId

      @Stability(Stable) public void setDashboardId(@NotNull String value)
      The ID for the dashboard, also added to the IAM policy.

    • getName

      @Stability(Stable) @NotNull public String getName()
      The display name of the dashboard.

    • setName

      @Stability(Stable) public void setName(@NotNull String value)
      The display name of the dashboard.

    • getDashboardPublishOptions

      @Stability(Stable) @Nullable public Object getDashboardPublishOptions()
      Options for publishing the dashboard when you create it:.

    • setDashboardPublishOptions

      @Stability(Stable) public void setDashboardPublishOptions(@Nullable IResolvable value)
      Options for publishing the dashboard when you create it:.

    • setDashboardPublishOptions

      @Stability(Stable) public void setDashboardPublishOptions(@Nullable CfnDashboard.DashboardPublishOptionsProperty value)
      Options for publishing the dashboard when you create it:.

    • getDefinition

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

    • setDefinition

      @Stability(Stable) public void setDefinition(@Nullable IResolvable value)

    • setDefinition

      @Stability(Stable) public void setDefinition(@Nullable CfnDashboard.DashboardVersionDefinitionProperty value)

    • getFolderArns

      @Stability(Stable) @Nullable public List<String> getFolderArns()

    • setFolderArns

      @Stability(Stable) public void setFolderArns(@Nullable List<String> value)

    • getLinkEntities

      @Stability(Stable) @Nullable public List<String> getLinkEntities()
      A list of analysis Amazon Resource Names (ARNs) to be linked to the dashboard.

    • setLinkEntities

      @Stability(Stable) public void setLinkEntities(@Nullable List<String> value)
      A list of analysis Amazon Resource Names (ARNs) to be linked to the dashboard.

    • getLinkSharingConfiguration

      @Stability(Stable) @Nullable public Object getLinkSharingConfiguration()
      A structure that contains the link sharing configurations that you want to apply overrides to.

    • setLinkSharingConfiguration

      @Stability(Stable) public void setLinkSharingConfiguration(@Nullable IResolvable value)
      A structure that contains the link sharing configurations that you want to apply overrides to.

    • setLinkSharingConfiguration

      @Stability(Stable) public void setLinkSharingConfiguration(@Nullable CfnDashboard.LinkSharingConfigurationProperty value)
      A structure that contains the link sharing configurations that you want to apply overrides to.

    • getParameters

      @Stability(Stable) @Nullable public Object getParameters()
      The parameters for the creation of the dashboard, which you want to use to override the default settings.

    • setParameters

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

    • setParameters

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

    • getPermissions

      @Stability(Stable) @Nullable public Object getPermissions()
      A structure that contains the permissions of the dashboard.

    • setPermissions

      @Stability(Stable) public void setPermissions(@Nullable IResolvable value)
      A structure that contains the permissions of the dashboard.

    • setPermissions

      @Stability(Stable) public void setPermissions(@Nullable List<Object> value)
      A structure that contains the permissions of the dashboard.

    • getSourceEntity

      @Stability(Stable) @Nullable public Object getSourceEntity()
      The entity that you are using as a source when you create the dashboard.

    • setSourceEntity

      @Stability(Stable) public void setSourceEntity(@Nullable IResolvable value)
      The entity that you are using as a source when you create the dashboard.

    • setSourceEntity

      @Stability(Stable) public void setSourceEntity(@Nullable CfnDashboard.DashboardSourceEntityProperty value)
      The entity that you are using as a source when you create the dashboard.

    • getTagsRaw

      @Stability(Stable) @Nullable public List<CfnTag> getTagsRaw()
      Contains a map of the key-value pairs for the resource tag or tags assigned to the dashboard.

    • setTagsRaw

      @Stability(Stable) public void setTagsRaw(@Nullable List<CfnTag> value)
      Contains a map of the key-value pairs for the resource tag or tags assigned to the dashboard.

    • getThemeArn

      @Stability(Stable) @Nullable public String getThemeArn()
      The Amazon Resource Name (ARN) of the theme that is being used for this dashboard.

    • setThemeArn

      @Stability(Stable) public void setThemeArn(@Nullable String value)
      The Amazon Resource Name (ARN) of the theme that is being used for this dashboard.

    • getValidationStrategy

      @Stability(Stable) @Nullable public Object getValidationStrategy()
      The option to relax the validation that is required to create and update analyses, dashboards, and templates with definition objects.

    • setValidationStrategy

      @Stability(Stable) public void setValidationStrategy(@Nullable IResolvable value)
      The option to relax the validation that is required to create and update analyses, dashboards, and templates with definition objects.

    • setValidationStrategy

      @Stability(Stable) public void setValidationStrategy(@Nullable CfnDashboard.ValidationStrategyProperty value)
      The option to relax the validation that is required to create and update analyses, dashboards, and templates with definition objects.

    • getVersionDescription

      @Stability(Stable) @Nullable public String getVersionDescription()
      A description for the first version of the dashboard being created.

    • setVersionDescription

      @Stability(Stable) public void setVersionDescription(@Nullable String value)
      A description for the first version of the dashboard being created.