Package software.amazon.awscdk.services.quicksight

Interface CfnAnalysisProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnAnalysisProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.106.0 (build e852934)",
           date="2025-03-12T01:36:42.950Z")
@Stability(Stable)
public interface CfnAnalysisProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a CfnAnalysis.

Example:

See Also:

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

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnAnalysisProps.Builder	A builder for CfnAnalysisProps
static final class	CfnAnalysisProps.Jsii$Proxy	An implementation for CfnAnalysisProps

Method Summary

Modifier and Type	Method	Description
static CfnAnalysisProps.Builder	builder()
String	getAnalysisId()	The ID for the analysis that you're creating.
String	getAwsAccountId()	The ID of the AWS account where you are creating an analysis.
default Object	getDefinition()
default Object	getErrors()	Errors associated with the analysis.
default List<String>	getFolderArns()
String	getName()	A descriptive name for the analysis that you're creating.
default Object	getParameters()	The parameter names and override values that you want to use.
default Object	getPermissions()	A structure that describes the principals and the resource-level permissions on an analysis.
default Object	getSheets()	A list of the associated sheets with the unique identifier and name of each sheet.
default Object	getSourceEntity()	A source entity to use for the analysis that you're creating.
default String	getStatus()	Status associated with the analysis.
default List<CfnTag>	getTags()	Contains a map of the key-value pairs for the resource tag or tags assigned to the analysis.
default String	getThemeArn()	The ARN for the theme to apply to the analysis that you're creating.
default Object	getValidationStrategy()	The option to relax the validation that is required to create and update analyses, dashboards, and templates with definition objects.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getAnalysisId

@Stability(Stable)
@NotNull
String getAnalysisId()

The ID for the analysis that you're creating.

This ID displays in the URL of the analysis.

See Also:

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

getAwsAccountId

@Stability(Stable)
@NotNull
String getAwsAccountId()

The ID of the AWS account where you are creating an analysis.

See Also:

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

getName

@Stability(Stable)
@NotNull
String getName()

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

This name displays for the analysis in the Amazon QuickSight console.

See Also:

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

getDefinition

@Stability(Stable)
@Nullable
default Object getDefinition()

See Also:

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

getErrors

@Stability(Stable)
@Nullable
default Object getErrors()

Errors associated with the analysis.

See Also:

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

getFolderArns

@Stability(Stable)
@Nullable
default List<String> getFolderArns()

See Also:

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

getParameters

@Stability(Stable)
@Nullable
default Object getParameters()

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.

See Also:

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

getPermissions

@Stability(Stable)
@Nullable
default Object getPermissions()

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 .

See Also:

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

getSheets

@Stability(Stable)
@Nullable
default Object getSheets()

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

See Also:

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

getSourceEntity

@Stability(Stable)
@Nullable
default Object getSourceEntity()

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.

See Also:

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

getStatus

@Stability(Stable)
@Nullable
default String getStatus()

Status associated with the analysis.

See Also:

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

getTags

@Stability(Stable)
@Nullable
default List<CfnTag> getTags()

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

See Also:

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

getThemeArn

@Stability(Stable)
@Nullable
default String getThemeArn()

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.

See Also:

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

getValidationStrategy

@Stability(Stable)
@Nullable
default Object getValidationStrategy()

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.

See Also:

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

builder

@Stability(Stable)
static CfnAnalysisProps.Builder builder()

Returns:

a CfnAnalysisProps.Builder of CfnAnalysisProps