CfnDataSource

class aws_cdk.aws_quicksight.CfnDataSource(scope, id, *, alternate_data_source_parameters=None, aws_account_id=None, credentials=None, data_source_id=None, data_source_parameters=None, error_info=None, name=None, permissions=None, ssl_properties=None, tags=None, type=None, vpc_connection_properties=None)

Bases: CfnResource

A CloudFormation AWS::QuickSight::DataSource.

Creates a data source.

CloudformationResource

AWS::QuickSight::DataSource

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-quicksight-datasource.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_data_source = quicksight.CfnDataSource(self, "MyCfnDataSource",
    alternate_data_source_parameters=[quicksight.CfnDataSource.DataSourceParametersProperty(
        amazon_elasticsearch_parameters=quicksight.CfnDataSource.AmazonElasticsearchParametersProperty(
            domain="domain"
        ),
        amazon_open_search_parameters=quicksight.CfnDataSource.AmazonOpenSearchParametersProperty(
            domain="domain"
        ),
        athena_parameters=quicksight.CfnDataSource.AthenaParametersProperty(
            work_group="workGroup"
        ),
        aurora_parameters=quicksight.CfnDataSource.AuroraParametersProperty(
            database="database",
            host="host",
            port=123
        ),
        aurora_postgre_sql_parameters=quicksight.CfnDataSource.AuroraPostgreSqlParametersProperty(
            database="database",
            host="host",
            port=123
        ),
        maria_db_parameters=quicksight.CfnDataSource.MariaDbParametersProperty(
            database="database",
            host="host",
            port=123
        ),
        my_sql_parameters=quicksight.CfnDataSource.MySqlParametersProperty(
            database="database",
            host="host",
            port=123
        ),
        oracle_parameters=quicksight.CfnDataSource.OracleParametersProperty(
            database="database",
            host="host",
            port=123
        ),
        postgre_sql_parameters=quicksight.CfnDataSource.PostgreSqlParametersProperty(
            database="database",
            host="host",
            port=123
        ),
        presto_parameters=quicksight.CfnDataSource.PrestoParametersProperty(
            catalog="catalog",
            host="host",
            port=123
        ),
        rds_parameters=quicksight.CfnDataSource.RdsParametersProperty(
            database="database",
            instance_id="instanceId"
        ),
        redshift_parameters=quicksight.CfnDataSource.RedshiftParametersProperty(
            database="database",

            # the properties below are optional
            cluster_id="clusterId",
            host="host",
            port=123
        ),
        s3_parameters=quicksight.CfnDataSource.S3ParametersProperty(
            manifest_file_location=quicksight.CfnDataSource.ManifestFileLocationProperty(
                bucket="bucket",
                key="key"
            )
        ),
        snowflake_parameters=quicksight.CfnDataSource.SnowflakeParametersProperty(
            database="database",
            host="host",
            warehouse="warehouse"
        ),
        spark_parameters=quicksight.CfnDataSource.SparkParametersProperty(
            host="host",
            port=123
        ),
        sql_server_parameters=quicksight.CfnDataSource.SqlServerParametersProperty(
            database="database",
            host="host",
            port=123
        ),
        teradata_parameters=quicksight.CfnDataSource.TeradataParametersProperty(
            database="database",
            host="host",
            port=123
        )
    )],
    aws_account_id="awsAccountId",
    credentials=quicksight.CfnDataSource.DataSourceCredentialsProperty(
        copy_source_arn="copySourceArn",
        credential_pair=quicksight.CfnDataSource.CredentialPairProperty(
            password="password",
            username="username",

            # the properties below are optional
            alternate_data_source_parameters=[quicksight.CfnDataSource.DataSourceParametersProperty(
                amazon_elasticsearch_parameters=quicksight.CfnDataSource.AmazonElasticsearchParametersProperty(
                    domain="domain"
                ),
                amazon_open_search_parameters=quicksight.CfnDataSource.AmazonOpenSearchParametersProperty(
                    domain="domain"
                ),
                athena_parameters=quicksight.CfnDataSource.AthenaParametersProperty(
                    work_group="workGroup"
                ),
                aurora_parameters=quicksight.CfnDataSource.AuroraParametersProperty(
                    database="database",
                    host="host",
                    port=123
                ),
                aurora_postgre_sql_parameters=quicksight.CfnDataSource.AuroraPostgreSqlParametersProperty(
                    database="database",
                    host="host",
                    port=123
                ),
                maria_db_parameters=quicksight.CfnDataSource.MariaDbParametersProperty(
                    database="database",
                    host="host",
                    port=123
                ),
                my_sql_parameters=quicksight.CfnDataSource.MySqlParametersProperty(
                    database="database",
                    host="host",
                    port=123
                ),
                oracle_parameters=quicksight.CfnDataSource.OracleParametersProperty(
                    database="database",
                    host="host",
                    port=123
                ),
                postgre_sql_parameters=quicksight.CfnDataSource.PostgreSqlParametersProperty(
                    database="database",
                    host="host",
                    port=123
                ),
                presto_parameters=quicksight.CfnDataSource.PrestoParametersProperty(
                    catalog="catalog",
                    host="host",
                    port=123
                ),
                rds_parameters=quicksight.CfnDataSource.RdsParametersProperty(
                    database="database",
                    instance_id="instanceId"
                ),
                redshift_parameters=quicksight.CfnDataSource.RedshiftParametersProperty(
                    database="database",

                    # the properties below are optional
                    cluster_id="clusterId",
                    host="host",
                    port=123
                ),
                s3_parameters=quicksight.CfnDataSource.S3ParametersProperty(
                    manifest_file_location=quicksight.CfnDataSource.ManifestFileLocationProperty(
                        bucket="bucket",
                        key="key"
                    )
                ),
                snowflake_parameters=quicksight.CfnDataSource.SnowflakeParametersProperty(
                    database="database",
                    host="host",
                    warehouse="warehouse"
                ),
                spark_parameters=quicksight.CfnDataSource.SparkParametersProperty(
                    host="host",
                    port=123
                ),
                sql_server_parameters=quicksight.CfnDataSource.SqlServerParametersProperty(
                    database="database",
                    host="host",
                    port=123
                ),
                teradata_parameters=quicksight.CfnDataSource.TeradataParametersProperty(
                    database="database",
                    host="host",
                    port=123
                )
            )]
        ),
        secret_arn="secretArn"
    ),
    data_source_id="dataSourceId",
    data_source_parameters=quicksight.CfnDataSource.DataSourceParametersProperty(
        amazon_elasticsearch_parameters=quicksight.CfnDataSource.AmazonElasticsearchParametersProperty(
            domain="domain"
        ),
        amazon_open_search_parameters=quicksight.CfnDataSource.AmazonOpenSearchParametersProperty(
            domain="domain"
        ),
        athena_parameters=quicksight.CfnDataSource.AthenaParametersProperty(
            work_group="workGroup"
        ),
        aurora_parameters=quicksight.CfnDataSource.AuroraParametersProperty(
            database="database",
            host="host",
            port=123
        ),
        aurora_postgre_sql_parameters=quicksight.CfnDataSource.AuroraPostgreSqlParametersProperty(
            database="database",
            host="host",
            port=123
        ),
        maria_db_parameters=quicksight.CfnDataSource.MariaDbParametersProperty(
            database="database",
            host="host",
            port=123
        ),
        my_sql_parameters=quicksight.CfnDataSource.MySqlParametersProperty(
            database="database",
            host="host",
            port=123
        ),
        oracle_parameters=quicksight.CfnDataSource.OracleParametersProperty(
            database="database",
            host="host",
            port=123
        ),
        postgre_sql_parameters=quicksight.CfnDataSource.PostgreSqlParametersProperty(
            database="database",
            host="host",
            port=123
        ),
        presto_parameters=quicksight.CfnDataSource.PrestoParametersProperty(
            catalog="catalog",
            host="host",
            port=123
        ),
        rds_parameters=quicksight.CfnDataSource.RdsParametersProperty(
            database="database",
            instance_id="instanceId"
        ),
        redshift_parameters=quicksight.CfnDataSource.RedshiftParametersProperty(
            database="database",

            # the properties below are optional
            cluster_id="clusterId",
            host="host",
            port=123
        ),
        s3_parameters=quicksight.CfnDataSource.S3ParametersProperty(
            manifest_file_location=quicksight.CfnDataSource.ManifestFileLocationProperty(
                bucket="bucket",
                key="key"
            )
        ),
        snowflake_parameters=quicksight.CfnDataSource.SnowflakeParametersProperty(
            database="database",
            host="host",
            warehouse="warehouse"
        ),
        spark_parameters=quicksight.CfnDataSource.SparkParametersProperty(
            host="host",
            port=123
        ),
        sql_server_parameters=quicksight.CfnDataSource.SqlServerParametersProperty(
            database="database",
            host="host",
            port=123
        ),
        teradata_parameters=quicksight.CfnDataSource.TeradataParametersProperty(
            database="database",
            host="host",
            port=123
        )
    ),
    error_info=quicksight.CfnDataSource.DataSourceErrorInfoProperty(
        message="message",
        type="type"
    ),
    name="name",
    permissions=[quicksight.CfnDataSource.ResourcePermissionProperty(
        actions=["actions"],
        principal="principal"
    )],
    ssl_properties=quicksight.CfnDataSource.SslPropertiesProperty(
        disable_ssl=False
    ),
    tags=[CfnTag(
        key="key",
        value="value"
    )],
    type="type",
    vpc_connection_properties=quicksight.CfnDataSource.VpcConnectionPropertiesProperty(
        vpc_connection_arn="vpcConnectionArn"
    )
)

