CfnAnalysis

class aws_cdk.aws_quicksight.CfnAnalysis(scope, id, *, analysis_id, aws_account_id, source_entity, errors=None, name=None, parameters=None, permissions=None, tags=None, theme_arn=None)

Bases: CfnResource

A CloudFormation AWS::QuickSight::Analysis.

Creates an analysis in Amazon QuickSight.

CloudformationResource

AWS::QuickSight::Analysis

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 = quicksight.CfnAnalysis(self, "MyCfnAnalysis",
    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"
)

Create a new AWS::QuickSight::Analysis.

Parameters
  • scope (Construct) –

    • scope in which this resource is defined.

  • id (str) –

    • scoped id of the resource.

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

Methods

add_deletion_override(path)

Syntactic sugar for addOverride(path, undefined).

Parameters

path (str) – The path of the value to delete.

Return type

None

add_depends_on(target)

Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope.

Parameters

target (CfnResource) –

Return type

None

add_metadata(key, value)

Add a value to the CloudFormation Resource Metadata.

Parameters
  • key (str) –

  • value (Any) –

See

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.

Return type

None

add_override(path, value)

Adds an override to the synthesized CloudFormation resource.

To add a property override, either use addPropertyOverride or prefix path with “Properties.” (i.e. Properties.TopicName).

If the override is nested, separate each nested level using a dot (.) in the path parameter. If there is an array as part of the nesting, specify the index in the path.

To include a literal . in the property name, prefix with a \. In most programming languages you will need to write this as "\\." because the \ itself will need to be escaped.

For example:

# Example automatically generated from non-compiling source. May contain errors.
cfn_resource.add_override("Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes", ["myattribute"])
cfn_resource.add_override("Properties.GlobalSecondaryIndexes.1.ProjectionType", "INCLUDE")

would add the overrides Example:

"Properties": {
   "GlobalSecondaryIndexes": [
     {
       "Projection": {
         "NonKeyAttributes": [ "myattribute" ]
         ...
       }
       ...
     },
     {
       "ProjectionType": "INCLUDE"
       ...
     },
   ]
   ...
}

The value argument to addOverride will not be processed or translated in any way. Pass raw JSON values in here with the correct capitalization for CloudFormation. If you pass CDK classes or structs, they will be rendered with lowercased key names, and CloudFormation will reject the template.

Parameters
  • path (str) –

    • The path of the property, you can use dot notation to override values in complex types. Any intermdediate keys will be created as needed.

  • value (Any) –

    • The value. Could be primitive or complex.

Return type

None

add_property_deletion_override(property_path)

Adds an override that deletes the value of a property from the resource definition.

Parameters

property_path (str) – The path to the property.

Return type

None

add_property_override(property_path, value)

Adds an override to a resource property.

Syntactic sugar for addOverride("Properties.<...>", value).

Parameters
  • property_path (str) – The path of the property.

  • value (Any) – The value.

Return type

None

apply_removal_policy(policy=None, *, apply_to_update_replace_policy=None, default=None)

Sets the deletion policy of the resource based on the removal policy specified.

The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you’ve removed it from the CDK application or because you’ve made a change that requires the resource to be replaced.

The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN). In some cases, a snapshot can be taken of the resource prior to deletion (RemovalPolicy.SNAPSHOT). A list of resources that support this policy can be found in the following link:

Parameters
  • policy (Optional[RemovalPolicy]) –

  • apply_to_update_replace_policy (Optional[bool]) – Apply the same deletion policy to the resource’s “UpdateReplacePolicy”. Default: true

  • default (Optional[RemovalPolicy]) – The default policy to apply in case the removal policy is not defined. Default: - Default value is resource specific. To determine the default value for a resoure, please consult that specific resource’s documentation.

See

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options

Return type

None

get_att(attribute_name)

Returns a token for an runtime attribute of this resource.

Ideally, use generated attribute accessors (e.g. resource.arn), but this can be used for future compatibility in case there is no generated attribute.

Parameters

attribute_name (str) – The name of the attribute.

Return type

Reference

get_metadata(key)

Retrieve a value value from the CloudFormation Resource Metadata.

Parameters

key (str) –

See

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.

Return type

Any

inspect(inspector)

Examines the CloudFormation resource and discloses attributes.

Parameters

inspector (TreeInspector) –

  • tree inspector to collect and process attributes.

Return type

None

override_logical_id(new_logical_id)

Overrides the auto-generated logical ID with a specific ID.

