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 Summary

Modifier and Type	Method	Description
CfnAnalysis.Builder	analysisId(String analysisId)	The ID for the analysis that you're creating.
CfnAnalysis.Builder	awsAccountId(String awsAccountId)	The ID of the AWS account where you are creating an analysis.
CfnAnalysis	build()
static CfnAnalysis.Builder	create(software.constructs.Construct scope, String id)
CfnAnalysis.Builder	definition(IResolvable definition)
CfnAnalysis.Builder	definition(CfnAnalysis.AnalysisDefinitionProperty definition)
CfnAnalysis.Builder	errors(List<? extends Object> errors)	Errors associated with the analysis.
CfnAnalysis.Builder	errors(IResolvable errors)	Errors associated with the analysis.
CfnAnalysis.Builder	folderArns(List<String> folderArns)
CfnAnalysis.Builder	name(String name)	A descriptive name for the analysis that you're creating.
CfnAnalysis.Builder	parameters(IResolvable parameters)	The parameter names and override values that you want to use.
CfnAnalysis.Builder	parameters(CfnAnalysis.ParametersProperty parameters)	The parameter names and override values that you want to use.
CfnAnalysis.Builder	permissions(List<? extends Object> permissions)	A structure that describes the principals and the resource-level permissions on an analysis.
CfnAnalysis.Builder	permissions(IResolvable permissions)	A structure that describes the principals and the resource-level permissions on an analysis.
CfnAnalysis.Builder	sheets(List<? extends Object> sheets)	A list of the associated sheets with the unique identifier and name of each sheet.
CfnAnalysis.Builder	sheets(IResolvable sheets)	A list of the associated sheets with the unique identifier and name of each sheet.
CfnAnalysis.Builder	sourceEntity(IResolvable sourceEntity)	A source entity to use for the analysis that you're creating.
CfnAnalysis.Builder	sourceEntity(CfnAnalysis.AnalysisSourceEntityProperty sourceEntity)	A source entity to use for the analysis that you're creating.
CfnAnalysis.Builder	status(String status)	Status associated with the analysis.
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.
CfnAnalysis.Builder	themeArn(String themeArn)	The ARN for the theme to apply to the analysis that you're creating.
CfnAnalysis.Builder	validationStrategy(IResolvable validationStrategy)	The option to relax the validation that is required to create and update analyses, dashboards, and templates with definition objects.
CfnAnalysis.Builder	validationStrategy(CfnAnalysis.ValidationStrategyProperty validationStrategy)	The option to relax the validation that is required to create and update analyses, dashboards, and templates with definition objects.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

create

@Stability(Stable)
public static CfnAnalysis.Builder create(software.constructs.Construct scope,
 String id)

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.

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-quicksight-analysis.html#cfn-quicksight-analysis-analysisid

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-quicksight-analysis.html#cfn-quicksight-analysis-awsaccountid

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-quicksight-analysis.html#cfn-quicksight-analysis-name

definition

@Stability(Stable)
public CfnAnalysis.Builder definition(IResolvable definition)

Parameters:

definition - This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-quicksight-analysis.html#cfn-quicksight-analysis-definition

definition

@Stability(Stable)
public CfnAnalysis.Builder definition(CfnAnalysis.AnalysisDefinitionProperty definition)

Parameters:

definition - This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-quicksight-analysis.html#cfn-quicksight-analysis-definition

errors

@Stability(Stable)
public CfnAnalysis.Builder errors(IResolvable errors)

Errors associated with the analysis.

Parameters:

errors - Errors associated with the analysis. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-quicksight-analysis.html#cfn-quicksight-analysis-errors

errors

@Stability(Stable)
public CfnAnalysis.Builder errors(List<? extends Object> errors)

Errors associated with the analysis.

Parameters:

errors - Errors associated with the analysis. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-quicksight-analysis.html#cfn-quicksight-analysis-errors

folderArns

@Stability(Stable)
public CfnAnalysis.Builder folderArns(List<String> folderArns)

Parameters:

folderArns - This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-quicksight-analysis.html#cfn-quicksight-analysis-folderarns

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-quicksight-analysis.html#cfn-quicksight-analysis-parameters

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-quicksight-analysis.html#cfn-quicksight-analysis-parameters

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-quicksight-analysis.html#cfn-quicksight-analysis-permissions

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-quicksight-analysis.html#cfn-quicksight-analysis-permissions

sheets

@Stability(Stable)
public CfnAnalysis.Builder sheets(IResolvable sheets)

A list of the associated sheets with the unique identifier and name of each sheet.

Parameters:

sheets - A list of the associated sheets with the unique identifier and name of each sheet. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-quicksight-analysis.html#cfn-quicksight-analysis-sheets

sheets

@Stability(Stable)
public CfnAnalysis.Builder sheets(List<? extends Object> sheets)

A list of the associated sheets with the unique identifier and name of each sheet.

Parameters:

sheets - A list of the associated sheets with the unique identifier and name of each sheet. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-quicksight-analysis.html#cfn-quicksight-analysis-sheets

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-quicksight-analysis.html#cfn-quicksight-analysis-sourceentity

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-quicksight-analysis.html#cfn-quicksight-analysis-sourceentity

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-quicksight-analysis.html#cfn-quicksight-analysis-status

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-quicksight-analysis.html#cfn-quicksight-analysis-tags

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-quicksight-analysis.html#cfn-quicksight-analysis-themearn

validationStrategy

@Stability(Stable)
public CfnAnalysis.Builder validationStrategy(IResolvable 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.

Parameters:

validationStrategy - The option to relax the validation that is required to create and update analyses, dashboards, and templates with definition objects. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-quicksight-analysis.html#cfn-quicksight-analysis-validationstrategy

validationStrategy

@Stability(Stable)
public CfnAnalysis.Builder validationStrategy(CfnAnalysis.ValidationStrategyProperty 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.

Parameters:

validationStrategy - The option to relax the validation that is required to create and update analyses, dashboards, and templates with definition objects. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-quicksight-analysis.html#cfn-quicksight-analysis-validationstrategy

build

@Stability(Stable)
public CfnAnalysis build()

Specified by:

build in interface software.amazon.jsii.Builder<CfnAnalysis>

Returns:

a newly built instance of CfnAnalysis.