Package software.amazon.awscdk.services.quicksight

Class CfnAnalysisProps.Builder

java.lang.Object

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

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnAnalysisProps>

Enclosing interface:

CfnAnalysisProps

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

A builder for CfnAnalysisProps

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
CfnAnalysisProps.Builder	analysisId(String analysisId)	Sets the value of CfnAnalysisProps.getAnalysisId()
CfnAnalysisProps.Builder	awsAccountId(String awsAccountId)	Sets the value of CfnAnalysisProps.getAwsAccountId()
CfnAnalysisProps	build()	Builds the configured instance.
CfnAnalysisProps.Builder	definition(IResolvable definition)	Sets the value of CfnAnalysisProps.getDefinition()
CfnAnalysisProps.Builder	definition(CfnAnalysis.AnalysisDefinitionProperty definition)	Sets the value of CfnAnalysisProps.getDefinition()
CfnAnalysisProps.Builder	name(String name)	Sets the value of CfnAnalysisProps.getName()
CfnAnalysisProps.Builder	parameters(IResolvable parameters)	Sets the value of CfnAnalysisProps.getParameters()
CfnAnalysisProps.Builder	parameters(CfnAnalysis.ParametersProperty parameters)	Sets the value of CfnAnalysisProps.getParameters()
CfnAnalysisProps.Builder	permissions(List<? extends Object> permissions)	Sets the value of CfnAnalysisProps.getPermissions()
CfnAnalysisProps.Builder	permissions(IResolvable permissions)	Sets the value of CfnAnalysisProps.getPermissions()
CfnAnalysisProps.Builder	sourceEntity(IResolvable sourceEntity)	Sets the value of CfnAnalysisProps.getSourceEntity()
CfnAnalysisProps.Builder	sourceEntity(CfnAnalysis.AnalysisSourceEntityProperty sourceEntity)	Sets the value of CfnAnalysisProps.getSourceEntity()
CfnAnalysisProps.Builder	status(String status)	Sets the value of CfnAnalysisProps.getStatus()
CfnAnalysisProps.Builder	tags(List<? extends CfnTag> tags)	Sets the value of CfnAnalysisProps.getTags()
CfnAnalysisProps.Builder	themeArn(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 Details

Builder

public Builder()

Method Details

analysisId

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

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

name

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

Sets the value of CfnAnalysisProps.getName()

Parameters:

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

Returns:

this

definition

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

Sets the value of CfnAnalysisProps.getDefinition()

Parameters:

definition - AWS::QuickSight::Analysis.Definition.

Returns:

this

definition

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

Sets the value of CfnAnalysisProps.getDefinition()

Parameters:

definition - AWS::QuickSight::Analysis.Definition.

Returns:

this

parameters

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

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

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

@Stability(Stable)
public CfnAnalysisProps.Builder permissions(List<? extends 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

sourceEntity

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

Returns:

this

sourceEntity

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

Returns:

this

status

@Stability(Stable)
public CfnAnalysisProps.Builder status(String status)

Sets the value of CfnAnalysisProps.getStatus()

Parameters:

status - Status associated with the analysis.

Returns:

this

tags

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

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

@Stability(Stable)
public CfnAnalysisProps build()

Builds the configured instance.

Specified by:

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

Returns:

a new instance of CfnAnalysisProps

Throws:

NullPointerException - if any required attribute was not provided