CfnDataSourcePropsMixin

class aws_cdk.mixins_preview.aws_quicksight.mixins.CfnDataSourcePropsMixin(props, *, strategy=None)

Bases: Mixin

Creates a data source.

See:

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

CloudformationResource:

AWS::QuickSight::DataSource

Mixin:

true

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.mixins_preview import mixins
from aws_cdk.mixins_preview.aws_quicksight import mixins as quicksight_mixins

cfn_data_source_props_mixin = quicksight_mixins.CfnDataSourcePropsMixin(quicksight_mixins.CfnDataSourceMixinProps(
    alternate_data_source_parameters=[quicksight_mixins.CfnDataSourcePropsMixin.DataSourceParametersProperty(
        amazon_elasticsearch_parameters=quicksight_mixins.CfnDataSourcePropsMixin.AmazonElasticsearchParametersProperty(
            domain="domain"
        ),
        amazon_open_search_parameters=quicksight_mixins.CfnDataSourcePropsMixin.AmazonOpenSearchParametersProperty(
            domain="domain"
        ),
        athena_parameters=quicksight_mixins.CfnDataSourcePropsMixin.AthenaParametersProperty(
            identity_center_configuration=quicksight_mixins.CfnDataSourcePropsMixin.IdentityCenterConfigurationProperty(
                enable_identity_propagation=False
            ),
            role_arn="roleArn",
            work_group="workGroup"
        ),
        aurora_parameters=quicksight_mixins.CfnDataSourcePropsMixin.AuroraParametersProperty(
            database="database",
            host="host",
            port=123
        ),
        aurora_postgre_sql_parameters=quicksight_mixins.CfnDataSourcePropsMixin.AuroraPostgreSqlParametersProperty(
            database="database",
            host="host",
            port=123
        ),
        databricks_parameters=quicksight_mixins.CfnDataSourcePropsMixin.DatabricksParametersProperty(
            host="host",
            port=123,
            sql_endpoint_path="sqlEndpointPath"
        ),
        maria_db_parameters=quicksight_mixins.CfnDataSourcePropsMixin.MariaDbParametersProperty(
            database="database",
            host="host",
            port=123
        ),
        my_sql_parameters=quicksight_mixins.CfnDataSourcePropsMixin.MySqlParametersProperty(
            database="database",
            host="host",
            port=123
        ),
        oracle_parameters=quicksight_mixins.CfnDataSourcePropsMixin.OracleParametersProperty(
            database="database",
            host="host",
            port=123,
            use_service_name=False
        ),
        postgre_sql_parameters=quicksight_mixins.CfnDataSourcePropsMixin.PostgreSqlParametersProperty(
            database="database",
            host="host",
            port=123
        ),
        presto_parameters=quicksight_mixins.CfnDataSourcePropsMixin.PrestoParametersProperty(
            catalog="catalog",
            host="host",
            port=123
        ),
        rds_parameters=quicksight_mixins.CfnDataSourcePropsMixin.RdsParametersProperty(
            database="database",
            instance_id="instanceId"
        ),
        redshift_parameters=quicksight_mixins.CfnDataSourcePropsMixin.RedshiftParametersProperty(
            cluster_id="clusterId",
            database="database",
            host="host",
            iam_parameters=quicksight_mixins.CfnDataSourcePropsMixin.RedshiftIAMParametersProperty(
                auto_create_database_user=False,
                database_groups=["databaseGroups"],
                database_user="databaseUser",
                role_arn="roleArn"
            ),
            identity_center_configuration=quicksight_mixins.CfnDataSourcePropsMixin.IdentityCenterConfigurationProperty(
                enable_identity_propagation=False
            ),
            port=123
        ),
        s3_parameters=quicksight_mixins.CfnDataSourcePropsMixin.S3ParametersProperty(
            manifest_file_location=quicksight_mixins.CfnDataSourcePropsMixin.ManifestFileLocationProperty(
                bucket="bucket",
                key="key"
            ),
            role_arn="roleArn"
        ),
        snowflake_parameters=quicksight_mixins.CfnDataSourcePropsMixin.SnowflakeParametersProperty(
            authentication_type="authenticationType",
            database="database",
            database_access_control_role="databaseAccessControlRole",
            host="host",
            o_auth_parameters=quicksight_mixins.CfnDataSourcePropsMixin.OAuthParametersProperty(
                identity_provider_resource_uri="identityProviderResourceUri",
                identity_provider_vpc_connection_properties=quicksight_mixins.CfnDataSourcePropsMixin.VpcConnectionPropertiesProperty(
                    vpc_connection_arn="vpcConnectionArn"
                ),
                o_auth_scope="oAuthScope",
                token_provider_url="tokenProviderUrl"
            ),
            warehouse="warehouse"
        ),
        spark_parameters=quicksight_mixins.CfnDataSourcePropsMixin.SparkParametersProperty(
            host="host",
            port=123
        ),
        sql_server_parameters=quicksight_mixins.CfnDataSourcePropsMixin.SqlServerParametersProperty(
            database="database",
            host="host",
            port=123
        ),
        starburst_parameters=quicksight_mixins.CfnDataSourcePropsMixin.StarburstParametersProperty(
            authentication_type="authenticationType",
            catalog="catalog",
            database_access_control_role="databaseAccessControlRole",
            host="host",
            o_auth_parameters=quicksight_mixins.CfnDataSourcePropsMixin.OAuthParametersProperty(
                identity_provider_resource_uri="identityProviderResourceUri",
                identity_provider_vpc_connection_properties=quicksight_mixins.CfnDataSourcePropsMixin.VpcConnectionPropertiesProperty(
                    vpc_connection_arn="vpcConnectionArn"
                ),
                o_auth_scope="oAuthScope",
                token_provider_url="tokenProviderUrl"
            ),
            port=123,
            product_type="productType"
        ),
        teradata_parameters=quicksight_mixins.CfnDataSourcePropsMixin.TeradataParametersProperty(
            database="database",
            host="host",
            port=123
        ),
        trino_parameters=quicksight_mixins.CfnDataSourcePropsMixin.TrinoParametersProperty(
            catalog="catalog",
            host="host",
            port=123
        )
    )],
    aws_account_id="awsAccountId",
    credentials=quicksight_mixins.CfnDataSourcePropsMixin.DataSourceCredentialsProperty(
        copy_source_arn="copySourceArn",
        credential_pair=quicksight_mixins.CfnDataSourcePropsMixin.CredentialPairProperty(
            alternate_data_source_parameters=[quicksight_mixins.CfnDataSourcePropsMixin.DataSourceParametersProperty(
                amazon_elasticsearch_parameters=quicksight_mixins.CfnDataSourcePropsMixin.AmazonElasticsearchParametersProperty(
                    domain="domain"
                ),
                amazon_open_search_parameters=quicksight_mixins.CfnDataSourcePropsMixin.AmazonOpenSearchParametersProperty(
                    domain="domain"
                ),
                athena_parameters=quicksight_mixins.CfnDataSourcePropsMixin.AthenaParametersProperty(
                    identity_center_configuration=quicksight_mixins.CfnDataSourcePropsMixin.IdentityCenterConfigurationProperty(
                        enable_identity_propagation=False
                    ),
                    role_arn="roleArn",
                    work_group="workGroup"
                ),
                aurora_parameters=quicksight_mixins.CfnDataSourcePropsMixin.AuroraParametersProperty(
                    database="database",
                    host="host",
                    port=123
                ),
                aurora_postgre_sql_parameters=quicksight_mixins.CfnDataSourcePropsMixin.AuroraPostgreSqlParametersProperty(
                    database="database",
                    host="host",
                    port=123
                ),
                databricks_parameters=quicksight_mixins.CfnDataSourcePropsMixin.DatabricksParametersProperty(
                    host="host",
                    port=123,
                    sql_endpoint_path="sqlEndpointPath"
                ),
                maria_db_parameters=quicksight_mixins.CfnDataSourcePropsMixin.MariaDbParametersProperty(
                    database="database",
                    host="host",
                    port=123
                ),
                my_sql_parameters=quicksight_mixins.CfnDataSourcePropsMixin.MySqlParametersProperty(
                    database="database",
                    host="host",
                    port=123
                ),
                oracle_parameters=quicksight_mixins.CfnDataSourcePropsMixin.OracleParametersProperty(
                    database="database",
                    host="host",
                    port=123,
                    use_service_name=False
                ),
                postgre_sql_parameters=quicksight_mixins.CfnDataSourcePropsMixin.PostgreSqlParametersProperty(
                    database="database",
                    host="host",
                    port=123
                ),
                presto_parameters=quicksight_mixins.CfnDataSourcePropsMixin.PrestoParametersProperty(
                    catalog="catalog",
                    host="host",
                    port=123
                ),
                rds_parameters=quicksight_mixins.CfnDataSourcePropsMixin.RdsParametersProperty(
                    database="database",
                    instance_id="instanceId"
                ),
                redshift_parameters=quicksight_mixins.CfnDataSourcePropsMixin.RedshiftParametersProperty(
                    cluster_id="clusterId",
                    database="database",
                    host="host",
                    iam_parameters=quicksight_mixins.CfnDataSourcePropsMixin.RedshiftIAMParametersProperty(
                        auto_create_database_user=False,
                        database_groups=["databaseGroups"],
                        database_user="databaseUser",
                        role_arn="roleArn"
                    ),
                    identity_center_configuration=quicksight_mixins.CfnDataSourcePropsMixin.IdentityCenterConfigurationProperty(
                        enable_identity_propagation=False
                    ),
                    port=123
                ),
                s3_parameters=quicksight_mixins.CfnDataSourcePropsMixin.S3ParametersProperty(
                    manifest_file_location=quicksight_mixins.CfnDataSourcePropsMixin.ManifestFileLocationProperty(
                        bucket="bucket",
                        key="key"
                    ),
                    role_arn="roleArn"
                ),
                snowflake_parameters=quicksight_mixins.CfnDataSourcePropsMixin.SnowflakeParametersProperty(
                    authentication_type="authenticationType",
                    database="database",
                    database_access_control_role="databaseAccessControlRole",
                    host="host",
                    o_auth_parameters=quicksight_mixins.CfnDataSourcePropsMixin.OAuthParametersProperty(
                        identity_provider_resource_uri="identityProviderResourceUri",
                        identity_provider_vpc_connection_properties=quicksight_mixins.CfnDataSourcePropsMixin.VpcConnectionPropertiesProperty(
                            vpc_connection_arn="vpcConnectionArn"
                        ),
                        o_auth_scope="oAuthScope",
                        token_provider_url="tokenProviderUrl"
                    ),
                    warehouse="warehouse"
                ),
                spark_parameters=quicksight_mixins.CfnDataSourcePropsMixin.SparkParametersProperty(
                    host="host",
                    port=123
                ),
                sql_server_parameters=quicksight_mixins.CfnDataSourcePropsMixin.SqlServerParametersProperty(
                    database="database",
                    host="host",
                    port=123
                ),
                starburst_parameters=quicksight_mixins.CfnDataSourcePropsMixin.StarburstParametersProperty(
                    authentication_type="authenticationType",
                    catalog="catalog",
                    database_access_control_role="databaseAccessControlRole",
                    host="host",
                    o_auth_parameters=quicksight_mixins.CfnDataSourcePropsMixin.OAuthParametersProperty(
                        identity_provider_resource_uri="identityProviderResourceUri",
                        identity_provider_vpc_connection_properties=quicksight_mixins.CfnDataSourcePropsMixin.VpcConnectionPropertiesProperty(
                            vpc_connection_arn="vpcConnectionArn"
                        ),
                        o_auth_scope="oAuthScope",
                        token_provider_url="tokenProviderUrl"
                    ),
                    port=123,
                    product_type="productType"
                ),
                teradata_parameters=quicksight_mixins.CfnDataSourcePropsMixin.TeradataParametersProperty(
                    database="database",
                    host="host",
                    port=123
                ),
                trino_parameters=quicksight_mixins.CfnDataSourcePropsMixin.TrinoParametersProperty(
                    catalog="catalog",
                    host="host",
                    port=123
                )
            )],
            password="password",
            username="username"
        ),
        secret_arn="secretArn"
    ),
    data_source_id="dataSourceId",
    data_source_parameters=quicksight_mixins.CfnDataSourcePropsMixin.DataSourceParametersProperty(
        amazon_elasticsearch_parameters=quicksight_mixins.CfnDataSourcePropsMixin.AmazonElasticsearchParametersProperty(
            domain="domain"
        ),
        amazon_open_search_parameters=quicksight_mixins.CfnDataSourcePropsMixin.AmazonOpenSearchParametersProperty(
            domain="domain"
        ),
        athena_parameters=quicksight_mixins.CfnDataSourcePropsMixin.AthenaParametersProperty(
            identity_center_configuration=quicksight_mixins.CfnDataSourcePropsMixin.IdentityCenterConfigurationProperty(
                enable_identity_propagation=False
            ),
            role_arn="roleArn",
            work_group="workGroup"
        ),
        aurora_parameters=quicksight_mixins.CfnDataSourcePropsMixin.AuroraParametersProperty(
            database="database",
            host="host",
            port=123
        ),
        aurora_postgre_sql_parameters=quicksight_mixins.CfnDataSourcePropsMixin.AuroraPostgreSqlParametersProperty(
            database="database",
            host="host",
            port=123
        ),
        databricks_parameters=quicksight_mixins.CfnDataSourcePropsMixin.DatabricksParametersProperty(
            host="host",
            port=123,
            sql_endpoint_path="sqlEndpointPath"
        ),
        maria_db_parameters=quicksight_mixins.CfnDataSourcePropsMixin.MariaDbParametersProperty(
            database="database",
            host="host",
            port=123
        ),
        my_sql_parameters=quicksight_mixins.CfnDataSourcePropsMixin.MySqlParametersProperty(
            database="database",
            host="host",
            port=123
        ),
        oracle_parameters=quicksight_mixins.CfnDataSourcePropsMixin.OracleParametersProperty(
            database="database",
            host="host",
            port=123,
            use_service_name=False
        ),
        postgre_sql_parameters=quicksight_mixins.CfnDataSourcePropsMixin.PostgreSqlParametersProperty(
            database="database",
            host="host",
            port=123
        ),
        presto_parameters=quicksight_mixins.CfnDataSourcePropsMixin.PrestoParametersProperty(
            catalog="catalog",
            host="host",
            port=123
        ),
        rds_parameters=quicksight_mixins.CfnDataSourcePropsMixin.RdsParametersProperty(
            database="database",
            instance_id="instanceId"
        ),
        redshift_parameters=quicksight_mixins.CfnDataSourcePropsMixin.RedshiftParametersProperty(
            cluster_id="clusterId",
            database="database",
            host="host",
            iam_parameters=quicksight_mixins.CfnDataSourcePropsMixin.RedshiftIAMParametersProperty(
                auto_create_database_user=False,
                database_groups=["databaseGroups"],
                database_user="databaseUser",
                role_arn="roleArn"
            ),
            identity_center_configuration=quicksight_mixins.CfnDataSourcePropsMixin.IdentityCenterConfigurationProperty(
                enable_identity_propagation=False
            ),
            port=123
        ),
        s3_parameters=quicksight_mixins.CfnDataSourcePropsMixin.S3ParametersProperty(
            manifest_file_location=quicksight_mixins.CfnDataSourcePropsMixin.ManifestFileLocationProperty(
                bucket="bucket",
                key="key"
            ),
            role_arn="roleArn"
        ),
        snowflake_parameters=quicksight_mixins.CfnDataSourcePropsMixin.SnowflakeParametersProperty(
            authentication_type="authenticationType",
            database="database",
            database_access_control_role="databaseAccessControlRole",
            host="host",
            o_auth_parameters=quicksight_mixins.CfnDataSourcePropsMixin.OAuthParametersProperty(
                identity_provider_resource_uri="identityProviderResourceUri",
                identity_provider_vpc_connection_properties=quicksight_mixins.CfnDataSourcePropsMixin.VpcConnectionPropertiesProperty(
                    vpc_connection_arn="vpcConnectionArn"
                ),
                o_auth_scope="oAuthScope",
                token_provider_url="tokenProviderUrl"
            ),
            warehouse="warehouse"
        ),
        spark_parameters=quicksight_mixins.CfnDataSourcePropsMixin.SparkParametersProperty(
            host="host",
            port=123
        ),
        sql_server_parameters=quicksight_mixins.CfnDataSourcePropsMixin.SqlServerParametersProperty(
            database="database",
            host="host",
            port=123
        ),
        starburst_parameters=quicksight_mixins.CfnDataSourcePropsMixin.StarburstParametersProperty(
            authentication_type="authenticationType",
            catalog="catalog",
            database_access_control_role="databaseAccessControlRole",
            host="host",
            o_auth_parameters=quicksight_mixins.CfnDataSourcePropsMixin.OAuthParametersProperty(
                identity_provider_resource_uri="identityProviderResourceUri",
                identity_provider_vpc_connection_properties=quicksight_mixins.CfnDataSourcePropsMixin.VpcConnectionPropertiesProperty(
                    vpc_connection_arn="vpcConnectionArn"
                ),
                o_auth_scope="oAuthScope",
                token_provider_url="tokenProviderUrl"
            ),
            port=123,
            product_type="productType"
        ),
        teradata_parameters=quicksight_mixins.CfnDataSourcePropsMixin.TeradataParametersProperty(
            database="database",
            host="host",
            port=123
        ),
        trino_parameters=quicksight_mixins.CfnDataSourcePropsMixin.TrinoParametersProperty(
            catalog="catalog",
            host="host",
            port=123
        )
    ),
    error_info=quicksight_mixins.CfnDataSourcePropsMixin.DataSourceErrorInfoProperty(
        message="message",
        type="type"
    ),
    folder_arns=["folderArns"],
    name="name",
    permissions=[quicksight_mixins.CfnDataSourcePropsMixin.ResourcePermissionProperty(
        actions=["actions"],
        principal="principal",
        resource="resource"
    )],
    ssl_properties=quicksight_mixins.CfnDataSourcePropsMixin.SslPropertiesProperty(
        disable_ssl=False
    ),
    tags=[CfnTag(
        key="key",
        value="value"
    )],
    type="type",
    vpc_connection_properties=quicksight_mixins.CfnDataSourcePropsMixin.VpcConnectionPropertiesProperty(
        vpc_connection_arn="vpcConnectionArn"
    )
),
    strategy=mixins.PropertyMergeStrategy.OVERRIDE
)

Create a mixin to apply properties to AWS::QuickSight::DataSource.

Parameters:

  • props (Union[CfnDataSourceMixinProps, Dict[str, Any]]) – L1 properties to apply.

  • strategy (Optional[PropertyMergeStrategy]) – (experimental) Strategy for merging nested properties. Default: - PropertyMergeStrategy.MERGE

Methods

apply_to(construct)

Apply the mixin properties to the construct.

Parameters:

construct (IConstruct)

Return type:

IConstruct

supports(construct)

Check if this mixin supports the given construct.

Parameters:

construct (IConstruct)

Return type:

bool

Attributes

CFN_PROPERTY_KEYS = ['alternateDataSourceParameters', 'awsAccountId', 'credentials', 'dataSourceId', 'dataSourceParameters', 'errorInfo', 'folderArns', 'name', 'permissions', 'sslProperties', 'tags', 'type', 'vpcConnectionProperties']

Static Methods

classmethod is_mixin(x)

(experimental) Checks if x is a Mixin.

Parameters:

x (Any) – Any object.

Return type:

bool

Returns:

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

Stability:

experimental

AmazonElasticsearchParametersProperty

class CfnDataSourcePropsMixin.AmazonElasticsearchParametersProperty(*, domain=None)

Bases: object

The parameters for OpenSearch.