Parameters

new_logical_id (str) – The new logical ID to use for this stack element.

Return type

None

to_string()

Returns a string representation of this construct.

Return type

str

Returns

a string representation of this resource

Attributes

CFN_RESOURCE_TYPE_NAME = 'AWS::QuickSight::Analysis'
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

attr_arn

The Amazon Resource Name (ARN) of the analysis.

CloudformationAttribute

Arn

Return type

str

attr_created_time

CreatedTime

Type

cloudformationAttribute

Return type

str

attr_data_set_arns

The ARNs of the datasets of the analysis.

CloudformationAttribute

DataSetArns

Return type

List[str]

attr_last_updated_time

The time that the analysis was last updated.

CloudformationAttribute

LastUpdatedTime

Return type

str

attr_sheets

Sheets

Type

cloudformationAttribute

Return type

IResolvable

attr_status

Status

Type

cloudformationAttribute

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

cfn_options

Options for this resource, such as condition, update policy etc.

Return type

ICfnResourceOptions

cfn_resource_type

AWS resource type.

Return type

str

creation_stack

return:

the stack trace of the point where this Resource was created from, sourced from the +metadata+ entry typed +aws:cdk:logicalId+, and with the bottom-most node +internal+ entries filtered.

Return type

List[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]

logical_id

The logical ID for this CloudFormation stack element.

The logical ID of the element is calculated from the path of the resource node in the construct tree.

To override this value, use overrideLogicalId(newLogicalId).

Return type

str

Returns

the logical ID as a stringified token. This value will only get resolved during synthesis.

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]

node

The tree node.

Return type

Node

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]

ref

Return a string that will be resolved to a CloudFormation { Ref } for this element.

If, by any chance, the intrinsic reference of a resource is not a string, you could coerce it to an IResolvable through Lazy.any({ produce: resource.ref }).

Return type

str

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]

stack

The stack in which this element is defined.

CfnElements must be defined within a stack scope (directly or indirectly).

Return type

Stack

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

TagManager

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]

Static Methods

classmethod is_cfn_element(x)

Returns true if a construct is a stack element (i.e. part of the synthesized cloudformation template).

Uses duck-typing instead of instanceof to allow stack elements from different versions of this library to be included in the same stack.

Parameters

x (Any) –

Return type

bool

Returns

The construct as a stack element or undefined if it is not a stack element.

classmethod is_cfn_resource(construct)

Check whether the given construct is a CfnResource.

Parameters

construct (IConstruct) –

Return type

bool

classmethod is_construct(x)

Checks if x is a construct.

Use this method instead of instanceof to properly detect Construct instances, even when the construct library is symlinked.

Explanation: in JavaScript, multiple copies of the constructs library on disk are seen as independent, completely different libraries. As a consequence, the class Construct in each copy of the constructs library is seen as a different class, and an instance of one class will not test as instanceof the other class. npm install will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the constructs library can be accidentally installed, and instanceof will behave unpredictably. It is safest to avoid using instanceof, and using this type-testing method instead.

Parameters

x (Any) – Any object.

Return type

bool

Returns

true if x is an object created from a class which extends Construct.

AnalysisErrorProperty

class CfnAnalysis.AnalysisErrorProperty(*, message=None, type=None)

Bases: object

Analysis error.

Parameters
  • message (Optional[str]) – The message associated with the analysis error.

  • type (Optional[str]) – The type of the analysis error.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-analysiserror.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

analysis_error_property = quicksight.CfnAnalysis.AnalysisErrorProperty(
    message="message",
    type="type"
)

Attributes

message

The message associated with the analysis error.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-analysiserror.html#cfn-quicksight-analysis-analysiserror-message

Return type

Optional[str]

type

The type of the analysis error.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-analysiserror.html#cfn-quicksight-analysis-analysiserror-type

Return type

Optional[str]

AnalysisSourceEntityProperty

class CfnAnalysis.AnalysisSourceEntityProperty(*, source_template=None)

Bases: object

The source entity of an analysis.

Parameters

source_template (Union[AnalysisSourceTemplateProperty, Dict[str, Any], IResolvable, None]) – The source template for the source entity of the analysis.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-analysissourceentity.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

analysis_source_entity_property = quicksight.CfnAnalysis.AnalysisSourceEntityProperty(
    source_template=quicksight.CfnAnalysis.AnalysisSourceTemplateProperty(
        arn="arn",
        data_set_references=[quicksight.CfnAnalysis.DataSetReferenceProperty(
            data_set_arn="dataSetArn",
            data_set_placeholder="dataSetPlaceholder"
        )]
    )
)

