AWS CDK Reference

Appearance

v2.275.0

CfnAnalysisProps Struct ​

Properties for defining a CfnAnalysis.

Source
Generated code
Type last changed
v2.163.0 · 22 Oct 2024

Example ​

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

Properties ​

analysisIdstringanalysis_idstranalysisIdStringAnalysisIdstringAnalysisId*stringrequired#
The ID for the analysis that you're creating.

This ID displays in the URL of the analysis.

awsAccountIdstringaws_account_idstrawsAccountIdStringAwsAccountIdstringAwsAccountId*stringrequired#
The ID of the AWS account where you are creating an analysis.
definitionoptionalIResolvable | CfnAnalysis.AnalysisDefinitionPropertydefinitionoptionaltyping.Union[IResolvable, AnalysisDefinitionProperty]definitionoptionalIResolvableDefinitionoptionalIResolvableDefinitionoptionalinterface{}#
errorsoptionalIResolvable | IResolvable | CfnAnalysis.AnalysisErrorProperty[]errorsoptionaltyping.Union[IResolvable, typing.List[typing.Union[IResolvable, AnalysisErrorProperty]]]errorsoptionalIResolvableErrorsoptionalIResolvableErrorsoptionalinterface{}#
Errors associated with the analysis.
folderArnsoptionalstring[]folder_arnsoptionaltyping.List[str]folderArnsoptionalList<String>FolderArnsoptionalstring[]FolderArnsoptional*[]*string#
namestringnamestrnameStringNamestringName*stringrequired#
A descriptive name for the analysis that you're creating.

This name displays for the analysis in the Amazon Quick Sight console.

parametersoptionalIResolvable | CfnAnalysis.ParametersPropertyparametersoptionaltyping.Union[IResolvable, ParametersProperty]parametersoptionalIResolvableParametersoptionalIResolvableParametersoptionalinterface{}#
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.

permissionsoptionalIResolvable | IResolvable | CfnAnalysis.ResourcePermissionProperty[]permissionsoptionaltyping.Union[IResolvable, typing.List[typing.Union[IResolvable, ResourcePermissionProperty]]]permissionsoptionalIResolvablePermissionsoptionalIResolvablePermissionsoptionalinterface{}#
A structure that describes the principals and the resource-level permissions on an analysis.
notes

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 .

sheetsoptionalIResolvable | IResolvable | CfnAnalysis.SheetProperty[]sheetsoptionaltyping.Union[IResolvable, typing.List[typing.Union[IResolvable, SheetProperty]]]sheetsoptionalIResolvableSheetsoptionalIResolvableSheetsoptionalinterface{}#
A list of the associated sheets with the unique identifier and name of each sheet.
sourceEntityoptionalIResolvable | CfnAnalysis.AnalysisSourceEntityPropertysource_entityoptionaltyping.Union[IResolvable, AnalysisSourceEntityProperty]sourceEntityoptionalIResolvableSourceEntityoptionalIResolvableSourceEntityoptionalinterface{}#
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.

statusoptionalstringstatusoptionalstrstatusoptionalStringStatusoptionalstringStatusoptional*string#
Status associated with the analysis.
tagsoptionalCfnTag[]tagsoptionaltyping.List[CfnTag]tagsoptionalList<CfnTag>TagsoptionalCfnTag[]Tagsoptional*[]CfnTag#
Contains a map of the key-value pairs for the resource tag or tags assigned to the analysis.
themeArnoptionalstringtheme_arnoptionalstrthemeArnoptionalStringThemeArnoptionalstringThemeArnoptional*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.

validationStrategyoptionalIResolvable | CfnAnalysis.ValidationStrategyPropertyvalidation_strategyoptionaltyping.Union[IResolvable, ValidationStrategyProperty]validationStrategyoptionalIResolvableValidationStrategyoptionalIResolvableValidationStrategyoptionalinterface{}#
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.