aws-cdk-lib.aws_quicksight.CfnDataSourceProps

interface CfnDataSourceProps

LanguageType name
.NETAmazon.CDK.AWS.QuickSight.CfnDataSourceProps
Gogithub.com/aws/aws-cdk-go/awscdk/v2/awsquicksight#CfnDataSourceProps
Javasoftware.amazon.awscdk.services.quicksight.CfnDataSourceProps
Pythonaws_cdk.aws_quicksight.CfnDataSourceProps
TypeScript aws-cdk-lib » aws_quicksight » CfnDataSourceProps

Properties for defining a CfnDataSource.

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_quicksight as quicksight } from 'aws-cdk-lib';
const cfnDataSourceProps: quicksight.CfnDataSourceProps = {
  alternateDataSourceParameters: [{
    amazonElasticsearchParameters: {
      domain: 'domain',
    },
    amazonOpenSearchParameters: {
      domain: 'domain',
    },
    athenaParameters: {
      roleArn: 'roleArn',
      workGroup: 'workGroup',
    },
    auroraParameters: {
      database: 'database',
      host: 'host',
      port: 123,
    },
    auroraPostgreSqlParameters: {
      database: 'database',
      host: 'host',
      port: 123,
    },
    databricksParameters: {
      host: 'host',
      port: 123,
      sqlEndpointPath: 'sqlEndpointPath',
    },
    mariaDbParameters: {
      database: 'database',
      host: 'host',
      port: 123,
    },
    mySqlParameters: {
      database: 'database',
      host: 'host',
      port: 123,
    },
    oracleParameters: {
      database: 'database',
      host: 'host',
      port: 123,
    },
    postgreSqlParameters: {
      database: 'database',
      host: 'host',
      port: 123,
    },
    prestoParameters: {
      catalog: 'catalog',
      host: 'host',
      port: 123,
    },
    rdsParameters: {
      database: 'database',
      instanceId: 'instanceId',
    },
    redshiftParameters: {
      database: 'database',

      // the properties below are optional
      clusterId: 'clusterId',
      host: 'host',
      port: 123,
    },
    s3Parameters: {
      manifestFileLocation: {
        bucket: 'bucket',
        key: 'key',
      },

      // the properties below are optional
      roleArn: 'roleArn',
    },
    snowflakeParameters: {
      database: 'database',
      host: 'host',
      warehouse: 'warehouse',
    },
    sparkParameters: {
      host: 'host',
      port: 123,
    },
    sqlServerParameters: {
      database: 'database',
      host: 'host',
      port: 123,
    },
    teradataParameters: {
      database: 'database',
      host: 'host',
      port: 123,
    },
  }],
  awsAccountId: 'awsAccountId',
  credentials: {
    copySourceArn: 'copySourceArn',
    credentialPair: {
      password: 'password',
      username: 'username',

      // the properties below are optional
      alternateDataSourceParameters: [{
        amazonElasticsearchParameters: {
          domain: 'domain',
        },
        amazonOpenSearchParameters: {
          domain: 'domain',
        },
        athenaParameters: {
          roleArn: 'roleArn',
          workGroup: 'workGroup',
        },
        auroraParameters: {
          database: 'database',
          host: 'host',
          port: 123,
        },
        auroraPostgreSqlParameters: {
          database: 'database',
          host: 'host',
          port: 123,
        },
        databricksParameters: {
          host: 'host',
          port: 123,
          sqlEndpointPath: 'sqlEndpointPath',
        },
        mariaDbParameters: {
          database: 'database',
          host: 'host',
          port: 123,
        },
        mySqlParameters: {
          database: 'database',
          host: 'host',
          port: 123,
        },
        oracleParameters: {
          database: 'database',
          host: 'host',
          port: 123,
        },
        postgreSqlParameters: {
          database: 'database',
          host: 'host',
          port: 123,
        },
        prestoParameters: {
          catalog: 'catalog',
          host: 'host',
          port: 123,
        },
        rdsParameters: {
          database: 'database',
          instanceId: 'instanceId',
        },
        redshiftParameters: {
          database: 'database',

          // the properties below are optional
          clusterId: 'clusterId',
          host: 'host',
          port: 123,
        },
        s3Parameters: {
          manifestFileLocation: {
            bucket: 'bucket',
            key: 'key',
          },

          // the properties below are optional
          roleArn: 'roleArn',
        },
        snowflakeParameters: {
          database: 'database',
          host: 'host',
          warehouse: 'warehouse',
        },
        sparkParameters: {
          host: 'host',
          port: 123,
        },
        sqlServerParameters: {
          database: 'database',
          host: 'host',
          port: 123,
        },
        teradataParameters: {
          database: 'database',
          host: 'host',
          port: 123,
        },
      }],
    },
    secretArn: 'secretArn',
  },
  dataSourceId: 'dataSourceId',
  dataSourceParameters: {
    amazonElasticsearchParameters: {
      domain: 'domain',
    },
    amazonOpenSearchParameters: {
      domain: 'domain',
    },
    athenaParameters: {
      roleArn: 'roleArn',
      workGroup: 'workGroup',
    },
    auroraParameters: {
      database: 'database',
      host: 'host',
      port: 123,
    },
    auroraPostgreSqlParameters: {
      database: 'database',
      host: 'host',
      port: 123,
    },
    databricksParameters: {
      host: 'host',
      port: 123,
      sqlEndpointPath: 'sqlEndpointPath',
    },
    mariaDbParameters: {
      database: 'database',
      host: 'host',
      port: 123,
    },
    mySqlParameters: {
      database: 'database',
      host: 'host',
      port: 123,
    },
    oracleParameters: {
      database: 'database',
      host: 'host',
      port: 123,
    },
    postgreSqlParameters: {
      database: 'database',
      host: 'host',
      port: 123,
    },
    prestoParameters: {
      catalog: 'catalog',
      host: 'host',
      port: 123,
    },
    rdsParameters: {
      database: 'database',
      instanceId: 'instanceId',
    },
    redshiftParameters: {
      database: 'database',

      // the properties below are optional
      clusterId: 'clusterId',
      host: 'host',
      port: 123,
    },
    s3Parameters: {
      manifestFileLocation: {
        bucket: 'bucket',
        key: 'key',
      },

      // the properties below are optional
      roleArn: 'roleArn',
    },
    snowflakeParameters: {
      database: 'database',
      host: 'host',
      warehouse: 'warehouse',
    },
    sparkParameters: {
      host: 'host',
      port: 123,
    },
    sqlServerParameters: {
      database: 'database',
      host: 'host',
      port: 123,
    },
    teradataParameters: {
      database: 'database',
      host: 'host',
      port: 123,
    },
  },
  errorInfo: {
    message: 'message',
    type: 'type',
  },
  name: 'name',
  permissions: [{
    actions: ['actions'],
    principal: 'principal',
  }],
  sslProperties: {
    disableSsl: false,
  },
  tags: [{
    key: 'key',
    value: 'value',
  }],
  type: 'type',
  vpcConnectionProperties: {
    vpcConnectionArn: 'vpcConnectionArn',
  },
};

Properties

NameTypeDescription
alternateDataSourceParameters?IResolvable | IResolvable | DataSourceParametersProperty[]A set of alternate data source parameters that you want to share for the credentials stored with this data source.
awsAccountId?stringThe AWS account ID.
credentials?IResolvable | DataSourceCredentialsPropertyThe credentials Amazon QuickSight that uses to connect to your underlying source.
dataSourceId?stringAn ID for the data source.
dataSourceParameters?IResolvable | DataSourceParametersPropertyThe parameters that Amazon QuickSight uses to connect to your underlying source.
errorInfo?IResolvable | DataSourceErrorInfoPropertyError information from the last update or the creation of the data source.
name?stringA display name for the data source.
permissions?IResolvable | IResolvable | ResourcePermissionProperty[]A list of resource permissions on the data source.
sslProperties?IResolvable | SslPropertiesPropertySecure Socket Layer (SSL) properties that apply when Amazon QuickSight connects to your underlying source.
tags?CfnTag[]Contains a map of the key-value pairs for the resource tag or tags assigned to the data source.
type?stringThe type of the data source. To return a list of all data sources, use ListDataSources .
vpcConnectionProperties?IResolvable | VpcConnectionPropertiesPropertyUse this parameter only when you want Amazon QuickSight to use a VPC connection when connecting to your underlying source.

alternateDataSourceParameters?

Type: IResolvable | IResolvable | DataSourceParametersProperty[] (optional)

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.


awsAccountId?

Type: string (optional)

The AWS account ID.


credentials?

Type: IResolvable | DataSourceCredentialsProperty (optional)

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

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


dataSourceId?

Type: string (optional)

An ID for the data source.

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


dataSourceParameters?

Type: IResolvable | DataSourceParametersProperty (optional)

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


errorInfo?

Type: IResolvable | DataSourceErrorInfoProperty (optional)

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


name?

Type: string (optional)

A display name for the data source.


permissions?

Type: IResolvable | IResolvable | ResourcePermissionProperty[] (optional)

A list of resource permissions on the data source.


sslProperties?

Type: IResolvable | SslPropertiesProperty (optional)

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


tags?

Type: CfnTag[] (optional)

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


type?

Type: string (optional)

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

Use AMAZON_ELASTICSEARCH for Amazon OpenSearch Service.


vpcConnectionProperties?

Type: IResolvable | VpcConnectionPropertiesProperty (optional)

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