CfnDataSource

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

Bases: CfnResource

Creates a data source.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-quicksight-datasource.html
CloudformationResource:: AWS::QuickSight::DataSource
ExampleMetadata:: fixture=_generated

Example:

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

cfn_data_source = quicksight.CfnDataSource(self, "MyCfnDataSource",
    name="name",
    type="type",

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

            # the properties below are optional
            cluster_id="clusterId",
            host="host",
            iam_parameters=quicksight.CfnDataSource.RedshiftIAMParametersProperty(
                role_arn="roleArn",

                # the properties below are optional
                auto_create_database_user=False,
                database_groups=["databaseGroups"],
                database_user="databaseUser"
            ),
            identity_center_configuration=quicksight.CfnDataSource.IdentityCenterConfigurationProperty(
                enable_identity_propagation=False
            ),
            port=123
        ),
        s3_parameters=quicksight.CfnDataSource.S3ParametersProperty(
            manifest_file_location=quicksight.CfnDataSource.ManifestFileLocationProperty(
                bucket="bucket",
                key="key"
            ),

            # the properties below are optional
            role_arn="roleArn"
        ),
        snowflake_parameters=quicksight.CfnDataSource.SnowflakeParametersProperty(
            database="database",
            host="host",
            warehouse="warehouse",

            # the properties below are optional
            authentication_type="authenticationType",
            database_access_control_role="databaseAccessControlRole",
            o_auth_parameters=quicksight.CfnDataSource.OAuthParametersProperty(
                token_provider_url="tokenProviderUrl",

                # the properties below are optional
                identity_provider_resource_uri="identityProviderResourceUri",
                identity_provider_vpc_connection_properties=quicksight.CfnDataSource.VpcConnectionPropertiesProperty(
                    vpc_connection_arn="vpcConnectionArn"
                ),
                o_auth_scope="oAuthScope"
            )
        ),
        spark_parameters=quicksight.CfnDataSource.SparkParametersProperty(
            host="host",
            port=123
        ),
        sql_server_parameters=quicksight.CfnDataSource.SqlServerParametersProperty(
            database="database",
            host="host",
            port=123
        ),
        starburst_parameters=quicksight.CfnDataSource.StarburstParametersProperty(
            catalog="catalog",
            host="host",
            port=123,

            # the properties below are optional
            authentication_type="authenticationType",
            database_access_control_role="databaseAccessControlRole",
            o_auth_parameters=quicksight.CfnDataSource.OAuthParametersProperty(
                token_provider_url="tokenProviderUrl",

                # the properties below are optional
                identity_provider_resource_uri="identityProviderResourceUri",
                identity_provider_vpc_connection_properties=quicksight.CfnDataSource.VpcConnectionPropertiesProperty(
                    vpc_connection_arn="vpcConnectionArn"
                ),
                o_auth_scope="oAuthScope"
            ),
            product_type="productType"
        ),
        teradata_parameters=quicksight.CfnDataSource.TeradataParametersProperty(
            database="database",
            host="host",
            port=123
        ),
        trino_parameters=quicksight.CfnDataSource.TrinoParametersProperty(
            catalog="catalog",
            host="host",
            port=123
        )
    )],
    aws_account_id="awsAccountId",
    credentials=quicksight.CfnDataSource.DataSourceCredentialsProperty(
        copy_source_arn="copySourceArn",
        credential_pair=quicksight.CfnDataSource.CredentialPairProperty(
            password="password",
            username="username",

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

                    # the properties below are optional
                    cluster_id="clusterId",
                    host="host",
                    iam_parameters=quicksight.CfnDataSource.RedshiftIAMParametersProperty(
                        role_arn="roleArn",

                        # the properties below are optional
                        auto_create_database_user=False,
                        database_groups=["databaseGroups"],
                        database_user="databaseUser"
                    ),
                    identity_center_configuration=quicksight.CfnDataSource.IdentityCenterConfigurationProperty(
                        enable_identity_propagation=False
                    ),
                    port=123
                ),
                s3_parameters=quicksight.CfnDataSource.S3ParametersProperty(
                    manifest_file_location=quicksight.CfnDataSource.ManifestFileLocationProperty(
                        bucket="bucket",
                        key="key"
                    ),

                    # the properties below are optional
                    role_arn="roleArn"
                ),
                snowflake_parameters=quicksight.CfnDataSource.SnowflakeParametersProperty(
                    database="database",
                    host="host",
                    warehouse="warehouse",

                    # the properties below are optional
                    authentication_type="authenticationType",
                    database_access_control_role="databaseAccessControlRole",
                    o_auth_parameters=quicksight.CfnDataSource.OAuthParametersProperty(
                        token_provider_url="tokenProviderUrl",

                        # the properties below are optional
                        identity_provider_resource_uri="identityProviderResourceUri",
                        identity_provider_vpc_connection_properties=quicksight.CfnDataSource.VpcConnectionPropertiesProperty(
                            vpc_connection_arn="vpcConnectionArn"
                        ),
                        o_auth_scope="oAuthScope"
                    )
                ),
                spark_parameters=quicksight.CfnDataSource.SparkParametersProperty(
                    host="host",
                    port=123
                ),
                sql_server_parameters=quicksight.CfnDataSource.SqlServerParametersProperty(
                    database="database",
                    host="host",
                    port=123
                ),
                starburst_parameters=quicksight.CfnDataSource.StarburstParametersProperty(
                    catalog="catalog",
                    host="host",
                    port=123,

                    # the properties below are optional
                    authentication_type="authenticationType",
                    database_access_control_role="databaseAccessControlRole",
                    o_auth_parameters=quicksight.CfnDataSource.OAuthParametersProperty(
                        token_provider_url="tokenProviderUrl",

                        # the properties below are optional
                        identity_provider_resource_uri="identityProviderResourceUri",
                        identity_provider_vpc_connection_properties=quicksight.CfnDataSource.VpcConnectionPropertiesProperty(
                            vpc_connection_arn="vpcConnectionArn"
                        ),
                        o_auth_scope="oAuthScope"
                    ),
                    product_type="productType"
                ),
                teradata_parameters=quicksight.CfnDataSource.TeradataParametersProperty(
                    database="database",
                    host="host",
                    port=123
                ),
                trino_parameters=quicksight.CfnDataSource.TrinoParametersProperty(
                    catalog="catalog",
                    host="host",
                    port=123
                )
            )]
        ),
        secret_arn="secretArn"
    ),
    data_source_id="dataSourceId",
    data_source_parameters=quicksight.CfnDataSource.DataSourceParametersProperty(
        amazon_elasticsearch_parameters=quicksight.CfnDataSource.AmazonElasticsearchParametersProperty(
            domain="domain"
        ),
        amazon_open_search_parameters=quicksight.CfnDataSource.AmazonOpenSearchParametersProperty(
            domain="domain"
        ),
        athena_parameters=quicksight.CfnDataSource.AthenaParametersProperty(
            role_arn="roleArn",
            work_group="workGroup"
        ),
        aurora_parameters=quicksight.CfnDataSource.AuroraParametersProperty(
            database="database",
            host="host",
            port=123
        ),
        aurora_postgre_sql_parameters=quicksight.CfnDataSource.AuroraPostgreSqlParametersProperty(
            database="database",
            host="host",
            port=123
        ),
        databricks_parameters=quicksight.CfnDataSource.DatabricksParametersProperty(
            host="host",
            port=123,
            sql_endpoint_path="sqlEndpointPath"
        ),
        maria_db_parameters=quicksight.CfnDataSource.MariaDbParametersProperty(
            database="database",
            host="host",
            port=123
        ),
        my_sql_parameters=quicksight.CfnDataSource.MySqlParametersProperty(
            database="database",
            host="host",
            port=123
        ),
        oracle_parameters=quicksight.CfnDataSource.OracleParametersProperty(
            database="database",
            host="host",
            port=123
        ),
        postgre_sql_parameters=quicksight.CfnDataSource.PostgreSqlParametersProperty(
            database="database",
            host="host",
            port=123
        ),
        presto_parameters=quicksight.CfnDataSource.PrestoParametersProperty(
            catalog="catalog",
            host="host",
            port=123
        ),
        rds_parameters=quicksight.CfnDataSource.RdsParametersProperty(
            database="database",
            instance_id="instanceId"
        ),
        redshift_parameters=quicksight.CfnDataSource.RedshiftParametersProperty(
            database="database",

            # the properties below are optional
            cluster_id="clusterId",
            host="host",
            iam_parameters=quicksight.CfnDataSource.RedshiftIAMParametersProperty(
                role_arn="roleArn",

                # the properties below are optional
                auto_create_database_user=False,
                database_groups=["databaseGroups"],
                database_user="databaseUser"
            ),
            identity_center_configuration=quicksight.CfnDataSource.IdentityCenterConfigurationProperty(
                enable_identity_propagation=False
            ),
            port=123
        ),
        s3_parameters=quicksight.CfnDataSource.S3ParametersProperty(
            manifest_file_location=quicksight.CfnDataSource.ManifestFileLocationProperty(
                bucket="bucket",
                key="key"
            ),

            # the properties below are optional
            role_arn="roleArn"
        ),
        snowflake_parameters=quicksight.CfnDataSource.SnowflakeParametersProperty(
            database="database",
            host="host",
            warehouse="warehouse",

            # the properties below are optional
            authentication_type="authenticationType",
            database_access_control_role="databaseAccessControlRole",
            o_auth_parameters=quicksight.CfnDataSource.OAuthParametersProperty(
                token_provider_url="tokenProviderUrl",

                # the properties below are optional
                identity_provider_resource_uri="identityProviderResourceUri",
                identity_provider_vpc_connection_properties=quicksight.CfnDataSource.VpcConnectionPropertiesProperty(
                    vpc_connection_arn="vpcConnectionArn"
                ),
                o_auth_scope="oAuthScope"
            )
        ),
        spark_parameters=quicksight.CfnDataSource.SparkParametersProperty(
            host="host",
            port=123
        ),
        sql_server_parameters=quicksight.CfnDataSource.SqlServerParametersProperty(
            database="database",
            host="host",
            port=123
        ),
        starburst_parameters=quicksight.CfnDataSource.StarburstParametersProperty(
            catalog="catalog",
            host="host",
            port=123,

            # the properties below are optional
            authentication_type="authenticationType",
            database_access_control_role="databaseAccessControlRole",
            o_auth_parameters=quicksight.CfnDataSource.OAuthParametersProperty(
                token_provider_url="tokenProviderUrl",

                # the properties below are optional
                identity_provider_resource_uri="identityProviderResourceUri",
                identity_provider_vpc_connection_properties=quicksight.CfnDataSource.VpcConnectionPropertiesProperty(
                    vpc_connection_arn="vpcConnectionArn"
                ),
                o_auth_scope="oAuthScope"
            ),
            product_type="productType"
        ),
        teradata_parameters=quicksight.CfnDataSource.TeradataParametersProperty(
            database="database",
            host="host",
            port=123
        ),
        trino_parameters=quicksight.CfnDataSource.TrinoParametersProperty(
            catalog="catalog",
            host="host",
            port=123
        )
    ),
    error_info=quicksight.CfnDataSource.DataSourceErrorInfoProperty(
        message="message",
        type="type"
    ),
    folder_arns=["folderArns"],
    permissions=[quicksight.CfnDataSource.ResourcePermissionProperty(
        actions=["actions"],
        principal="principal",

        # the properties below are optional
        resource="resource"
    )],
    ssl_properties=quicksight.CfnDataSource.SslPropertiesProperty(
        disable_ssl=False
    ),
    tags=[CfnTag(
        key="key",
        value="value"
    )],
    vpc_connection_properties=quicksight.CfnDataSource.VpcConnectionPropertiesProperty(
        vpc_connection_arn="vpcConnectionArn"
    )
)

