MDAA TS Docs
    Preparing search index...

    Interface DataSourceWithIdAndTypeProps

    Core data source configuration for QuickSight, defining connection parameters, credentials, permissions, and optional SSL/VPC settings.

    Use cases: Redshift data source; Athena data source; S3/RDS connectivity

    AWS: QuickSight CfnDataSource

    Validation: dataSourceSpecificParameters, displayName, and permissions required

    interface DataSourceWithIdAndTypeProps {
        awsAccountId?: string;
        credentials?: DataSourceCredentialsProps;
        dataSourceId: string;
        dataSourceSpecificParameters: ConfigurationElement;
        displayName: string;
        errorInfo?: DataSourceErrorInfoProps;
        permissions: DataSourcePermissionsProps[];
        secretsManager?: SecretsManagerAuthProps;
        sslProperties?: DataSourceSSLProps;
        type: string;
        vpcConnectionProperties?: DataSourceVPCProps;
    }

    Hierarchy (View Summary)

    Index

    Properties

    awsAccountId? credentials? dataSourceId dataSourceSpecificParameters displayName errorInfo? permissions secretsManager? sslProperties? type vpcConnectionProperties?

    Properties

    awsAccountId?: string

    The AWS account ID.

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

    credentials?: DataSourceCredentialsProps

    The credentials Amazon QuickSight that uses to connect to your underlying source. Currently, only credentials based on user name and password are supported.

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

    dataSourceId: string

    An ID for the data source. This ID is unique per AWS Region for each AWS account.

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

    dataSourceSpecificParameters: ConfigurationElement
    displayName: string

    A display name for the data source.

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

    errorInfo?: DataSourceErrorInfoProps

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

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

    permissions: DataSourcePermissionsProps[]

    A list of resource permissions on the data source.

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

    secretsManager?: SecretsManagerAuthProps

    Secrets Manager authentication for the data source. When set, MDAA both (a) wires the secret as the data source credentials, and (b) grants QuickSight's account-level Secrets Manager role (aws-quicksight-secretsmanager-role-v0) read access to the secret (and decrypt on its KMS key). This is the single toggle for the secret-based auth path — the role name and all IAM wiring are handled automatically.

    Use cases: Secret-based Redshift (or other credential-pair) data source authentication

    AWS: QuickSight DataSourceCredentials.SecretArn + IAM grant on the QuickSight SM role

    Validation: Optional; when present, arn is required

    sslProperties?: DataSourceSSLProps

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

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

    type: string

    Type of Data Source. ADOBE_ANALYTICS | AMAZON_ELASTICSEARCH | AMAZON_OPENSEARCH | ATHENA | AURORA | AURORA_POSTGRESQL | AWS_IOT_ANALYTICS | DATABRICKS | EXASOL | GITHUB | JIRA | MARIADB | MYSQL | ORACLE | POSTGRESQL | PRESTO | REDSHIFT | S3 | SALESFORCE | SERVICENOW | SNOWFLAKE | SPARK | SQLSERVER | TERADATA | TIMESTREAM | TWITTER

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

    vpcConnectionProperties?: DataSourceVPCProps

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

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

    Settings

    Member Visibility

    On This Page

    Properties