aws-cdk-lib.aws_quicksight.CfnAnalysisProps

interface CfnAnalysisProps

LanguageType name
.NETAmazon.CDK.AWS.QuickSight.CfnAnalysisProps
Gogithub.com/aws/aws-cdk-go/awscdk/v2/awsquicksight#CfnAnalysisProps
Javasoftware.amazon.awscdk.services.quicksight.CfnAnalysisProps
Pythonaws_cdk.aws_quicksight.CfnAnalysisProps
TypeScript aws-cdk-lib » aws_quicksight » CfnAnalysisProps

Properties for defining a CfnAnalysis.

Example

// The generated example for this type would exceed 500 lines,
// and has been elided for readability.

Properties

NameTypeDescription
analysisIdstringThe ID for the analysis that you're creating.
awsAccountIdstringThe ID of the AWS account where you are creating an analysis.
namestringA descriptive name for the analysis that you're creating.
definition?IResolvable | AnalysisDefinitionPropertyAWS::QuickSight::Analysis.Definition.
parameters?IResolvable | ParametersPropertyThe parameter names and override values that you want to use.
permissions?IResolvable | IResolvable | ResourcePermissionProperty[]A structure that describes the principals and the resource-level permissions on an analysis.
sourceEntity?IResolvable | AnalysisSourceEntityPropertyA source entity to use for the analysis that you're creating.
status?stringStatus associated with the analysis.
tags?CfnTag[]Contains a map of the key-value pairs for the resource tag or tags assigned to the analysis.
themeArn?stringThe ARN for the theme to apply to the analysis that you're creating.

analysisId

Type: string

The ID for the analysis that you're creating.

This ID displays in the URL of the analysis.


awsAccountId

Type: string

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


name

Type: string

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

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


definition?

Type: IResolvable | AnalysisDefinitionProperty (optional)

AWS::QuickSight::Analysis.Definition.


parameters?

Type: IResolvable | ParametersProperty (optional)

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.


permissions?

Type: IResolvable | IResolvable | ResourcePermissionProperty[] (optional)

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 .


sourceEntity?

Type: IResolvable | AnalysisSourceEntityProperty (optional)

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.


status?

Type: string (optional)

Status associated with the analysis.


tags?

Type: CfnTag[] (optional)

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


themeArn?

Type: string (optional)

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.