Parameters:

scope (Construct) – Scope in which this resource is defined.
id (str) – Construct identifier for this resource (unique in its scope).
name (str) – A display name for the data source.
type (str) – The type of the data source. To return a list of all data sources, use ListDataSources . Use AMAZON_ELASTICSEARCH for Amazon OpenSearch Service.
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 the credentials stored with this data source. The credentials are applied in tandem with the data source parameters when you copy a data source by using a create or update request. The API operation compares the DataSourceParameters structure that’s in the request with the structures in the AlternateDataSourceParameters allow list. If the structures are an exact match, the request is allowed to use the credentials from this existing data source. If the AlternateDataSourceParameters list is null, the Credentials originally used with this DataSourceParameters are automatically allowed.
aws_account_id (Optional[str]) – The AWS account ID.
credentials (Union[IResolvable, DataSourceCredentialsProperty, Dict[str, Any], None]) – The credentials Amazon QuickSight that uses to connect to your underlying source. Currently, only credentials based on user name and password are supported.
data_source_id (Optional[str]) – An ID for the data source. This ID is unique per AWS Region for each AWS account.
data_source_parameters (Union[IResolvable, DataSourceParametersProperty, Dict[str, Any], None]) – The parameters that Amazon QuickSight uses to connect to your underlying source.
error_info (Union[IResolvable, DataSourceErrorInfoProperty, Dict[str, Any], None]) – Error information from the last update or the creation of the data source.
folder_arns (Optional[Sequence[str]]) –
permissions (Union[IResolvable, Sequence[Union[IResolvable, ResourcePermissionProperty, Dict[str, Any]]], None]) – A list of resource permissions on the data source.
ssl_properties (Union[IResolvable, SslPropertiesProperty, Dict[str, Any], None]) – Secure Socket Layer (SSL) properties that apply when Amazon QuickSight connects to your underlying source.
tags (Optional[Sequence[Union[CfnTag, Dict[str, Any]]]]) – Contains a map of the key-value pairs for the resource tag or tags assigned to the data source.
vpc_connection_properties (Union[IResolvable, VpcConnectionPropertiesProperty, Dict[str, Any], None]) – Use this parameter only when you want Amazon QuickSight to use a VPC connection when connecting to your underlying source.

Methods

add_deletion_override(path)

Syntactic sugar for addOverride(path, undefined).

Parameters:: path (str) – The path of the value to delete.
Return type:: None

add_dependency(target)

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

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

Parameters:

target (CfnResource) –

Return type:

None

add_depends_on(target)

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

Parameters:

target (CfnResource) –

Deprecated:

use addDependency

Stability:

deprecated

Return type:

None

add_metadata(key, value)

Add a value to the CloudFormation Resource Metadata.

Parameters:

key (str) –
value (Any) –

See:

Return type:

None

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

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

add_override(path, value)

Adds an override to the synthesized CloudFormation resource.

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

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

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

For example:

cfn_resource.add_override("Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes", ["myattribute"])
cfn_resource.add_override("Properties.GlobalSecondaryIndexes.1.ProjectionType", "INCLUDE")

would add the overrides Example:

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

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

Parameters:

path (str) –
- The path of the property, you can use dot notation to override values in complex types. Any intermediate keys will be created as needed.
value (Any) –
- The value. Could be primitive or complex.

Return type:

None

add_property_deletion_override(property_path)

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

Parameters:: property_path (str) – The path to the property.
Return type:: None

add_property_override(property_path, value)

Adds an override to a resource property.

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

Parameters:

property_path (str) – The path of the property.
value (Any) – The value.

Return type:

None

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

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

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

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

Parameters:

policy (Optional[RemovalPolicy]) –
apply_to_update_replace_policy (Optional[bool]) – Apply the same deletion policy to the resource’s “UpdateReplacePolicy”. Default: true
default (Optional[RemovalPolicy]) – The default policy to apply in case the removal policy is not defined. Default: - Default value is resource specific. To determine the default value for a resource, please consult that specific resource’s documentation.

See:

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

Return type:

None

get_att(attribute_name, type_hint=None)

Returns a token for an runtime attribute of this resource.

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

Parameters:

attribute_name (str) – The name of the attribute.
type_hint (Optional[ResolutionTypeHint]) –

Return type:

Reference

get_metadata(key)

Retrieve a value value from the CloudFormation Resource Metadata.

Parameters:

key (str) –

See:

Return type:

Any

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

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

inspect(inspector)

Examines the CloudFormation resource and discloses attributes.

Parameters:: inspector (TreeInspector) – tree inspector to collect and process attributes.
Return type:: None

obtain_dependencies()

Retrieves an array of resources this resource depends on.

This assembles dependencies on resources across stacks (including nested stacks) automatically.

Return type:: List[Union[Stack, CfnResource]]

obtain_resource_dependencies()

Get a shallow copy of dependencies between this resource and other resources in the same stack.

Return type:: List[CfnResource]

override_logical_id(new_logical_id)

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

Parameters:: new_logical_id (str) – The new logical ID to use for this stack element.
Return type:: None

remove_dependency(target)

Indicates that this resource no longer depends on another resource.

This can be used for resources across stacks (including nested stacks) and the dependency will automatically be removed from the relevant scope.

Parameters:

target (CfnResource) –

Return type:

None

replace_dependency(target, new_target)

Replaces one dependency with another.

Parameters:

target (CfnResource) – The dependency to replace.
new_target (CfnResource) – The new dependency to add.

Return type:

None

to_string()

Returns a string representation of this construct.

Return type:: str
Returns:: a string representation of this resource

Attributes

CFN_RESOURCE_TYPE_NAME = 'AWS::QuickSight::DataSource'

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

attr_arn

The Amazon Resource Name (ARN) of the dataset.

CloudformationAttribute:: Arn

attr_created_time

The time that this data source was created.

CloudformationAttribute:: CreatedTime

attr_last_updated_time

The last time that this data source was updated.

CloudformationAttribute:: LastUpdatedTime

attr_status

The HTTP status of the request.

CloudformationAttribute:: Status

aws_account_id: The AWS account ID.

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

cfn_resource_type: AWS resource type.

creation_stack

return:

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

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

data_source_id: An ID for the data source.

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

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

folder_arns

logical_id

The logical ID for this CloudFormation stack element.

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

To override this value, use overrideLogicalId(newLogicalId).

Returns:

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

name: A display name for the data source.

node: The tree node.

permissions: A list of resource permissions on the data source.

ref

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

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

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

stack

The stack in which this element is defined.

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

tags: Tag Manager which manages the tags for this resource.

tags_raw: Contains a map of the key-value pairs for the resource tag or tags assigned to the data source.

type

The type of the data source.

To return a list of all data sources, use ListDataSources .

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

Static Methods

classmethod is_cfn_element(x)

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

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

Parameters:

x (Any) –

Return type:

bool

Returns:

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

classmethod is_cfn_resource(x)

Check whether the given object is a CfnResource.

Parameters:

x (Any) –

Return type:

bool

classmethod is_construct(x)

Checks if x is a construct.

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

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

Parameters:: x (Any) – Any object.
Return type:: bool
Returns:: true if x is an object created from a class which extends Construct.

AmazonElasticsearchParametersProperty

class CfnDataSource.AmazonElasticsearchParametersProperty(*, domain)

Bases: object

The parameters for OpenSearch.

Parameters:: domain (str) – The OpenSearch domain.
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 import aws_quicksight as quicksight

amazon_elasticsearch_parameters_property = quicksight.CfnDataSource.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 CfnDataSource.AmazonOpenSearchParametersProperty(*, domain)

Bases: object

The parameters for OpenSearch.

Parameters:: domain (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 import aws_quicksight as quicksight

amazon_open_search_parameters_property = quicksight.CfnDataSource.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 CfnDataSource.AthenaParametersProperty(*, role_arn=None, work_group=None)

Bases: object

Parameters for Amazon Athena.

Parameters:

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 import aws_quicksight as quicksight

athena_parameters_property = quicksight.CfnDataSource.AthenaParametersProperty(
    role_arn="roleArn",
    work_group="workGroup"
)

Attributes

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 CfnDataSource.AuroraParametersProperty(*, database, host, port)

Bases: object

Parameters for Amazon Aurora.

Parameters:

database (str) – Database.
host (str) – Host.
port (Union[int, float]) – 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 import aws_quicksight as quicksight

aurora_parameters_property = quicksight.CfnDataSource.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 CfnDataSource.AuroraPostgreSqlParametersProperty(*, database, host, port)

Bases: object

Parameters for Amazon Aurora PostgreSQL-Compatible Edition.

Parameters:

database (str) – The Amazon Aurora PostgreSQL database to connect to.
host (str) – The Amazon Aurora PostgreSQL-Compatible host to connect to.
port (Union[int, float]) – The port that Amazon Aurora PostgreSQL is listening on. 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 import aws_quicksight as quicksight

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

Attributes

database

The Amazon Aurora PostgreSQL database to connect to.

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 CfnDataSource.CredentialPairProperty(*, password, username, alternate_data_source_parameters=None)

Bases: object

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

Parameters:

password (str) – Password.
username (str) – User name.
alternate_data_source_parameters (Union[IResolvable, Sequence[Union[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.

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 import aws_quicksight as quicksight

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

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

            # the properties below are optional
            cluster_id="clusterId",
            host="host",
            iam_parameters=quicksight.CfnDataSource.RedshiftIAMParametersProperty(
                role_arn="roleArn",

                # the properties below are optional
                auto_create_database_user=False,
                database_groups=["databaseGroups"],
                database_user="databaseUser"
            ),
            identity_center_configuration=quicksight.CfnDataSource.IdentityCenterConfigurationProperty(
                enable_identity_propagation=False
            ),
            port=123
        ),
        s3_parameters=quicksight.CfnDataSource.S3ParametersProperty(
            manifest_file_location=quicksight.CfnDataSource.ManifestFileLocationProperty(
                bucket="bucket",
                key="key"
            ),

            # the properties below are optional
            role_arn="roleArn"
        ),
        snowflake_parameters=quicksight.CfnDataSource.SnowflakeParametersProperty(
            database="database",
            host="host",
            warehouse="warehouse",

            # the properties below are optional
            authentication_type="authenticationType",
            database_access_control_role="databaseAccessControlRole",
            o_auth_parameters=quicksight.CfnDataSource.OAuthParametersProperty(
                token_provider_url="tokenProviderUrl",

                # the properties below are optional
                identity_provider_resource_uri="identityProviderResourceUri",
                identity_provider_vpc_connection_properties=quicksight.CfnDataSource.VpcConnectionPropertiesProperty(
                    vpc_connection_arn="vpcConnectionArn"
                ),
                o_auth_scope="oAuthScope"
            )
        ),
        spark_parameters=quicksight.CfnDataSource.SparkParametersProperty(
            host="host",
            port=123
        ),
        sql_server_parameters=quicksight.CfnDataSource.SqlServerParametersProperty(
            database="database",
            host="host",
            port=123
        ),
        starburst_parameters=quicksight.CfnDataSource.StarburstParametersProperty(
            catalog="catalog",
            host="host",
            port=123,

            # the properties below are optional
            authentication_type="authenticationType",
            database_access_control_role="databaseAccessControlRole",
            o_auth_parameters=quicksight.CfnDataSource.OAuthParametersProperty(
                token_provider_url="tokenProviderUrl",

                # the properties below are optional
                identity_provider_resource_uri="identityProviderResourceUri",
                identity_provider_vpc_connection_properties=quicksight.CfnDataSource.VpcConnectionPropertiesProperty(
                    vpc_connection_arn="vpcConnectionArn"
                ),
                o_auth_scope="oAuthScope"
            ),
            product_type="productType"
        ),
        teradata_parameters=quicksight.CfnDataSource.TeradataParametersProperty(
            database="database",
            host="host",
            port=123
        ),
        trino_parameters=quicksight.CfnDataSource.TrinoParametersProperty(
            catalog="catalog",
            host="host",
            port=123
        )
    )]
)

Attributes

alternate_data_source_parameters

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

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

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 CfnDataSource.DataSourceCredentialsProperty(*, copy_source_arn=None, credential_pair=None, secret_arn=None)

Bases: object

Data source credentials.

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

Parameters:

copy_source_arn (Optional[str]) – The Amazon Resource Name (ARN) of a data source that has the credential pair that you want to use. When CopySourceArn is not null, the credential pair from the data source in the ARN is used as the credentials for the DataSourceCredentials structure.
credential_pair (Union[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 import aws_quicksight as quicksight

data_source_credentials_property = quicksight.CfnDataSource.DataSourceCredentialsProperty(
    copy_source_arn="copySourceArn",
    credential_pair=quicksight.CfnDataSource.CredentialPairProperty(
        password="password",
        username="username",

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

                # the properties below are optional
                cluster_id="clusterId",
                host="host",
                iam_parameters=quicksight.CfnDataSource.RedshiftIAMParametersProperty(
                    role_arn="roleArn",

                    # the properties below are optional
                    auto_create_database_user=False,
                    database_groups=["databaseGroups"],
                    database_user="databaseUser"
                ),
                identity_center_configuration=quicksight.CfnDataSource.IdentityCenterConfigurationProperty(
                    enable_identity_propagation=False
                ),
                port=123
            ),
            s3_parameters=quicksight.CfnDataSource.S3ParametersProperty(
                manifest_file_location=quicksight.CfnDataSource.ManifestFileLocationProperty(
                    bucket="bucket",
                    key="key"
                ),

                # the properties below are optional
                role_arn="roleArn"
            ),
            snowflake_parameters=quicksight.CfnDataSource.SnowflakeParametersProperty(
                database="database",
                host="host",
                warehouse="warehouse",

                # the properties below are optional
                authentication_type="authenticationType",
                database_access_control_role="databaseAccessControlRole",
                o_auth_parameters=quicksight.CfnDataSource.OAuthParametersProperty(
                    token_provider_url="tokenProviderUrl",

                    # the properties below are optional
                    identity_provider_resource_uri="identityProviderResourceUri",
                    identity_provider_vpc_connection_properties=quicksight.CfnDataSource.VpcConnectionPropertiesProperty(
                        vpc_connection_arn="vpcConnectionArn"
                    ),
                    o_auth_scope="oAuthScope"
                )
            ),
            spark_parameters=quicksight.CfnDataSource.SparkParametersProperty(
                host="host",
                port=123
            ),
            sql_server_parameters=quicksight.CfnDataSource.SqlServerParametersProperty(
                database="database",
                host="host",
                port=123
            ),
            starburst_parameters=quicksight.CfnDataSource.StarburstParametersProperty(
                catalog="catalog",
                host="host",
                port=123,

                # the properties below are optional
                authentication_type="authenticationType",
                database_access_control_role="databaseAccessControlRole",
                o_auth_parameters=quicksight.CfnDataSource.OAuthParametersProperty(
                    token_provider_url="tokenProviderUrl",

                    # the properties below are optional
                    identity_provider_resource_uri="identityProviderResourceUri",
                    identity_provider_vpc_connection_properties=quicksight.CfnDataSource.VpcConnectionPropertiesProperty(
                        vpc_connection_arn="vpcConnectionArn"
                    ),
                    o_auth_scope="oAuthScope"
                ),
                product_type="productType"
            ),
            teradata_parameters=quicksight.CfnDataSource.TeradataParametersProperty(
                database="database",
                host="host",
                port=123
            ),
            trino_parameters=quicksight.CfnDataSource.TrinoParametersProperty(
                catalog="catalog",
                host="host",
                port=123
            )
        )]
    ),
    secret_arn="secretArn"
)

Attributes

copy_source_arn

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

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

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 CfnDataSource.DataSourceErrorInfoProperty(*, message=None, type=None)

Bases: object

Error information for the data source creation or update.

Parameters:

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

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 import aws_quicksight as quicksight

data_source_error_info_property = quicksight.CfnDataSource.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 CfnDataSource.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 Amazon QuickSight uses to connect to your underlying data source.

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

Parameters:

amazon_elasticsearch_parameters (Union[IResolvable, AmazonElasticsearchParametersProperty, Dict[str, Any], None]) – The parameters for OpenSearch.
amazon_open_search_parameters (Union[IResolvable, AmazonOpenSearchParametersProperty, Dict[str, Any], None]) – The parameters for OpenSearch.
athena_parameters (Union[IResolvable, AthenaParametersProperty, Dict[str, Any], None]) – The parameters for Amazon Athena.
aurora_parameters (Union[IResolvable, AuroraParametersProperty, Dict[str, Any], None]) – The parameters for Amazon Aurora MySQL.
aurora_postgre_sql_parameters (Union[IResolvable, AuroraPostgreSqlParametersProperty, Dict[str, Any], None]) – The parameters for Amazon Aurora.
databricks_parameters (Union[IResolvable, DatabricksParametersProperty, Dict[str, Any], None]) – The required parameters that are needed to connect to a Databricks data source.
maria_db_parameters (Union[IResolvable, MariaDbParametersProperty, Dict[str, Any], None]) – The parameters for MariaDB.
my_sql_parameters (Union[IResolvable, MySqlParametersProperty, Dict[str, Any], None]) – The parameters for MySQL.
oracle_parameters (Union[IResolvable, OracleParametersProperty, Dict[str, Any], None]) – Oracle parameters.
postgre_sql_parameters (Union[IResolvable, PostgreSqlParametersProperty, Dict[str, Any], None]) – The parameters for PostgreSQL.
presto_parameters (Union[IResolvable, PrestoParametersProperty, Dict[str, Any], None]) – The parameters for Presto.
rds_parameters (Union[IResolvable, RdsParametersProperty, Dict[str, Any], None]) – The parameters for Amazon RDS.
redshift_parameters (Union[IResolvable, RedshiftParametersProperty, Dict[str, Any], None]) – The parameters for Amazon Redshift.
s3_parameters (Union[IResolvable, S3ParametersProperty, Dict[str, Any], None]) – The parameters for S3.
snowflake_parameters (Union[IResolvable, SnowflakeParametersProperty, Dict[str, Any], None]) – The parameters for Snowflake.
spark_parameters (Union[IResolvable, SparkParametersProperty, Dict[str, Any], None]) – The parameters for Spark.
sql_server_parameters (Union[IResolvable, SqlServerParametersProperty, Dict[str, Any], None]) – The parameters for SQL Server.
starburst_parameters (Union[IResolvable, StarburstParametersProperty, Dict[str, Any], None]) – The parameters that are required to connect to a Starburst data source.
teradata_parameters (Union[IResolvable, TeradataParametersProperty, Dict[str, Any], None]) – The parameters for Teradata.
trino_parameters (Union[IResolvable, TrinoParametersProperty, Dict[str, Any], None]) – 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

ExampleMetadata:

fixture=_generated

Example:

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

data_source_parameters_property = quicksight.CfnDataSource.DataSourceParametersProperty(
    amazon_elasticsearch_parameters=quicksight.CfnDataSource.AmazonElasticsearchParametersProperty(
        domain="domain"
    ),
    amazon_open_search_parameters=quicksight.CfnDataSource.AmazonOpenSearchParametersProperty(
        domain="domain"
    ),
    athena_parameters=quicksight.CfnDataSource.AthenaParametersProperty(
        role_arn="roleArn",
        work_group="workGroup"
    ),
    aurora_parameters=quicksight.CfnDataSource.AuroraParametersProperty(
        database="database",
        host="host",
        port=123
    ),
    aurora_postgre_sql_parameters=quicksight.CfnDataSource.AuroraPostgreSqlParametersProperty(
        database="database",
        host="host",
        port=123
    ),
    databricks_parameters=quicksight.CfnDataSource.DatabricksParametersProperty(
        host="host",
        port=123,
        sql_endpoint_path="sqlEndpointPath"
    ),
    maria_db_parameters=quicksight.CfnDataSource.MariaDbParametersProperty(
        database="database",
        host="host",
        port=123
    ),
    my_sql_parameters=quicksight.CfnDataSource.MySqlParametersProperty(
        database="database",
        host="host",
        port=123
    ),
    oracle_parameters=quicksight.CfnDataSource.OracleParametersProperty(
        database="database",
        host="host",
        port=123
    ),
    postgre_sql_parameters=quicksight.CfnDataSource.PostgreSqlParametersProperty(
        database="database",
        host="host",
        port=123
    ),
    presto_parameters=quicksight.CfnDataSource.PrestoParametersProperty(
        catalog="catalog",
        host="host",
        port=123
    ),
    rds_parameters=quicksight.CfnDataSource.RdsParametersProperty(
        database="database",
        instance_id="instanceId"
    ),
    redshift_parameters=quicksight.CfnDataSource.RedshiftParametersProperty(
        database="database",

        # the properties below are optional
        cluster_id="clusterId",
        host="host",
        iam_parameters=quicksight.CfnDataSource.RedshiftIAMParametersProperty(
            role_arn="roleArn",

            # the properties below are optional
            auto_create_database_user=False,
            database_groups=["databaseGroups"],
            database_user="databaseUser"
        ),
        identity_center_configuration=quicksight.CfnDataSource.IdentityCenterConfigurationProperty(
            enable_identity_propagation=False
        ),
        port=123
    ),
    s3_parameters=quicksight.CfnDataSource.S3ParametersProperty(
        manifest_file_location=quicksight.CfnDataSource.ManifestFileLocationProperty(
            bucket="bucket",
            key="key"
        ),

        # the properties below are optional
        role_arn="roleArn"
    ),
    snowflake_parameters=quicksight.CfnDataSource.SnowflakeParametersProperty(
        database="database",
        host="host",
        warehouse="warehouse",

        # the properties below are optional
        authentication_type="authenticationType",
        database_access_control_role="databaseAccessControlRole",
        o_auth_parameters=quicksight.CfnDataSource.OAuthParametersProperty(
            token_provider_url="tokenProviderUrl",

            # the properties below are optional
            identity_provider_resource_uri="identityProviderResourceUri",
            identity_provider_vpc_connection_properties=quicksight.CfnDataSource.VpcConnectionPropertiesProperty(
                vpc_connection_arn="vpcConnectionArn"
            ),
            o_auth_scope="oAuthScope"
        )
    ),
    spark_parameters=quicksight.CfnDataSource.SparkParametersProperty(
        host="host",
        port=123
    ),
    sql_server_parameters=quicksight.CfnDataSource.SqlServerParametersProperty(
        database="database",
        host="host",
        port=123
    ),
    starburst_parameters=quicksight.CfnDataSource.StarburstParametersProperty(
        catalog="catalog",
        host="host",
        port=123,

        # the properties below are optional
        authentication_type="authenticationType",
        database_access_control_role="databaseAccessControlRole",
        o_auth_parameters=quicksight.CfnDataSource.OAuthParametersProperty(
            token_provider_url="tokenProviderUrl",

            # the properties below are optional
            identity_provider_resource_uri="identityProviderResourceUri",
            identity_provider_vpc_connection_properties=quicksight.CfnDataSource.VpcConnectionPropertiesProperty(
                vpc_connection_arn="vpcConnectionArn"
            ),
            o_auth_scope="oAuthScope"
        ),
        product_type="productType"
    ),
    teradata_parameters=quicksight.CfnDataSource.TeradataParametersProperty(
        database="database",
        host="host",
        port=123
    ),
    trino_parameters=quicksight.CfnDataSource.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 CfnDataSource.DatabricksParametersProperty(*, host, port, sql_endpoint_path)

Bases: object

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

Parameters:

host (str) – The host name of the Databricks data source.
port (Union[int, float]) – The port for the Databricks data source. Default: - 0
sql_endpoint_path (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 import aws_quicksight as quicksight

databricks_parameters_property = quicksight.CfnDataSource.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 CfnDataSource.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 import aws_quicksight as quicksight

identity_center_configuration_property = quicksight.CfnDataSource.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 CfnDataSource.ManifestFileLocationProperty(*, bucket, key)

Bases: object

Amazon S3 manifest file location.

Parameters:

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

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 import aws_quicksight as quicksight

manifest_file_location_property = quicksight.CfnDataSource.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 CfnDataSource.MariaDbParametersProperty(*, database, host, port)

Bases: object

The parameters for MariaDB.

Parameters:

database (str) – Database.
host (str) – Host.
port (Union[int, float]) – 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 import aws_quicksight as quicksight

maria_db_parameters_property = quicksight.CfnDataSource.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 CfnDataSource.MySqlParametersProperty(*, database, host, port)

Bases: object

The parameters for MySQL.

Parameters:

database (str) – Database.
host (str) – Host.
port (Union[int, float]) – 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 import aws_quicksight as quicksight

my_sql_parameters_property = quicksight.CfnDataSource.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 CfnDataSource.OAuthParametersProperty(*, token_provider_url, identity_provider_resource_uri=None, identity_provider_vpc_connection_properties=None, o_auth_scope=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:

token_provider_url (str) – The token endpoint URL of the identity provider.
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.

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 import aws_quicksight as quicksight

o_auth_parameters_property = quicksight.CfnDataSource.OAuthParametersProperty(
    token_provider_url="tokenProviderUrl",

    # the properties below are optional
    identity_provider_resource_uri="identityProviderResourceUri",
    identity_provider_vpc_connection_properties=quicksight.CfnDataSource.VpcConnectionPropertiesProperty(
        vpc_connection_arn="vpcConnectionArn"
    ),
    o_auth_scope="oAuthScope"
)

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 CfnDataSource.OracleParametersProperty(*, database, host, port)

Bases: object

Oracle parameters.

Parameters:

database (str) – Database.
host (str) – Host.
port (Union[int, float]) – Port. Default: - 0

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 import aws_quicksight as quicksight

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

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

PostgreSqlParametersProperty

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

Bases: object

The parameters for PostgreSQL.

Parameters:

database (str) – Database.
host (str) – Host.
port (Union[int, float]) – Port. 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 import aws_quicksight as quicksight

postgre_sql_parameters_property = quicksight.CfnDataSource.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 CfnDataSource.PrestoParametersProperty(*, catalog, host, port)

Bases: object

The parameters for Presto.

Parameters:

catalog (str) – Catalog.
host (str) – Host.
port (Union[int, float]) – 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 import aws_quicksight as quicksight

presto_parameters_property = quicksight.CfnDataSource.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 CfnDataSource.RdsParametersProperty(*, database, instance_id)

Bases: object

The parameters for Amazon RDS.

Parameters:

database (str) – Database.
instance_id (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 import aws_quicksight as quicksight

rds_parameters_property = quicksight.CfnDataSource.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 CfnDataSource.RedshiftIAMParametersProperty(*, role_arn, auto_create_database_user=None, database_groups=None, database_user=None)

Bases: object

A structure that grants Amazon QuickSight 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:

role_arn (str) – Use the RoleArn structure to allow Amazon QuickSight to call redshift:GetClusterCredentials on your cluster. The calling principal must have iam:PassRole access to pass the role to Amazon QuickSight. The role’s trust policy must allow the Amazon QuickSight service principal to assume the role.
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 , Amazon QuickSight 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 Amazon QuickSight to access the cluster. These permissions are combined with the permissions granted to Amazon QuickSight 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 Amazon QuickSight to access the cluster. If this user already exists in your database, Amazon QuickSight 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

ExampleMetadata:

fixture=_generated

Example:

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

redshift_iAMParameters_property = quicksight.CfnDataSource.RedshiftIAMParametersProperty(
    role_arn="roleArn",

    # the properties below are optional
    auto_create_database_user=False,
    database_groups=["databaseGroups"],
    database_user="databaseUser"
)

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 , Amazon QuickSight 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 Amazon QuickSight to access the cluster.

These permissions are combined with the permissions granted to Amazon QuickSight 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 Amazon QuickSight to access the cluster.

If this user already exists in your database, Amazon QuickSight 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 Amazon QuickSight to call redshift:GetClusterCredentials on your cluster.

The calling principal must have iam:PassRole access to pass the role to Amazon QuickSight. The role’s trust policy must allow the Amazon QuickSight 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 CfnDataSource.RedshiftParametersProperty(*, database, cluster_id=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:

database (str) – Database.
cluster_id (Optional[str]) – Cluster ID. This field can be blank if the Host and Port are provided.
host (Optional[str]) – Host. This field can be blank if ClusterId is provided.
iam_parameters (Union[IResolvable, RedshiftIAMParametersProperty, Dict[str, Any], None]) – An optional parameter that uses IAM authentication to grant Amazon QuickSight 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 Amazon QuickSight access to your cluster. This parameter can only be specified if your Amazon QuickSight 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 import aws_quicksight as quicksight

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

    # the properties below are optional
    cluster_id="clusterId",
    host="host",
    iam_parameters=quicksight.CfnDataSource.RedshiftIAMParametersProperty(
        role_arn="roleArn",

        # the properties below are optional
        auto_create_database_user=False,
        database_groups=["databaseGroups"],
        database_user="databaseUser"
    ),
    identity_center_configuration=quicksight.CfnDataSource.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 Amazon QuickSight 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 Amazon QuickSight access to your cluster.

This parameter can only be specified if your Amazon QuickSight 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 CfnDataSource.ResourcePermissionProperty(*, actions, principal, resource=None)

Bases: object

Permission for the resource.

Parameters:

actions (Sequence[str]) – The IAM action to grant or revoke permissions on.
principal (str) – The Amazon Resource Name (ARN) of the principal. This can be one of the following:. - The ARN of an Amazon QuickSight user or group associated with a data source or dataset. (This is common.) - The ARN of an Amazon QuickSight user, group, or namespace associated with an analysis, dashboard, template, or theme. (This is common.) - The ARN of an AWS account root: This is an IAM ARN rather than a Amazon QuickSight ARN. Use this option only to share resources (templates) across AWS accounts . (This is less common.)
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 import aws_quicksight as quicksight

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

    # the properties below are optional
    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 QuickSight user or group associated with a data source or dataset. (This is common.)
The ARN of an Amazon QuickSight user, group, or namespace associated with an analysis, dashboard, template, or theme. (This is common.)
The ARN of an AWS account root: This is an IAM ARN rather than a Amazon QuickSight ARN. Use this option only to share resources (templates) across AWS accounts . (This is less common.)

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 CfnDataSource.S3ParametersProperty(*, manifest_file_location, role_arn=None)

Bases: object

The parameters for S3.

Parameters:

manifest_file_location (Union[IResolvable, ManifestFileLocationProperty, Dict[str, Any]]) – Location of the Amazon S3 manifest file. This is NULL if the manifest file was uploaded into Amazon QuickSight.
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 import aws_quicksight as quicksight

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

    # the properties below are optional
    role_arn="roleArn"
)

Attributes

manifest_file_location

Location of the Amazon S3 manifest file.

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

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 CfnDataSource.SnowflakeParametersProperty(*, database, host, warehouse, authentication_type=None, database_access_control_role=None, o_auth_parameters=None)

Bases: object

The parameters for Snowflake.

Parameters:

database (str) – Database.
host (str) – Host.
warehouse (str) – Warehouse.
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_access_control_role (Optional[str]) – The database access control role.
o_auth_parameters (Union[IResolvable, OAuthParametersProperty, Dict[str, Any], None]) – An object that contains information needed to create a data source connection between an Amazon QuickSight account and Snowflake.

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 import aws_quicksight as quicksight

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

    # the properties below are optional
    authentication_type="authenticationType",
    database_access_control_role="databaseAccessControlRole",
    o_auth_parameters=quicksight.CfnDataSource.OAuthParametersProperty(
        token_provider_url="tokenProviderUrl",

        # the properties below are optional
        identity_provider_resource_uri="identityProviderResourceUri",
        identity_provider_vpc_connection_properties=quicksight.CfnDataSource.VpcConnectionPropertiesProperty(
            vpc_connection_arn="vpcConnectionArn"
        ),
        o_auth_scope="oAuthScope"
    )
)

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 Amazon QuickSight 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 CfnDataSource.SparkParametersProperty(*, host, port)

Bases: object

The parameters for Spark.

Parameters:

host (str) – Host.
port (Union[int, float]) – 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 import aws_quicksight as quicksight

spark_parameters_property = quicksight.CfnDataSource.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 CfnDataSource.SqlServerParametersProperty(*, database, host, port)

Bases: object

The parameters for SQL Server.

Parameters:

database (str) – Database.
host (str) – Host.
port (Union[int, float]) – 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 import aws_quicksight as quicksight

sql_server_parameters_property = quicksight.CfnDataSource.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 CfnDataSource.SslPropertiesProperty(*, disable_ssl=None)

Bases: object

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

Parameters:: disable_ssl (Union[bool, IResolvable, None]) – A Boolean option to control whether SSL should be disabled. 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 import aws_quicksight as quicksight

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

Attributes

disable_ssl

A Boolean option to control whether SSL should be disabled.

Default:

false

See:

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

StarburstParametersProperty

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

Bases: object

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

Parameters:

catalog (str) – The catalog name for the Starburst data source.
host (str) – The host name of the Starburst data source.
port (Union[int, float]) – The port for the Starburst data source. Default: - 0
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_access_control_role (Optional[str]) – The database access control role.
o_auth_parameters (Union[IResolvable, OAuthParametersProperty, Dict[str, Any], None]) – An object that contains information needed to create a data source connection between an Amazon QuickSight account and Starburst.
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 import aws_quicksight as quicksight

starburst_parameters_property = quicksight.CfnDataSource.StarburstParametersProperty(
    catalog="catalog",
    host="host",
    port=123,

    # the properties below are optional
    authentication_type="authenticationType",
    database_access_control_role="databaseAccessControlRole",
    o_auth_parameters=quicksight.CfnDataSource.OAuthParametersProperty(
        token_provider_url="tokenProviderUrl",

        # the properties below are optional
        identity_provider_resource_uri="identityProviderResourceUri",
        identity_provider_vpc_connection_properties=quicksight.CfnDataSource.VpcConnectionPropertiesProperty(
            vpc_connection_arn="vpcConnectionArn"
        ),
        o_auth_scope="oAuthScope"
    ),
    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 Amazon QuickSight 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 CfnDataSource.TeradataParametersProperty(*, database, host, port)

Bases: object

The parameters for Teradata.

Parameters:

database (str) – Database.
host (str) – Host.
port (Union[int, float]) – 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 import aws_quicksight as quicksight

teradata_parameters_property = quicksight.CfnDataSource.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 CfnDataSource.TrinoParametersProperty(*, catalog, host, port)

Bases: object

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

Parameters:

catalog (str) – The catalog name for the Trino data source.
host (str) – The host name of the Trino data source.
port (Union[int, float]) – 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 import aws_quicksight as quicksight

trino_parameters_property = quicksight.CfnDataSource.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 CfnDataSource.VpcConnectionPropertiesProperty(*, vpc_connection_arn)

Bases: object

VPC connection properties.

Parameters:: vpc_connection_arn (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 import aws_quicksight as quicksight

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

Attributes

vpc_connection_arn

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

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