Package software.amazon.awscdk.services.quicksight

Class CfnDashboardProps.Builder

java.lang.Object
software.amazon.awscdk.services.quicksight.CfnDashboardProps.Builder
All Implemented Interfaces:
software.amazon.jsii.Builder<CfnDashboardProps>
Enclosing interface:
CfnDashboardProps
@Stability(Stable) public static final class CfnDashboardProps.Builder extends Object implements software.amazon.jsii.Builder<CfnDashboardProps>
A builder for CfnDashboardProps

  • Constructor Details

    • Builder

      public Builder()

  • Method Details

    • awsAccountId

      @Stability(Stable) public CfnDashboardProps.Builder awsAccountId(String awsAccountId)
      Sets the value of CfnDashboardProps.getAwsAccountId()
      Parameters:
      awsAccountId - The ID of the AWS account where you want to create the dashboard. This parameter is required.
      Returns:
      this

    • dashboardId

      @Stability(Stable) public CfnDashboardProps.Builder dashboardId(String dashboardId)
      Sets the value of CfnDashboardProps.getDashboardId()
      Parameters:
      dashboardId - The ID for the dashboard, also added to the IAM policy. This parameter is required.
      Returns:
      this

    • name

      @Stability(Stable) public CfnDashboardProps.Builder name(String name)
      Sets the value of CfnDashboardProps.getName()
      Parameters:
      name - The display name of the dashboard. This parameter is required.
      Returns:
      this

    • dashboardPublishOptions

      @Stability(Stable) public CfnDashboardProps.Builder dashboardPublishOptions(IResolvable dashboardPublishOptions)
      Sets the value of CfnDashboardProps.getDashboardPublishOptions()
      Parameters:
      dashboardPublishOptions - 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.
      Returns:
      this

    • dashboardPublishOptions

      @Stability(Stable) public CfnDashboardProps.Builder dashboardPublishOptions(CfnDashboard.DashboardPublishOptionsProperty dashboardPublishOptions)
      Sets the value of CfnDashboardProps.getDashboardPublishOptions()
      Parameters:
      dashboardPublishOptions - 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.
      Returns:
      this

    • definition

      @Stability(Stable) public CfnDashboardProps.Builder definition(IResolvable definition)
      Sets the value of CfnDashboardProps.getDefinition()
      Parameters:
      definition - AWS::QuickSight::Dashboard.Definition.
      Returns:
      this

    • definition

      @Stability(Stable) public CfnDashboardProps.Builder definition(CfnDashboard.DashboardVersionDefinitionProperty definition)
      Sets the value of CfnDashboardProps.getDefinition()
      Parameters:
      definition - AWS::QuickSight::Dashboard.Definition.
      Returns:
      this

    • parameters

      @Stability(Stable) public CfnDashboardProps.Builder parameters(IResolvable parameters)
      Sets the value of CfnDashboardProps.getParameters()
      Parameters:
      parameters - 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.
      Returns:
      this

    • parameters

      @Stability(Stable) public CfnDashboardProps.Builder parameters(CfnDashboard.ParametersProperty parameters)
      Sets the value of CfnDashboardProps.getParameters()
      Parameters:
      parameters - 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.
      Returns:
      this

    • permissions

      @Stability(Stable) public CfnDashboardProps.Builder permissions(IResolvable permissions)
      Sets the value of CfnDashboardProps.getPermissions()
      Parameters:
      permissions - 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.

      Returns:
      this

    • permissions

      @Stability(Stable) public CfnDashboardProps.Builder permissions(List<? extends Object> permissions)
      Sets the value of CfnDashboardProps.getPermissions()
      Parameters:
      permissions - 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.

      Returns:
      this

    • sourceEntity

      @Stability(Stable) public CfnDashboardProps.Builder sourceEntity(IResolvable sourceEntity)
      Sets the value of CfnDashboardProps.getSourceEntity()
      Parameters:
      sourceEntity - 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.

      Returns:
      this

    • sourceEntity

      @Stability(Stable) public CfnDashboardProps.Builder sourceEntity(CfnDashboard.DashboardSourceEntityProperty sourceEntity)
      Sets the value of CfnDashboardProps.getSourceEntity()
      Parameters:
      sourceEntity - 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.

      Returns:
      this

    • tags

      @Stability(Stable) public CfnDashboardProps.Builder tags(List<? extends CfnTag> tags)
      Sets the value of CfnDashboardProps.getTags()
      Parameters:
      tags - Contains a map of the key-value pairs for the resource tag or tags assigned to the dashboard.
      Returns:
      this

    • themeArn

      @Stability(Stable) public CfnDashboardProps.Builder themeArn(String themeArn)
      Sets the value of CfnDashboardProps.getThemeArn()
      Parameters:
      themeArn - 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.
      Returns:
      this

    • versionDescription

      @Stability(Stable) public CfnDashboardProps.Builder versionDescription(String versionDescription)
      Sets the value of CfnDashboardProps.getVersionDescription()
      Parameters:
      versionDescription - A description for the first version of the dashboard being created.
      Returns:
      this

    • build

      @Stability(Stable) public CfnDashboardProps build()
      Builds the configured instance.
      Specified by:
      build in interface software.amazon.jsii.Builder<CfnDashboardProps>
      Returns:
      a new instance of CfnDashboardProps
      Throws:
      NullPointerException - if any required attribute was not provided