--- # generated by https://github.com/hashicorp/terraform-plugin-docs page_title: "awscc_quicksight_data_source Resource - terraform-provider-awscc" subcategory: "" description: |- Definition of the AWS::QuickSight::DataSource Resource Type. --- # awscc_quicksight_data_source (Resource) Definition of the AWS::QuickSight::DataSource Resource Type. ## Schema ### Optional - `alternate_data_source_parameters` (Attributes List)
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.
Data source credentials. This is a variant type structure. For this structure to be valid, only one of the attributes can be non-null.
(see [below for nested schema](#nestedatt--credentials)) - `data_source_id` (String) - `data_source_parameters` (Attributes)The parameters that Amazon QuickSight 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.
(see [below for nested schema](#nestedatt--data_source_parameters)) - `error_info` (Attributes)Error information for the data source creation or update.
(see [below for nested schema](#nestedatt--error_info)) - `name` (String)A display name for the data source.
- `permissions` (Attributes List)A list of resource permissions on the data source.
(see [below for nested schema](#nestedatt--permissions)) - `ssl_properties` (Attributes)Secure Socket Layer (SSL) properties that apply when QuickSight connects to your underlying data source.
(see [below for nested schema](#nestedatt--ssl_properties)) - `tags` (Attributes List)Contains a map of the key-value pairs for the resource tag or tags assigned to the data source.
(see [below for nested schema](#nestedatt--tags)) - `type` (String) - `vpc_connection_properties` (Attributes)VPC connection properties.
(see [below for nested schema](#nestedatt--vpc_connection_properties)) ### Read-Only - `arn` (String)The Amazon Resource Name (ARN) of the data source.
- `created_time` (String)The time that this data source was created.
- `id` (String) Uniquely identifies the resource. - `last_updated_time` (String)The last time that this data source was updated.
- `status` (String) ### Nested Schema for `alternate_data_source_parameters` Optional: - `amazon_elasticsearch_parameters` (Attributes)Amazon Elasticsearch Service parameters.
(see [below for nested schema](#nestedatt--alternate_data_source_parameters--amazon_elasticsearch_parameters)) - `amazon_open_search_parameters` (Attributes)Amazon OpenSearch Service parameters.
(see [below for nested schema](#nestedatt--alternate_data_source_parameters--amazon_open_search_parameters)) - `athena_parameters` (Attributes)Amazon Athena parameters.
(see [below for nested schema](#nestedatt--alternate_data_source_parameters--athena_parameters)) - `aurora_parameters` (Attributes)Amazon Aurora parameters.
(see [below for nested schema](#nestedatt--alternate_data_source_parameters--aurora_parameters)) - `aurora_postgre_sql_parameters` (Attributes)Amazon Aurora with PostgreSQL compatibility parameters.
(see [below for nested schema](#nestedatt--alternate_data_source_parameters--aurora_postgre_sql_parameters)) - `maria_db_parameters` (Attributes)MariaDB parameters.
(see [below for nested schema](#nestedatt--alternate_data_source_parameters--maria_db_parameters)) - `my_sql_parameters` (Attributes)MySQL parameters.
(see [below for nested schema](#nestedatt--alternate_data_source_parameters--my_sql_parameters)) - `oracle_parameters` (Attributes) (see [below for nested schema](#nestedatt--alternate_data_source_parameters--oracle_parameters)) - `postgre_sql_parameters` (Attributes)PostgreSQL parameters.
(see [below for nested schema](#nestedatt--alternate_data_source_parameters--postgre_sql_parameters)) - `presto_parameters` (Attributes)Presto parameters.
(see [below for nested schema](#nestedatt--alternate_data_source_parameters--presto_parameters)) - `rds_parameters` (Attributes)Amazon RDS parameters.
(see [below for nested schema](#nestedatt--alternate_data_source_parameters--rds_parameters)) - `redshift_parameters` (Attributes)Amazon Redshift parameters. 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.
S3 parameters.
(see [below for nested schema](#nestedatt--alternate_data_source_parameters--s3_parameters)) - `snowflake_parameters` (Attributes)Snowflake parameters.
(see [below for nested schema](#nestedatt--alternate_data_source_parameters--snowflake_parameters)) - `spark_parameters` (Attributes)Spark parameters.
(see [below for nested schema](#nestedatt--alternate_data_source_parameters--spark_parameters)) - `sql_server_parameters` (Attributes)SQL Server parameters.
(see [below for nested schema](#nestedatt--alternate_data_source_parameters--sql_server_parameters)) - `teradata_parameters` (Attributes)Teradata parameters.
(see [below for nested schema](#nestedatt--alternate_data_source_parameters--teradata_parameters)) ### Nested Schema for `alternate_data_source_parameters.amazon_elasticsearch_parameters` Optional: - `domain` (String)The Amazon Elasticsearch Service domain.
### Nested Schema for `alternate_data_source_parameters.amazon_open_search_parameters` Optional: - `domain` (String)The Amazon OpenSearch Service domain.
### Nested Schema for `alternate_data_source_parameters.athena_parameters` Optional: - `work_group` (String)The workgroup that Amazon Athena uses.
### Nested Schema for `alternate_data_source_parameters.aurora_parameters` Optional: - `database` (String)Database.
- `host` (String)Host.
- `port` (Number)Port.
### Nested Schema for `alternate_data_source_parameters.aurora_postgre_sql_parameters` Optional: - `database` (String)Database.
- `host` (String)Host.
- `port` (Number)Port.
### Nested Schema for `alternate_data_source_parameters.maria_db_parameters` Optional: - `database` (String)Database.
- `host` (String)Host.
- `port` (Number)Port.
### Nested Schema for `alternate_data_source_parameters.my_sql_parameters` Optional: - `database` (String)Database.
- `host` (String)Host.
- `port` (Number)Port.
### Nested Schema for `alternate_data_source_parameters.oracle_parameters` Optional: - `database` (String) - `host` (String) - `port` (Number) ### Nested Schema for `alternate_data_source_parameters.postgre_sql_parameters` Optional: - `database` (String)Database.
- `host` (String)Host.
- `port` (Number)Port.
### Nested Schema for `alternate_data_source_parameters.presto_parameters` Optional: - `catalog` (String)Catalog.
- `host` (String)Host.
- `port` (Number)Port.
### Nested Schema for `alternate_data_source_parameters.rds_parameters` Optional: - `database` (String)Database.
- `instance_id` (String)Instance ID.
### Nested Schema for `alternate_data_source_parameters.redshift_parameters` Optional: - `cluster_id` (String)Cluster ID. This field can be blank if the Host
and Port
are
provided.
Database.
- `host` (String)Host. This field can be blank if ClusterId
is provided.
Port. This field can be blank if the ClusterId
is provided.
Amazon S3 manifest file location.
(see [below for nested schema](#nestedatt--alternate_data_source_parameters--s3_parameters--manifest_file_location)) ### Nested Schema for `alternate_data_source_parameters.s3_parameters.manifest_file_location` Optional: - `bucket` (String)Amazon S3 bucket.
- `key` (String)Amazon S3 key that identifies an object.
### Nested Schema for `alternate_data_source_parameters.snowflake_parameters` Optional: - `database` (String)Database.
- `host` (String)Host.
- `warehouse` (String)Warehouse.
### Nested Schema for `alternate_data_source_parameters.spark_parameters` Optional: - `host` (String)Host.
- `port` (Number)Port.
### Nested Schema for `alternate_data_source_parameters.sql_server_parameters` Optional: - `database` (String)Database.
- `host` (String)Host.
- `port` (Number)Port.
### Nested Schema for `alternate_data_source_parameters.teradata_parameters` Optional: - `database` (String)Database.
- `host` (String)Host.
- `port` (Number)Port.
### Nested Schema for `credentials` Optional: - `copy_source_arn` (String)The Amazon Resource Name (ARN) of a data source that has the credential pair that you
want to use. When CopySourceArn
is not null, the credential pair from the
data source in the ARN is used as the credentials for the
DataSourceCredentials
structure.
The combination of user name and password that are used as credentials.
(see [below for nested schema](#nestedatt--credentials--credential_pair)) ### Nested Schema for `credentials.credential_pair` Optional: - `alternate_data_source_parameters` (Attributes List)A set of alternate data source parameters that you want to share for these
credentials. 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 new data source with
the existing credentials. If the AlternateDataSourceParameters
list is
null, the DataSourceParameters
originally used with these
Credentials
is automatically allowed.
Password.
- `username` (String)User name.
### Nested Schema for `credentials.credential_pair.alternate_data_source_parameters` Optional: - `amazon_elasticsearch_parameters` (Attributes)Amazon Elasticsearch Service parameters.
(see [below for nested schema](#nestedatt--credentials--credential_pair--alternate_data_source_parameters--amazon_elasticsearch_parameters)) - `amazon_open_search_parameters` (Attributes)Amazon OpenSearch Service parameters.
(see [below for nested schema](#nestedatt--credentials--credential_pair--alternate_data_source_parameters--amazon_open_search_parameters)) - `athena_parameters` (Attributes)Amazon Athena parameters.
(see [below for nested schema](#nestedatt--credentials--credential_pair--alternate_data_source_parameters--athena_parameters)) - `aurora_parameters` (Attributes)Amazon Aurora parameters.
(see [below for nested schema](#nestedatt--credentials--credential_pair--alternate_data_source_parameters--aurora_parameters)) - `aurora_postgre_sql_parameters` (Attributes)Amazon Aurora with PostgreSQL compatibility parameters.
(see [below for nested schema](#nestedatt--credentials--credential_pair--alternate_data_source_parameters--aurora_postgre_sql_parameters)) - `maria_db_parameters` (Attributes)MariaDB parameters.
(see [below for nested schema](#nestedatt--credentials--credential_pair--alternate_data_source_parameters--maria_db_parameters)) - `my_sql_parameters` (Attributes)MySQL parameters.
(see [below for nested schema](#nestedatt--credentials--credential_pair--alternate_data_source_parameters--my_sql_parameters)) - `oracle_parameters` (Attributes) (see [below for nested schema](#nestedatt--credentials--credential_pair--alternate_data_source_parameters--oracle_parameters)) - `postgre_sql_parameters` (Attributes)PostgreSQL parameters.
(see [below for nested schema](#nestedatt--credentials--credential_pair--alternate_data_source_parameters--postgre_sql_parameters)) - `presto_parameters` (Attributes)Presto parameters.
(see [below for nested schema](#nestedatt--credentials--credential_pair--alternate_data_source_parameters--presto_parameters)) - `rds_parameters` (Attributes)Amazon RDS parameters.
(see [below for nested schema](#nestedatt--credentials--credential_pair--alternate_data_source_parameters--rds_parameters)) - `redshift_parameters` (Attributes)Amazon Redshift parameters. 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.
S3 parameters.
(see [below for nested schema](#nestedatt--credentials--credential_pair--alternate_data_source_parameters--s3_parameters)) - `snowflake_parameters` (Attributes)Snowflake parameters.
(see [below for nested schema](#nestedatt--credentials--credential_pair--alternate_data_source_parameters--snowflake_parameters)) - `spark_parameters` (Attributes)Spark parameters.
(see [below for nested schema](#nestedatt--credentials--credential_pair--alternate_data_source_parameters--spark_parameters)) - `sql_server_parameters` (Attributes)SQL Server parameters.
(see [below for nested schema](#nestedatt--credentials--credential_pair--alternate_data_source_parameters--sql_server_parameters)) - `teradata_parameters` (Attributes)Teradata parameters.
(see [below for nested schema](#nestedatt--credentials--credential_pair--alternate_data_source_parameters--teradata_parameters)) ### Nested Schema for `credentials.credential_pair.alternate_data_source_parameters.teradata_parameters` Optional: - `domain` (String)The Amazon Elasticsearch Service domain.
### Nested Schema for `credentials.credential_pair.alternate_data_source_parameters.teradata_parameters` Optional: - `domain` (String)The Amazon OpenSearch Service domain.
### Nested Schema for `credentials.credential_pair.alternate_data_source_parameters.teradata_parameters` Optional: - `work_group` (String)The workgroup that Amazon Athena uses.
### Nested Schema for `credentials.credential_pair.alternate_data_source_parameters.teradata_parameters` Optional: - `database` (String)Database.
- `host` (String)Host.
- `port` (Number)Port.
### Nested Schema for `credentials.credential_pair.alternate_data_source_parameters.teradata_parameters` Optional: - `database` (String)Database.
- `host` (String)Host.
- `port` (Number)Port.
### Nested Schema for `credentials.credential_pair.alternate_data_source_parameters.teradata_parameters` Optional: - `database` (String)Database.
- `host` (String)Host.
- `port` (Number)Port.
### Nested Schema for `credentials.credential_pair.alternate_data_source_parameters.teradata_parameters` Optional: - `database` (String)Database.
- `host` (String)Host.
- `port` (Number)Port.
### Nested Schema for `credentials.credential_pair.alternate_data_source_parameters.teradata_parameters` Optional: - `database` (String) - `host` (String) - `port` (Number) ### Nested Schema for `credentials.credential_pair.alternate_data_source_parameters.teradata_parameters` Optional: - `database` (String)Database.
- `host` (String)Host.
- `port` (Number)Port.
### Nested Schema for `credentials.credential_pair.alternate_data_source_parameters.teradata_parameters` Optional: - `catalog` (String)Catalog.
- `host` (String)Host.
- `port` (Number)Port.
### Nested Schema for `credentials.credential_pair.alternate_data_source_parameters.teradata_parameters` Optional: - `database` (String)Database.
- `instance_id` (String)Instance ID.
### Nested Schema for `credentials.credential_pair.alternate_data_source_parameters.teradata_parameters` Optional: - `cluster_id` (String)Cluster ID. This field can be blank if the Host
and Port
are
provided.
Database.
- `host` (String)Host. This field can be blank if ClusterId
is provided.
Port. This field can be blank if the ClusterId
is provided.
Amazon S3 manifest file location.
(see [below for nested schema](#nestedatt--credentials--credential_pair--alternate_data_source_parameters--teradata_parameters--manifest_file_location)) ### Nested Schema for `credentials.credential_pair.alternate_data_source_parameters.teradata_parameters.manifest_file_location` Optional: - `bucket` (String)Amazon S3 bucket.
- `key` (String)Amazon S3 key that identifies an object.
### Nested Schema for `credentials.credential_pair.alternate_data_source_parameters.teradata_parameters` Optional: - `database` (String)Database.
- `host` (String)Host.
- `warehouse` (String)Warehouse.
### Nested Schema for `credentials.credential_pair.alternate_data_source_parameters.teradata_parameters` Optional: - `host` (String)Host.
- `port` (Number)Port.
### Nested Schema for `credentials.credential_pair.alternate_data_source_parameters.teradata_parameters` Optional: - `database` (String)Database.
- `host` (String)Host.
- `port` (Number)Port.
### Nested Schema for `credentials.credential_pair.alternate_data_source_parameters.teradata_parameters` Optional: - `database` (String)Database.
- `host` (String)Host.
- `port` (Number)Port.
### Nested Schema for `data_source_parameters` Optional: - `amazon_elasticsearch_parameters` (Attributes)Amazon Elasticsearch Service parameters.
(see [below for nested schema](#nestedatt--data_source_parameters--amazon_elasticsearch_parameters)) - `amazon_open_search_parameters` (Attributes)Amazon OpenSearch Service parameters.
(see [below for nested schema](#nestedatt--data_source_parameters--amazon_open_search_parameters)) - `athena_parameters` (Attributes)Amazon Athena parameters.
(see [below for nested schema](#nestedatt--data_source_parameters--athena_parameters)) - `aurora_parameters` (Attributes)Amazon Aurora parameters.
(see [below for nested schema](#nestedatt--data_source_parameters--aurora_parameters)) - `aurora_postgre_sql_parameters` (Attributes)Amazon Aurora with PostgreSQL compatibility parameters.
(see [below for nested schema](#nestedatt--data_source_parameters--aurora_postgre_sql_parameters)) - `maria_db_parameters` (Attributes)MariaDB parameters.
(see [below for nested schema](#nestedatt--data_source_parameters--maria_db_parameters)) - `my_sql_parameters` (Attributes)MySQL parameters.
(see [below for nested schema](#nestedatt--data_source_parameters--my_sql_parameters)) - `oracle_parameters` (Attributes) (see [below for nested schema](#nestedatt--data_source_parameters--oracle_parameters)) - `postgre_sql_parameters` (Attributes)PostgreSQL parameters.
(see [below for nested schema](#nestedatt--data_source_parameters--postgre_sql_parameters)) - `presto_parameters` (Attributes)Presto parameters.
(see [below for nested schema](#nestedatt--data_source_parameters--presto_parameters)) - `rds_parameters` (Attributes)Amazon RDS parameters.
(see [below for nested schema](#nestedatt--data_source_parameters--rds_parameters)) - `redshift_parameters` (Attributes)Amazon Redshift parameters. 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.
S3 parameters.
(see [below for nested schema](#nestedatt--data_source_parameters--s3_parameters)) - `snowflake_parameters` (Attributes)Snowflake parameters.
(see [below for nested schema](#nestedatt--data_source_parameters--snowflake_parameters)) - `spark_parameters` (Attributes)Spark parameters.
(see [below for nested schema](#nestedatt--data_source_parameters--spark_parameters)) - `sql_server_parameters` (Attributes)SQL Server parameters.
(see [below for nested schema](#nestedatt--data_source_parameters--sql_server_parameters)) - `teradata_parameters` (Attributes)Teradata parameters.
(see [below for nested schema](#nestedatt--data_source_parameters--teradata_parameters)) ### Nested Schema for `data_source_parameters.amazon_elasticsearch_parameters` Optional: - `domain` (String)The Amazon Elasticsearch Service domain.
### Nested Schema for `data_source_parameters.amazon_open_search_parameters` Optional: - `domain` (String)The Amazon OpenSearch Service domain.
### Nested Schema for `data_source_parameters.athena_parameters` Optional: - `work_group` (String)The workgroup that Amazon Athena uses.
### Nested Schema for `data_source_parameters.aurora_parameters` Optional: - `database` (String)Database.
- `host` (String)Host.
- `port` (Number)Port.
### Nested Schema for `data_source_parameters.aurora_postgre_sql_parameters` Optional: - `database` (String)Database.
- `host` (String)Host.
- `port` (Number)Port.
### Nested Schema for `data_source_parameters.maria_db_parameters` Optional: - `database` (String)Database.
- `host` (String)Host.
- `port` (Number)Port.
### Nested Schema for `data_source_parameters.my_sql_parameters` Optional: - `database` (String)Database.
- `host` (String)Host.
- `port` (Number)Port.
### Nested Schema for `data_source_parameters.oracle_parameters` Optional: - `database` (String) - `host` (String) - `port` (Number) ### Nested Schema for `data_source_parameters.postgre_sql_parameters` Optional: - `database` (String)Database.
- `host` (String)Host.
- `port` (Number)Port.
### Nested Schema for `data_source_parameters.presto_parameters` Optional: - `catalog` (String)Catalog.
- `host` (String)Host.
- `port` (Number)Port.
### Nested Schema for `data_source_parameters.rds_parameters` Optional: - `database` (String)Database.
- `instance_id` (String)Instance ID.
### Nested Schema for `data_source_parameters.redshift_parameters` Optional: - `cluster_id` (String)Cluster ID. This field can be blank if the Host
and Port
are
provided.
Database.
- `host` (String)Host. This field can be blank if ClusterId
is provided.
Port. This field can be blank if the ClusterId
is provided.
Amazon S3 manifest file location.
(see [below for nested schema](#nestedatt--data_source_parameters--s3_parameters--manifest_file_location)) ### Nested Schema for `data_source_parameters.s3_parameters.manifest_file_location` Optional: - `bucket` (String)Amazon S3 bucket.
- `key` (String)Amazon S3 key that identifies an object.
### Nested Schema for `data_source_parameters.snowflake_parameters` Optional: - `database` (String)Database.
- `host` (String)Host.
- `warehouse` (String)Warehouse.
### Nested Schema for `data_source_parameters.spark_parameters` Optional: - `host` (String)Host.
- `port` (Number)Port.
### Nested Schema for `data_source_parameters.sql_server_parameters` Optional: - `database` (String)Database.
- `host` (String)Host.
- `port` (Number)Port.
### Nested Schema for `data_source_parameters.teradata_parameters` Optional: - `database` (String)Database.
- `host` (String)Host.
- `port` (Number)Port.
### Nested Schema for `error_info` Optional: - `message` (String)Error message.
- `type` (String) ### Nested Schema for `permissions` Optional: - `actions` (List of String)The IAM action to grant or revoke permissions on.
- `principal` (String)The Amazon Resource Name (ARN) of the principal. This can be one of the following:
The ARN of an Amazon QuickSight user or group associated with a data source or dataset. (This is common.)
The ARN of an Amazon QuickSight user, group, or namespace associated with an analysis, dashboard, template, or theme. (This is common.)
The ARN of an AWS account root: This is an IAM ARN rather than a QuickSight ARN. Use this option only to share resources (templates) across AWS accounts. (This is less common.)
A Boolean option to control whether SSL should be disabled.
### Nested Schema for `tags` Optional: - `key` (String)Tag key.
- `value` (String)Tag value.
### Nested Schema for `vpc_connection_properties` Optional: - `vpc_connection_arn` (String)The Amazon Resource Name (ARN) for the VPC connection.
## Import Import is supported using the following syntax: ```shell $ terraform import awscc_quicksight_data_source.example