software.amazon.awscdk.services.quicksight

Class CfnAnalysisProps.Builder

java.lang.Object

software.amazon.awscdk.services.quicksight.CfnAnalysisProps.Builder

Enclosing interface:

CfnAnalysisProps

public static final class CfnAnalysisProps.Builder
extends java.lang.Object

A builder for CfnAnalysisProps

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
CfnAnalysisProps.Builder	analysisId(java.lang.String analysisId) Sets the value of CfnAnalysisProps.getAnalysisId()
CfnAnalysisProps.Builder	awsAccountId(java.lang.String awsAccountId) Sets the value of CfnAnalysisProps.getAwsAccountId()
CfnAnalysisProps	build() Builds the configured instance.
CfnAnalysisProps.Builder	errors(IResolvable errors) Sets the value of CfnAnalysisProps.getErrors()
CfnAnalysisProps.Builder	errors(java.util.List<? extends java.lang.Object> errors) Sets the value of CfnAnalysisProps.getErrors()
CfnAnalysisProps.Builder	name(java.lang.String name) Sets the value of CfnAnalysisProps.getName()
CfnAnalysisProps.Builder	parameters(CfnAnalysis.ParametersProperty parameters) Sets the value of CfnAnalysisProps.getParameters()
CfnAnalysisProps.Builder	parameters(IResolvable parameters) Sets the value of CfnAnalysisProps.getParameters()
CfnAnalysisProps.Builder	permissions(IResolvable permissions) Sets the value of CfnAnalysisProps.getPermissions()
CfnAnalysisProps.Builder	permissions(java.util.List<? extends java.lang.Object> permissions) Sets the value of CfnAnalysisProps.getPermissions()
CfnAnalysisProps.Builder	sourceEntity(CfnAnalysis.AnalysisSourceEntityProperty sourceEntity) Sets the value of CfnAnalysisProps.getSourceEntity()
CfnAnalysisProps.Builder	sourceEntity(IResolvable sourceEntity) Sets the value of CfnAnalysisProps.getSourceEntity()
CfnAnalysisProps.Builder	tags(java.util.List<? extends CfnTag> tags) Sets the value of CfnAnalysisProps.getTags()
CfnAnalysisProps.Builder	themeArn(java.lang.String themeArn) Sets the value of CfnAnalysisProps.getThemeArn()

Methods inherited from class java.lang.Object

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

Constructor Detail

Builder

public Builder()

Method Detail

analysisId

public CfnAnalysisProps.Builder analysisId(java.lang.String analysisId)

Sets the value of CfnAnalysisProps.getAnalysisId()

Parameters:

analysisId - The ID for the analysis that you're creating. This parameter is required. This ID displays in the URL of the analysis.

Returns:

this

awsAccountId

public CfnAnalysisProps.Builder awsAccountId(java.lang.String awsAccountId)

Sets the value of CfnAnalysisProps.getAwsAccountId()

Parameters:

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

Returns:

this

sourceEntity

public CfnAnalysisProps.Builder sourceEntity(CfnAnalysis.AnalysisSourceEntityProperty sourceEntity)

Sets the value of CfnAnalysisProps.getSourceEntity()

Parameters:

sourceEntity - A source entity to use for the analysis that you're creating. This parameter is required. This metadata structure contains details that describe a source template and one or more datasets.

Returns:

this

sourceEntity

public CfnAnalysisProps.Builder sourceEntity(IResolvable sourceEntity)

Sets the value of CfnAnalysisProps.getSourceEntity()

Parameters:

sourceEntity - A source entity to use for the analysis that you're creating. This parameter is required. This metadata structure contains details that describe a source template and one or more datasets.

Returns:

this

errors

public CfnAnalysisProps.Builder errors(IResolvable errors)

Sets the value of CfnAnalysisProps.getErrors()

Parameters:

errors - `AWS::QuickSight::Analysis.Errors`.

Returns:

this

errors

public CfnAnalysisProps.Builder errors(java.util.List<? extends java.lang.Object> errors)

Sets the value of CfnAnalysisProps.getErrors()

Parameters:

errors - `AWS::QuickSight::Analysis.Errors`.

Returns:

this

name

public CfnAnalysisProps.Builder name(java.lang.String name)

Sets the value of CfnAnalysisProps.getName()

Parameters:

name - A descriptive name for the analysis that you're creating. This name displays for the analysis in the Amazon QuickSight console.

Returns:

this

parameters

public CfnAnalysisProps.Builder parameters(IResolvable parameters)

Sets the value of CfnAnalysisProps.getParameters()

Parameters:

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.

Returns:

this

parameters

public CfnAnalysisProps.Builder parameters(CfnAnalysis.ParametersProperty parameters)

Sets the value of CfnAnalysisProps.getParameters()

Parameters:

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.

Returns:

this

permissions

public CfnAnalysisProps.Builder permissions(IResolvable permissions)

Sets the value of CfnAnalysisProps.getPermissions()

Parameters:

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 .

Returns:

this

permissions

public CfnAnalysisProps.Builder permissions(java.util.List<? extends java.lang.Object> permissions)

Sets the value of CfnAnalysisProps.getPermissions()

Parameters:

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 .

Returns:

this

tags

public CfnAnalysisProps.Builder tags(java.util.List<? extends CfnTag> tags)

Sets the value of CfnAnalysisProps.getTags()

Parameters:

tags - Contains a map of the key-value pairs for the resource tag or tags assigned to the analysis.

Returns:

this

themeArn

public CfnAnalysisProps.Builder themeArn(java.lang.String themeArn)

Sets the value of CfnAnalysisProps.getThemeArn()

Parameters:

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.

Returns:

this

build

public CfnAnalysisProps build()

Builds the configured instance.

Returns:

a new instance of CfnAnalysisProps

Throws:

java.lang.NullPointerException - if any required attribute was not provided