CfnDataSourceProps

class aws_cdk.aws_quicksight.CfnDataSourceProps(*, 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: object

Properties for defining a CfnDataSource.

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

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_props = quicksight.CfnDataSourceProps(
    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"
    )
)

Attributes

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]

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]

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]

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]

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]

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]

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

Optional[List[CfnTag]]

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]