Create a new AWS::QuickSight::DataSource.

Parameters
  • scope (Construct) –

    • scope in which this resource is defined.

  • id (str) –

    • scoped id of the resource.

  • alternate_data_source_parameters (Union[IResolvable, Sequence[Union[DataSourceParametersProperty, Dict[str, Any], IResolvable]], None]) – A set of alternate data source parameters that you want to share for the credentials stored with this data source. The credentials are applied in tandem with the data source parameters when you copy a data source by using a create or update request. The API operation compares the DataSourceParameters structure that’s in the request with the structures in the AlternateDataSourceParameters allow list. If the structures are an exact match, the request is allowed to use the credentials from this existing data source. If the AlternateDataSourceParameters list is null, the Credentials originally used with this DataSourceParameters are automatically allowed.

  • aws_account_id (Optional[str]) – The AWS account ID.

  • credentials (Union[DataSourceCredentialsProperty, Dict[str, Any], IResolvable, None]) – The credentials Amazon QuickSight that uses to connect to your underlying source. Currently, only credentials based on user name and password are supported.

  • data_source_id (Optional[str]) – An ID for the data source. This ID is unique per AWS Region for each AWS account.

  • data_source_parameters (Union[DataSourceParametersProperty, Dict[str, Any], IResolvable, None]) – The parameters that Amazon QuickSight uses to connect to your underlying source.

  • error_info (Union[DataSourceErrorInfoProperty, Dict[str, Any], IResolvable, None]) – Error information from the last update or the creation of the data source.

  • name (Optional[str]) – A display name for the data source.

  • permissions (Union[IResolvable, Sequence[Union[ResourcePermissionProperty, Dict[str, Any], IResolvable]], None]) – A list of resource permissions on the data source.

  • ssl_properties (Union[SslPropertiesProperty, Dict[str, Any], IResolvable, None]) – Secure Socket Layer (SSL) properties that apply when Amazon QuickSight connects to your underlying source.

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

  • type (Optional[str]) – The type of the data source. To return a list of all data sources, use ListDataSources . Use AMAZON_ELASTICSEARCH for Amazon OpenSearch Service.

  • vpc_connection_properties (Union[VpcConnectionPropertiesProperty, Dict[str, Any], IResolvable, None]) – Use this parameter only when you want Amazon QuickSight to use a VPC connection when connecting to your underlying source.

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::DataSource'
alternate_data_source_parameters

A set of alternate data source parameters that you want to share for the credentials stored with this data source.

