AWS Fundamentals Logo
AWS Fundamentals
L1 ConstructAWS::QuickSight::Analysis

CfnAnalysis

Creates an analysis in Amazon QuickSight.

Import

import { CfnAnalysis } from 'aws-cdk-lib/aws-quicksight';

Or use the module namespace:

import * as quicksight from 'aws-cdk-lib/aws-quicksight';
// quicksight.CfnAnalysis

Properties

Configuration passed to the constructor as CfnAnalysisProps.

analysisIdRequired
string

The ID for the analysis that you're creating. This ID displays in the URL of the analysis.

awsAccountIdRequired
string

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

nameRequired
string

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

definitionOptional
IResolvable | AnalysisDefinitionProperty
errorsOptional
IResolvable | IResolvable | AnalysisErrorProperty[]

Errors associated with the analysis.

folderArnsOptional
string[]
parametersOptional
IResolvable | ParametersProperty

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.

permissionsOptional
IResolvable | IResolvable | ResourcePermissionProperty[]

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` .

sheetsOptional
IResolvable | IResolvable | SheetProperty[]

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

sourceEntityOptional
IResolvable | AnalysisSourceEntityProperty

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.

statusOptional
string

Status associated with the analysis.

tagsOptional
CfnTag[]

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

themeArnOptional
string

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.

validationStrategyOptional
IResolvable | ValidationStrategyProperty

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.

CloudFormation Resource

This L1 construct maps directly to the following CloudFormation resource type.

AWS::QuickSight::AnalysisView in CloudFormation Explorer

Learn AWS the Practical Way

Our bi-weekly newsletter teaches hands-on AWS fundamentals. No certification fluff - just practical knowledge.

Subscribe to Newsletter

Quick Facts

LevelL1 (CloudFormation)
Moduleaws-quicksight
CFN TypeAWS::QuickSight::Analysis
Properties14

Related Constructs

Explore This Service

External Links