Package software.amazon.awscdk.services.quicksight

Class CfnAnalysis.Builder

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

  • Method Details

    • create

      @Stability(Stable) public static CfnAnalysis.Builder create(Construct scope, String id)
      Parameters:
      scope -
      • scope in which this resource is defined.
      This parameter is required.
      id -
      • scoped id of the resource.
      This parameter is required.
      Returns:
      a new instance of CfnAnalysis.Builder.

    • analysisId

      @Stability(Stable) public CfnAnalysis.Builder analysisId(String analysisId)
      The ID for the analysis that you're creating.

      This ID displays in the URL of the analysis.

      Parameters:
      analysisId - The ID for the analysis that you're creating. This parameter is required.
      Returns:
      this

    • awsAccountId

      @Stability(Stable) public CfnAnalysis.Builder awsAccountId(String awsAccountId)
      The ID of the AWS account where you are creating an analysis.

      Parameters:
      awsAccountId - The ID of the AWS account where you are creating an analysis. This parameter is required.
      Returns:
      this

    • name

      @Stability(Stable) public CfnAnalysis.Builder name(String name)
      A descriptive name for the analysis that you're creating.

      This name displays for the analysis in the Amazon QuickSight console.

      Parameters:
      name - A descriptive name for the analysis that you're creating. This parameter is required.
      Returns:
      this

    • definition

      @Stability(Stable) public CfnAnalysis.Builder definition(CfnAnalysis.AnalysisDefinitionProperty definition)
      AWS::QuickSight::Analysis.Definition.

      Parameters:
      definition - AWS::QuickSight::Analysis.Definition. This parameter is required.
      Returns:
      this

    • definition

      @Stability(Stable) public CfnAnalysis.Builder definition(IResolvable definition)
      AWS::QuickSight::Analysis.Definition.

      Parameters:
      definition - AWS::QuickSight::Analysis.Definition. This parameter is required.
      Returns:
      this

    • parameters

      @Stability(Stable) public CfnAnalysis.Builder parameters(IResolvable parameters)
      The parameter names and override values that you want to use.

      An analysis can have any parameter type, and some parameters might accept multiple values.

      Parameters:
      parameters - The parameter names and override values that you want to use. This parameter is required.
      Returns:
      this

    • parameters

      @Stability(Stable) public CfnAnalysis.Builder parameters(CfnAnalysis.ParametersProperty parameters)
      The parameter names and override values that you want to use.

      An analysis can have any parameter type, and some parameters might accept multiple values.

      Parameters:
      parameters - The parameter names and override values that you want to use. This parameter is required.
      Returns:
      this

    • permissions

      @Stability(Stable) public CfnAnalysis.Builder permissions(IResolvable permissions)
      A structure that describes the principals and the resource-level permissions on an analysis.

      You can use the Permissions structure to grant permissions by providing a list of AWS Identity and Access Management (IAM) action information for each principal listed by Amazon Resource Name (ARN).

      To specify no permissions, omit Permissions .

      Parameters:
      permissions - A structure that describes the principals and the resource-level permissions on an analysis. This parameter is required.
      Returns:
      this

    • permissions

      @Stability(Stable) public CfnAnalysis.Builder permissions(List<? extends Object> permissions)
      A structure that describes the principals and the resource-level permissions on an analysis.

      You can use the Permissions structure to grant permissions by providing a list of AWS Identity and Access Management (IAM) action information for each principal listed by Amazon Resource Name (ARN).

      To specify no permissions, omit Permissions .

      Parameters:
      permissions - A structure that describes the principals and the resource-level permissions on an analysis. This parameter is required.
      Returns:
      this

    • sourceEntity

      @Stability(Stable) public CfnAnalysis.Builder sourceEntity(IResolvable sourceEntity)
      A source entity to use for the analysis that you're creating.

      This metadata structure contains details that describe a source template and one or more datasets.

      Either a SourceEntity or a Definition must be provided in order for the request to be valid.

      Parameters:
      sourceEntity - A source entity to use for the analysis that you're creating. This parameter is required.
      Returns:
      this

    • sourceEntity

      @Stability(Stable) public CfnAnalysis.Builder sourceEntity(CfnAnalysis.AnalysisSourceEntityProperty sourceEntity)
      A source entity to use for the analysis that you're creating.

      This metadata structure contains details that describe a source template and one or more datasets.

      Either a SourceEntity or a Definition must be provided in order for the request to be valid.

      Parameters:
      sourceEntity - A source entity to use for the analysis that you're creating. This parameter is required.
      Returns:
      this

    • status

      @Stability(Stable) public CfnAnalysis.Builder status(String status)
      Status associated with the analysis.

      Parameters:
      status - Status associated with the analysis. This parameter is required.
      Returns:
      this

    • tags

      @Stability(Stable) public CfnAnalysis.Builder tags(List<? extends CfnTag> tags)
      Contains a map of the key-value pairs for the resource tag or tags assigned to the analysis.

      Parameters:
      tags - Contains a map of the key-value pairs for the resource tag or tags assigned to the analysis. This parameter is required.
      Returns:
      this

    • themeArn

      @Stability(Stable) public CfnAnalysis.Builder themeArn(String themeArn)
      The ARN for the theme to apply to the analysis that you're creating.

      To see the theme in the Amazon QuickSight console, make sure that you have access to it.

      Parameters:
      themeArn - The ARN for the theme to apply to the analysis that you're creating. This parameter is required.
      Returns:
      this

    • build

      @Stability(Stable) public CfnAnalysis build()
      Specified by:
      build in interface software.amazon.jsii.Builder<CfnAnalysis>
      Returns:
      a newly built instance of CfnAnalysis.