The credentials are applied in tandem with the data source parameters when you copy a data source by using a create or update request. The API operation compares the DataSourceParameters structure that’s in the request with the structures in the AlternateDataSourceParameters allow list. If the structures are an exact match, the request is allowed to use the credentials from this existing data source. If the AlternateDataSourceParameters list is null, the Credentials originally used with this DataSourceParameters are automatically allowed.

Link

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

Return type

Union[IResolvable, List[Union[DataSourceParametersProperty, IResolvable]], None]

attr_arn

The Amazon Resource Name (ARN) of the dataset.

CloudformationAttribute

Arn

Return type

str

attr_created_time

The time that this data source was created.

CloudformationAttribute

CreatedTime

Return type

str

attr_last_updated_time

The last time that this data source was updated.

CloudformationAttribute

LastUpdatedTime

Return type

str

attr_status

The HTTP status of the request.

CloudformationAttribute

Status

Return type

str

aws_account_id

The AWS account ID.

Link

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

Return type

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

credentials

The credentials Amazon QuickSight that uses to connect to your underlying source.

Currently, only credentials based on user name and password are supported.

Link

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

Return type

Union[DataSourceCredentialsProperty, IResolvable, None]

data_source_id

An ID for the data source.

This ID is unique per AWS Region for each AWS account.

Link

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

Return type

Optional[str]

data_source_parameters

The parameters that Amazon QuickSight uses to connect to your underlying source.

Link

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

Return type

Union[DataSourceParametersProperty, IResolvable, None]

error_info

Error information from the last update or the creation of the data source.

Link

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

Return type

