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

Class CfnAnalysisPropsMixin.Builder

java.lang.Object

software.amazon.awscdk.cfnpropertymixins.services.quicksight.CfnAnalysisPropsMixin.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnAnalysisPropsMixin>

Enclosing class:

CfnAnalysisPropsMixin

@Stability(Stable)
public static final class CfnAnalysisPropsMixin.Builder
extends Object
implements software.amazon.jsii.Builder<CfnAnalysisPropsMixin>

A fluent builder for CfnAnalysisPropsMixin.

Method Summary

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

Parameters:

options - Mixin options.

Returns:

a new instance of CfnAnalysisPropsMixin.Builder.

create

@Stability(Stable)
public static CfnAnalysisPropsMixin.Builder create()

Returns:

a new instance of CfnAnalysisPropsMixin.Builder.

analysisId

@Stability(Stable)
public CfnAnalysisPropsMixin.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 CfnAnalysisPropsMixin.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

definition

@Stability(Stable)
public CfnAnalysisPropsMixin.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 CfnAnalysisPropsMixin.Builder definition(CfnAnalysisPropsMixin.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 CfnAnalysisPropsMixin.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 CfnAnalysisPropsMixin.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 CfnAnalysisPropsMixin.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

name

@Stability(Stable)
public CfnAnalysisPropsMixin.Builder name(String name)

A descriptive name for the analysis that you're creating.

This name displays for the analysis in the Amazon Quick Sight 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

parameters

@Stability(Stable)
public CfnAnalysisPropsMixin.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 CfnAnalysisPropsMixin.Builder parameters(CfnAnalysisPropsMixin.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 CfnAnalysisPropsMixin.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 CfnAnalysisPropsMixin.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 CfnAnalysisPropsMixin.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 CfnAnalysisPropsMixin.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 CfnAnalysisPropsMixin.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 CfnAnalysisPropsMixin.Builder sourceEntity(CfnAnalysisPropsMixin.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 CfnAnalysisPropsMixin.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 CfnAnalysisPropsMixin.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 CfnAnalysisPropsMixin.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 Quick Sight 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 CfnAnalysisPropsMixin.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 CfnAnalysisPropsMixin.Builder validationStrategy(CfnAnalysisPropsMixin.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 CfnAnalysisPropsMixin build()

Specified by:

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

Returns:

a newly built instance of CfnAnalysisPropsMixin.