Class CfnAnalysisMixinProps.Builder
java.lang.Object
software.amazon.awscdk.cfnpropertymixins.services.quicksight.CfnAnalysisMixinProps.Builder
- All Implemented Interfaces:
software.amazon.jsii.Builder<CfnAnalysisMixinProps>
- Enclosing interface:
CfnAnalysisMixinProps
@Stability(Stable)
public static final class CfnAnalysisMixinProps.Builder
extends Object
implements software.amazon.jsii.Builder<CfnAnalysisMixinProps>
A builder for
CfnAnalysisMixinProps-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionanalysisId(String analysisId) Sets the value ofCfnAnalysisMixinProps.getAnalysisId()awsAccountId(String awsAccountId) Sets the value ofCfnAnalysisMixinProps.getAwsAccountId()build()Builds the configured instance.Sets the value ofCfnAnalysisMixinProps.getDefinition()definition(IResolvable definition) Sets the value ofCfnAnalysisMixinProps.getDefinition()Sets the value ofCfnAnalysisMixinProps.getErrors()errors(IResolvable errors) Sets the value ofCfnAnalysisMixinProps.getErrors()folderArns(List<String> folderArns) Sets the value ofCfnAnalysisMixinProps.getFolderArns()Sets the value ofCfnAnalysisMixinProps.getName()parameters(CfnAnalysisPropsMixin.ParametersProperty parameters) Sets the value ofCfnAnalysisMixinProps.getParameters()parameters(IResolvable parameters) Sets the value ofCfnAnalysisMixinProps.getParameters()permissions(List<? extends Object> permissions) Sets the value ofCfnAnalysisMixinProps.getPermissions()permissions(IResolvable permissions) Sets the value ofCfnAnalysisMixinProps.getPermissions()Sets the value ofCfnAnalysisMixinProps.getSheets()sheets(IResolvable sheets) Sets the value ofCfnAnalysisMixinProps.getSheets()Sets the value ofCfnAnalysisMixinProps.getSourceEntity()sourceEntity(IResolvable sourceEntity) Sets the value ofCfnAnalysisMixinProps.getSourceEntity()Sets the value ofCfnAnalysisMixinProps.getStatus()Sets the value ofCfnAnalysisMixinProps.getTags()Sets the value ofCfnAnalysisMixinProps.getThemeArn()validationStrategy(CfnAnalysisPropsMixin.ValidationStrategyProperty validationStrategy) Sets the value ofCfnAnalysisMixinProps.getValidationStrategy()validationStrategy(IResolvable validationStrategy) Sets the value ofCfnAnalysisMixinProps.getValidationStrategy()
-
Constructor Details
-
Builder
public Builder()
-
-
Method Details
-
analysisId
Sets the value ofCfnAnalysisMixinProps.getAnalysisId()- Parameters:
analysisId- The ID for the analysis that you're creating. This ID displays in the URL of the analysis.- Returns:
this
-
awsAccountId
Sets the value ofCfnAnalysisMixinProps.getAwsAccountId()- Parameters:
awsAccountId- The ID of the AWS account where you are creating an analysis.- Returns:
this
-
definition
Sets the value ofCfnAnalysisMixinProps.getDefinition()- Parameters:
definition- the value to be set.- Returns:
this
-
definition
@Stability(Stable) public CfnAnalysisMixinProps.Builder definition(CfnAnalysisPropsMixin.AnalysisDefinitionProperty definition) Sets the value ofCfnAnalysisMixinProps.getDefinition()- Parameters:
definition- the value to be set.- Returns:
this
-
errors
Sets the value ofCfnAnalysisMixinProps.getErrors()- Parameters:
errors- Errors associated with the analysis.- Returns:
this
-
errors
Sets the value ofCfnAnalysisMixinProps.getErrors()- Parameters:
errors- Errors associated with the analysis.- Returns:
this
-
folderArns
Sets the value ofCfnAnalysisMixinProps.getFolderArns()- Parameters:
folderArns- the value to be set.- Returns:
this
-
name
Sets the value ofCfnAnalysisMixinProps.getName()- Parameters:
name- A descriptive name for the analysis that you're creating. This name displays for the analysis in the Amazon Quick Sight console.- Returns:
this
-
parameters
Sets the value ofCfnAnalysisMixinProps.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 CfnAnalysisMixinProps.Builder parameters(CfnAnalysisPropsMixin.ParametersProperty parameters) Sets the value ofCfnAnalysisMixinProps.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
Sets the value ofCfnAnalysisMixinProps.getPermissions()- Parameters:
permissions- A structure that describes the principals and the resource-level permissions on an analysis. You can use thePermissionsstructure 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 CfnAnalysisMixinProps.Builder permissions(List<? extends Object> permissions) Sets the value ofCfnAnalysisMixinProps.getPermissions()- Parameters:
permissions- A structure that describes the principals and the resource-level permissions on an analysis. You can use thePermissionsstructure 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
-
sheets
Sets the value ofCfnAnalysisMixinProps.getSheets()- Parameters:
sheets- A list of the associated sheets with the unique identifier and name of each sheet.- Returns:
this
-
sheets
Sets the value ofCfnAnalysisMixinProps.getSheets()- Parameters:
sheets- A list of the associated sheets with the unique identifier and name of each sheet.- Returns:
this
-
sourceEntity
Sets the value ofCfnAnalysisMixinProps.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
SourceEntityor aDefinitionmust be provided in order for the request to be valid.- Returns:
this
-
sourceEntity
@Stability(Stable) public CfnAnalysisMixinProps.Builder sourceEntity(CfnAnalysisPropsMixin.AnalysisSourceEntityProperty sourceEntity) Sets the value ofCfnAnalysisMixinProps.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
SourceEntityor aDefinitionmust be provided in order for the request to be valid.- Returns:
this
-
status
Sets the value ofCfnAnalysisMixinProps.getStatus()- Parameters:
status- Status associated with the analysis.- Returns:
this
-
tags
Sets the value ofCfnAnalysisMixinProps.getTags()- Parameters:
tags- Contains a map of the key-value pairs for the resource tag or tags assigned to the analysis.- Returns:
this
-
themeArn
Sets the value ofCfnAnalysisMixinProps.getThemeArn()- Parameters:
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.- Returns:
this
-
validationStrategy
@Stability(Stable) public CfnAnalysisMixinProps.Builder validationStrategy(IResolvable validationStrategy) Sets the value ofCfnAnalysisMixinProps.getValidationStrategy()- Parameters:
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 toLENIENT, validation is skipped for specific errors.- Returns:
this
-
validationStrategy
@Stability(Stable) public CfnAnalysisMixinProps.Builder validationStrategy(CfnAnalysisPropsMixin.ValidationStrategyProperty validationStrategy) Sets the value ofCfnAnalysisMixinProps.getValidationStrategy()- Parameters:
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 toLENIENT, validation is skipped for specific errors.- Returns:
this
-
build
Builds the configured instance.- Specified by:
buildin interfacesoftware.amazon.jsii.Builder<CfnAnalysisMixinProps>- Returns:
- a new instance of
CfnAnalysisMixinProps - Throws:
NullPointerException- if any required attribute was not provided
-