DataSource
The structure of a data source.
Contents
Note
In the following list, the required parameters are described first.
- AlternateDataSourceParameters
-
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 theAlternateDataSourceParameters
allow list. If the structures are an exact match, the request is allowed to use the credentials from this existing data source. If theAlternateDataSourceParameters
list is null, theCredentials
originally used with thisDataSourceParameters
are automatically allowed.Type: Array of DataSourceParameters objects
Array Members: Minimum number of 1 item. Maximum number of 50 items.
Required: No
- Arn
-
The Amazon Resource Name (ARN) of the data source.
Type: String
Required: No
- CreatedTime
-
The time that this data source was created.
Type: Timestamp
Required: No
- DataSourceId
-
The ID of the data source. This ID is unique per AWS Region for each AWS account.
Type: String
Required: No
- DataSourceParameters
-
The parameters that Amazon QuickSight uses to connect to your underlying source. This is a variant type structure. For this structure to be valid, only one of the attributes can be non-null.
Type: DataSourceParameters object
Required: No
- ErrorInfo
-
Error information from the last update or the creation of the data source.
Type: DataSourceErrorInfo object
Required: No
- LastUpdatedTime
-
The last time that this data source was updated.
Type: Timestamp
Required: No
- Name
-
A display name for the data source.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 128.
Required: No
- SecretArn
-
The Amazon Resource Name (ARN) of the secret associated with the data source in Amazon Secrets Manager.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 2048.
Pattern:
^arn:[-a-z0-9]*:secretsmanager:[-a-z0-9]*:[0-9]{12}:secret:.+
Required: No
- SslProperties
-
Secure Socket Layer (SSL) properties that apply when Amazon QuickSight connects to your underlying source.
Type: SslProperties object
Required: No
- Status
-
The HTTP status of the request.
Type: String
Valid Values:
CREATION_IN_PROGRESS | CREATION_SUCCESSFUL | CREATION_FAILED | UPDATE_IN_PROGRESS | UPDATE_SUCCESSFUL | UPDATE_FAILED | DELETED
Required: No
- Type
-
The type of the data source. This type indicates which database engine the data source connects to.
Type: String
Valid Values:
ADOBE_ANALYTICS | AMAZON_ELASTICSEARCH | ATHENA | AURORA | AURORA_POSTGRESQL | AWS_IOT_ANALYTICS | GITHUB | JIRA | MARIADB | MYSQL | ORACLE | POSTGRESQL | PRESTO | REDSHIFT | S3 | SALESFORCE | SERVICENOW | SNOWFLAKE | SPARK | SQLSERVER | TERADATA | TWITTER | TIMESTREAM | AMAZON_OPENSEARCH | EXASOL | DATABRICKS | STARBURST | TRINO | BIGQUERY
Required: No
- VpcConnectionProperties
-
The VPC connection information. You need to use this parameter only when you want Amazon QuickSight to use a VPC connection when connecting to your underlying source.
Type: VpcConnectionProperties object
Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following: