DataSource
quicksight.services.k8s.aws/v1alpha1
| Type | Link |
|---|---|
| GoDoc | quicksight-controller/apis/v1alpha1#DataSource |
Metadata
| Property | Value |
|---|---|
| Scope | Namespaced |
| Kind | DataSource |
| ListKind | DataSourceList |
| Plural | datasources |
| Singular | datasource |
The structure of a data source.
Spec
awsAccountID: string
credentials:
copySourceARN: string
credentialPair:
alternateDataSourceParameters:
amazonElasticsearchParameters:
domain: string
amazonOpenSearchParameters:
domain: string
athenaParameters:
identityCenterConfiguration:
enableIdentityPropagation: boolean
roleARN: string
roleRef:
from:
name: string
namespace: string
workGroup: string
auroraParameters:
database: string
host: string
port: integer
auroraPostgreSQLParameters:
database: string
host: string
port: integer
awsIOtAnalyticsParameters:
dataSetName: string
bigQueryParameters:
dataSetRegion: string
projectID: string
confluenceParameters:
confluenceURL: string
customConnectionParameters:
connectionType: string
databricksParameters:
host: string
port: integer
sqlEndpointPath: string
exasolParameters:
host: string
port: integer
impalaParameters:
database: string
host: string
port: integer
sqlEndpointPath: string
jiraParameters:
siteBaseURL: string
mariaDBParameters:
database: string
host: string
port: integer
mySQLParameters:
database: string
host: string
port: integer
oracleParameters:
database: string
host: string
port: integer
useServiceName: boolean
postgreSQLParameters:
database: string
host: string
port: integer
prestoParameters:
catalog: string
host: string
port: integer
qBusinessParameters:
applicationARN: string
rdsParameters:
database: string
instanceID: string
instanceRef:
from:
name: string
namespace: string
redshiftParameters:
clusterID: string
database: string
host: string
iamParameters:
autoCreateDatabaseUser: boolean
databaseGroups:
- string
databaseUser: string
roleARN: string
roleRef:
from:
name: string
namespace: string
identityCenterConfiguration:
enableIdentityPropagation: boolean
port: integer
s3KnowledgeBaseParameters:
bucketURL: string
metadataFilesLocation: string
roleARN: string
roleRef:
from:
name: string
namespace: string
s3Parameters:
manifestFileLocation:
bucket: string
bucketRef:
from:
name: string
namespace: string
key: string
roleARN: string
roleRef:
from:
name: string
namespace: string
serviceNowParameters:
siteBaseURL: string
snowflakeParameters:
authenticationType: string
database: string
databaseAccessControlRole: string
host: string
oAuthParameters:
identityProviderResourceURI: string
identityProviderVPCConnectionProperties:
vpcConnectionARN: string
oAuthScope: string
tokenProviderURL: string
warehouse: string
sparkParameters:
host: string
port: integer
sqlServerParameters:
database: string
host: string
port: integer
starburstParameters:
authenticationType: string
catalog: string
databaseAccessControlRole: string
host: string
oAuthParameters:
identityProviderResourceURI: string
identityProviderVPCConnectionProperties:
vpcConnectionARN: string
oAuthScope: string
tokenProviderURL: string
port: integer
productType: string
teradataParameters:
database: string
host: string
port: integer
trinoParameters:
catalog: string
host: string
port: integer
twitterParameters:
maxRows: integer
query: string
webCrawlerParameters:
loginPageURL: string
passwordButtonXpath: string
passwordFieldXpath: string
usernameButtonXpath: string
usernameFieldXpath: string
webCrawlerAuthType: string
webProxyHostName: string
webProxyPortNumber: integer
password:
key: string
name: string
namespace: string
username: string
keyPairCredentials:
keyPairUsername: string
privateKey:
key: string
name: string
namespace: string
privateKeyPassphrase:
key: string
name: string
namespace: string
secretARN: string
secretRef:
from:
name: string
namespace: string
webProxyCredentials:
webProxyPassword:
key: string
name: string
namespace: string
webProxyUsername: string
folderARNs:
- string
id: string
name: string
parameters:
amazonElasticsearchParameters:
domain: string
amazonOpenSearchParameters:
domain: string
athenaParameters:
identityCenterConfiguration:
enableIdentityPropagation: boolean
roleARN: string
roleRef:
from:
name: string
namespace: string
workGroup: string
auroraParameters:
database: string
host: string
port: integer
auroraPostgreSQLParameters:
database: string
host: string
port: integer
awsIOtAnalyticsParameters:
dataSetName: string
bigQueryParameters:
dataSetRegion: string
projectID: string
confluenceParameters:
confluenceURL: string
customConnectionParameters:
connectionType: string
databricksParameters:
host: string
port: integer
sqlEndpointPath: string
exasolParameters:
host: string
port: integer
impalaParameters:
database: string
host: string
port: integer
sqlEndpointPath: string
jiraParameters:
siteBaseURL: string
mariaDBParameters:
database: string
host: string
port: integer
mySQLParameters:
database: string
host: string
port: integer
oracleParameters:
database: string
host: string
port: integer
useServiceName: boolean
postgreSQLParameters:
database: string
host: string
port: integer
prestoParameters:
catalog: string
host: string
port: integer
qBusinessParameters:
applicationARN: string
rdsParameters:
database: string
instanceID: string
instanceRef:
from:
name: string
namespace: string
redshiftParameters:
clusterID: string
database: string
host: string
iamParameters:
autoCreateDatabaseUser: boolean
databaseGroups:
- string
databaseUser: string
roleARN: string
roleRef:
from:
name: string
namespace: string
identityCenterConfiguration:
enableIdentityPropagation: boolean
port: integer
s3KnowledgeBaseParameters:
bucketURL: string
metadataFilesLocation: string
roleARN: string
roleRef:
from:
name: string
namespace: string
s3Parameters:
manifestFileLocation:
bucket: string
bucketRef:
from:
name: string
namespace: string
key: string
roleARN: string
roleRef:
from:
name: string
namespace: string
serviceNowParameters:
siteBaseURL: string
snowflakeParameters:
authenticationType: string
database: string
databaseAccessControlRole: string
host: string
oAuthParameters:
identityProviderResourceURI: string
identityProviderVPCConnectionProperties:
vpcConnectionARN: string
oAuthScope: string
tokenProviderURL: string
warehouse: string
sparkParameters:
host: string
port: integer
sqlServerParameters:
database: string
host: string
port: integer
starburstParameters:
authenticationType: string
catalog: string
databaseAccessControlRole: string
host: string
oAuthParameters:
identityProviderResourceURI: string
identityProviderVPCConnectionProperties:
vpcConnectionARN: string
oAuthScope: string
tokenProviderURL: string
port: integer
productType: string
teradataParameters:
database: string
host: string
port: integer
trinoParameters:
catalog: string
host: string
port: integer
twitterParameters:
maxRows: integer
query: string
webCrawlerParameters:
loginPageURL: string
passwordButtonXpath: string
passwordFieldXpath: string
usernameButtonXpath: string
usernameFieldXpath: string
webCrawlerAuthType: string
webProxyHostName: string
webProxyPortNumber: integer
permissions:
actions:
- string
principal: string
sslProperties:
disableSSL: boolean
tags:
- key: string
value: string
type: string
vpcConnectionProperties:
vpcConnectionARN: string
| Field | Description |
|---|---|
| awsAccountID Required | string The Amazon Web Services account ID. Regex Pattern: ^[0-9]{12}$ |
| credentials Optional | object The credentials Amazon Quick Sight that uses to connect to your underlying source. Currently, only credentials based on user name and password are supported. |
| credentials.copySourceARN Optional | string |
| credentials.credentialPair Optional | object The combination of user name and password that are used as credentials. |
| credentials.credentialPair.alternateDataSourceParameters Optional | array |
| credentials.credentialPair.alternateDataSourceParameters.[] Required | object The parameters that Quick Sight uses to connect to your underlying data source. |
| This is a variant type structure. For this structure to be valid, only one | |
| of the attributes can be non-null. | |
| credentials.credentialPair.alternateDataSourceParameters.[].amazonElasticsearchParameters.domain Optional | string |
| credentials.credentialPair.alternateDataSourceParameters.[].amazonOpenSearchParameters Optional | object The parameters for OpenSearch. |
| credentials.credentialPair.alternateDataSourceParameters.[].amazonOpenSearchParameters.domain Optional | string |
| credentials.credentialPair.alternateDataSourceParameters.[].athenaParameters Optional | object Parameters for Amazon Athena. |
| credentials.credentialPair.alternateDataSourceParameters.[].athenaParameters.identityCenterConfiguration Optional | object The parameters for an IAM Identity Center configuration. |
| credentials.credentialPair.alternateDataSourceParameters.[].athenaParameters.identityCenterConfiguration.enableIdentityPropagation Optional | boolean |
| credentials.credentialPair.alternateDataSourceParameters.[].athenaParameters.roleARN Optional | string |
| credentials.credentialPair.alternateDataSourceParameters.[].athenaParameters.roleRef Optional | object Reference field for RoleARN |
| credentials.credentialPair.alternateDataSourceParameters.[].athenaParameters.roleRef.from Optional | object AWSResourceReference provides all the values necessary to reference another k8s resource for finding the identifier(Id/ARN/Name) |
| credentials.credentialPair.alternateDataSourceParameters.[].athenaParameters.roleRef.from.name Optional | string |
| credentials.credentialPair.alternateDataSourceParameters.[].athenaParameters.roleRef.from.namespace Optional | string |
| credentials.credentialPair.alternateDataSourceParameters.[].athenaParameters.workGroup Optional | string |
| credentials.credentialPair.alternateDataSourceParameters.[].auroraParameters Optional | object Parameters for Amazon Aurora. |
| credentials.credentialPair.alternateDataSourceParameters.[].auroraParameters.database Optional | string |
| credentials.credentialPair.alternateDataSourceParameters.[].auroraParameters.host Optional | string |
| credentials.credentialPair.alternateDataSourceParameters.[].auroraParameters.port Optional | integer |
| credentials.credentialPair.alternateDataSourceParameters.[].auroraPostgreSQLParameters Optional | object Parameters for Amazon Aurora PostgreSQL-Compatible Edition. |
| credentials.credentialPair.alternateDataSourceParameters.[].auroraPostgreSQLParameters.database Optional | string |
| credentials.credentialPair.alternateDataSourceParameters.[].auroraPostgreSQLParameters.host Optional | string |
| credentials.credentialPair.alternateDataSourceParameters.[].auroraPostgreSQLParameters.port Optional | integer |
| credentials.credentialPair.alternateDataSourceParameters.[].awsIOtAnalyticsParameters Optional | object The parameters for IoT Analytics. |
| credentials.credentialPair.alternateDataSourceParameters.[].awsIOtAnalyticsParameters.dataSetName Optional | string |
| credentials.credentialPair.alternateDataSourceParameters.[].bigQueryParameters Optional | object The parameters that are required to connect to a Google BigQuery data source. |
| credentials.credentialPair.alternateDataSourceParameters.[].bigQueryParameters.dataSetRegion Optional | string |
| credentials.credentialPair.alternateDataSourceParameters.[].bigQueryParameters.projectID Optional | string |
| credentials.credentialPair.alternateDataSourceParameters.[].confluenceParameters Optional | object The parameters that are required to connect to a Confluence data source |
| credentials.credentialPair.alternateDataSourceParameters.[].confluenceParameters.confluenceURL Optional | string |
| credentials.credentialPair.alternateDataSourceParameters.[].customConnectionParameters Optional | object The parameters that are required to connect to a custom connection data source. |
| credentials.credentialPair.alternateDataSourceParameters.[].customConnectionParameters.connectionType Optional | string |
| credentials.credentialPair.alternateDataSourceParameters.[].databricksParameters Optional | object The parameters that are required to connect to a Databricks data source. |
| credentials.credentialPair.alternateDataSourceParameters.[].databricksParameters.host Optional | string |
| credentials.credentialPair.alternateDataSourceParameters.[].databricksParameters.port Optional | integer |
| credentials.credentialPair.alternateDataSourceParameters.[].databricksParameters.sqlEndpointPath Optional | string |
| credentials.credentialPair.alternateDataSourceParameters.[].exasolParameters Optional | object The required parameters for connecting to an Exasol data source. |
| credentials.credentialPair.alternateDataSourceParameters.[].exasolParameters.host Optional | string |
| credentials.credentialPair.alternateDataSourceParameters.[].exasolParameters.port Optional | integer |
| credentials.credentialPair.alternateDataSourceParameters.[].impalaParameters Optional | object The parameters that are required to connect to a Impala data source. |
| credentials.credentialPair.alternateDataSourceParameters.[].impalaParameters.database Optional | string |
| credentials.credentialPair.alternateDataSourceParameters.[].impalaParameters.host Optional | string |
| credentials.credentialPair.alternateDataSourceParameters.[].impalaParameters.port Optional | integer |
| credentials.credentialPair.alternateDataSourceParameters.[].impalaParameters.sqlEndpointPath Optional | string |
| credentials.credentialPair.alternateDataSourceParameters.[].jiraParameters Optional | object The parameters for Jira. |
| credentials.credentialPair.alternateDataSourceParameters.[].jiraParameters.siteBaseURL Optional | string |
| credentials.credentialPair.alternateDataSourceParameters.[].mariaDBParameters Optional | object The parameters for MariaDB. |
| credentials.credentialPair.alternateDataSourceParameters.[].mariaDBParameters.database Optional | string |
| credentials.credentialPair.alternateDataSourceParameters.[].mariaDBParameters.host Optional | string |
| credentials.credentialPair.alternateDataSourceParameters.[].mariaDBParameters.port Optional | integer |
| credentials.credentialPair.alternateDataSourceParameters.[].mySQLParameters Optional | object The parameters for MySQL. |
| credentials.credentialPair.alternateDataSourceParameters.[].mySQLParameters.database Optional | string |
| credentials.credentialPair.alternateDataSourceParameters.[].mySQLParameters.host Optional | string |
| credentials.credentialPair.alternateDataSourceParameters.[].mySQLParameters.port Optional | integer |
| credentials.credentialPair.alternateDataSourceParameters.[].oracleParameters Optional | object The parameters for Oracle. |
| credentials.credentialPair.alternateDataSourceParameters.[].oracleParameters.database Optional | string |
| credentials.credentialPair.alternateDataSourceParameters.[].oracleParameters.host Optional | string |
| credentials.credentialPair.alternateDataSourceParameters.[].oracleParameters.port Optional | integer |
| credentials.credentialPair.alternateDataSourceParameters.[].oracleParameters.useServiceName Optional | boolean |
| credentials.credentialPair.alternateDataSourceParameters.[].postgreSQLParameters Optional | object The parameters for PostgreSQL. |
| credentials.credentialPair.alternateDataSourceParameters.[].postgreSQLParameters.database Optional | string |
| credentials.credentialPair.alternateDataSourceParameters.[].postgreSQLParameters.host Optional | string |
| credentials.credentialPair.alternateDataSourceParameters.[].postgreSQLParameters.port Optional | integer |
| credentials.credentialPair.alternateDataSourceParameters.[].prestoParameters Optional | object The parameters for Presto. |
| credentials.credentialPair.alternateDataSourceParameters.[].prestoParameters.catalog Optional | string |
| credentials.credentialPair.alternateDataSourceParameters.[].prestoParameters.host Optional | string |
| credentials.credentialPair.alternateDataSourceParameters.[].prestoParameters.port Optional | integer |
| credentials.credentialPair.alternateDataSourceParameters.[].qBusinessParameters Optional | object The parameters that are required to connect to an Amazon Q Business data source. |
| credentials.credentialPair.alternateDataSourceParameters.[].qBusinessParameters.applicationARN Optional | string |
| credentials.credentialPair.alternateDataSourceParameters.[].rdsParameters Optional | object The parameters for Amazon RDS. |
| credentials.credentialPair.alternateDataSourceParameters.[].rdsParameters.database Optional | string |
| credentials.credentialPair.alternateDataSourceParameters.[].rdsParameters.instanceID Optional | string |
| credentials.credentialPair.alternateDataSourceParameters.[].rdsParameters.instanceRef Optional | object Reference field for InstanceID |
| credentials.credentialPair.alternateDataSourceParameters.[].rdsParameters.instanceRef.from Optional | object AWSResourceReference provides all the values necessary to reference another k8s resource for finding the identifier(Id/ARN/Name) |
| credentials.credentialPair.alternateDataSourceParameters.[].rdsParameters.instanceRef.from.name Optional | string |
| credentials.credentialPair.alternateDataSourceParameters.[].rdsParameters.instanceRef.from.namespace Optional | string |
| credentials.credentialPair.alternateDataSourceParameters.[].redshiftParameters Optional | 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. |
| credentials.credentialPair.alternateDataSourceParameters.[].redshiftParameters.clusterID Optional | string |
| credentials.credentialPair.alternateDataSourceParameters.[].redshiftParameters.database Optional | string |
| credentials.credentialPair.alternateDataSourceParameters.[].redshiftParameters.host Optional | string |
| credentials.credentialPair.alternateDataSourceParameters.[].redshiftParameters.iamParameters Optional | object A structure that grants Quick Sight access to your cluster and make a call to the redshift:GetClusterCredentials API. For more information on the redshift:GetClusterCredentials API, see GetClusterCredentials (https://docs.aws.amazon.com/redshift/latest/APIReference/API_GetClusterCredentials.html). |
| credentials.credentialPair.alternateDataSourceParameters.[].redshiftParameters.iamParameters.autoCreateDatabaseUser Optional | boolean |
| credentials.credentialPair.alternateDataSourceParameters.[].redshiftParameters.iamParameters.databaseGroups Optional | array |
| credentials.credentialPair.alternateDataSourceParameters.[].redshiftParameters.iamParameters.databaseGroups.[] Required | string |
| credentials.credentialPair.alternateDataSourceParameters.[].redshiftParameters.iamParameters.roleARN Optional | string |
| credentials.credentialPair.alternateDataSourceParameters.[].redshiftParameters.iamParameters.roleRef Optional | object Reference field for RoleARN |
| credentials.credentialPair.alternateDataSourceParameters.[].redshiftParameters.iamParameters.roleRef.from Optional | object AWSResourceReference provides all the values necessary to reference another k8s resource for finding the identifier(Id/ARN/Name) |
| credentials.credentialPair.alternateDataSourceParameters.[].redshiftParameters.iamParameters.roleRef.from.name Optional | string |
| credentials.credentialPair.alternateDataSourceParameters.[].redshiftParameters.iamParameters.roleRef.from.namespace Optional | string |
| credentials.credentialPair.alternateDataSourceParameters.[].redshiftParameters.identityCenterConfiguration Optional | object The parameters for an IAM Identity Center configuration. |
| credentials.credentialPair.alternateDataSourceParameters.[].redshiftParameters.identityCenterConfiguration.enableIdentityPropagation Optional | boolean |
| credentials.credentialPair.alternateDataSourceParameters.[].redshiftParameters.port Optional | integer |
| credentials.credentialPair.alternateDataSourceParameters.[].s3KnowledgeBaseParameters Optional | object The parameters that are required to connect to a S3 Knowledge Base data source. |
| credentials.credentialPair.alternateDataSourceParameters.[].s3KnowledgeBaseParameters.bucketURL Optional | string |
| credentials.credentialPair.alternateDataSourceParameters.[].s3KnowledgeBaseParameters.metadataFilesLocation Optional | string |
| credentials.credentialPair.alternateDataSourceParameters.[].s3KnowledgeBaseParameters.roleARN Optional | string |
| credentials.credentialPair.alternateDataSourceParameters.[].s3KnowledgeBaseParameters.roleRef Optional | object Reference field for RoleARN |
| credentials.credentialPair.alternateDataSourceParameters.[].s3KnowledgeBaseParameters.roleRef.from Optional | object AWSResourceReference provides all the values necessary to reference another k8s resource for finding the identifier(Id/ARN/Name) |
| credentials.credentialPair.alternateDataSourceParameters.[].s3KnowledgeBaseParameters.roleRef.from.name Optional | string |
| credentials.credentialPair.alternateDataSourceParameters.[].s3KnowledgeBaseParameters.roleRef.from.namespace Optional | string |
| credentials.credentialPair.alternateDataSourceParameters.[].s3Parameters Optional | object The parameters for S3. |
| credentials.credentialPair.alternateDataSourceParameters.[].s3Parameters.manifestFileLocation Optional | object Amazon S3 manifest file location. |
| credentials.credentialPair.alternateDataSourceParameters.[].s3Parameters.manifestFileLocation.bucket Optional | string |
| credentials.credentialPair.alternateDataSourceParameters.[].s3Parameters.manifestFileLocation.bucketRef Optional | object Reference field for Bucket |
| credentials.credentialPair.alternateDataSourceParameters.[].s3Parameters.manifestFileLocation.bucketRef.from Optional | object AWSResourceReference provides all the values necessary to reference another k8s resource for finding the identifier(Id/ARN/Name) |
| credentials.credentialPair.alternateDataSourceParameters.[].s3Parameters.manifestFileLocation.bucketRef.from.name Optional | string |
| credentials.credentialPair.alternateDataSourceParameters.[].s3Parameters.manifestFileLocation.bucketRef.from.namespace Optional | string |
| credentials.credentialPair.alternateDataSourceParameters.[].s3Parameters.manifestFileLocation.key Optional | string |
| credentials.credentialPair.alternateDataSourceParameters.[].s3Parameters.roleARN Optional | string |
| credentials.credentialPair.alternateDataSourceParameters.[].s3Parameters.roleRef Optional | object Reference field for RoleARN |
| credentials.credentialPair.alternateDataSourceParameters.[].s3Parameters.roleRef.from Optional | object AWSResourceReference provides all the values necessary to reference another k8s resource for finding the identifier(Id/ARN/Name) |
| credentials.credentialPair.alternateDataSourceParameters.[].s3Parameters.roleRef.from.name Optional | string |
| credentials.credentialPair.alternateDataSourceParameters.[].s3Parameters.roleRef.from.namespace Optional | string |
| credentials.credentialPair.alternateDataSourceParameters.[].serviceNowParameters Optional | object The parameters for ServiceNow. |
| credentials.credentialPair.alternateDataSourceParameters.[].serviceNowParameters.siteBaseURL Optional | string |
| credentials.credentialPair.alternateDataSourceParameters.[].snowflakeParameters Optional | object The parameters for Snowflake. |
| credentials.credentialPair.alternateDataSourceParameters.[].snowflakeParameters.authenticationType Optional | string |
| credentials.credentialPair.alternateDataSourceParameters.[].snowflakeParameters.database Optional | string |
| credentials.credentialPair.alternateDataSourceParameters.[].snowflakeParameters.databaseAccessControlRole Optional | string |
| credentials.credentialPair.alternateDataSourceParameters.[].snowflakeParameters.host Optional | string |
| credentials.credentialPair.alternateDataSourceParameters.[].snowflakeParameters.oAuthParameters Optional | 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. |
| credentials.credentialPair.alternateDataSourceParameters.[].snowflakeParameters.oAuthParameters.identityProviderResourceURI Optional | string |
| credentials.credentialPair.alternateDataSourceParameters.[].snowflakeParameters.oAuthParameters.identityProviderVPCConnectionProperties Optional | object VPC connection properties. |
| credentials.credentialPair.alternateDataSourceParameters.[].snowflakeParameters.oAuthParameters.identityProviderVPCConnectionProperties.vpcConnectionARN Optional | string |
| credentials.credentialPair.alternateDataSourceParameters.[].snowflakeParameters.oAuthParameters.oAuthScope Optional | string |
| credentials.credentialPair.alternateDataSourceParameters.[].snowflakeParameters.oAuthParameters.tokenProviderURL Optional | string |
| credentials.credentialPair.alternateDataSourceParameters.[].snowflakeParameters.warehouse Optional | string |
| credentials.credentialPair.alternateDataSourceParameters.[].sparkParameters Optional | object The parameters for Spark. |
| credentials.credentialPair.alternateDataSourceParameters.[].sparkParameters.host Optional | string |
| credentials.credentialPair.alternateDataSourceParameters.[].sparkParameters.port Optional | integer |
| credentials.credentialPair.alternateDataSourceParameters.[].sqlServerParameters Optional | object The parameters for SQL Server. |
| credentials.credentialPair.alternateDataSourceParameters.[].sqlServerParameters.database Optional | string |
| credentials.credentialPair.alternateDataSourceParameters.[].sqlServerParameters.host Optional | string |
| credentials.credentialPair.alternateDataSourceParameters.[].sqlServerParameters.port Optional | integer |
| credentials.credentialPair.alternateDataSourceParameters.[].starburstParameters Optional | object The parameters that are required to connect to a Starburst data source. |
| credentials.credentialPair.alternateDataSourceParameters.[].starburstParameters.authenticationType Optional | string |
| credentials.credentialPair.alternateDataSourceParameters.[].starburstParameters.catalog Optional | string |
| credentials.credentialPair.alternateDataSourceParameters.[].starburstParameters.databaseAccessControlRole Optional | string |
| credentials.credentialPair.alternateDataSourceParameters.[].starburstParameters.host Optional | string |
| credentials.credentialPair.alternateDataSourceParameters.[].starburstParameters.oAuthParameters Optional | 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. |
| credentials.credentialPair.alternateDataSourceParameters.[].starburstParameters.oAuthParameters.identityProviderResourceURI Optional | string |
| credentials.credentialPair.alternateDataSourceParameters.[].starburstParameters.oAuthParameters.identityProviderVPCConnectionProperties Optional | object VPC connection properties. |
| credentials.credentialPair.alternateDataSourceParameters.[].starburstParameters.oAuthParameters.identityProviderVPCConnectionProperties.vpcConnectionARN Optional | string |
| credentials.credentialPair.alternateDataSourceParameters.[].starburstParameters.oAuthParameters.oAuthScope Optional | string |
| credentials.credentialPair.alternateDataSourceParameters.[].starburstParameters.oAuthParameters.tokenProviderURL Optional | string |
| credentials.credentialPair.alternateDataSourceParameters.[].starburstParameters.port Optional | integer |
| credentials.credentialPair.alternateDataSourceParameters.[].starburstParameters.productType Optional | string |
| credentials.credentialPair.alternateDataSourceParameters.[].teradataParameters Optional | object The parameters for Teradata. |
| credentials.credentialPair.alternateDataSourceParameters.[].teradataParameters.database Optional | string |
| credentials.credentialPair.alternateDataSourceParameters.[].teradataParameters.host Optional | string |
| credentials.credentialPair.alternateDataSourceParameters.[].teradataParameters.port Optional | integer |
| credentials.credentialPair.alternateDataSourceParameters.[].trinoParameters Optional | object The parameters that are required to connect to a Trino data source. |
| credentials.credentialPair.alternateDataSourceParameters.[].trinoParameters.catalog Optional | string |
| credentials.credentialPair.alternateDataSourceParameters.[].trinoParameters.host Optional | string |
| credentials.credentialPair.alternateDataSourceParameters.[].trinoParameters.port Optional | integer |
| credentials.credentialPair.alternateDataSourceParameters.[].twitterParameters Optional | object The parameters for Twitter. |
| credentials.credentialPair.alternateDataSourceParameters.[].twitterParameters.maxRows Optional | integer |
| credentials.credentialPair.alternateDataSourceParameters.[].twitterParameters.query Optional | string |
| credentials.credentialPair.alternateDataSourceParameters.[].webCrawlerParameters Optional | object The parameters for a web crawler data source. |
| credentials.credentialPair.alternateDataSourceParameters.[].webCrawlerParameters.loginPageURL Optional | string |
| credentials.credentialPair.alternateDataSourceParameters.[].webCrawlerParameters.passwordButtonXpath Optional | string |
| credentials.credentialPair.alternateDataSourceParameters.[].webCrawlerParameters.passwordFieldXpath Optional | string |
| credentials.credentialPair.alternateDataSourceParameters.[].webCrawlerParameters.usernameButtonXpath Optional | string |
| credentials.credentialPair.alternateDataSourceParameters.[].webCrawlerParameters.usernameFieldXpath Optional | string |
| credentials.credentialPair.alternateDataSourceParameters.[].webCrawlerParameters.webCrawlerAuthType Optional | string |
| credentials.credentialPair.alternateDataSourceParameters.[].webCrawlerParameters.webProxyHostName Optional | string |
| credentials.credentialPair.alternateDataSourceParameters.[].webCrawlerParameters.webProxyPortNumber Optional | integer |
| credentials.credentialPair.password Optional | object SecretKeyReference combines a k8s corev1.SecretReference with a specific key within the referred-to Secret |
| credentials.credentialPair.password.key Required | string Key is the key within the secret |
| credentials.credentialPair.password.name Optional | string name is unique within a namespace to reference a secret resource. |
| credentials.credentialPair.password.namespace Optional | string namespace defines the space within which the secret name must be unique. |
| credentials.credentialPair.username Optional | string |
| credentials.keyPairCredentials Optional | object The combination of username, private key and passphrase that are used as credentials. |
| credentials.keyPairCredentials.keyPairUsername Optional | string |
| credentials.keyPairCredentials.privateKey Optional | object SecretKeyReference combines a k8s corev1.SecretReference with a specific key within the referred-to Secret |
| credentials.keyPairCredentials.privateKey.key Required | string Key is the key within the secret |
| credentials.keyPairCredentials.privateKey.name Optional | string name is unique within a namespace to reference a secret resource. |
| credentials.keyPairCredentials.privateKey.namespace Optional | string namespace defines the space within which the secret name must be unique. |
| credentials.keyPairCredentials.privateKeyPassphrase Optional | object SecretKeyReference combines a k8s corev1.SecretReference with a specific key within the referred-to Secret |
| credentials.keyPairCredentials.privateKeyPassphrase.key Required | string Key is the key within the secret |
| credentials.keyPairCredentials.privateKeyPassphrase.name Optional | string name is unique within a namespace to reference a secret resource. |
| credentials.keyPairCredentials.privateKeyPassphrase.namespace Optional | string namespace defines the space within which the secret name must be unique. |
| credentials.secretARN Optional | string |
| credentials.secretRef Optional | object Reference field for SecretARN |
| credentials.secretRef.from Optional | object AWSResourceReference provides all the values necessary to reference another k8s resource for finding the identifier(Id/ARN/Name) |
| credentials.secretRef.from.name Optional | string |
| credentials.secretRef.from.namespace Optional | string |
| credentials.webProxyCredentials Optional | object The credentials for authenticating with a web proxy server. |
| credentials.webProxyCredentials.webProxyPassword Optional | object SecretKeyReference combines a k8s corev1.SecretReference with a specific key within the referred-to Secret |
| credentials.webProxyCredentials.webProxyPassword.key Required | string Key is the key within the secret |
| credentials.webProxyCredentials.webProxyPassword.name Optional | string name is unique within a namespace to reference a secret resource. |
| credentials.webProxyCredentials.webProxyPassword.namespace Optional | string namespace defines the space within which the secret name must be unique. |
| credentials.webProxyCredentials.webProxyUsername Optional | string |
| folderARNs Optional | array When you create the data source, Amazon Quick Sight adds the data source to these folders. |
| folderARNs.[] Required | string |
| name Required | string A display name for the data source. |
| parameters Optional | object The parameters that Amazon Quick Sight uses to connect to your underlying source. |
| parameters.amazonElasticsearchParameters Optional | object The parameters for OpenSearch. |
| parameters.amazonElasticsearchParameters.domain Optional | string |
| parameters.amazonOpenSearchParameters Optional | object The parameters for OpenSearch. |
| parameters.amazonOpenSearchParameters.domain Optional | string |
| parameters.athenaParameters Optional | object Parameters for Amazon Athena. |
| parameters.athenaParameters.identityCenterConfiguration Optional | object The parameters for an IAM Identity Center configuration. |
| parameters.athenaParameters.identityCenterConfiguration.enableIdentityPropagation Optional | boolean |
| parameters.athenaParameters.roleARN Optional | string |
| parameters.athenaParameters.roleRef Optional | object Reference field for RoleARN |
| parameters.athenaParameters.roleRef.from Optional | object AWSResourceReference provides all the values necessary to reference another k8s resource for finding the identifier(Id/ARN/Name) |
| parameters.athenaParameters.roleRef.from.name Optional | string |
| parameters.athenaParameters.roleRef.from.namespace Optional | string |
| parameters.athenaParameters.workGroup Optional | string |
| parameters.auroraParameters Optional | object Parameters for Amazon Aurora. |
| parameters.auroraParameters.database Optional | string |
| parameters.auroraParameters.host Optional | string |
| parameters.auroraParameters.port Optional | integer |
| parameters.auroraPostgreSQLParameters Optional | object Parameters for Amazon Aurora PostgreSQL-Compatible Edition. |
| parameters.auroraPostgreSQLParameters.database Optional | string |
| parameters.auroraPostgreSQLParameters.host Optional | string |
| parameters.auroraPostgreSQLParameters.port Optional | integer |
| parameters.awsIOtAnalyticsParameters Optional | object The parameters for IoT Analytics. |
| parameters.awsIOtAnalyticsParameters.dataSetName Optional | string |
| parameters.bigQueryParameters Optional | object The parameters that are required to connect to a Google BigQuery data source. |
| parameters.bigQueryParameters.dataSetRegion Optional | string |
| parameters.bigQueryParameters.projectID Optional | string |
| parameters.confluenceParameters Optional | object The parameters that are required to connect to a Confluence data source |
| parameters.confluenceParameters.confluenceURL Optional | string |
| parameters.customConnectionParameters Optional | object The parameters that are required to connect to a custom connection data source. |
| parameters.customConnectionParameters.connectionType Optional | string |
| parameters.databricksParameters Optional | object The parameters that are required to connect to a Databricks data source. |
| parameters.databricksParameters.host Optional | string |
| parameters.databricksParameters.port Optional | integer |
| parameters.databricksParameters.sqlEndpointPath Optional | string |
| parameters.exasolParameters Optional | object The required parameters for connecting to an Exasol data source. |
| parameters.exasolParameters.host Optional | string |
| parameters.exasolParameters.port Optional | integer |
| parameters.impalaParameters Optional | object The parameters that are required to connect to a Impala data source. |
| parameters.impalaParameters.database Optional | string |
| parameters.impalaParameters.host Optional | string |
| parameters.impalaParameters.port Optional | integer |
| parameters.impalaParameters.sqlEndpointPath Optional | string |
| parameters.jiraParameters Optional | object The parameters for Jira. |
| parameters.jiraParameters.siteBaseURL Optional | string |
| parameters.mariaDBParameters Optional | object The parameters for MariaDB. |
| parameters.mariaDBParameters.database Optional | string |
| parameters.mariaDBParameters.host Optional | string |
| parameters.mariaDBParameters.port Optional | integer |
| parameters.mySQLParameters Optional | object The parameters for MySQL. |
| parameters.mySQLParameters.database Optional | string |
| parameters.mySQLParameters.host Optional | string |
| parameters.mySQLParameters.port Optional | integer |
| parameters.oracleParameters Optional | object The parameters for Oracle. |
| parameters.oracleParameters.database Optional | string |
| parameters.oracleParameters.host Optional | string |
| parameters.oracleParameters.port Optional | integer |
| parameters.oracleParameters.useServiceName Optional | boolean |
| parameters.postgreSQLParameters Optional | object The parameters for PostgreSQL. |
| parameters.postgreSQLParameters.database Optional | string |
| parameters.postgreSQLParameters.host Optional | string |
| parameters.postgreSQLParameters.port Optional | integer |
| parameters.prestoParameters Optional | object The parameters for Presto. |
| parameters.prestoParameters.catalog Optional | string |
| parameters.prestoParameters.host Optional | string |
| parameters.prestoParameters.port Optional | integer |
| parameters.qBusinessParameters Optional | object The parameters that are required to connect to an Amazon Q Business data source. |
| parameters.qBusinessParameters.applicationARN Optional | string |
| parameters.rdsParameters Optional | object The parameters for Amazon RDS. |
| parameters.rdsParameters.database Optional | string |
| parameters.rdsParameters.instanceID Optional | string |
| parameters.rdsParameters.instanceRef Optional | object Reference field for InstanceID |
| parameters.rdsParameters.instanceRef.from Optional | object AWSResourceReference provides all the values necessary to reference another k8s resource for finding the identifier(Id/ARN/Name) |
| parameters.rdsParameters.instanceRef.from.name Optional | string |
| parameters.rdsParameters.instanceRef.from.namespace Optional | string |
| parameters.redshiftParameters Optional | 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.redshiftParameters.clusterID Optional | string |
| parameters.redshiftParameters.database Optional | string |
| parameters.redshiftParameters.host Optional | string |
| parameters.redshiftParameters.iamParameters Optional | object A structure that grants Quick Sight access to your cluster and make a call to the redshift:GetClusterCredentials API. For more information on the redshift:GetClusterCredentials API, see GetClusterCredentials (https://docs.aws.amazon.com/redshift/latest/APIReference/API_GetClusterCredentials.html). |
| parameters.redshiftParameters.iamParameters.autoCreateDatabaseUser Optional | boolean |
| parameters.redshiftParameters.iamParameters.databaseGroups Optional | array |
| parameters.redshiftParameters.iamParameters.databaseGroups.[] Required | string |
| parameters.redshiftParameters.iamParameters.roleARN Optional | string |
| parameters.redshiftParameters.iamParameters.roleRef Optional | object Reference field for RoleARN |
| parameters.redshiftParameters.iamParameters.roleRef.from Optional | object AWSResourceReference provides all the values necessary to reference another k8s resource for finding the identifier(Id/ARN/Name) |
| parameters.redshiftParameters.iamParameters.roleRef.from.name Optional | string |
| parameters.redshiftParameters.iamParameters.roleRef.from.namespace Optional | string |
| parameters.redshiftParameters.identityCenterConfiguration Optional | object The parameters for an IAM Identity Center configuration. |
| parameters.redshiftParameters.identityCenterConfiguration.enableIdentityPropagation Optional | boolean |
| parameters.redshiftParameters.port Optional | integer |
| parameters.s3KnowledgeBaseParameters Optional | object The parameters that are required to connect to a S3 Knowledge Base data source. |
| parameters.s3KnowledgeBaseParameters.bucketURL Optional | string |
| parameters.s3KnowledgeBaseParameters.metadataFilesLocation Optional | string |
| parameters.s3KnowledgeBaseParameters.roleARN Optional | string |
| parameters.s3KnowledgeBaseParameters.roleRef Optional | object Reference field for RoleARN |
| parameters.s3KnowledgeBaseParameters.roleRef.from Optional | object AWSResourceReference provides all the values necessary to reference another k8s resource for finding the identifier(Id/ARN/Name) |
| parameters.s3KnowledgeBaseParameters.roleRef.from.name Optional | string |
| parameters.s3KnowledgeBaseParameters.roleRef.from.namespace Optional | string |
| parameters.s3Parameters Optional | object The parameters for S3. |
| parameters.s3Parameters.manifestFileLocation Optional | object Amazon S3 manifest file location. |
| parameters.s3Parameters.manifestFileLocation.bucket Optional | string |
| parameters.s3Parameters.manifestFileLocation.bucketRef Optional | object Reference field for Bucket |
| parameters.s3Parameters.manifestFileLocation.bucketRef.from Optional | object AWSResourceReference provides all the values necessary to reference another k8s resource for finding the identifier(Id/ARN/Name) |
| parameters.s3Parameters.manifestFileLocation.bucketRef.from.name Optional | string |
| parameters.s3Parameters.manifestFileLocation.bucketRef.from.namespace Optional | string |
| parameters.s3Parameters.manifestFileLocation.key Optional | string |
| parameters.s3Parameters.roleARN Optional | string |
| parameters.s3Parameters.roleRef Optional | object Reference field for RoleARN |
| parameters.s3Parameters.roleRef.from Optional | object AWSResourceReference provides all the values necessary to reference another k8s resource for finding the identifier(Id/ARN/Name) |
| parameters.s3Parameters.roleRef.from.name Optional | string |
| parameters.s3Parameters.roleRef.from.namespace Optional | string |
| parameters.serviceNowParameters Optional | object The parameters for ServiceNow. |
| parameters.serviceNowParameters.siteBaseURL Optional | string |
| parameters.snowflakeParameters Optional | object The parameters for Snowflake. |
| parameters.snowflakeParameters.authenticationType Optional | string |
| parameters.snowflakeParameters.database Optional | string |
| parameters.snowflakeParameters.databaseAccessControlRole Optional | string |
| parameters.snowflakeParameters.host Optional | string |
| parameters.snowflakeParameters.oAuthParameters Optional | 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.snowflakeParameters.oAuthParameters.identityProviderResourceURI Optional | string |
| parameters.snowflakeParameters.oAuthParameters.identityProviderVPCConnectionProperties Optional | object VPC connection properties. |
| parameters.snowflakeParameters.oAuthParameters.identityProviderVPCConnectionProperties.vpcConnectionARN Optional | string |
| parameters.snowflakeParameters.oAuthParameters.oAuthScope Optional | string |
| parameters.snowflakeParameters.oAuthParameters.tokenProviderURL Optional | string |
| parameters.snowflakeParameters.warehouse Optional | string |
| parameters.sparkParameters Optional | object The parameters for Spark. |
| parameters.sparkParameters.host Optional | string |
| parameters.sparkParameters.port Optional | integer |
| parameters.sqlServerParameters Optional | object The parameters for SQL Server. |
| parameters.sqlServerParameters.database Optional | string |
| parameters.sqlServerParameters.host Optional | string |
| parameters.sqlServerParameters.port Optional | integer |
| parameters.starburstParameters Optional | object The parameters that are required to connect to a Starburst data source. |
| parameters.starburstParameters.authenticationType Optional | string |
| parameters.starburstParameters.catalog Optional | string |
| parameters.starburstParameters.databaseAccessControlRole Optional | string |
| parameters.starburstParameters.host Optional | string |
| parameters.starburstParameters.oAuthParameters Optional | 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.starburstParameters.oAuthParameters.identityProviderResourceURI Optional | string |
| parameters.starburstParameters.oAuthParameters.identityProviderVPCConnectionProperties Optional | object VPC connection properties. |
| parameters.starburstParameters.oAuthParameters.identityProviderVPCConnectionProperties.vpcConnectionARN Optional | string |
| parameters.starburstParameters.oAuthParameters.oAuthScope Optional | string |
| parameters.starburstParameters.oAuthParameters.tokenProviderURL Optional | string |
| parameters.starburstParameters.port Optional | integer |
| parameters.starburstParameters.productType Optional | string |
| parameters.teradataParameters Optional | object The parameters for Teradata. |
| parameters.teradataParameters.database Optional | string |
| parameters.teradataParameters.host Optional | string |
| parameters.teradataParameters.port Optional | integer |
| parameters.trinoParameters Optional | object The parameters that are required to connect to a Trino data source. |
| parameters.trinoParameters.catalog Optional | string |
| parameters.trinoParameters.host Optional | string |
| parameters.trinoParameters.port Optional | integer |
| parameters.twitterParameters Optional | object The parameters for Twitter. |
| parameters.twitterParameters.maxRows Optional | integer |
| parameters.twitterParameters.query Optional | string |
| parameters.webCrawlerParameters Optional | object The parameters for a web crawler data source. |
| parameters.webCrawlerParameters.loginPageURL Optional | string |
| parameters.webCrawlerParameters.passwordButtonXpath Optional | string |
| parameters.webCrawlerParameters.passwordFieldXpath Optional | string |
| parameters.webCrawlerParameters.usernameButtonXpath Optional | string |
| parameters.webCrawlerParameters.usernameFieldXpath Optional | string |
| parameters.webCrawlerParameters.webCrawlerAuthType Optional | string |
| parameters.webCrawlerParameters.webProxyHostName Optional | string |
| parameters.webCrawlerParameters.webProxyPortNumber Optional | integer |
| permissions Optional | array A list of resource permissions on the data source. |
| permissions.[] Required | object Permission for the resource. |
| permissions.[].actions.[] Required | string |
| sslProperties Optional | object Secure Socket Layer (SSL) properties that apply when Amazon Quick Sight connects to your underlying source. |
| sslProperties.disableSSL Optional | boolean |
| tags Optional | array Contains a map of the key-value pairs for the resource tag or tags assigned to the data source. |
| tags.[] Required | object The key or keys of the key-value pairs for the resource tag or tags assigned |
| to the resource. | |
| tags.[].value Optional | string |
| type Required | string The type of the data source. To return a list of all data sources, use ListDataSources. Use AMAZON_ELASTICSEARCH for Amazon OpenSearch Service. |
| vpcConnectionProperties Optional | object Use this parameter only when you want Amazon Quick Sight to use a VPC connection when connecting to your underlying source. |
| vpcConnectionProperties.vpcConnectionARN Optional | string |
Status
ackResourceMetadata:
arn: string
ownerAccountID: string
partition: string
region: string
conditions:
- lastTransitionTime: string
message: string
reason: string
status: string
type: string
createdTime: string
errorInfo:
message: string
type: string
lastUpdatedTime: string
status: string
| Field | Description |
|---|---|
| ackResourceMetadata Optional | object All CRs managed by ACK have a common Status.ACKResourceMetadata memberthat is used to contain resource sync state, account ownership, constructed ARN for the resource |
| ackResourceMetadata.arn Optional | string ARN is the Amazon Resource Name for the resource. This is a globally-unique identifier and is set only by the ACK service controller once the controller has orchestrated the creation of the resource OR when it has verified that an “adopted” resource (a resource where the ARN annotation was set by the Kubernetes user on the CR) exists and matches the supplied CR’s Spec field values. https://github.com/aws/aws-controllers-k8s/issues/270 |
| ackResourceMetadata.ownerAccountID Required | string OwnerAccountID is the AWS Account ID of the account that owns the backend AWS service API resource. |
| ackResourceMetadata.partition Optional | string Partition is the AWS partition in which the resource exists or will exist |
| ackResourceMetadata.region Required | string Region is the AWS region in which the resource exists or will exist. |
| conditions Optional | array All CRs managed by ACK have a common Status.Conditions member thatcontains a collection of ackv1alpha1.Condition objects that describethe various terminal states of the CR and its backend AWS service API resource |
| conditions.[] Required | object Condition is the common struct used by all CRDs managed by ACK service |
| controllers to indicate terminal states of the CR and its backend AWS | |
| service API resource | |
| conditions.[].message Optional | string A human readable message indicating details about the transition. |
| conditions.[].reason Optional | string The reason for the condition’s last transition. |
| conditions.[].status Optional | string Status of the condition, one of True, False, Unknown. |
| conditions.[].type Optional | string Type is the type of the Condition |
| createdTime Optional | string The time that this data source was created. |
| errorInfo Optional | object Error information from the last update or the creation of the data source. |
| errorInfo.message Optional | string |
| errorInfo.type Optional | string |
| lastUpdatedTime Optional | string The last time that this data source was updated. |
| status Optional | string The status of the data source. Possible values are CREATION_IN_PROGRESS, CREATION_SUCCESSFUL, CREATION_FAILED, UPDATE_IN_PROGRESS, UPDATE_SUCCESSFUL, UPDATE_FAILED, or DELETED. The resource is considered synced when the status is CREATION_SUCCESSFUL or UPDATE_SUCCESSFUL. |