Definition of the AWS::QuickSight::DataSource Resource Type.
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.
aws_account_id
(String)credentials
(Attributes) 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)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)error_info
(Attributes) Error information for the data source creation or update.
(see below for nested schema)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)ssl_properties
(Attributes) Secure Socket Layer (SSL) properties that apply when QuickSight connects to your underlying data source.
(see below for nested schema)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)type
(String)vpc_connection_properties
(Attributes) VPC connection properties.
(see below for nested schema)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)alternate_data_source_parameters
Optional:
amazon_elasticsearch_parameters
(Attributes) Amazon Elasticsearch Service parameters.
(see below for nested schema)amazon_open_search_parameters
(Attributes) Amazon OpenSearch Service parameters.
(see below for nested schema)athena_parameters
(Attributes) Amazon Athena parameters.
(see below for nested schema)aurora_parameters
(Attributes) Amazon Aurora parameters.
(see below for nested schema)aurora_postgre_sql_parameters
(Attributes) Amazon Aurora with PostgreSQL compatibility parameters.
(see below for nested schema)databricks_parameters
(Attributes) Databricks parameters.
(see below for nested schema)maria_db_parameters
(Attributes) MariaDB parameters.
(see below for nested schema)my_sql_parameters
(Attributes) MySQL parameters.
(see below for nested schema)oracle_parameters
(Attributes) (see below for nested schema)postgre_sql_parameters
(Attributes) PostgreSQL parameters.
(see below for nested schema)presto_parameters
(Attributes) Presto parameters.
(see below for nested schema)rds_parameters
(Attributes) Amazon RDS parameters.
(see below for nested schema)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
(Attributes) S3 parameters.
(see below for nested schema)snowflake_parameters
(Attributes) Snowflake parameters.
(see below for nested schema)spark_parameters
(Attributes) Spark parameters.
(see below for nested schema)sql_server_parameters
(Attributes) SQL Server parameters.
(see below for nested schema)starburst_parameters
(Attributes) Starburst parameters.
(see below for nested schema)teradata_parameters
(Attributes) Teradata parameters.
(see below for nested schema)trino_parameters
(Attributes) Trino parameters.
(see below for nested schema)alternate_data_source_parameters.amazon_elasticsearch_parameters
Required:
domain
(String) The Amazon Elasticsearch Service domain.
alternate_data_source_parameters.amazon_open_search_parameters
Required:
domain
(String) The Amazon OpenSearch Service domain.
alternate_data_source_parameters.athena_parameters
Optional:
role_arn
(String) Use the RoleArn
structure to override an account-wide role for a specific Athena data source. For example, say an account administrator has turned off all Athena access with an account-wide role. The administrator can then use RoleArn
to bypass the account-wide role and allow Athena access for the single Athena data source that is specified in the structure, even if the account-wide role forbidding Athena access is still active.
work_group
(String) The workgroup that Amazon Athena uses.
alternate_data_source_parameters.aurora_parameters
Required:
database
(String) Database.
host
(String) Host.
port
(Number) Port.
alternate_data_source_parameters.aurora_postgre_sql_parameters
Required:
database
(String) Database.
host
(String) Host.
port
(Number) Port.
alternate_data_source_parameters.databricks_parameters
Required:
host
(String) Host.
port
(Number) Port.
sql_endpoint_path
(String) The HTTP Path of the Databricks data source.
alternate_data_source_parameters.maria_db_parameters
Required:
database
(String) Database.
host
(String) Host.
port
(Number) Port.
alternate_data_source_parameters.my_sql_parameters
Required:
database
(String) Database.
host
(String) Host.
port
(Number) Port.
alternate_data_source_parameters.oracle_parameters
Required:
database
(String)host
(String)port
(Number)alternate_data_source_parameters.postgre_sql_parameters
Required:
database
(String) Database.
host
(String) Host.
port
(Number) Port.
alternate_data_source_parameters.presto_parameters
Required:
catalog
(String) Catalog.
host
(String) Host.
port
(Number) Port.
alternate_data_source_parameters.rds_parameters
Required:
database
(String) Database.
instance_id
(String) Instance ID.
alternate_data_source_parameters.redshift_parameters
Required:
database
(String) Database.
Optional:
cluster_id
(String) Cluster ID. This field can be blank if the Host
and Port
are
provided.
host
(String) Host. This field can be blank if ClusterId
is provided.
port
(Number) Port. This field can be blank if the ClusterId
is provided.
alternate_data_source_parameters.s3_parameters
Required:
manifest_file_location
(Attributes) Amazon S3 manifest file location.
(see below for nested schema)Optional:
role_arn
(String) Use the RoleArn
structure to override an account-wide role for a specific S3 data source. For example, say an account administrator has turned off all S3 access with an account-wide role. The administrator can then use RoleArn
to bypass the account-wide role and allow S3 access for the single S3 data source that is specified in the structure, even if the account-wide role forbidding S3 access is still active.
alternate_data_source_parameters.s3_parameters.manifest_file_location
Required:
bucket
(String) Amazon S3 bucket.
key
(String) Amazon S3 key that identifies an object.
alternate_data_source_parameters.snowflake_parameters
Required:
database
(String) Database.
host
(String) Host.
warehouse
(String) Warehouse.
alternate_data_source_parameters.spark_parameters
Required:
host
(String) Host.
port
(Number) Port.
alternate_data_source_parameters.sql_server_parameters
Required:
database
(String) Database.
host
(String) Host.
port
(Number) Port.
alternate_data_source_parameters.starburst_parameters
Required:
catalog
(String) Catalog.
host
(String) Host.
port
(Number) Port.
Optional:
product_type
(String)alternate_data_source_parameters.teradata_parameters
Required:
database
(String) Database.
host
(String) Host.
port
(Number) Port.
alternate_data_source_parameters.trino_parameters
Required:
catalog
(String) Catalog.
host
(String) Host.
port
(Number) Port.
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.
credential_pair
(Attributes) The combination of user name and password that are used as credentials.
(see below for nested schema)secret_arn
(String) The Amazon Resource Name (ARN) of the secret associated with the data source in Amazon Secrets Manager.
credentials.credential_pair
Required:
password
(String) Password.
username
(String) User name.
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.
credentials.credential_pair.alternate_data_source_parameters
Optional:
amazon_elasticsearch_parameters
(Attributes) Amazon Elasticsearch Service parameters.
(see below for nested schema)amazon_open_search_parameters
(Attributes) Amazon OpenSearch Service parameters.
(see below for nested schema)athena_parameters
(Attributes) Amazon Athena parameters.
(see below for nested schema)aurora_parameters
(Attributes) Amazon Aurora parameters.
(see below for nested schema)aurora_postgre_sql_parameters
(Attributes) Amazon Aurora with PostgreSQL compatibility parameters.
(see below for nested schema)databricks_parameters
(Attributes) Databricks parameters.
(see below for nested schema)maria_db_parameters
(Attributes) MariaDB parameters.
(see below for nested schema)my_sql_parameters
(Attributes) MySQL parameters.
(see below for nested schema)oracle_parameters
(Attributes) (see below for nested schema)postgre_sql_parameters
(Attributes) PostgreSQL parameters.
(see below for nested schema)presto_parameters
(Attributes) Presto parameters.
(see below for nested schema)rds_parameters
(Attributes) Amazon RDS parameters.
(see below for nested schema)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
(Attributes) S3 parameters.
(see below for nested schema)snowflake_parameters
(Attributes) Snowflake parameters.
(see below for nested schema)spark_parameters
(Attributes) Spark parameters.
(see below for nested schema)sql_server_parameters
(Attributes) SQL Server parameters.
(see below for nested schema)starburst_parameters
(Attributes) Starburst parameters.
(see below for nested schema)teradata_parameters
(Attributes) Teradata parameters.
(see below for nested schema)trino_parameters
(Attributes) Trino parameters.
(see below for nested schema)credentials.credential_pair.alternate_data_source_parameters.amazon_elasticsearch_parameters
Required:
domain
(String) The Amazon Elasticsearch Service domain.
credentials.credential_pair.alternate_data_source_parameters.amazon_open_search_parameters
Required:
domain
(String) The Amazon OpenSearch Service domain.
credentials.credential_pair.alternate_data_source_parameters.athena_parameters
Optional:
role_arn
(String) Use the RoleArn
structure to override an account-wide role for a specific Athena data source. For example, say an account administrator has turned off all Athena access with an account-wide role. The administrator can then use RoleArn
to bypass the account-wide role and allow Athena access for the single Athena data source that is specified in the structure, even if the account-wide role forbidding Athena access is still active.
work_group
(String) The workgroup that Amazon Athena uses.
credentials.credential_pair.alternate_data_source_parameters.aurora_parameters
Required:
database
(String) Database.
host
(String) Host.
port
(Number) Port.
credentials.credential_pair.alternate_data_source_parameters.aurora_postgre_sql_parameters
Required:
database
(String) Database.
host
(String) Host.
port
(Number) Port.
credentials.credential_pair.alternate_data_source_parameters.databricks_parameters
Required:
host
(String) Host.
port
(Number) Port.
sql_endpoint_path
(String) The HTTP Path of the Databricks data source.
credentials.credential_pair.alternate_data_source_parameters.maria_db_parameters
Required:
database
(String) Database.
host
(String) Host.
port
(Number) Port.
credentials.credential_pair.alternate_data_source_parameters.my_sql_parameters
Required:
database
(String) Database.
host
(String) Host.
port
(Number) Port.
credentials.credential_pair.alternate_data_source_parameters.oracle_parameters
Required:
database
(String)host
(String)port
(Number)credentials.credential_pair.alternate_data_source_parameters.postgre_sql_parameters
Required:
database
(String) Database.
host
(String) Host.
port
(Number) Port.
credentials.credential_pair.alternate_data_source_parameters.presto_parameters
Required:
catalog
(String) Catalog.
host
(String) Host.
port
(Number) Port.
credentials.credential_pair.alternate_data_source_parameters.rds_parameters
Required:
database
(String) Database.
instance_id
(String) Instance ID.
credentials.credential_pair.alternate_data_source_parameters.redshift_parameters
Required:
database
(String) Database.
Optional:
cluster_id
(String) Cluster ID. This field can be blank if the Host
and Port
are
provided.
host
(String) Host. This field can be blank if ClusterId
is provided.
port
(Number) Port. This field can be blank if the ClusterId
is provided.
credentials.credential_pair.alternate_data_source_parameters.s3_parameters
Required:
manifest_file_location
(Attributes) Amazon S3 manifest file location.
(see below for nested schema)Optional:
role_arn
(String) Use the RoleArn
structure to override an account-wide role for a specific S3 data source. For example, say an account administrator has turned off all S3 access with an account-wide role. The administrator can then use RoleArn
to bypass the account-wide role and allow S3 access for the single S3 data source that is specified in the structure, even if the account-wide role forbidding S3 access is still active.
credentials.credential_pair.alternate_data_source_parameters.trino_parameters.manifest_file_location
Required:
bucket
(String) Amazon S3 bucket.
key
(String) Amazon S3 key that identifies an object.
credentials.credential_pair.alternate_data_source_parameters.snowflake_parameters
Required:
database
(String) Database.
host
(String) Host.
warehouse
(String) Warehouse.
credentials.credential_pair.alternate_data_source_parameters.spark_parameters
Required:
host
(String) Host.
port
(Number) Port.
credentials.credential_pair.alternate_data_source_parameters.sql_server_parameters
Required:
database
(String) Database.
host
(String) Host.
port
(Number) Port.
credentials.credential_pair.alternate_data_source_parameters.starburst_parameters
Required:
catalog
(String) Catalog.
host
(String) Host.
port
(Number) Port.
Optional:
product_type
(String)credentials.credential_pair.alternate_data_source_parameters.teradata_parameters
Required:
database
(String) Database.
host
(String) Host.
port
(Number) Port.
credentials.credential_pair.alternate_data_source_parameters.trino_parameters
Required:
catalog
(String) Catalog.
host
(String) Host.
port
(Number) Port.
data_source_parameters
Optional:
amazon_elasticsearch_parameters
(Attributes) Amazon Elasticsearch Service parameters.
(see below for nested schema)amazon_open_search_parameters
(Attributes) Amazon OpenSearch Service parameters.
(see below for nested schema)athena_parameters
(Attributes) Amazon Athena parameters.
(see below for nested schema)aurora_parameters
(Attributes) Amazon Aurora parameters.
(see below for nested schema)aurora_postgre_sql_parameters
(Attributes) Amazon Aurora with PostgreSQL compatibility parameters.
(see below for nested schema)databricks_parameters
(Attributes) Databricks parameters.
(see below for nested schema)maria_db_parameters
(Attributes) MariaDB parameters.
(see below for nested schema)my_sql_parameters
(Attributes) MySQL parameters.
(see below for nested schema)oracle_parameters
(Attributes) (see below for nested schema)postgre_sql_parameters
(Attributes) PostgreSQL parameters.
(see below for nested schema)presto_parameters
(Attributes) Presto parameters.
(see below for nested schema)rds_parameters
(Attributes) Amazon RDS parameters.
(see below for nested schema)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
(Attributes) S3 parameters.
(see below for nested schema)snowflake_parameters
(Attributes) Snowflake parameters.
(see below for nested schema)spark_parameters
(Attributes) Spark parameters.
(see below for nested schema)sql_server_parameters
(Attributes) SQL Server parameters.
(see below for nested schema)starburst_parameters
(Attributes) Starburst parameters.
(see below for nested schema)teradata_parameters
(Attributes) Teradata parameters.
(see below for nested schema)trino_parameters
(Attributes) Trino parameters.
(see below for nested schema)data_source_parameters.amazon_elasticsearch_parameters
Required:
domain
(String) The Amazon Elasticsearch Service domain.
data_source_parameters.amazon_open_search_parameters
Required:
domain
(String) The Amazon OpenSearch Service domain.
data_source_parameters.athena_parameters
Optional:
role_arn
(String) Use the RoleArn
structure to override an account-wide role for a specific Athena data source. For example, say an account administrator has turned off all Athena access with an account-wide role. The administrator can then use RoleArn
to bypass the account-wide role and allow Athena access for the single Athena data source that is specified in the structure, even if the account-wide role forbidding Athena access is still active.
work_group
(String) The workgroup that Amazon Athena uses.
data_source_parameters.aurora_parameters
Required:
database
(String) Database.
host
(String) Host.
port
(Number) Port.
data_source_parameters.aurora_postgre_sql_parameters
Required:
database
(String) Database.
host
(String) Host.
port
(Number) Port.
data_source_parameters.databricks_parameters
Required:
host
(String) Host.
port
(Number) Port.
sql_endpoint_path
(String) The HTTP Path of the Databricks data source.
data_source_parameters.maria_db_parameters
Required:
database
(String) Database.
host
(String) Host.
port
(Number) Port.
data_source_parameters.my_sql_parameters
Required:
database
(String) Database.
host
(String) Host.
port
(Number) Port.
data_source_parameters.oracle_parameters
Required:
database
(String)host
(String)port
(Number)data_source_parameters.postgre_sql_parameters
Required:
database
(String) Database.
host
(String) Host.
port
(Number) Port.
data_source_parameters.presto_parameters
Required:
catalog
(String) Catalog.
host
(String) Host.
port
(Number) Port.
data_source_parameters.rds_parameters
Required:
database
(String) Database.
instance_id
(String) Instance ID.
data_source_parameters.redshift_parameters
Required:
database
(String) Database.
Optional:
cluster_id
(String) Cluster ID. This field can be blank if the Host
and Port
are
provided.
host
(String) Host. This field can be blank if ClusterId
is provided.
port
(Number) Port. This field can be blank if the ClusterId
is provided.
data_source_parameters.s3_parameters
Required:
manifest_file_location
(Attributes) Amazon S3 manifest file location.
(see below for nested schema)Optional:
role_arn
(String) Use the RoleArn
structure to override an account-wide role for a specific S3 data source. For example, say an account administrator has turned off all S3 access with an account-wide role. The administrator can then use RoleArn
to bypass the account-wide role and allow S3 access for the single S3 data source that is specified in the structure, even if the account-wide role forbidding S3 access is still active.
data_source_parameters.s3_parameters.manifest_file_location
Required:
bucket
(String) Amazon S3 bucket.
key
(String) Amazon S3 key that identifies an object.
data_source_parameters.snowflake_parameters
Required:
database
(String) Database.
host
(String) Host.
warehouse
(String) Warehouse.
data_source_parameters.spark_parameters
Required:
host
(String) Host.
port
(Number) Port.
data_source_parameters.sql_server_parameters
Required:
database
(String) Database.
host
(String) Host.
port
(Number) Port.
data_source_parameters.starburst_parameters
Required:
catalog
(String) Catalog.
host
(String) Host.
port
(Number) Port.
Optional:
product_type
(String)data_source_parameters.teradata_parameters
Required:
database
(String) Database.
host
(String) Host.
port
(Number) Port.
data_source_parameters.trino_parameters
Required:
catalog
(String) Catalog.
host
(String) Host.
port
(Number) Port.
error_info
Optional:
message
(String) Error message.
type
(String)permissions
Required:
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.)
ssl_properties
Optional:
disable_ssl
(Boolean) A Boolean option to control whether SSL should be disabled.
tags
Required:
key
(String) Tag key.
value
(String) Tag value.
vpc_connection_properties
Required:
vpc_connection_arn
(String) The Amazon Resource Name (ARN) for the VPC connection.
Import is supported using the following syntax:
$ terraform import awscc_quicksight_data_source.example <resource ID>