Parameters:

domain (Optional[str]) – The OpenSearch domain.

See:

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.mixins_preview.aws_quicksight import mixins as quicksight_mixins

amazon_elasticsearch_parameters_property = quicksight_mixins.CfnDataSourcePropsMixin.AmazonElasticsearchParametersProperty(
    domain="domain"
)

Attributes

domain

The OpenSearch domain.

See:

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

AmazonOpenSearchParametersProperty

class CfnDataSourcePropsMixin.AmazonOpenSearchParametersProperty(*, domain=None)

Bases: object

The parameters for OpenSearch.

Parameters:

domain (Optional[str]) – The OpenSearch domain.

See:

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.mixins_preview.aws_quicksight import mixins as quicksight_mixins

amazon_open_search_parameters_property = quicksight_mixins.CfnDataSourcePropsMixin.AmazonOpenSearchParametersProperty(
    domain="domain"
)

Attributes

domain

The OpenSearch domain.

See:

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

AthenaParametersProperty

class CfnDataSourcePropsMixin.AthenaParametersProperty(*, identity_center_configuration=None, role_arn=None, work_group=None)

Bases: object

Parameters for Amazon Athena.

Parameters:

  • identity_center_configuration (Union[IResolvable, IdentityCenterConfigurationProperty, Dict[str, Any], None]) – An optional parameter that configures IAM Identity Center authentication to grant Quick Sight access to your workgroup. This parameter can only be specified if your Quick Sight account is configured with IAM Identity Center.

  • role_arn (Optional[str]) – Use the RoleArn structure to override an account-wide role for a specific Athena data source. For example, say an account administrator has turned off all Athena access with an account-wide role. The administrator can then use RoleArn to bypass the account-wide role and allow Athena access for the single Athena data source that is specified in the structure, even if the account-wide role forbidding Athena access is still active.

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

See:

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.mixins_preview.aws_quicksight import mixins as quicksight_mixins

athena_parameters_property = quicksight_mixins.CfnDataSourcePropsMixin.AthenaParametersProperty(
    identity_center_configuration=quicksight_mixins.CfnDataSourcePropsMixin.IdentityCenterConfigurationProperty(
        enable_identity_propagation=False
    ),
    role_arn="roleArn",
    work_group="workGroup"
)

Attributes

identity_center_configuration

An optional parameter that configures IAM Identity Center authentication to grant Quick Sight access to your workgroup.

This parameter can only be specified if your Quick Sight account is configured with IAM Identity Center.

See:

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

role_arn

Use the RoleArn structure to override an account-wide role for a specific Athena data source.

For example, say an account administrator has turned off all Athena access with an account-wide role. The administrator can then use RoleArn to bypass the account-wide role and allow Athena access for the single Athena data source that is specified in the structure, even if the account-wide role forbidding Athena access is still active.

See:

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

work_group

The workgroup that Amazon Athena uses.

See:

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

AuroraParametersProperty

class CfnDataSourcePropsMixin.AuroraParametersProperty(*, database=None, host=None, port=None)

Bases: object

Parameters for Amazon Aurora.

Parameters:

  • database (Optional[str]) – Database.

  • host (Optional[str]) – Host.

  • port (Union[int, float, None]) – Port. Default: - 0

See:

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.mixins_preview.aws_quicksight import mixins as quicksight_mixins

aurora_parameters_property = quicksight_mixins.CfnDataSourcePropsMixin.AuroraParametersProperty(
    database="database",
    host="host",
    port=123
)

Attributes

database

Database.

See:

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

host

Host.

See:

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

port

Port.

Default:

  • 0

See:

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

AuroraPostgreSqlParametersProperty

class CfnDataSourcePropsMixin.AuroraPostgreSqlParametersProperty(*, database=None, host=None, port=None)

Bases: object

Parameters for Amazon Aurora PostgreSQL-Compatible Edition.

Parameters:

  • database (Optional[str]) – The Amazon Aurora PostgreSQL database to connect to.

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

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

See:

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.mixins_preview.aws_quicksight import mixins as quicksight_mixins

aurora_postgre_sql_parameters_property = quicksight_mixins.CfnDataSourcePropsMixin.AuroraPostgreSqlParametersProperty(
    database="database",
    host="host",
    port=123
)

Attributes

database

The Amazon Aurora PostgreSQL database to connect to.

See:

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

host

The Amazon Aurora PostgreSQL-Compatible host to connect to.

See:

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

port

The port that Amazon Aurora PostgreSQL is listening on.

Default:

  • 0

See:

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

CredentialPairProperty

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

Bases: object

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

