CfnAnalysisProps

class aws_cdk.aws_quicksight.CfnAnalysisProps(*, analysis_id, aws_account_id, source_entity, errors=None, name=None, parameters=None, permissions=None, tags=None, theme_arn=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.

  • source_entity (Union[AnalysisSourceEntityProperty, Dict[str, Any], IResolvable]) – 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.

  • errors (Union[IResolvable, Sequence[Union[AnalysisErrorProperty, Dict[str, Any], IResolvable]], None]) – AWS::QuickSight::Analysis.Errors.

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

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

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

Link

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

ExampleMetadata

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_quicksight as quicksight

cfn_analysis_props = quicksight.CfnAnalysisProps(
    analysis_id="analysisId",
    aws_account_id="awsAccountId",
    source_entity=quicksight.CfnAnalysis.AnalysisSourceEntityProperty(
        source_template=quicksight.CfnAnalysis.AnalysisSourceTemplateProperty(
            arn="arn",
            data_set_references=[quicksight.CfnAnalysis.DataSetReferenceProperty(
                data_set_arn="dataSetArn",
                data_set_placeholder="dataSetPlaceholder"
            )]
        )
    ),

    # the properties below are optional
    errors=[quicksight.CfnAnalysis.AnalysisErrorProperty(
        message="message",
        type="type"
    )],
    name="name",
    parameters=quicksight.CfnAnalysis.ParametersProperty(
        date_time_parameters=[quicksight.CfnAnalysis.DateTimeParameterProperty(
            name="name",
            values=["values"]
        )],
        decimal_parameters=[quicksight.CfnAnalysis.DecimalParameterProperty(
            name="name",
            values=[123]
        )],
        integer_parameters=[quicksight.CfnAnalysis.IntegerParameterProperty(
            name="name",
            values=[123]
        )],
        string_parameters=[quicksight.CfnAnalysis.StringParameterProperty(
            name="name",
            values=["values"]
        )]
    ),
    permissions=[quicksight.CfnAnalysis.ResourcePermissionProperty(
        actions=["actions"],
        principal="principal"
    )],
    tags=[CfnTag(
        key="key",
        value="value"
    )],
    theme_arn="themeArn"
)

Attributes

analysis_id

The ID for the analysis that you’re creating.

This ID displays in the URL of the analysis.

Link

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

Return type

str

aws_account_id

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

Link

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

Return type

str

errors

AWS::QuickSight::Analysis.Errors.

Link

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

Return type

Union[IResolvable, List[Union[AnalysisErrorProperty, IResolvable]], None]

name

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

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

Link

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

Return type

Optional[str]

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.

Link

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

Return type

Union[ParametersProperty, IResolvable, None]

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 .

Link

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

Return type

Union[IResolvable, List[Union[ResourcePermissionProperty, IResolvable]], None]

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.

Link

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

Return type

Union[AnalysisSourceEntityProperty, IResolvable]

tags

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

Link

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

Return type

Optional[List[CfnTag]]

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.

Link

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

Return type

Optional[str]