Attributes

source_template

The source template for the source entity of the analysis.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-analysissourceentity.html#cfn-quicksight-analysis-analysissourceentity-sourcetemplate

Return type

Union[AnalysisSourceTemplateProperty, IResolvable, None]

AnalysisSourceTemplateProperty

class CfnAnalysis.AnalysisSourceTemplateProperty(*, arn, data_set_references)

Bases: object

The source template of an analysis.

Parameters
  • arn (str) – The Amazon Resource Name (ARN) of the source template of an analysis.

  • data_set_references (Union[IResolvable, Sequence[Union[DataSetReferenceProperty, Dict[str, Any], IResolvable]]]) – The dataset references of the source template of an analysis.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-analysissourcetemplate.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

analysis_source_template_property = quicksight.CfnAnalysis.AnalysisSourceTemplateProperty(
    arn="arn",
    data_set_references=[quicksight.CfnAnalysis.DataSetReferenceProperty(
        data_set_arn="dataSetArn",
        data_set_placeholder="dataSetPlaceholder"
    )]
)

Attributes

arn

The Amazon Resource Name (ARN) of the source template of an analysis.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-analysissourcetemplate.html#cfn-quicksight-analysis-analysissourcetemplate-arn

Return type

str

data_set_references

The dataset references of the source template of an analysis.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-analysissourcetemplate.html#cfn-quicksight-analysis-analysissourcetemplate-datasetreferences

Return type

Union[IResolvable, List[Union[DataSetReferenceProperty, IResolvable]]]

DataSetReferenceProperty

class CfnAnalysis.DataSetReferenceProperty(*, data_set_arn, data_set_placeholder)

Bases: object

Dataset reference.

Parameters
  • data_set_arn (str) – Dataset Amazon Resource Name (ARN).

  • data_set_placeholder (str) – Dataset placeholder.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-datasetreference.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

data_set_reference_property = quicksight.CfnAnalysis.DataSetReferenceProperty(
    data_set_arn="dataSetArn",
    data_set_placeholder="dataSetPlaceholder"
)

Attributes

data_set_arn

Dataset Amazon Resource Name (ARN).

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-datasetreference.html#cfn-quicksight-analysis-datasetreference-datasetarn

Return type

str

data_set_placeholder

Dataset placeholder.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-datasetreference.html#cfn-quicksight-analysis-datasetreference-datasetplaceholder

Return type

str

DateTimeParameterProperty

class CfnAnalysis.DateTimeParameterProperty(*, name, values)

Bases: object

A date-time parameter.

Parameters
  • name (str) – A display name for the date-time parameter.

  • values (Sequence[str]) – The values for the date-time parameter.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-datetimeparameter.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

date_time_parameter_property = quicksight.CfnAnalysis.DateTimeParameterProperty(
    name="name",
    values=["values"]
)

Attributes

name

A display name for the date-time parameter.

Link

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

Return type

str

values

The values for the date-time parameter.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-datetimeparameter.html#cfn-quicksight-analysis-datetimeparameter-values

Return type

List[str]

DecimalParameterProperty

class CfnAnalysis.DecimalParameterProperty(*, name, values)

Bases: object

A decimal parameter.

Parameters
  • name (str) – A display name for the decimal parameter.

  • values (Union[IResolvable, Sequence[Union[int, float]]]) – The values for the decimal parameter.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-decimalparameter.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

decimal_parameter_property = quicksight.CfnAnalysis.DecimalParameterProperty(
    name="name",
    values=[123]
)

Attributes

name

A display name for the decimal parameter.

Link

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

Return type

str

values

The values for the decimal parameter.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-decimalparameter.html#cfn-quicksight-analysis-decimalparameter-values

Return type

Union[IResolvable, List[Union[int, float]]]

IntegerParameterProperty

class CfnAnalysis.IntegerParameterProperty(*, name, values)

Bases: object

An integer parameter.

Parameters
  • name (str) – The name of the integer parameter.

  • values (Union[IResolvable, Sequence[Union[int, float]]]) – The values for the integer parameter.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-integerparameter.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

integer_parameter_property = quicksight.CfnAnalysis.IntegerParameterProperty(
    name="name",
    values=[123]
)

Attributes

name

The name of the integer parameter.

Link

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

Return type

str

values

