interface CfnDataSourceProps
Language | Type name |
---|---|
![]() | Amazon.CDK.AWS.QuickSight.CfnDataSourceProps |
![]() | github.com/aws/aws-cdk-go/awscdk/v2/awsquicksight#CfnDataSourceProps |
![]() | software.amazon.awscdk.services.quicksight.CfnDataSourceProps |
![]() | aws_cdk.aws_quicksight.CfnDataSourceProps |
![]() | 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 = {
name: 'name',
type: 'type',
// 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',
iamParameters: {
roleArn: 'roleArn',
// the properties below are optional
autoCreateDatabaseUser: false,
databaseGroups: ['databaseGroups'],
databaseUser: 'databaseUser',
},
identityCenterConfiguration: {
enableIdentityPropagation: false,
},
port: 123,
},
s3Parameters: {
manifestFileLocation: {
bucket: 'bucket',
key: 'key',
},
// the properties below are optional
roleArn: 'roleArn',
},
snowflakeParameters: {
database: 'database',
host: 'host',
warehouse: 'warehouse',
// the properties below are optional
authenticationType: 'authenticationType',
databaseAccessControlRole: 'databaseAccessControlRole',
oAuthParameters: {
tokenProviderUrl: 'tokenProviderUrl',
// the properties below are optional
identityProviderResourceUri: 'identityProviderResourceUri',
identityProviderVpcConnectionProperties: {
vpcConnectionArn: 'vpcConnectionArn',
},
oAuthScope: 'oAuthScope',
},
},
sparkParameters: {
host: 'host',
port: 123,
},
sqlServerParameters: {
database: 'database',
host: 'host',
port: 123,
},
starburstParameters: {
catalog: 'catalog',
host: 'host',
port: 123,
// the properties below are optional
authenticationType: 'authenticationType',
databaseAccessControlRole: 'databaseAccessControlRole',
oAuthParameters: {
tokenProviderUrl: 'tokenProviderUrl',
// the properties below are optional
identityProviderResourceUri: 'identityProviderResourceUri',
identityProviderVpcConnectionProperties: {
vpcConnectionArn: 'vpcConnectionArn',
},
oAuthScope: 'oAuthScope',
},
productType: 'productType',
},
teradataParameters: {
database: 'database',
host: 'host',
port: 123,
},
trinoParameters: {
catalog: 'catalog',
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',
iamParameters: {
roleArn: 'roleArn',
// the properties below are optional
autoCreateDatabaseUser: false,
databaseGroups: ['databaseGroups'],
databaseUser: 'databaseUser',
},
identityCenterConfiguration: {
enableIdentityPropagation: false,
},
port: 123,
},
s3Parameters: {
manifestFileLocation: {
bucket: 'bucket',
key: 'key',
},
// the properties below are optional
roleArn: 'roleArn',
},
snowflakeParameters: {
database: 'database',
host: 'host',
warehouse: 'warehouse',
// the properties below are optional
authenticationType: 'authenticationType',
databaseAccessControlRole: 'databaseAccessControlRole',
oAuthParameters: {
tokenProviderUrl: 'tokenProviderUrl',
// the properties below are optional
identityProviderResourceUri: 'identityProviderResourceUri',
identityProviderVpcConnectionProperties: {
vpcConnectionArn: 'vpcConnectionArn',
},
oAuthScope: 'oAuthScope',
},
},
sparkParameters: {
host: 'host',
port: 123,
},
sqlServerParameters: {
database: 'database',
host: 'host',
port: 123,
},
starburstParameters: {
catalog: 'catalog',
host: 'host',
port: 123,
// the properties below are optional
authenticationType: 'authenticationType',
databaseAccessControlRole: 'databaseAccessControlRole',
oAuthParameters: {
tokenProviderUrl: 'tokenProviderUrl',
// the properties below are optional
identityProviderResourceUri: 'identityProviderResourceUri',
identityProviderVpcConnectionProperties: {
vpcConnectionArn: 'vpcConnectionArn',
},
oAuthScope: 'oAuthScope',
},
productType: 'productType',
},
teradataParameters: {
database: 'database',
host: 'host',
port: 123,
},
trinoParameters: {
catalog: 'catalog',
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',
iamParameters: {
roleArn: 'roleArn',
// the properties below are optional
autoCreateDatabaseUser: false,
databaseGroups: ['databaseGroups'],
databaseUser: 'databaseUser',
},
identityCenterConfiguration: {
enableIdentityPropagation: false,
},
port: 123,
},
s3Parameters: {
manifestFileLocation: {
bucket: 'bucket',
key: 'key',
},
// the properties below are optional
roleArn: 'roleArn',
},
snowflakeParameters: {
database: 'database',
host: 'host',
warehouse: 'warehouse',
// the properties below are optional
authenticationType: 'authenticationType',
databaseAccessControlRole: 'databaseAccessControlRole',
oAuthParameters: {
tokenProviderUrl: 'tokenProviderUrl',
// the properties below are optional
identityProviderResourceUri: 'identityProviderResourceUri',
identityProviderVpcConnectionProperties: {
vpcConnectionArn: 'vpcConnectionArn',
},
oAuthScope: 'oAuthScope',
},
},
sparkParameters: {
host: 'host',
port: 123,
},
sqlServerParameters: {
database: 'database',
host: 'host',
port: 123,
},
starburstParameters: {
catalog: 'catalog',
host: 'host',
port: 123,
// the properties below are optional
authenticationType: 'authenticationType',
databaseAccessControlRole: 'databaseAccessControlRole',
oAuthParameters: {
tokenProviderUrl: 'tokenProviderUrl',
// the properties below are optional
identityProviderResourceUri: 'identityProviderResourceUri',
identityProviderVpcConnectionProperties: {
vpcConnectionArn: 'vpcConnectionArn',
},
oAuthScope: 'oAuthScope',
},
productType: 'productType',
},
teradataParameters: {
database: 'database',
host: 'host',
port: 123,
},
trinoParameters: {
catalog: 'catalog',
host: 'host',
port: 123,
},
},
errorInfo: {
message: 'message',
type: 'type',
},
folderArns: ['folderArns'],
permissions: [{
actions: ['actions'],
principal: 'principal',
// the properties below are optional
resource: 'resource',
}],
sslProperties: {
disableSsl: false,
},
tags: [{
key: 'key',
value: 'value',
}],
vpcConnectionProperties: {
vpcConnectionArn: 'vpcConnectionArn',
},
};
Properties
Name | Type | Description |
---|---|---|
name | string | A display name for the data source. |
type | string | The type of the data source. To return a list of all data sources, use ListDataSources . |
alternate | IResolvable | IResolvable | Data [] | A set of alternate data source parameters that you want to share for the credentials stored with this data source. |
aws | string | The AWS account ID. |
credentials? | IResolvable | Data | The credentials Amazon QuickSight that uses to connect to your underlying source. |
data | string | An ID for the data source. |
data | IResolvable | Data | The parameters that Amazon QuickSight uses to connect to your underlying source. |
error | IResolvable | Data | Error information from the last update or the creation of the data source. |
folder | string[] | |
permissions? | IResolvable | IResolvable | Resource [] | A list of resource permissions on the data source. |
ssl | IResolvable | Ssl | Secure Socket Layer (SSL) properties that apply when Amazon QuickSight connects to your underlying source. |
tags? | Cfn [] | Contains a map of the key-value pairs for the resource tag or tags assigned to the data source. |
vpc | IResolvable | Vpc | Use this parameter only when you want Amazon QuickSight to use a VPC connection when connecting to your underlying source. |
name
Type:
string
A display name for the data source.
type
Type:
string
The type of the data source. To return a list of all data sources, use ListDataSources
.
Use AMAZON_ELASTICSEARCH
for Amazon OpenSearch Service.
alternateDataSourceParameters?
Type:
IResolvable
|
IResolvable
|
Data
[]
(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
|
Data
(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
|
Data
(optional)
The parameters that Amazon QuickSight uses to connect to your underlying source.
errorInfo?
Type:
IResolvable
|
Data
(optional)
Error information from the last update or the creation of the data source.
folderArns?
Type:
string[]
(optional)
permissions?
Type:
IResolvable
|
IResolvable
|
Resource
[]
(optional)
A list of resource permissions on the data source.
sslProperties?
Type:
IResolvable
|
Ssl
(optional)
Secure Socket Layer (SSL) properties that apply when Amazon QuickSight connects to your underlying source.
tags?
Type:
Cfn
[]
(optional)
Contains a map of the key-value pairs for the resource tag or tags assigned to the data source.
vpcConnectionProperties?
Type:
IResolvable
|
Vpc
(optional)
Use this parameter only when you want Amazon QuickSight to use a VPC connection when connecting to your underlying source.