CfnAnalysisProps

class aws_cdk.aws_quicksight.CfnAnalysisProps(*, analysis_id, aws_account_id, name, definition=None, errors=None, folder_arns=None, parameters=None, permissions=None, sheets=None, source_entity=None, status=None, tags=None, theme_arn=None, validation_strategy=None)

Bases: object

Properties for defining a CfnAnalysis.

Parameters:

  • analysis_id (str) – The ID for the analysis that you’re creating. This ID displays in the URL of the analysis.

  • aws_account_id (str) – The ID of the AWS account where you are creating an analysis.

  • name (str) – A descriptive name for the analysis that you’re creating. This name displays for the analysis in the Amazon QuickSight console.

  • definition (Union[IResolvable, AnalysisDefinitionProperty, Dict[str, Any], None]) –

  • errors (Union[IResolvable, Sequence[Union[IResolvable, AnalysisErrorProperty, Dict[str, Any]]], None]) – Errors associated with the analysis.

  • folder_arns (Optional[Sequence[str]]) –

  • parameters (Union[IResolvable, ParametersProperty, Dict[str, Any], None]) – 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 (Union[IResolvable, Sequence[Union[IResolvable, ResourcePermissionProperty, Dict[str, Any]]], None]) – 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 .

  • sheets (Union[IResolvable, Sequence[Union[IResolvable, SheetProperty, Dict[str, Any]]], None]) – A list of the associated sheets with the unique identifier and name of each sheet.

  • source_entity (Union[IResolvable, AnalysisSourceEntityProperty, Dict[str, Any], None]) – 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 (Optional[str]) – Status associated with the analysis.

  • tags (Optional[Sequence[Union[CfnTag, Dict[str, Any]]]]) – Contains a map of the key-value pairs for the resource tag or tags assigned to the analysis.

  • theme_arn (Optional[str]) – 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.

  • validation_strategy (Union[IResolvable, ValidationStrategyProperty, Dict[str, Any], None]) – 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:

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

ExampleMetadata:

fixture=_generated

Example:

.. rubric:: Attributes
analysis_id

The ID for the analysis that you’re creating.

This ID displays in the URL of the analysis.

See:

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

aws_account_id

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

See:

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

definition

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

Type:

see

errors

Errors associated with the analysis.

See:

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

folder_arns

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

Type:

see

name

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

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

See:

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

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.

See:

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

permissions

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:

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

sheets

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

See:

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

source_entity

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:

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

status

Status associated with the analysis.

See:

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

tags

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

See:

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

theme_arn

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:

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

validation_strategy

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:

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