Parameters:

  • alternate_data_source_parameters (Union[IResolvable, Sequence[Union[IResolvable, DataSourceParametersProperty, Dict[str, Any]]], 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.

  • password (Optional[str]) – Password.

  • username (Optional[str]) – User name.

See:

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.mixins_preview.aws_quicksight import mixins as quicksight_mixins

credential_pair_property = quicksight_mixins.CfnDataSourcePropsMixin.CredentialPairProperty(
    alternate_data_source_parameters=[quicksight_mixins.CfnDataSourcePropsMixin.DataSourceParametersProperty(
        amazon_elasticsearch_parameters=quicksight_mixins.CfnDataSourcePropsMixin.AmazonElasticsearchParametersProperty(
            domain="domain"
        ),
        amazon_open_search_parameters=quicksight_mixins.CfnDataSourcePropsMixin.AmazonOpenSearchParametersProperty(
            domain="domain"
        ),
        athena_parameters=quicksight_mixins.CfnDataSourcePropsMixin.AthenaParametersProperty(
            identity_center_configuration=quicksight_mixins.CfnDataSourcePropsMixin.IdentityCenterConfigurationProperty(
                enable_identity_propagation=False
            ),
            role_arn="roleArn",
            work_group="workGroup"
        ),
        aurora_parameters=quicksight_mixins.CfnDataSourcePropsMixin.AuroraParametersProperty(
            database="database",
            host="host",
            port=123
        ),
        aurora_postgre_sql_parameters=quicksight_mixins.CfnDataSourcePropsMixin.AuroraPostgreSqlParametersProperty(
            database="database",
            host="host",
            port=123
        ),
        databricks_parameters=quicksight_mixins.CfnDataSourcePropsMixin.DatabricksParametersProperty(
            host="host",
            port=123,
            sql_endpoint_path="sqlEndpointPath"
        ),
        maria_db_parameters=quicksight_mixins.CfnDataSourcePropsMixin.MariaDbParametersProperty(
            database="database",
            host="host",
            port=123
        ),
        my_sql_parameters=quicksight_mixins.CfnDataSourcePropsMixin.MySqlParametersProperty(
            database="database",
            host="host",
            port=123
        ),
        oracle_parameters=quicksight_mixins.CfnDataSourcePropsMixin.OracleParametersProperty(
            database="database",
            host="host",
            port=123,
            use_service_name=False
        ),
        postgre_sql_parameters=quicksight_mixins.CfnDataSourcePropsMixin.PostgreSqlParametersProperty(
            database="database",
            host="host",
            port=123
        ),
        presto_parameters=quicksight_mixins.CfnDataSourcePropsMixin.PrestoParametersProperty(
            catalog="catalog",
            host="host",
            port=123
        ),
        rds_parameters=quicksight_mixins.CfnDataSourcePropsMixin.RdsParametersProperty(
            database="database",
            instance_id="instanceId"
        ),
        redshift_parameters=quicksight_mixins.CfnDataSourcePropsMixin.RedshiftParametersProperty(
            cluster_id="clusterId",
            database="database",
            host="host",
            iam_parameters=quicksight_mixins.CfnDataSourcePropsMixin.RedshiftIAMParametersProperty(
                auto_create_database_user=False,
                database_groups=["databaseGroups"],
                database_user="databaseUser",
                role_arn="roleArn"
            ),
            identity_center_configuration=quicksight_mixins.CfnDataSourcePropsMixin.IdentityCenterConfigurationProperty(
                enable_identity_propagation=False
            ),
            port=123
        ),
        s3_parameters=quicksight_mixins.CfnDataSourcePropsMixin.S3ParametersProperty(
            manifest_file_location=quicksight_mixins.CfnDataSourcePropsMixin.ManifestFileLocationProperty(
                bucket="bucket",
                key="key"
            ),
            role_arn="roleArn"
        ),
        snowflake_parameters=quicksight_mixins.CfnDataSourcePropsMixin.SnowflakeParametersProperty(
            authentication_type="authenticationType",
            database="database",
            database_access_control_role="databaseAccessControlRole",
            host="host",
            o_auth_parameters=quicksight_mixins.CfnDataSourcePropsMixin.OAuthParametersProperty(
                identity_provider_resource_uri="identityProviderResourceUri",
                identity_provider_vpc_connection_properties=quicksight_mixins.CfnDataSourcePropsMixin.VpcConnectionPropertiesProperty(
                    vpc_connection_arn="vpcConnectionArn"
                ),
                o_auth_scope="oAuthScope",
                token_provider_url="tokenProviderUrl"
            ),
            warehouse="warehouse"
        ),
        spark_parameters=quicksight_mixins.CfnDataSourcePropsMixin.SparkParametersProperty(
            host="host",
            port=123
        ),
        sql_server_parameters=quicksight_mixins.CfnDataSourcePropsMixin.SqlServerParametersProperty(
            database="database",
            host="host",
            port=123
        ),
        starburst_parameters=quicksight_mixins.CfnDataSourcePropsMixin.StarburstParametersProperty(
            authentication_type="authenticationType",
            catalog="catalog",
            database_access_control_role="databaseAccessControlRole",
            host="host",
            o_auth_parameters=quicksight_mixins.CfnDataSourcePropsMixin.OAuthParametersProperty(
                identity_provider_resource_uri="identityProviderResourceUri",
                identity_provider_vpc_connection_properties=quicksight_mixins.CfnDataSourcePropsMixin.VpcConnectionPropertiesProperty(
                    vpc_connection_arn="vpcConnectionArn"
                ),
                o_auth_scope="oAuthScope",
                token_provider_url="tokenProviderUrl"
            ),
            port=123,
            product_type="productType"
        ),
        teradata_parameters=quicksight_mixins.CfnDataSourcePropsMixin.TeradataParametersProperty(
            database="database",
            host="host",
            port=123
        ),
        trino_parameters=quicksight_mixins.CfnDataSourcePropsMixin.TrinoParametersProperty(
            catalog="catalog",
            host="host",
            port=123
        )
    )],
    password="password",
    username="username"
)

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.

See:

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

password

Password.

See:

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

username

User name.

See:

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

DataSourceCredentialsProperty

class CfnDataSourcePropsMixin.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[IResolvable, CredentialPairProperty, Dict[str, Any], None]) – Credential pair. For more information, see [CredentialPair](https://docs.aws.amazon.com/quicksight/latest/APIReference/API_CredentialPair.html) .

  • secret_arn (Optional[str]) – The Amazon Resource Name (ARN) of the secret associated with the data source in AWS Secrets Manager .

See:

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.mixins_preview.aws_quicksight import mixins as quicksight_mixins

data_source_credentials_property = quicksight_mixins.CfnDataSourcePropsMixin.DataSourceCredentialsProperty(
    copy_source_arn="copySourceArn",
    credential_pair=quicksight_mixins.CfnDataSourcePropsMixin.CredentialPairProperty(
        alternate_data_source_parameters=[quicksight_mixins.CfnDataSourcePropsMixin.DataSourceParametersProperty(
            amazon_elasticsearch_parameters=quicksight_mixins.CfnDataSourcePropsMixin.AmazonElasticsearchParametersProperty(
                domain="domain"
            ),
            amazon_open_search_parameters=quicksight_mixins.CfnDataSourcePropsMixin.AmazonOpenSearchParametersProperty(
                domain="domain"
            ),
            athena_parameters=quicksight_mixins.CfnDataSourcePropsMixin.AthenaParametersProperty(
                identity_center_configuration=quicksight_mixins.CfnDataSourcePropsMixin.IdentityCenterConfigurationProperty(
                    enable_identity_propagation=False
                ),
                role_arn="roleArn",
                work_group="workGroup"
            ),
            aurora_parameters=quicksight_mixins.CfnDataSourcePropsMixin.AuroraParametersProperty(
                database="database",
                host="host",
                port=123
            ),
            aurora_postgre_sql_parameters=quicksight_mixins.CfnDataSourcePropsMixin.AuroraPostgreSqlParametersProperty(
                database="database",
                host="host",
                port=123
            ),
            databricks_parameters=quicksight_mixins.CfnDataSourcePropsMixin.DatabricksParametersProperty(
                host="host",
                port=123,
                sql_endpoint_path="sqlEndpointPath"
            ),
            maria_db_parameters=quicksight_mixins.CfnDataSourcePropsMixin.MariaDbParametersProperty(
                database="database",
                host="host",
                port=123
            ),
            my_sql_parameters=quicksight_mixins.CfnDataSourcePropsMixin.MySqlParametersProperty(
                database="database",
                host="host",
                port=123
            ),
            oracle_parameters=quicksight_mixins.CfnDataSourcePropsMixin.OracleParametersProperty(
                database="database",
                host="host",
                port=123,
                use_service_name=False
            ),
            postgre_sql_parameters=quicksight_mixins.CfnDataSourcePropsMixin.PostgreSqlParametersProperty(
                database="database",
                host="host",
                port=123
            ),
            presto_parameters=quicksight_mixins.CfnDataSourcePropsMixin.PrestoParametersProperty(
                catalog="catalog",
                host="host",
                port=123
            ),
            rds_parameters=quicksight_mixins.CfnDataSourcePropsMixin.RdsParametersProperty(
                database="database",
                instance_id="instanceId"
            ),
            redshift_parameters=quicksight_mixins.CfnDataSourcePropsMixin.RedshiftParametersProperty(
                cluster_id="clusterId",
                database="database",
                host="host",
                iam_parameters=quicksight_mixins.CfnDataSourcePropsMixin.RedshiftIAMParametersProperty(
                    auto_create_database_user=False,
                    database_groups=["databaseGroups"],
                    database_user="databaseUser",
                    role_arn="roleArn"
                ),
                identity_center_configuration=quicksight_mixins.CfnDataSourcePropsMixin.IdentityCenterConfigurationProperty(
                    enable_identity_propagation=False
                ),
                port=123
            ),
            s3_parameters=quicksight_mixins.CfnDataSourcePropsMixin.S3ParametersProperty(
                manifest_file_location=quicksight_mixins.CfnDataSourcePropsMixin.ManifestFileLocationProperty(
                    bucket="bucket",
                    key="key"
                ),
                role_arn="roleArn"
            ),
            snowflake_parameters=quicksight_mixins.CfnDataSourcePropsMixin.SnowflakeParametersProperty(
                authentication_type="authenticationType",
                database="database",
                database_access_control_role="databaseAccessControlRole",
                host="host",
                o_auth_parameters=quicksight_mixins.CfnDataSourcePropsMixin.OAuthParametersProperty(
                    identity_provider_resource_uri="identityProviderResourceUri",
                    identity_provider_vpc_connection_properties=quicksight_mixins.CfnDataSourcePropsMixin.VpcConnectionPropertiesProperty(
                        vpc_connection_arn="vpcConnectionArn"
                    ),
                    o_auth_scope="oAuthScope",
                    token_provider_url="tokenProviderUrl"
                ),
                warehouse="warehouse"
            ),
            spark_parameters=quicksight_mixins.CfnDataSourcePropsMixin.SparkParametersProperty(
                host="host",
                port=123
            ),
            sql_server_parameters=quicksight_mixins.CfnDataSourcePropsMixin.SqlServerParametersProperty(
                database="database",
                host="host",
                port=123
            ),
            starburst_parameters=quicksight_mixins.CfnDataSourcePropsMixin.StarburstParametersProperty(
                authentication_type="authenticationType",
                catalog="catalog",
                database_access_control_role="databaseAccessControlRole",
                host="host",
                o_auth_parameters=quicksight_mixins.CfnDataSourcePropsMixin.OAuthParametersProperty(
                    identity_provider_resource_uri="identityProviderResourceUri",
                    identity_provider_vpc_connection_properties=quicksight_mixins.CfnDataSourcePropsMixin.VpcConnectionPropertiesProperty(
                        vpc_connection_arn="vpcConnectionArn"
                    ),
                    o_auth_scope="oAuthScope",
                    token_provider_url="tokenProviderUrl"
                ),
                port=123,
                product_type="productType"
            ),
            teradata_parameters=quicksight_mixins.CfnDataSourcePropsMixin.TeradataParametersProperty(
                database="database",
                host="host",
                port=123
            ),
            trino_parameters=quicksight_mixins.CfnDataSourcePropsMixin.TrinoParametersProperty(
                catalog="catalog",
                host="host",
                port=123
            )
        )],
        password="password",
        username="username"
    ),
    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.

See:

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

credential_pair

Credential pair.

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

See:

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

secret_arn

The Amazon Resource Name (ARN) of the secret associated with the data source in AWS Secrets Manager .

See:

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

DataSourceErrorInfoProperty

class CfnDataSourcePropsMixin.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.

See:

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.mixins_preview.aws_quicksight import mixins as quicksight_mixins

data_source_error_info_property = quicksight_mixins.CfnDataSourcePropsMixin.DataSourceErrorInfoProperty(
    message="message",
    type="type"
)

Attributes

message

Error message.

See:

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

type

Error type.

See:

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

DataSourceParametersProperty

class CfnDataSourcePropsMixin.DataSourceParametersProperty(*, amazon_elasticsearch_parameters=None, amazon_open_search_parameters=None, athena_parameters=None, aurora_parameters=None, aurora_postgre_sql_parameters=None, databricks_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, starburst_parameters=None, teradata_parameters=None, trino_parameters=None)

Bases: object

The parameters that Quick Sight 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:
See:

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.mixins_preview.aws_quicksight import mixins as quicksight_mixins

data_source_parameters_property = quicksight_mixins.CfnDataSourcePropsMixin.DataSourceParametersProperty(
    amazon_elasticsearch_parameters=quicksight_mixins.CfnDataSourcePropsMixin.AmazonElasticsearchParametersProperty(
        domain="domain"
    ),
    amazon_open_search_parameters=quicksight_mixins.CfnDataSourcePropsMixin.AmazonOpenSearchParametersProperty(
        domain="domain"
    ),
    athena_parameters=quicksight_mixins.CfnDataSourcePropsMixin.AthenaParametersProperty(
        identity_center_configuration=quicksight_mixins.CfnDataSourcePropsMixin.IdentityCenterConfigurationProperty(
            enable_identity_propagation=False
        ),
        role_arn="roleArn",
        work_group="workGroup"
    ),
    aurora_parameters=quicksight_mixins.CfnDataSourcePropsMixin.AuroraParametersProperty(
        database="database",
        host="host",
        port=123
    ),
    aurora_postgre_sql_parameters=quicksight_mixins.CfnDataSourcePropsMixin.AuroraPostgreSqlParametersProperty(
        database="database",
        host="host",
        port=123
    ),
    databricks_parameters=quicksight_mixins.CfnDataSourcePropsMixin.DatabricksParametersProperty(
        host="host",
        port=123,
        sql_endpoint_path="sqlEndpointPath"
    ),
    maria_db_parameters=quicksight_mixins.CfnDataSourcePropsMixin.MariaDbParametersProperty(
        database="database",
        host="host",
        port=123
    ),
    my_sql_parameters=quicksight_mixins.CfnDataSourcePropsMixin.MySqlParametersProperty(
        database="database",
        host="host",
        port=123
    ),
    oracle_parameters=quicksight_mixins.CfnDataSourcePropsMixin.OracleParametersProperty(
        database="database",
        host="host",
        port=123,
        use_service_name=False
    ),
    postgre_sql_parameters=quicksight_mixins.CfnDataSourcePropsMixin.PostgreSqlParametersProperty(
        database="database",
        host="host",
        port=123
    ),
    presto_parameters=quicksight_mixins.CfnDataSourcePropsMixin.PrestoParametersProperty(
        catalog="catalog",
        host="host",
        port=123
    ),
    rds_parameters=quicksight_mixins.CfnDataSourcePropsMixin.RdsParametersProperty(
        database="database",
        instance_id="instanceId"
    ),
    redshift_parameters=quicksight_mixins.CfnDataSourcePropsMixin.RedshiftParametersProperty(
        cluster_id="clusterId",
        database="database",
        host="host",
        iam_parameters=quicksight_mixins.CfnDataSourcePropsMixin.RedshiftIAMParametersProperty(
            auto_create_database_user=False,
            database_groups=["databaseGroups"],
            database_user="databaseUser",
            role_arn="roleArn"
        ),
        identity_center_configuration=quicksight_mixins.CfnDataSourcePropsMixin.IdentityCenterConfigurationProperty(
            enable_identity_propagation=False
        ),
        port=123
    ),
    s3_parameters=quicksight_mixins.CfnDataSourcePropsMixin.S3ParametersProperty(
        manifest_file_location=quicksight_mixins.CfnDataSourcePropsMixin.ManifestFileLocationProperty(
            bucket="bucket",
            key="key"
        ),
        role_arn="roleArn"
    ),
    snowflake_parameters=quicksight_mixins.CfnDataSourcePropsMixin.SnowflakeParametersProperty(
        authentication_type="authenticationType",
        database="database",
        database_access_control_role="databaseAccessControlRole",
        host="host",
        o_auth_parameters=quicksight_mixins.CfnDataSourcePropsMixin.OAuthParametersProperty(
            identity_provider_resource_uri="identityProviderResourceUri",
            identity_provider_vpc_connection_properties=quicksight_mixins.CfnDataSourcePropsMixin.VpcConnectionPropertiesProperty(
                vpc_connection_arn="vpcConnectionArn"
            ),
            o_auth_scope="oAuthScope",
            token_provider_url="tokenProviderUrl"
        ),
        warehouse="warehouse"
    ),
    spark_parameters=quicksight_mixins.CfnDataSourcePropsMixin.SparkParametersProperty(
        host="host",
        port=123
    ),
    sql_server_parameters=quicksight_mixins.CfnDataSourcePropsMixin.SqlServerParametersProperty(
        database="database",
        host="host",
        port=123
    ),
    starburst_parameters=quicksight_mixins.CfnDataSourcePropsMixin.StarburstParametersProperty(
        authentication_type="authenticationType",
        catalog="catalog",
        database_access_control_role="databaseAccessControlRole",
        host="host",
        o_auth_parameters=quicksight_mixins.CfnDataSourcePropsMixin.OAuthParametersProperty(
            identity_provider_resource_uri="identityProviderResourceUri",
            identity_provider_vpc_connection_properties=quicksight_mixins.CfnDataSourcePropsMixin.VpcConnectionPropertiesProperty(
                vpc_connection_arn="vpcConnectionArn"
            ),
            o_auth_scope="oAuthScope",
            token_provider_url="tokenProviderUrl"
        ),
        port=123,
        product_type="productType"
    ),
    teradata_parameters=quicksight_mixins.CfnDataSourcePropsMixin.TeradataParametersProperty(
        database="database",
        host="host",
        port=123
    ),
    trino_parameters=quicksight_mixins.CfnDataSourcePropsMixin.TrinoParametersProperty(
        catalog="catalog",
        host="host",
        port=123
    )
)

Attributes

amazon_elasticsearch_parameters

The parameters for OpenSearch.

See:

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

amazon_open_search_parameters

The parameters for OpenSearch.

See:

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

athena_parameters

The parameters for Amazon Athena.

See:

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

aurora_parameters

The parameters for Amazon Aurora MySQL.

See:

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

aurora_postgre_sql_parameters

The parameters for Amazon Aurora.

See:

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

databricks_parameters

The required parameters that are needed to connect to a Databricks data source.

See:

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

maria_db_parameters

The parameters for MariaDB.

See:

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

my_sql_parameters

The parameters for MySQL.

See:

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

oracle_parameters

Oracle parameters.

See:

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

postgre_sql_parameters

The parameters for PostgreSQL.

See:

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

presto_parameters

The parameters for Presto.

See:

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

rds_parameters

The parameters for Amazon RDS.

See:

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

redshift_parameters

The parameters for Amazon Redshift.

See:

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

s3_parameters

The parameters for S3.

See:

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

snowflake_parameters

The parameters for Snowflake.

See:

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

spark_parameters

The parameters for Spark.

See:

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

sql_server_parameters

The parameters for SQL Server.

See:

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

starburst_parameters

The parameters that are required to connect to a Starburst data source.

See:

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

teradata_parameters

The parameters for Teradata.

See:

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

trino_parameters

The parameters that are required to connect to a Trino data source.

See:

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

DatabricksParametersProperty

class CfnDataSourcePropsMixin.DatabricksParametersProperty(*, host=None, port=None, sql_endpoint_path=None)

Bases: object

The required parameters that are needed to connect to a Databricks data source.

Parameters:

  • host (Optional[str]) – The host name of the Databricks data source.

  • port (Union[int, float, None]) – The port for the Databricks data source. Default: - 0

  • sql_endpoint_path (Optional[str]) – The HTTP path of the Databricks data source.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-datasource-databricksparameters.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.mixins_preview.aws_quicksight import mixins as quicksight_mixins

databricks_parameters_property = quicksight_mixins.CfnDataSourcePropsMixin.DatabricksParametersProperty(
    host="host",
    port=123,
    sql_endpoint_path="sqlEndpointPath"
)

Attributes

host

The host name of the Databricks data source.

See:

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

port

The port for the Databricks data source.

Default:

  • 0

See:

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

sql_endpoint_path

The HTTP path of the Databricks data source.

See:

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

IdentityCenterConfigurationProperty

class CfnDataSourcePropsMixin.IdentityCenterConfigurationProperty(*, enable_identity_propagation=None)

Bases: object

The parameters for an IAM Identity Center configuration.

Parameters:

enable_identity_propagation (Union[bool, IResolvable, None]) – A Boolean option that controls whether Trusted Identity Propagation should be used.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-datasource-identitycenterconfiguration.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.mixins_preview.aws_quicksight import mixins as quicksight_mixins

identity_center_configuration_property = quicksight_mixins.CfnDataSourcePropsMixin.IdentityCenterConfigurationProperty(
    enable_identity_propagation=False
)

Attributes

enable_identity_propagation

A Boolean option that controls whether Trusted Identity Propagation should be used.

See:

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

ManifestFileLocationProperty

class CfnDataSourcePropsMixin.ManifestFileLocationProperty(*, bucket=None, key=None)

Bases: object

Amazon S3 manifest file location.

Parameters:

  • bucket (Optional[str]) – Amazon S3 bucket.

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

See:

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.mixins_preview.aws_quicksight import mixins as quicksight_mixins

manifest_file_location_property = quicksight_mixins.CfnDataSourcePropsMixin.ManifestFileLocationProperty(
    bucket="bucket",
    key="key"
)

Attributes

bucket

Amazon S3 bucket.

See:

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

key

Amazon S3 key that identifies an object.

See:

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

MariaDbParametersProperty

class CfnDataSourcePropsMixin.MariaDbParametersProperty(*, database=None, host=None, port=None)

Bases: object

The parameters for MariaDB.

Parameters:

  • database (Optional[str]) – Database.

  • host (Optional[str]) – Host.

  • port (Union[int, float, None]) – Port. Default: - 0

See:

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.mixins_preview.aws_quicksight import mixins as quicksight_mixins

maria_db_parameters_property = quicksight_mixins.CfnDataSourcePropsMixin.MariaDbParametersProperty(
    database="database",
    host="host",
    port=123
)

Attributes

database

Database.

See:

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

host

Host.

See:

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

port

Port.

Default:

  • 0

See:

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

MySqlParametersProperty

class CfnDataSourcePropsMixin.MySqlParametersProperty(*, database=None, host=None, port=None)

Bases: object

The parameters for MySQL.

Parameters:

  • database (Optional[str]) – Database.

  • host (Optional[str]) – Host.

  • port (Union[int, float, None]) – Port. Default: - 0

See:

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.mixins_preview.aws_quicksight import mixins as quicksight_mixins

my_sql_parameters_property = quicksight_mixins.CfnDataSourcePropsMixin.MySqlParametersProperty(
    database="database",
    host="host",
    port=123
)

Attributes

database

Database.

See:

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

host

Host.

See:

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

port

Port.

Default:

  • 0

See:

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

OAuthParametersProperty

class CfnDataSourcePropsMixin.OAuthParametersProperty(*, identity_provider_resource_uri=None, identity_provider_vpc_connection_properties=None, o_auth_scope=None, token_provider_url=None)

Bases: object

An object that contains information needed to create a data source connection that uses OAuth client credentials.

This option is available for data source connections that are made with Snowflake and Starburst.

Parameters:

  • identity_provider_resource_uri (Optional[str]) – The resource uri of the identity provider.

  • identity_provider_vpc_connection_properties (Union[IResolvable, VpcConnectionPropertiesProperty, Dict[str, Any], None])

  • o_auth_scope (Optional[str]) – The OAuth scope.

  • token_provider_url (Optional[str]) – The token endpoint URL of the identity provider.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-datasource-oauthparameters.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.mixins_preview.aws_quicksight import mixins as quicksight_mixins

o_auth_parameters_property = quicksight_mixins.CfnDataSourcePropsMixin.OAuthParametersProperty(
    identity_provider_resource_uri="identityProviderResourceUri",
    identity_provider_vpc_connection_properties=quicksight_mixins.CfnDataSourcePropsMixin.VpcConnectionPropertiesProperty(
        vpc_connection_arn="vpcConnectionArn"
    ),
    o_auth_scope="oAuthScope",
    token_provider_url="tokenProviderUrl"
)

Attributes

identity_provider_resource_uri

The resource uri of the identity provider.

See:

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

identity_provider_vpc_connection_properties

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

Type:

see

o_auth_scope

The OAuth scope.

See:

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

token_provider_url

The token endpoint URL of the identity provider.

See:

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

OracleParametersProperty

class CfnDataSourcePropsMixin.OracleParametersProperty(*, database=None, host=None, port=None, use_service_name=None)

Bases: object

Oracle parameters.

Parameters:

  • database (Optional[str]) – Database.

  • host (Optional[str]) – Host.

  • port (Union[int, float, None]) – Port. Default: - 0

  • use_service_name (Union[bool, IResolvable, None]) – A Boolean value that indicates whether the Database uses a service name or an SID. If this value is left blank, the default value is SID . If this value is set to false , the value is SID . Default: - false

See:

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.mixins_preview.aws_quicksight import mixins as quicksight_mixins

oracle_parameters_property = quicksight_mixins.CfnDataSourcePropsMixin.OracleParametersProperty(
    database="database",
    host="host",
    port=123,
    use_service_name=False
)

Attributes

database

Database.

See:

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

host

Host.

See:

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

port

Port.

Default:

  • 0

See:

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

use_service_name

A Boolean value that indicates whether the Database uses a service name or an SID.

If this value is left blank, the default value is SID . If this value is set to false , the value is SID .

Default:

  • false

See:

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

PostgreSqlParametersProperty

class CfnDataSourcePropsMixin.PostgreSqlParametersProperty(*, database=None, host=None, port=None)

Bases: object

The parameters for PostgreSQL.

Parameters:

  • database (Optional[str]) – Database.

  • host (Optional[str]) – Host.

  • port (Union[int, float, None]) – Port. Default: - 0

See:

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.mixins_preview.aws_quicksight import mixins as quicksight_mixins

postgre_sql_parameters_property = quicksight_mixins.CfnDataSourcePropsMixin.PostgreSqlParametersProperty(
    database="database",
    host="host",
    port=123
)

Attributes

database

Database.

See:

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

host

Host.

See:

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

port

Port.

Default:

  • 0

See:

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

PrestoParametersProperty

class CfnDataSourcePropsMixin.PrestoParametersProperty(*, catalog=None, host=None, port=None)

Bases: object

The parameters for Presto.

Parameters:

  • catalog (Optional[str]) – Catalog.

  • host (Optional[str]) – Host.

  • port (Union[int, float, None]) – Port. Default: - 0

See:

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.mixins_preview.aws_quicksight import mixins as quicksight_mixins

presto_parameters_property = quicksight_mixins.CfnDataSourcePropsMixin.PrestoParametersProperty(
    catalog="catalog",
    host="host",
    port=123
)

Attributes

catalog

Catalog.

See:

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

host

Host.

See:

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

port

Port.

Default:

  • 0

See:

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

RdsParametersProperty

class CfnDataSourcePropsMixin.RdsParametersProperty(*, database=None, instance_id=None)

Bases: object

The parameters for Amazon RDS.

Parameters:

  • database (Optional[str]) – Database.

  • instance_id (Optional[str]) – Instance ID.

See:

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.mixins_preview.aws_quicksight import mixins as quicksight_mixins

rds_parameters_property = quicksight_mixins.CfnDataSourcePropsMixin.RdsParametersProperty(
    database="database",
    instance_id="instanceId"
)

Attributes

database

Database.

See:

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

instance_id

Instance ID.

See:

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

RedshiftIAMParametersProperty

class CfnDataSourcePropsMixin.RedshiftIAMParametersProperty(*, auto_create_database_user=None, database_groups=None, database_user=None, role_arn=None)

Bases: object

A structure that grants Quick Sight access to your cluster and make a call to the redshift:GetClusterCredentials API.

For more information on the redshift:GetClusterCredentials API, see `GetClusterCredentials <https://docs.aws.amazon.com/redshift/latest/APIReference/API_GetClusterCredentials.html>`_ .

Parameters:

  • auto_create_database_user (Union[bool, IResolvable, None]) – Automatically creates a database user. If your database doesn’t have a DatabaseUser , set this parameter to True . If there is no DatabaseUser , Quick Sight can’t connect to your cluster. The RoleArn that you use for this operation must grant access to redshift:CreateClusterUser to successfully create the user. Default: - false

  • database_groups (Optional[Sequence[str]]) – A list of groups whose permissions will be granted to Quick Sight to access the cluster. These permissions are combined with the permissions granted to Quick Sight by the DatabaseUser . If you choose to include this parameter, the RoleArn must grant access to redshift:JoinGroup .

  • database_user (Optional[str]) – The user whose permissions and group memberships will be used by Quick Sight to access the cluster. If this user already exists in your database, Amazon Quick Sight is granted the same permissions that the user has. If the user doesn’t exist, set the value of AutoCreateDatabaseUser to True to create a new user with PUBLIC permissions.

  • role_arn (Optional[str]) – Use the RoleArn structure to allow Quick Sight to call redshift:GetClusterCredentials on your cluster. The calling principal must have iam:PassRole access to pass the role to Quick Sight. The role’s trust policy must allow the Quick Sight service principal to assume the role.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-datasource-redshiftiamparameters.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.mixins_preview.aws_quicksight import mixins as quicksight_mixins

redshift_iAMParameters_property = quicksight_mixins.CfnDataSourcePropsMixin.RedshiftIAMParametersProperty(
    auto_create_database_user=False,
    database_groups=["databaseGroups"],
    database_user="databaseUser",
    role_arn="roleArn"
)

Attributes

auto_create_database_user

Automatically creates a database user.

If your database doesn’t have a DatabaseUser , set this parameter to True . If there is no DatabaseUser , Quick Sight can’t connect to your cluster. The RoleArn that you use for this operation must grant access to redshift:CreateClusterUser to successfully create the user.

Default:

  • false

See:

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

database_groups

A list of groups whose permissions will be granted to Quick Sight to access the cluster.

These permissions are combined with the permissions granted to Quick Sight by the DatabaseUser . If you choose to include this parameter, the RoleArn must grant access to redshift:JoinGroup .

See:

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

database_user

The user whose permissions and group memberships will be used by Quick Sight to access the cluster.

If this user already exists in your database, Amazon Quick Sight is granted the same permissions that the user has. If the user doesn’t exist, set the value of AutoCreateDatabaseUser to True to create a new user with PUBLIC permissions.

See:

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

role_arn

Use the RoleArn structure to allow Quick Sight to call redshift:GetClusterCredentials on your cluster.

The calling principal must have iam:PassRole access to pass the role to Quick Sight. The role’s trust policy must allow the Quick Sight service principal to assume the role.

See:

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

RedshiftParametersProperty

class CfnDataSourcePropsMixin.RedshiftParametersProperty(*, cluster_id=None, database=None, host=None, iam_parameters=None, identity_center_configuration=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:

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

  • database (Optional[str]) – Database.

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

  • iam_parameters (Union[IResolvable, RedshiftIAMParametersProperty, Dict[str, Any], None]) – An optional parameter that uses IAM authentication to grant Quick Sight access to your cluster. This parameter can be used instead of DataSourceCredentials .

  • identity_center_configuration (Union[IResolvable, IdentityCenterConfigurationProperty, Dict[str, Any], None]) – An optional parameter that configures IAM Identity Center authentication to grant Quick Sight access to your cluster. This parameter can only be specified if your Quick Sight account is configured with IAM Identity Center.

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

See:

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.mixins_preview.aws_quicksight import mixins as quicksight_mixins

redshift_parameters_property = quicksight_mixins.CfnDataSourcePropsMixin.RedshiftParametersProperty(
    cluster_id="clusterId",
    database="database",
    host="host",
    iam_parameters=quicksight_mixins.CfnDataSourcePropsMixin.RedshiftIAMParametersProperty(
        auto_create_database_user=False,
        database_groups=["databaseGroups"],
        database_user="databaseUser",
        role_arn="roleArn"
    ),
    identity_center_configuration=quicksight_mixins.CfnDataSourcePropsMixin.IdentityCenterConfigurationProperty(
        enable_identity_propagation=False
    ),
    port=123
)

Attributes

cluster_id

Cluster ID.

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

See:

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

database

Database.

See:

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

host

Host.

This field can be blank if ClusterId is provided.

See:

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

iam_parameters

An optional parameter that uses IAM authentication to grant Quick Sight access to your cluster.

This parameter can be used instead of DataSourceCredentials .

See:

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

identity_center_configuration

An optional parameter that configures IAM Identity Center authentication to grant Quick Sight access to your cluster.

This parameter can only be specified if your Quick Sight account is configured with IAM Identity Center.

See:

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

port

Port.

This field can be blank if the ClusterId is provided.

Default:

  • 0

See:

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

ResourcePermissionProperty

class CfnDataSourcePropsMixin.ResourcePermissionProperty(*, actions=None, principal=None, resource=None)

Bases: object

Permission for the resource.

Parameters:

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

  • principal (Optional[str]) – The Amazon Resource Name (ARN) of the principal. This can be one of the following:. - The ARN of an Amazon Quick Suite user or group associated with a data source or dataset. (This is common.) - The ARN of an Amazon Quick Suite 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 Quick Suite ARN. Use this option only to share resources (templates) across AWS accounts . (This is less common.)

  • resource (Optional[str])

See:

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.mixins_preview.aws_quicksight import mixins as quicksight_mixins

resource_permission_property = quicksight_mixins.CfnDataSourcePropsMixin.ResourcePermissionProperty(
    actions=["actions"],
    principal="principal",
    resource="resource"
)

Attributes

actions

The IAM action to grant or revoke permissions on.

See:

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

principal

.

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

  • The ARN of an Amazon Quick Suite 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 Quick Suite ARN. Use this option only to share resources (templates) across AWS accounts . (This is less common.)

See:

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

resource

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

Type:

see

S3ParametersProperty

class CfnDataSourcePropsMixin.S3ParametersProperty(*, manifest_file_location=None, role_arn=None)

Bases: object

The parameters for S3.

Parameters:

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

  • role_arn (Optional[str]) – Use the RoleArn structure to override an account-wide role for a specific S3 data source. For example, say an account administrator has turned off all S3 access with an account-wide role. The administrator can then use RoleArn to bypass the account-wide role and allow S3 access for the single S3 data source that is specified in the structure, even if the account-wide role forbidding S3 access is still active.

See:

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.mixins_preview.aws_quicksight import mixins as quicksight_mixins

s3_parameters_property = quicksight_mixins.CfnDataSourcePropsMixin.S3ParametersProperty(
    manifest_file_location=quicksight_mixins.CfnDataSourcePropsMixin.ManifestFileLocationProperty(
        bucket="bucket",
        key="key"
    ),
    role_arn="roleArn"
)

Attributes

manifest_file_location

Location of the Amazon S3 manifest file.

This is NULL if the manifest file was uploaded into Quick Sight.

See:

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

role_arn

Use the RoleArn structure to override an account-wide role for a specific S3 data source.

For example, say an account administrator has turned off all S3 access with an account-wide role. The administrator can then use RoleArn to bypass the account-wide role and allow S3 access for the single S3 data source that is specified in the structure, even if the account-wide role forbidding S3 access is still active.

See:

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

SnowflakeParametersProperty

class CfnDataSourcePropsMixin.SnowflakeParametersProperty(*, authentication_type=None, database=None, database_access_control_role=None, host=None, o_auth_parameters=None, warehouse=None)

Bases: object

The parameters for Snowflake.

Parameters:

  • authentication_type (Optional[str]) – The authentication type that you want to use for your connection. This parameter accepts OAuth and non-OAuth authentication types.

  • database (Optional[str]) – Database.

  • database_access_control_role (Optional[str]) – The database access control role.

  • host (Optional[str]) – Host.

  • o_auth_parameters (Union[IResolvable, OAuthParametersProperty, Dict[str, Any], None]) – An object that contains information needed to create a data source connection between an Quick Sight account and Snowflake.

  • warehouse (Optional[str]) – Warehouse.

See:

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.mixins_preview.aws_quicksight import mixins as quicksight_mixins

snowflake_parameters_property = quicksight_mixins.CfnDataSourcePropsMixin.SnowflakeParametersProperty(
    authentication_type="authenticationType",
    database="database",
    database_access_control_role="databaseAccessControlRole",
    host="host",
    o_auth_parameters=quicksight_mixins.CfnDataSourcePropsMixin.OAuthParametersProperty(
        identity_provider_resource_uri="identityProviderResourceUri",
        identity_provider_vpc_connection_properties=quicksight_mixins.CfnDataSourcePropsMixin.VpcConnectionPropertiesProperty(
            vpc_connection_arn="vpcConnectionArn"
        ),
        o_auth_scope="oAuthScope",
        token_provider_url="tokenProviderUrl"
    ),
    warehouse="warehouse"
)

Attributes

authentication_type

The authentication type that you want to use for your connection.

This parameter accepts OAuth and non-OAuth authentication types.

See:

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

database

Database.

See:

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

database_access_control_role

The database access control role.

See:

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

host

Host.

See:

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

o_auth_parameters

An object that contains information needed to create a data source connection between an Quick Sight account and Snowflake.

See:

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

warehouse

Warehouse.

See:

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

SparkParametersProperty

class CfnDataSourcePropsMixin.SparkParametersProperty(*, host=None, port=None)

Bases: object

The parameters for Spark.

Parameters:

  • host (Optional[str]) – Host.

  • port (Union[int, float, None]) – Port. Default: - 0

See:

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.mixins_preview.aws_quicksight import mixins as quicksight_mixins

spark_parameters_property = quicksight_mixins.CfnDataSourcePropsMixin.SparkParametersProperty(
    host="host",
    port=123
)

Attributes

host

Host.

See:

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

port

Port.

Default:

  • 0

See:

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

SqlServerParametersProperty

class CfnDataSourcePropsMixin.SqlServerParametersProperty(*, database=None, host=None, port=None)

Bases: object

The parameters for SQL Server.

Parameters:

  • database (Optional[str]) – Database.

  • host (Optional[str]) – Host.

  • port (Union[int, float, None]) – Port. Default: - 0

See:

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.mixins_preview.aws_quicksight import mixins as quicksight_mixins

sql_server_parameters_property = quicksight_mixins.CfnDataSourcePropsMixin.SqlServerParametersProperty(
    database="database",
    host="host",
    port=123
)

Attributes

database

Database.

See:

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

host

Host.

See:

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

port

Port.

Default:

  • 0

See:

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

SslPropertiesProperty

class CfnDataSourcePropsMixin.SslPropertiesProperty(*, disable_ssl=None)

Bases: object

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

Parameters:

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

See:

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.mixins_preview.aws_quicksight import mixins as quicksight_mixins

ssl_properties_property = quicksight_mixins.CfnDataSourcePropsMixin.SslPropertiesProperty(
    disable_ssl=False
)

Attributes

disable_ssl

A Boolean option to control whether SSL should be disabled.

Default:

  • false

See:

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

StarburstParametersProperty

class CfnDataSourcePropsMixin.StarburstParametersProperty(*, authentication_type=None, catalog=None, database_access_control_role=None, host=None, o_auth_parameters=None, port=None, product_type=None)

Bases: object

The parameters that are required to connect to a Starburst data source.

Parameters:

  • authentication_type (Optional[str]) – The authentication type that you want to use for your connection. This parameter accepts OAuth and non-OAuth authentication types.

  • catalog (Optional[str]) – The catalog name for the Starburst data source.

  • database_access_control_role (Optional[str]) – The database access control role.

  • host (Optional[str]) – The host name of the Starburst data source.

  • o_auth_parameters (Union[IResolvable, OAuthParametersProperty, Dict[str, Any], None]) – An object that contains information needed to create a data source connection between an Quick Sight account and Starburst.

  • port (Union[int, float, None]) – The port for the Starburst data source. Default: - 0

  • product_type (Optional[str]) – The product type for the Starburst data source.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-datasource-starburstparameters.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.mixins_preview.aws_quicksight import mixins as quicksight_mixins

starburst_parameters_property = quicksight_mixins.CfnDataSourcePropsMixin.StarburstParametersProperty(
    authentication_type="authenticationType",
    catalog="catalog",
    database_access_control_role="databaseAccessControlRole",
    host="host",
    o_auth_parameters=quicksight_mixins.CfnDataSourcePropsMixin.OAuthParametersProperty(
        identity_provider_resource_uri="identityProviderResourceUri",
        identity_provider_vpc_connection_properties=quicksight_mixins.CfnDataSourcePropsMixin.VpcConnectionPropertiesProperty(
            vpc_connection_arn="vpcConnectionArn"
        ),
        o_auth_scope="oAuthScope",
        token_provider_url="tokenProviderUrl"
    ),
    port=123,
    product_type="productType"
)

Attributes

authentication_type

The authentication type that you want to use for your connection.

This parameter accepts OAuth and non-OAuth authentication types.

See:

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

catalog

The catalog name for the Starburst data source.

See:

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

database_access_control_role

The database access control role.

See:

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

host

The host name of the Starburst data source.

See:

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

o_auth_parameters

An object that contains information needed to create a data source connection between an Quick Sight account and Starburst.

See:

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

port

The port for the Starburst data source.

Default:

  • 0

See:

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

product_type

The product type for the Starburst data source.

See:

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

TeradataParametersProperty

class CfnDataSourcePropsMixin.TeradataParametersProperty(*, database=None, host=None, port=None)

Bases: object

The parameters for Teradata.

Parameters:

  • database (Optional[str]) – Database.

  • host (Optional[str]) – Host.

  • port (Union[int, float, None]) – Port. Default: - 0

See:

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.mixins_preview.aws_quicksight import mixins as quicksight_mixins

teradata_parameters_property = quicksight_mixins.CfnDataSourcePropsMixin.TeradataParametersProperty(
    database="database",
    host="host",
    port=123
)

Attributes

database

Database.

See:

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

host

Host.

See:

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

port

Port.

Default:

  • 0

See:

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

TrinoParametersProperty

class CfnDataSourcePropsMixin.TrinoParametersProperty(*, catalog=None, host=None, port=None)

Bases: object

The parameters that are required to connect to a Trino data source.

Parameters:

  • catalog (Optional[str]) – The catalog name for the Trino data source.

  • host (Optional[str]) – The host name of the Trino data source.

  • port (Union[int, float, None]) – The port for the Trino data source. Default: - 0

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-datasource-trinoparameters.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.mixins_preview.aws_quicksight import mixins as quicksight_mixins

trino_parameters_property = quicksight_mixins.CfnDataSourcePropsMixin.TrinoParametersProperty(
    catalog="catalog",
    host="host",
    port=123
)

Attributes

catalog

The catalog name for the Trino data source.

See:

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

host

The host name of the Trino data source.

See:

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

port

The port for the Trino data source.

Default:

  • 0

See:

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

VpcConnectionPropertiesProperty

class CfnDataSourcePropsMixin.VpcConnectionPropertiesProperty(*, vpc_connection_arn=None)

Bases: object

VPC connection properties.

Parameters:

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

See:

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.mixins_preview.aws_quicksight import mixins as quicksight_mixins

vpc_connection_properties_property = quicksight_mixins.CfnDataSourcePropsMixin.VpcConnectionPropertiesProperty(
    vpc_connection_arn="vpcConnectionArn"
)

Attributes

vpc_connection_arn

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

See:

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