Union[DataSourceErrorInfoProperty, 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 display name for the data source.

Link

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

Return type

Optional[str]

node

The tree node.

Return type

Node

permissions

A list of resource permissions on the data source.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-quicksight-datasource.html#cfn-quicksight-datasource-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

ssl_properties

Secure Socket Layer (SSL) properties that apply when Amazon QuickSight connects to your underlying source.

Link

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

Return type

Union[SslPropertiesProperty, IResolvable, None]

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 data source.

Link

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

Return type

TagManager

type

The type of the data source. To return a list of all data sources, use ListDataSources .

Use AMAZON_ELASTICSEARCH for Amazon OpenSearch Service.

Link

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

Return type

Optional[str]

vpc_connection_properties

Use this parameter only when you want Amazon QuickSight to use a VPC connection when connecting to your underlying source.

Link

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

Return type

Union[VpcConnectionPropertiesProperty, IResolvable, None]

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.

AmazonElasticsearchParametersProperty

class CfnDataSource.AmazonElasticsearchParametersProperty(*, domain)

Bases: object

The parameters for OpenSearch.

Parameters

domain (str) – The OpenSearch domain.

Link

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

amazon_elasticsearch_parameters_property = quicksight.CfnDataSource.AmazonElasticsearchParametersProperty(
    domain="domain"
)

Attributes

domain

The OpenSearch domain.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-datasource-amazonelasticsearchparameters.html#cfn-quicksight-datasource-amazonelasticsearchparameters-domain

Return type

str

AmazonOpenSearchParametersProperty

class CfnDataSource.AmazonOpenSearchParametersProperty(*, domain)

Bases: object

The parameters for OpenSearch.

Parameters

domain (str) – The OpenSearch domain.

Link

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

amazon_open_search_parameters_property = quicksight.CfnDataSource.AmazonOpenSearchParametersProperty(
    domain="domain"
)

Attributes

domain

The OpenSearch domain.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-datasource-amazonopensearchparameters.html#cfn-quicksight-datasource-amazonopensearchparameters-domain

Return type

str

AthenaParametersProperty

class CfnDataSource.AthenaParametersProperty(*, work_group=None)

Bases: object

Parameters for Amazon Athena.

Parameters

work_group (Optional[str]) – The workgroup that Amazon Athena uses.

Link

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

athena_parameters_property = quicksight.CfnDataSource.AthenaParametersProperty(
    work_group="workGroup"
)

Attributes

work_group

The workgroup that Amazon Athena uses.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-datasource-athenaparameters.html#cfn-quicksight-datasource-athenaparameters-workgroup

Return type

Optional[str]

AuroraParametersProperty

class CfnDataSource.AuroraParametersProperty(*, database, host, port)

Bases: object

Parameters for Amazon Aurora.

Parameters
  • database (str) – Database.

  • host (str) – Host.

  • port (Union[int, float]) – Port.

Link

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

aurora_parameters_property = quicksight.CfnDataSource.AuroraParametersProperty(
    database="database",
    host="host",
    port=123
)

Attributes

database

Database.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-datasource-auroraparameters.html#cfn-quicksight-datasource-auroraparameters-database

Return type

str

host

Host.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-datasource-auroraparameters.html#cfn-quicksight-datasource-auroraparameters-host

Return type

str

port

Port.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-datasource-auroraparameters.html#cfn-quicksight-datasource-auroraparameters-port

Return type

Union[int, float]

AuroraPostgreSqlParametersProperty

class CfnDataSource.AuroraPostgreSqlParametersProperty(*, database, host, port)

Bases: object

Parameters for Amazon Aurora PostgreSQL-Compatible Edition.

Parameters
  • database (str) – The Amazon Aurora PostgreSQL database to connect to.

  • host (str) – The Amazon Aurora PostgreSQL-Compatible host to connect to.

  • port (Union[int, float]) – The port that Amazon Aurora PostgreSQL is listening on.

Link

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

aurora_postgre_sql_parameters_property = quicksight.CfnDataSource.AuroraPostgreSqlParametersProperty(
    database="database",
    host="host",
    port=123
)

Attributes

database

The Amazon Aurora PostgreSQL database to connect to.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-datasource-aurorapostgresqlparameters.html#cfn-quicksight-datasource-aurorapostgresqlparameters-database

Return type

str

host

The Amazon Aurora PostgreSQL-Compatible host to connect to.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-datasource-aurorapostgresqlparameters.html#cfn-quicksight-datasource-aurorapostgresqlparameters-host

Return type

str

port

The port that Amazon Aurora PostgreSQL is listening on.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-datasource-aurorapostgresqlparameters.html#cfn-quicksight-datasource-aurorapostgresqlparameters-port

Return type

Union[int, float]

CredentialPairProperty

class CfnDataSource.CredentialPairProperty(*, password, username, alternate_data_source_parameters=None)

Bases: object

The combination of user name and password that are used as credentials.

Parameters
  • password (str) – Password.

  • username (str) – User name.

  • alternate_data_source_parameters (Union[IResolvable, Sequence[Union[DataSourceParametersProperty, Dict[str, Any], IResolvable]], None]) – A set of alternate data source parameters that you want to share for these credentials. The credentials are applied in tandem with the data source parameters when you copy a data source by using a create or update request. The API operation compares the DataSourceParameters structure that’s in the request with the structures in the AlternateDataSourceParameters allow list. If the structures are an exact match, the request is allowed to use the new data source with the existing credentials. If the AlternateDataSourceParameters list is null, the DataSourceParameters originally used with these Credentials is automatically allowed.

Link

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

credential_pair_property = quicksight.CfnDataSource.CredentialPairProperty(
    password="password",
    username="username",

    # the properties below are optional
    alternate_data_source_parameters=[quicksight.CfnDataSource.DataSourceParametersProperty(
        amazon_elasticsearch_parameters=quicksight.CfnDataSource.AmazonElasticsearchParametersProperty(
            domain="domain"
        ),
        amazon_open_search_parameters=quicksight.CfnDataSource.AmazonOpenSearchParametersProperty(
            domain="domain"
        ),
        athena_parameters=quicksight.CfnDataSource.AthenaParametersProperty(
            work_group="workGroup"
        ),
        aurora_parameters=quicksight.CfnDataSource.AuroraParametersProperty(
            database="database",
            host="host",
            port=123
        ),
        aurora_postgre_sql_parameters=quicksight.CfnDataSource.AuroraPostgreSqlParametersProperty(
            database="database",
            host="host",
            port=123
        ),
        maria_db_parameters=quicksight.CfnDataSource.MariaDbParametersProperty(
            database="database",
            host="host",
            port=123
        ),
        my_sql_parameters=quicksight.CfnDataSource.MySqlParametersProperty(
            database="database",
            host="host",
            port=123
        ),
        oracle_parameters=quicksight.CfnDataSource.OracleParametersProperty(
            database="database",
            host="host",
            port=123
        ),
        postgre_sql_parameters=quicksight.CfnDataSource.PostgreSqlParametersProperty(
            database="database",
            host="host",
            port=123
        ),
        presto_parameters=quicksight.CfnDataSource.PrestoParametersProperty(
            catalog="catalog",
            host="host",
            port=123
        ),
        rds_parameters=quicksight.CfnDataSource.RdsParametersProperty(
            database="database",
            instance_id="instanceId"
        ),
        redshift_parameters=quicksight.CfnDataSource.RedshiftParametersProperty(
            database="database",

            # the properties below are optional
            cluster_id="clusterId",
            host="host",
            port=123
        ),
        s3_parameters=quicksight.CfnDataSource.S3ParametersProperty(
            manifest_file_location=quicksight.CfnDataSource.ManifestFileLocationProperty(
                bucket="bucket",
                key="key"
            )
        ),
        snowflake_parameters=quicksight.CfnDataSource.SnowflakeParametersProperty(
            database="database",
            host="host",
            warehouse="warehouse"
        ),
        spark_parameters=quicksight.CfnDataSource.SparkParametersProperty(
            host="host",
            port=123
        ),
        sql_server_parameters=quicksight.CfnDataSource.SqlServerParametersProperty(
            database="database",
            host="host",
            port=123
        ),
        teradata_parameters=quicksight.CfnDataSource.TeradataParametersProperty(
            database="database",
            host="host",
            port=123
        )
    )]
)

Attributes

alternate_data_source_parameters

A set of alternate data source parameters that you want to share for these credentials.

The credentials are applied in tandem with the data source parameters when you copy a data source by using a create or update request. The API operation compares the DataSourceParameters structure that’s in the request with the structures in the AlternateDataSourceParameters allow list. If the structures are an exact match, the request is allowed to use the new data source with the existing credentials. If the AlternateDataSourceParameters list is null, the DataSourceParameters originally used with these Credentials is automatically allowed.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-datasource-credentialpair.html#cfn-quicksight-datasource-credentialpair-alternatedatasourceparameters

Return type

Union[IResolvable, List[Union[DataSourceParametersProperty, IResolvable]], None]

password

Password.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-datasource-credentialpair.html#cfn-quicksight-datasource-credentialpair-password

Return type

str

username

User name.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-datasource-credentialpair.html#cfn-quicksight-datasource-credentialpair-username

Return type

str

DataSourceCredentialsProperty

class CfnDataSource.DataSourceCredentialsProperty(*, copy_source_arn=None, credential_pair=None, secret_arn=None)

Bases: object

Data source credentials.

This is a variant type structure. For this structure to be valid, only one of the attributes can be non-null.

Parameters
  • copy_source_arn (Optional[str]) – The Amazon Resource Name (ARN) of a data source that has the credential pair that you want to use. When CopySourceArn is not null, the credential pair from the data source in the ARN is used as the credentials for the DataSourceCredentials structure.

  • credential_pair (Union[CredentialPairProperty, Dict[str, Any], IResolvable, None]) – Credential pair. For more information, see [CredentialPair](https://docs.aws.amazon.com/quicksight/latest/APIReference/API_CredentialPair.html) .

  • secret_arn (Optional[str]) – CfnDataSource.DataSourceCredentialsProperty.SecretArn.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-datasource-datasourcecredentials.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_source_credentials_property = quicksight.CfnDataSource.DataSourceCredentialsProperty(
    copy_source_arn="copySourceArn",
    credential_pair=quicksight.CfnDataSource.CredentialPairProperty(
        password="password",
        username="username",

        # the properties below are optional
        alternate_data_source_parameters=[quicksight.CfnDataSource.DataSourceParametersProperty(
            amazon_elasticsearch_parameters=quicksight.CfnDataSource.AmazonElasticsearchParametersProperty(
                domain="domain"
            ),
            amazon_open_search_parameters=quicksight.CfnDataSource.AmazonOpenSearchParametersProperty(
                domain="domain"
            ),
            athena_parameters=quicksight.CfnDataSource.AthenaParametersProperty(
                work_group="workGroup"
            ),
            aurora_parameters=quicksight.CfnDataSource.AuroraParametersProperty(
                database="database",
                host="host",
                port=123
            ),
            aurora_postgre_sql_parameters=quicksight.CfnDataSource.AuroraPostgreSqlParametersProperty(
                database="database",
                host="host",
                port=123
            ),
            maria_db_parameters=quicksight.CfnDataSource.MariaDbParametersProperty(
                database="database",
                host="host",
                port=123
            ),
            my_sql_parameters=quicksight.CfnDataSource.MySqlParametersProperty(
                database="database",
                host="host",
                port=123
            ),
            oracle_parameters=quicksight.CfnDataSource.OracleParametersProperty(
                database="database",
                host="host",
                port=123
            ),
            postgre_sql_parameters=quicksight.CfnDataSource.PostgreSqlParametersProperty(
                database="database",
                host="host",
                port=123
            ),
            presto_parameters=quicksight.CfnDataSource.PrestoParametersProperty(
                catalog="catalog",
                host="host",
                port=123
            ),
            rds_parameters=quicksight.CfnDataSource.RdsParametersProperty(
                database="database",
                instance_id="instanceId"
            ),
            redshift_parameters=quicksight.CfnDataSource.RedshiftParametersProperty(
                database="database",

                # the properties below are optional
                cluster_id="clusterId",
                host="host",
                port=123
            ),
            s3_parameters=quicksight.CfnDataSource.S3ParametersProperty(
                manifest_file_location=quicksight.CfnDataSource.ManifestFileLocationProperty(
                    bucket="bucket",
                    key="key"
                )
            ),
            snowflake_parameters=quicksight.CfnDataSource.SnowflakeParametersProperty(
                database="database",
                host="host",
                warehouse="warehouse"
            ),
            spark_parameters=quicksight.CfnDataSource.SparkParametersProperty(
                host="host",
                port=123
            ),
            sql_server_parameters=quicksight.CfnDataSource.SqlServerParametersProperty(
                database="database",
                host="host",
                port=123
            ),
            teradata_parameters=quicksight.CfnDataSource.TeradataParametersProperty(
                database="database",
                host="host",
                port=123
            )
        )]
    ),
    secret_arn="secretArn"
)

Attributes

copy_source_arn

The Amazon Resource Name (ARN) of a data source that has the credential pair that you want to use.

When CopySourceArn is not null, the credential pair from the data source in the ARN is used as the credentials for the DataSourceCredentials structure.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-datasource-datasourcecredentials.html#cfn-quicksight-datasource-datasourcecredentials-copysourcearn

Return type

Optional[str]

credential_pair

Credential pair.

For more information, see [CredentialPair](https://docs.aws.amazon.com/quicksight/latest/APIReference/API_CredentialPair.html) .

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-datasource-datasourcecredentials.html#cfn-quicksight-datasource-datasourcecredentials-credentialpair

Return type

Union[CredentialPairProperty, IResolvable, None]

secret_arn

CfnDataSource.DataSourceCredentialsProperty.SecretArn.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-datasource-datasourcecredentials.html#cfn-quicksight-datasource-datasourcecredentials-secretarn

Return type

Optional[str]

DataSourceErrorInfoProperty

class CfnDataSource.DataSourceErrorInfoProperty(*, message=None, type=None)

Bases: object

Error information for the data source creation or update.

Parameters
  • message (Optional[str]) – Error message.

  • type (Optional[str]) – Error type.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-datasource-datasourceerrorinfo.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_source_error_info_property = quicksight.CfnDataSource.DataSourceErrorInfoProperty(
    message="message",
    type="type"
)

Attributes

message

Error message.

Link

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

Return type

Optional[str]

type

Error type.

Link

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

Return type

Optional[str]

DataSourceParametersProperty

class CfnDataSource.DataSourceParametersProperty(*, amazon_elasticsearch_parameters=None, amazon_open_search_parameters=None, athena_parameters=None, aurora_parameters=None, aurora_postgre_sql_parameters=None, maria_db_parameters=None, my_sql_parameters=None, oracle_parameters=None, postgre_sql_parameters=None, presto_parameters=None, rds_parameters=None, redshift_parameters=None, s3_parameters=None, snowflake_parameters=None, spark_parameters=None, sql_server_parameters=None, teradata_parameters=None)

Bases: object

The parameters that Amazon QuickSight uses to connect to your underlying data source.

This is a variant type structure. For this structure to be valid, only one of the attributes can be non-null.

Parameters
Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-datasource-datasourceparameters.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_source_parameters_property = quicksight.CfnDataSource.DataSourceParametersProperty(
    amazon_elasticsearch_parameters=quicksight.CfnDataSource.AmazonElasticsearchParametersProperty(
        domain="domain"
    ),
    amazon_open_search_parameters=quicksight.CfnDataSource.AmazonOpenSearchParametersProperty(
        domain="domain"
    ),
    athena_parameters=quicksight.CfnDataSource.AthenaParametersProperty(
        work_group="workGroup"
    ),
    aurora_parameters=quicksight.CfnDataSource.AuroraParametersProperty(
        database="database",
        host="host",
        port=123
    ),
    aurora_postgre_sql_parameters=quicksight.CfnDataSource.AuroraPostgreSqlParametersProperty(
        database="database",
        host="host",
        port=123
    ),
    maria_db_parameters=quicksight.CfnDataSource.MariaDbParametersProperty(
        database="database",
        host="host",
        port=123
    ),
    my_sql_parameters=quicksight.CfnDataSource.MySqlParametersProperty(
        database="database",
        host="host",
        port=123
    ),
    oracle_parameters=quicksight.CfnDataSource.OracleParametersProperty(
        database="database",
        host="host",
        port=123
    ),
    postgre_sql_parameters=quicksight.CfnDataSource.PostgreSqlParametersProperty(
        database="database",
        host="host",
        port=123
    ),
    presto_parameters=quicksight.CfnDataSource.PrestoParametersProperty(
        catalog="catalog",
        host="host",
        port=123
    ),
    rds_parameters=quicksight.CfnDataSource.RdsParametersProperty(
        database="database",
        instance_id="instanceId"
    ),
    redshift_parameters=quicksight.CfnDataSource.RedshiftParametersProperty(
        database="database",

        # the properties below are optional
        cluster_id="clusterId",
        host="host",
        port=123
    ),
    s3_parameters=quicksight.CfnDataSource.S3ParametersProperty(
        manifest_file_location=quicksight.CfnDataSource.ManifestFileLocationProperty(
            bucket="bucket",
            key="key"
        )
    ),
    snowflake_parameters=quicksight.CfnDataSource.SnowflakeParametersProperty(
        database="database",
        host="host",
        warehouse="warehouse"
    ),
    spark_parameters=quicksight.CfnDataSource.SparkParametersProperty(
        host="host",
        port=123
    ),
    sql_server_parameters=quicksight.CfnDataSource.SqlServerParametersProperty(
        database="database",
        host="host",
        port=123
    ),
    teradata_parameters=quicksight.CfnDataSource.TeradataParametersProperty(
        database="database",
        host="host",
        port=123
    )
)

Attributes

amazon_elasticsearch_parameters

The parameters for OpenSearch.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-datasource-datasourceparameters.html#cfn-quicksight-datasource-datasourceparameters-amazonelasticsearchparameters

Return type

Union[AmazonElasticsearchParametersProperty, IResolvable, None]

amazon_open_search_parameters

The parameters for OpenSearch.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-datasource-datasourceparameters.html#cfn-quicksight-datasource-datasourceparameters-amazonopensearchparameters

Return type

Union[AmazonOpenSearchParametersProperty, IResolvable, None]

athena_parameters

The parameters for Amazon Athena.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-datasource-datasourceparameters.html#cfn-quicksight-datasource-datasourceparameters-athenaparameters

Return type

Union[AthenaParametersProperty, IResolvable, None]

aurora_parameters

The parameters for Amazon Aurora MySQL.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-datasource-datasourceparameters.html#cfn-quicksight-datasource-datasourceparameters-auroraparameters

Return type

Union[AuroraParametersProperty, IResolvable, None]

aurora_postgre_sql_parameters

The parameters for Amazon Aurora.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-datasource-datasourceparameters.html#cfn-quicksight-datasource-datasourceparameters-aurorapostgresqlparameters

Return type

Union[AuroraPostgreSqlParametersProperty, IResolvable, None]

maria_db_parameters

The parameters for MariaDB.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-datasource-datasourceparameters.html#cfn-quicksight-datasource-datasourceparameters-mariadbparameters

Return type

Union[MariaDbParametersProperty, IResolvable, None]

my_sql_parameters

The parameters for MySQL.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-datasource-datasourceparameters.html#cfn-quicksight-datasource-datasourceparameters-mysqlparameters

Return type

Union[MySqlParametersProperty, IResolvable, None]

oracle_parameters

Oracle parameters.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-datasource-datasourceparameters.html#cfn-quicksight-datasource-datasourceparameters-oracleparameters

Return type

Union[OracleParametersProperty, IResolvable, None]

postgre_sql_parameters

The parameters for PostgreSQL.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-datasource-datasourceparameters.html#cfn-quicksight-datasource-datasourceparameters-postgresqlparameters

Return type

Union[PostgreSqlParametersProperty, IResolvable, None]

presto_parameters

The parameters for Presto.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-datasource-datasourceparameters.html#cfn-quicksight-datasource-datasourceparameters-prestoparameters

Return type

Union[PrestoParametersProperty, IResolvable, None]

rds_parameters

The parameters for Amazon RDS.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-datasource-datasourceparameters.html#cfn-quicksight-datasource-datasourceparameters-rdsparameters

Return type

Union[RdsParametersProperty, IResolvable, None]

redshift_parameters

The parameters for Amazon Redshift.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-datasource-datasourceparameters.html#cfn-quicksight-datasource-datasourceparameters-redshiftparameters

Return type

Union[RedshiftParametersProperty, IResolvable, None]

s3_parameters

The parameters for S3.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-datasource-datasourceparameters.html#cfn-quicksight-datasource-datasourceparameters-s3parameters

Return type

Union[S3ParametersProperty, IResolvable, None]

snowflake_parameters

The parameters for Snowflake.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-datasource-datasourceparameters.html#cfn-quicksight-datasource-datasourceparameters-snowflakeparameters

Return type

Union[SnowflakeParametersProperty, IResolvable, None]

spark_parameters

The parameters for Spark.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-datasource-datasourceparameters.html#cfn-quicksight-datasource-datasourceparameters-sparkparameters

Return type

Union[SparkParametersProperty, IResolvable, None]

sql_server_parameters

The parameters for SQL Server.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-datasource-datasourceparameters.html#cfn-quicksight-datasource-datasourceparameters-sqlserverparameters

Return type

Union[SqlServerParametersProperty, IResolvable, None]

teradata_parameters

The parameters for Teradata.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-datasource-datasourceparameters.html#cfn-quicksight-datasource-datasourceparameters-teradataparameters

Return type

Union[TeradataParametersProperty, IResolvable, None]

ManifestFileLocationProperty

class CfnDataSource.ManifestFileLocationProperty(*, bucket, key)

Bases: object

Amazon S3 manifest file location.

Parameters
  • bucket (str) – Amazon S3 bucket.

  • key (str) – Amazon S3 key that identifies an object.

Link

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

manifest_file_location_property = quicksight.CfnDataSource.ManifestFileLocationProperty(
    bucket="bucket",
    key="key"
)

Attributes

bucket

Amazon S3 bucket.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-datasource-manifestfilelocation.html#cfn-quicksight-datasource-manifestfilelocation-bucket

Return type

str

key

Amazon S3 key that identifies an object.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-datasource-manifestfilelocation.html#cfn-quicksight-datasource-manifestfilelocation-key

Return type

str

MariaDbParametersProperty

class CfnDataSource.MariaDbParametersProperty(*, database, host, port)

Bases: object

The parameters for MariaDB.

Parameters
  • database (str) – Database.

  • host (str) – Host.

  • port (Union[int, float]) – Port.

Link

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

maria_db_parameters_property = quicksight.CfnDataSource.MariaDbParametersProperty(
    database="database",
    host="host",
    port=123
)

Attributes

database

Database.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-datasource-mariadbparameters.html#cfn-quicksight-datasource-mariadbparameters-database

Return type

str

host

Host.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-datasource-mariadbparameters.html#cfn-quicksight-datasource-mariadbparameters-host

Return type

str

port

Port.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-datasource-mariadbparameters.html#cfn-quicksight-datasource-mariadbparameters-port

Return type

Union[int, float]

MySqlParametersProperty

class CfnDataSource.MySqlParametersProperty(*, database, host, port)

Bases: object

The parameters for MySQL.

Parameters
  • database (str) – Database.

  • host (str) – Host.

  • port (Union[int, float]) – Port.

Link

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

my_sql_parameters_property = quicksight.CfnDataSource.MySqlParametersProperty(
    database="database",
    host="host",
    port=123
)

Attributes

database

Database.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-datasource-mysqlparameters.html#cfn-quicksight-datasource-mysqlparameters-database

Return type

str

host

Host.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-datasource-mysqlparameters.html#cfn-quicksight-datasource-mysqlparameters-host

Return type

str

port

Port.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-datasource-mysqlparameters.html#cfn-quicksight-datasource-mysqlparameters-port

Return type

Union[int, float]

OracleParametersProperty

class CfnDataSource.OracleParametersProperty(*, database, host, port)

Bases: object

Oracle parameters.

Parameters
  • database (str) – Database.

  • host (str) – Host.

  • port (Union[int, float]) – Port.

Link

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

oracle_parameters_property = quicksight.CfnDataSource.OracleParametersProperty(
    database="database",
    host="host",
    port=123
)

Attributes

database

Database.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-datasource-oracleparameters.html#cfn-quicksight-datasource-oracleparameters-database

Return type

str

host

Host.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-datasource-oracleparameters.html#cfn-quicksight-datasource-oracleparameters-host

Return type

str

port

Port.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-datasource-oracleparameters.html#cfn-quicksight-datasource-oracleparameters-port

Return type

Union[int, float]

PostgreSqlParametersProperty

class CfnDataSource.PostgreSqlParametersProperty(*, database, host, port)

Bases: object

The parameters for PostgreSQL.

Parameters
  • database (str) – Database.

  • host (str) – Host.

  • port (Union[int, float]) – Port.

Link

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

postgre_sql_parameters_property = quicksight.CfnDataSource.PostgreSqlParametersProperty(
    database="database",
    host="host",
    port=123
)

Attributes

database

Database.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-datasource-postgresqlparameters.html#cfn-quicksight-datasource-postgresqlparameters-database

Return type

str

host

Host.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-datasource-postgresqlparameters.html#cfn-quicksight-datasource-postgresqlparameters-host

Return type

str

port

Port.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-datasource-postgresqlparameters.html#cfn-quicksight-datasource-postgresqlparameters-port

Return type

Union[int, float]

PrestoParametersProperty

class CfnDataSource.PrestoParametersProperty(*, catalog, host, port)

Bases: object

The parameters for Presto.

Parameters
  • catalog (str) – Catalog.

  • host (str) – Host.

  • port (Union[int, float]) – Port.

Link

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

presto_parameters_property = quicksight.CfnDataSource.PrestoParametersProperty(
    catalog="catalog",
    host="host",
    port=123
)

Attributes

catalog

Catalog.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-datasource-prestoparameters.html#cfn-quicksight-datasource-prestoparameters-catalog

Return type

str

host

Host.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-datasource-prestoparameters.html#cfn-quicksight-datasource-prestoparameters-host

Return type

str

port

Port.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-datasource-prestoparameters.html#cfn-quicksight-datasource-prestoparameters-port

Return type

Union[int, float]

RdsParametersProperty

class CfnDataSource.RdsParametersProperty(*, database, instance_id)

Bases: object

The parameters for Amazon RDS.

Parameters
  • database (str) – Database.

  • instance_id (str) – Instance ID.

Link

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

rds_parameters_property = quicksight.CfnDataSource.RdsParametersProperty(
    database="database",
    instance_id="instanceId"
)

Attributes

database

Database.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-datasource-rdsparameters.html#cfn-quicksight-datasource-rdsparameters-database

Return type

str

instance_id

Instance ID.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-datasource-rdsparameters.html#cfn-quicksight-datasource-rdsparameters-instanceid

Return type

str

RedshiftParametersProperty

class CfnDataSource.RedshiftParametersProperty(*, database, cluster_id=None, host=None, port=None)

Bases: object

The parameters for Amazon Redshift.

The ClusterId field can be blank if Host and Port are both set. The Host and Port fields can be blank if the ClusterId field is set.

Parameters
  • database (str) – Database.

  • cluster_id (Optional[str]) – Cluster ID. This field can be blank if the Host and Port are provided.

  • host (Optional[str]) – Host. This field can be blank if ClusterId is provided.

  • port (Union[int, float, None]) – Port. This field can be blank if the ClusterId is provided.

Link

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

redshift_parameters_property = quicksight.CfnDataSource.RedshiftParametersProperty(
    database="database",

    # the properties below are optional
    cluster_id="clusterId",
    host="host",
    port=123
)

Attributes

cluster_id

Cluster ID.

This field can be blank if the Host and Port are provided.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-datasource-redshiftparameters.html#cfn-quicksight-datasource-redshiftparameters-clusterid

Return type

Optional[str]

database

Database.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-datasource-redshiftparameters.html#cfn-quicksight-datasource-redshiftparameters-database

Return type

str

host

Host.

This field can be blank if ClusterId is provided.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-datasource-redshiftparameters.html#cfn-quicksight-datasource-redshiftparameters-host

Return type

Optional[str]

port

Port.

This field can be blank if the ClusterId is provided.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-datasource-redshiftparameters.html#cfn-quicksight-datasource-redshiftparameters-port

Return type

Union[int, float, None]

ResourcePermissionProperty

class CfnDataSource.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-datasource-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.CfnDataSource.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-datasource-resourcepermission.html#cfn-quicksight-datasource-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-datasource-resourcepermission.html#cfn-quicksight-datasource-resourcepermission-principal

Type

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

Return type

str

S3ParametersProperty

class CfnDataSource.S3ParametersProperty(*, manifest_file_location)

Bases: object

The parameters for S3.

Parameters

manifest_file_location (Union[ManifestFileLocationProperty, Dict[str, Any], IResolvable]) – Location of the Amazon S3 manifest file. This is NULL if the manifest file was uploaded into Amazon QuickSight.

Link

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

s3_parameters_property = quicksight.CfnDataSource.S3ParametersProperty(
    manifest_file_location=quicksight.CfnDataSource.ManifestFileLocationProperty(
        bucket="bucket",
        key="key"
    )
)

Attributes

manifest_file_location

Location of the Amazon S3 manifest file.

This is NULL if the manifest file was uploaded into Amazon QuickSight.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-datasource-s3parameters.html#cfn-quicksight-datasource-s3parameters-manifestfilelocation

Return type

Union[ManifestFileLocationProperty, IResolvable]

SnowflakeParametersProperty

class CfnDataSource.SnowflakeParametersProperty(*, database, host, warehouse)

Bases: object

The parameters for Snowflake.

Parameters
  • database (str) – Database.

  • host (str) – Host.

  • warehouse (str) – Warehouse.

Link

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

snowflake_parameters_property = quicksight.CfnDataSource.SnowflakeParametersProperty(
    database="database",
    host="host",
    warehouse="warehouse"
)

Attributes

database

Database.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-datasource-snowflakeparameters.html#cfn-quicksight-datasource-snowflakeparameters-database

Return type

str

host

Host.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-datasource-snowflakeparameters.html#cfn-quicksight-datasource-snowflakeparameters-host

Return type

str

warehouse

Warehouse.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-datasource-snowflakeparameters.html#cfn-quicksight-datasource-snowflakeparameters-warehouse

Return type

str

SparkParametersProperty

class CfnDataSource.SparkParametersProperty(*, host, port)

Bases: object

The parameters for Spark.

Parameters
  • host (str) – Host.

  • port (Union[int, float]) – Port.

Link

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

spark_parameters_property = quicksight.CfnDataSource.SparkParametersProperty(
    host="host",
    port=123
)

Attributes

host

Host.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-datasource-sparkparameters.html#cfn-quicksight-datasource-sparkparameters-host

Return type

str

port

Port.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-datasource-sparkparameters.html#cfn-quicksight-datasource-sparkparameters-port

Return type

Union[int, float]

SqlServerParametersProperty

class CfnDataSource.SqlServerParametersProperty(*, database, host, port)

Bases: object

The parameters for SQL Server.

Parameters
  • database (str) – Database.

  • host (str) – Host.

  • port (Union[int, float]) – Port.

Link

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

sql_server_parameters_property = quicksight.CfnDataSource.SqlServerParametersProperty(
    database="database",
    host="host",
    port=123
)

Attributes

database

Database.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-datasource-sqlserverparameters.html#cfn-quicksight-datasource-sqlserverparameters-database

Return type

str

host

Host.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-datasource-sqlserverparameters.html#cfn-quicksight-datasource-sqlserverparameters-host

Return type

str

port

Port.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-datasource-sqlserverparameters.html#cfn-quicksight-datasource-sqlserverparameters-port

Return type

Union[int, float]

SslPropertiesProperty

class CfnDataSource.SslPropertiesProperty(*, disable_ssl=None)

Bases: object

Secure Socket Layer (SSL) properties that apply when Amazon QuickSight connects to your underlying data source.

Parameters

disable_ssl (Union[bool, IResolvable, None]) – A Boolean option to control whether SSL should be disabled.

Link

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

ssl_properties_property = quicksight.CfnDataSource.SslPropertiesProperty(
    disable_ssl=False
)

Attributes

disable_ssl

A Boolean option to control whether SSL should be disabled.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-datasource-sslproperties.html#cfn-quicksight-datasource-sslproperties-disablessl

Return type

Union[bool, IResolvable, None]

TeradataParametersProperty

class CfnDataSource.TeradataParametersProperty(*, database, host, port)

Bases: object

The parameters for Teradata.

Parameters
  • database (str) – Database.

  • host (str) – Host.

  • port (Union[int, float]) – Port.

Link

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

teradata_parameters_property = quicksight.CfnDataSource.TeradataParametersProperty(
    database="database",
    host="host",
    port=123
)

Attributes

database

Database.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-datasource-teradataparameters.html#cfn-quicksight-datasource-teradataparameters-database

Return type

str

host

Host.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-datasource-teradataparameters.html#cfn-quicksight-datasource-teradataparameters-host

Return type

str

port

Port.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-datasource-teradataparameters.html#cfn-quicksight-datasource-teradataparameters-port

Return type

Union[int, float]

VpcConnectionPropertiesProperty

class CfnDataSource.VpcConnectionPropertiesProperty(*, vpc_connection_arn)

Bases: object

VPC connection properties.

Parameters

vpc_connection_arn (str) – The Amazon Resource Name (ARN) for the VPC connection.

Link

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

vpc_connection_properties_property = quicksight.CfnDataSource.VpcConnectionPropertiesProperty(
    vpc_connection_arn="vpcConnectionArn"
)

Attributes

vpc_connection_arn

The Amazon Resource Name (ARN) for the VPC connection.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-datasource-vpcconnectionproperties.html#cfn-quicksight-datasource-vpcconnectionproperties-vpcconnectionarn

Return type

str