The values for the integer parameter.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-integerparameter.html#cfn-quicksight-analysis-integerparameter-values

Return type

Union[IResolvable, List[Union[int, float]]]

ParametersProperty

class CfnAnalysis.ParametersProperty(*, date_time_parameters=None, decimal_parameters=None, integer_parameters=None, string_parameters=None)

Bases: object

A list of Amazon QuickSight parameters and the list’s override values.

Parameters
Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-parameters.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

parameters_property = 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"]
    )]
)

Attributes

date_time_parameters

The parameters that have a data type of date-time.

Link

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

Return type

Union[IResolvable, List[Union[DateTimeParameterProperty, IResolvable]], None]

decimal_parameters

The parameters that have a data type of decimal.

Link

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

Return type

Union[IResolvable, List[Union[DecimalParameterProperty, IResolvable]], None]

integer_parameters

The parameters that have a data type of integer.

Link

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

Return type

Union[IResolvable, List[Union[IntegerParameterProperty, IResolvable]], None]

string_parameters

The parameters that have a data type of string.

Link

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

Return type

Union[IResolvable, List[Union[StringParameterProperty, IResolvable]], None]

ResourcePermissionProperty

class CfnAnalysis.ResourcePermissionProperty(*, actions, principal)

Bases: object

Permission for the resource.

Parameters
  • actions (Sequence[str]) – The IAM action to grant or revoke permissions on.

  • principal (str) – The Amazon Resource Name (ARN) of the principal. This can be one of the following:. - The ARN of an Amazon QuickSight user or group associated with a data source or dataset. (This is common.) - The ARN of an Amazon QuickSight user, group, or namespace associated with an analysis, dashboard, template, or theme. (This is common.) - The ARN of an AWS account root: This is an IAM ARN rather than a Amazon QuickSight ARN. Use this option only to share resources (templates) across AWS accounts . (This is less common.)

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-resourcepermission.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

resource_permission_property = quicksight.CfnAnalysis.ResourcePermissionProperty(
    actions=["actions"],
    principal="principal"
)

Attributes

actions

The IAM action to grant or revoke permissions on.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-resourcepermission.html#cfn-quicksight-analysis-resourcepermission-actions

Return type

List[str]

principal

.

  • The ARN of an Amazon QuickSight user or group associated with a data source or dataset. (This is common.)

  • The ARN of an Amazon QuickSight user, group, or namespace associated with an analysis, dashboard, template, or theme. (This is common.)

  • The ARN of an AWS account root: This is an IAM ARN rather than a Amazon QuickSight ARN. Use this option only to share resources (templates) across AWS accounts . (This is less common.)

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-resourcepermission.html#cfn-quicksight-analysis-resourcepermission-principal

Type

The Amazon Resource Name (ARN) of the principal. This can be one of the following

Return type

str

SheetProperty

class CfnAnalysis.SheetProperty(*, name=None, sheet_id=None)

Bases: object

A sheet , which is an object that contains a set of visuals that are viewed together on one page in Amazon QuickSight.

Every analysis and dashboard contains at least one sheet. Each sheet contains at least one visualization widget, for example a chart, pivot table, or narrative insight. Sheets can be associated with other components, such as controls, filters, and so on.

Parameters
  • name (Optional[str]) – The name of a sheet. This name is displayed on the sheet’s tab in the Amazon QuickSight console.

  • sheet_id (Optional[str]) – The unique identifier associated with a sheet.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-sheet.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

sheet_property = quicksight.CfnAnalysis.SheetProperty(
    name="name",
    sheet_id="sheetId"
)

Attributes

name

The name of a sheet.

This name is displayed on the sheet’s tab in the Amazon QuickSight console.

Link

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

Return type

Optional[str]

sheet_id

The unique identifier associated with a sheet.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-sheet.html#cfn-quicksight-analysis-sheet-sheetid

Return type

Optional[str]

StringParameterProperty

class CfnAnalysis.StringParameterProperty(*, name, values)

Bases: object

A string parameter.

Parameters
  • name (str) – A display name for a string parameter.

  • values (Sequence[str]) – The values of a string parameter.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-stringparameter.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

string_parameter_property = quicksight.CfnAnalysis.StringParameterProperty(
    name="name",
    values=["values"]
)

Attributes

name

A display name for a string parameter.

Link

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

Return type

str

values

The values of a string parameter.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-stringparameter.html#cfn-quicksight-analysis-stringparameter-values

Return type

List[str]