Package software.amazon.awscdk.cfnpropertymixins.services.quicksight

Class CfnDashboardMixinProps.Builder

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

  • Constructor Details

    • Builder

      public Builder()

  • Method Details

    • awsAccountId

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

    • dashboardId

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

    • dashboardPublishOptions

      @Stability(Stable) public CfnDashboardMixinProps.Builder dashboardPublishOptions(IResolvable dashboardPublishOptions)
      Sets the value of CfnDashboardMixinProps.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 Quick Sight 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.
      • AvailabilityStatus for QuickSuiteActionsOption - This status can be either ENABLED or DISABLED . Features related to Actions in Amazon Quick Suite on dashboards are disabled when this is set to DISABLED . This option is DISABLED by default.
      • AvailabilityStatus for ExecutiveSummaryOption - This status can be either ENABLED or DISABLED . The option to build an executive summary is disabled when this is set to DISABLED . This option is ENABLED by default.
      • AvailabilityStatus for DataStoriesSharingOption - This status can be either ENABLED or DISABLED . The option to share a data story is disabled when this is set to DISABLED . This option is ENABLED by default.
      Returns:
      this

    • dashboardPublishOptions

      @Stability(Stable) public CfnDashboardMixinProps.Builder dashboardPublishOptions(CfnDashboardPropsMixin.DashboardPublishOptionsProperty dashboardPublishOptions)
      Sets the value of CfnDashboardMixinProps.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 Quick Sight 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.
      • AvailabilityStatus for QuickSuiteActionsOption - This status can be either ENABLED or DISABLED . Features related to Actions in Amazon Quick Suite on dashboards are disabled when this is set to DISABLED . This option is DISABLED by default.
      • AvailabilityStatus for ExecutiveSummaryOption - This status can be either ENABLED or DISABLED . The option to build an executive summary is disabled when this is set to DISABLED . This option is ENABLED by default.
      • AvailabilityStatus for DataStoriesSharingOption - This status can be either ENABLED or DISABLED . The option to share a data story is disabled when this is set to DISABLED . This option is ENABLED by default.
      Returns:
      this

    • definition

      @Stability(Stable) public CfnDashboardMixinProps.Builder definition(IResolvable definition)
      Sets the value of CfnDashboardMixinProps.getDefinition()
      Parameters:
      definition - the value to be set.
      Returns:
      this

    • definition

      @Stability(Stable) public CfnDashboardMixinProps.Builder definition(CfnDashboardPropsMixin.DashboardVersionDefinitionProperty definition)
      Sets the value of CfnDashboardMixinProps.getDefinition()
      Parameters:
      definition - the value to be set.
      Returns:
      this

    • folderArns

      @Stability(Stable) public CfnDashboardMixinProps.Builder folderArns(List<String> folderArns)
      Sets the value of CfnDashboardMixinProps.getFolderArns()
      Parameters:
      folderArns - the value to be set.
      Returns:
      this

    • linkEntities

      @Stability(Stable) public CfnDashboardMixinProps.Builder linkEntities(List<String> linkEntities)
      Sets the value of CfnDashboardMixinProps.getLinkEntities()
      Parameters:
      linkEntities - A list of analysis Amazon Resource Names (ARNs) to be linked to the dashboard.
      Returns:
      this

    • linkSharingConfiguration

      @Stability(Stable) public CfnDashboardMixinProps.Builder linkSharingConfiguration(IResolvable linkSharingConfiguration)
      Sets the value of CfnDashboardMixinProps.getLinkSharingConfiguration()
      Parameters:
      linkSharingConfiguration - A structure that contains the link sharing configurations that you want to apply overrides to.
      Returns:
      this

    • linkSharingConfiguration

      @Stability(Stable) public CfnDashboardMixinProps.Builder linkSharingConfiguration(CfnDashboardPropsMixin.LinkSharingConfigurationProperty linkSharingConfiguration)
      Sets the value of CfnDashboardMixinProps.getLinkSharingConfiguration()
      Parameters:
      linkSharingConfiguration - A structure that contains the link sharing configurations that you want to apply overrides to.
      Returns:
      this

    • name

      @Stability(Stable) public CfnDashboardMixinProps.Builder name(String name)
      Sets the value of CfnDashboardMixinProps.getName()
      Parameters:
      name - The display name of the dashboard.
      Returns:
      this

    • parameters

      @Stability(Stable) public CfnDashboardMixinProps.Builder parameters(IResolvable parameters)
      Sets the value of CfnDashboardMixinProps.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 CfnDashboardMixinProps.Builder parameters(CfnDashboardPropsMixin.ParametersProperty parameters)
      Sets the value of CfnDashboardMixinProps.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 CfnDashboardMixinProps.Builder permissions(IResolvable permissions)
      Sets the value of CfnDashboardMixinProps.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 CfnDashboardMixinProps.Builder permissions(List<? extends Object> permissions)
      Sets the value of CfnDashboardMixinProps.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 CfnDashboardMixinProps.Builder sourceEntity(IResolvable sourceEntity)
      Sets the value of CfnDashboardMixinProps.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 CfnDashboardMixinProps.Builder sourceEntity(CfnDashboardPropsMixin.DashboardSourceEntityProperty sourceEntity)
      Sets the value of CfnDashboardMixinProps.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 CfnDashboardMixinProps.Builder tags(List<? extends CfnTag> tags)
      Sets the value of CfnDashboardMixinProps.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 CfnDashboardMixinProps.Builder themeArn(String themeArn)
      Sets the value of CfnDashboardMixinProps.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

    • themeArn

      @Stability(Stable) public CfnDashboardMixinProps.Builder themeArn(IThemeRef themeArn)
      Sets the value of CfnDashboardMixinProps.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

    • validationStrategy

      @Stability(Stable) public CfnDashboardMixinProps.Builder validationStrategy(IResolvable validationStrategy)
      Sets the value of CfnDashboardMixinProps.getValidationStrategy()
      Parameters:
      validationStrategy - The option to relax the validation that is required to create and update analyses, dashboards, and templates with definition objects. When you set this value to LENIENT , validation is skipped for specific errors.
      Returns:
      this

    • validationStrategy

      @Stability(Stable) public CfnDashboardMixinProps.Builder validationStrategy(CfnDashboardPropsMixin.ValidationStrategyProperty validationStrategy)
      Sets the value of CfnDashboardMixinProps.getValidationStrategy()
      Parameters:
      validationStrategy - The option to relax the validation that is required to create and update analyses, dashboards, and templates with definition objects. When you set this value to LENIENT , validation is skipped for specific errors.
      Returns:
      this

    • versionDescription

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

    • build

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