Resource for managing QuickSight Data Source
resource "aws_quicksight_data_source" "default" {
data_source_id = "example-id"
name = "My Cool Data in S3"
parameters {
s3 {
manifest_file_location {
bucket = "my-bucket"
key = "path/to/manifest.json"
}
}
}
type = "S3"
}
The following arguments are required:
data_source_id
- (Required, Forces new resource) An identifier for the data source.name
- (Required) A name for the data source, maximum of 128 characters.parameters
- (Required) The parameters used to connect to this data source (exactly one).type
- (Required) The type of the data source. See the AWS Documentation for the complete list of valid values.The following arguments are optional:
aws_account_id
- (Optional, Forces new resource) The ID for the AWS account that the data source is in. Currently, you use the ID for the AWS account that contains your Amazon QuickSight account.credentials
- (Optional) The credentials Amazon QuickSight uses to connect to your underlying source. Currently, only credentials based on user name and password are supported. See Credentials below for more details.permission
- (Optional) A set of resource permissions on the data source. Maximum of 64 items. See Permission below for more details.ssl_properties
- (Optional) Secure Socket Layer (SSL) properties that apply when Amazon QuickSight connects to your underlying source. See SSL Properties below for more details.tags
- (Optional) Key-value map of resource tags. If configured with a provider default_tags
configuration block present, tags with matching keys will overwrite those defined at the provider-level.vpc_connection_properties
- (Optional) Use this parameter only when you want Amazon QuickSight to use a VPC connection when connecting to your underlying source. See VPC Connection Properties below for more details.copy_source_arn
(Optional, Conflicts with credential_pair
) - The Amazon Resource Name (ARN) of a data source that has the credential pair that you want to use.
When the value is not null, the credential_pair
from the data source in the ARN is used.credential_pair
(Optional, Conflicts with copy_source_arn
) - Credential pair. See Credential Pair below for more details.password
- (Required) Password, maximum length of 1024 characters.username
- (Required) User name, maximum length of 64 characters.To specify data source connection parameters, exactly one of the following sub-objects must be provided.
amazon_elasticsearch
- (Optional) Parameters for connecting to Amazon Elasticsearch.athena
- (Optional) Parameters for connecting to Athena.aurora
- (Optional) Parameters for connecting to Aurora MySQL.aurora_postgresql
- (Optional) Parameters for connecting to Aurora Postgresql.aws_iot_analytics
- (Optional) Parameters for connecting to AWS IOT Analytics.jira
- (Optional) Parameters for connecting to Jira.maria_db
- (Optional) Parameters for connecting to MariaDB.mysql
- (Optional) Parameters for connecting to MySQL.oracle
- (Optional) Parameters for connecting to Oracle.postgresql
- (Optional) Parameters for connecting to Postgresql.presto
- (Optional) Parameters for connecting to Presto.rds
- (Optional) Parameters for connecting to RDS.redshift
- (Optional) Parameters for connecting to Redshift.s3
- (Optional) Parameters for connecting to S3.service_now
- (Optional) Parameters for connecting to ServiceNow.snowflake
- (Optional) Parameters for connecting to Snowflake.spark
- (Optional) Parameters for connecting to Spark.sql_server
- (Optional) Parameters for connecting to SQL Server.teradata
- (Optional) Parameters for connecting to Teradata.twitter
- (Optional) Parameters for connecting to Twitter.actions
- (Required) Set of IAM actions to grant or revoke permissions on. Max of 16 items.principal
- (Required) The Amazon Resource Name (ARN) of the principal.disable_ssl
- (Required) A Boolean option to control whether SSL should be disabled.vpc_connection_arn
- (Required) The Amazon Resource Name (ARN) for the VPC connection.domain
- (Required) The OpenSearch domain.work_group
- (Optional) The work-group to which to connect.database
- (Required) The database to which to connect.host
- (Required) The host to which to connect.port
- (Required) The port to which to connect.database
- (Required) The database to which to connect.host
- (Required) The host to which to connect.port
- (Required) The port to which to connect.data_set_name
- (Required) The name of the data set to which to connect.site_base_url
- (Required) The base URL of the Jira instance's site to which to connect.database
- (Required) The database to which to connect.host
- (Required) The host to which to connect.port
- (Required) The port to which to connect.database
- (Required) The database to which to connect.host
- (Required) The host to which to connect.port
- (Required) The port to which to connect.database
- (Required) The database to which to connect.host
- (Required) The host to which to connect.port
- (Required) The port to which to connect.database
- (Required) The database to which to connect.host
- (Required) The host to which to connect.port
- (Required) The port to which to connect.catalog
- (Required) The catalog to which to connect.host
- (Required) The host to which to connect.port
- (Required) The port to which to connect.database
- (Required) The database to which to connect.instance_id
- (Optional) The instance ID to which to connect.cluster_id
- (Optional, Required if host
and port
are not provided) The ID of the cluster to which to connect.database
- (Required) The database to which to connect.host
- (Optional, Required if cluster_id
is not provided) The host to which to connect.port
- (Optional, Required if cluster_id
is not provided) The port to which to connect.manifest_file_location
- (Required) An object containing the S3 location of the S3 manifest file.bucket
- (Required) The name of the bucket that contains the manifest file.key
- (Required) The key of the manifest file within the bucket.site_base_url
- (Required) The base URL of the Jira instance's site to which to connect.database
- (Required) The database to which to connect.host
- (Required) The host to which to connect.warehouse
- (Required) The warehouse to which to connect.host
- (Required) The host to which to connect.port
- (Required) The warehouse to which to connect.database
- (Required) The database to which to connect.host
- (Required) The host to which to connect.port
- (Required) The warehouse to which to connect.database
- (Required) The database to which to connect.host
- (Required) The host to which to connect.port
- (Required) The warehouse to which to connect.max_rows
- (Required) The maximum number of rows to query.query
- (Required) The Twitter query to retrieve the data.This resource exports the following attributes in addition to the arguments above:
arn
- Amazon Resource Name (ARN) of the data sourcetags_all
- A map of tags assigned to the resource, including those inherited from the provider default_tags
configuration block.In Terraform v1.5.0 and later, use an import
block to import a QuickSight data source using the AWS account ID, and data source ID separated by a slash (/
). For example:
import {
to = aws_quicksight_data_source.example
id = "123456789123/my-data-source-id"
}
Using terraform import
, import a QuickSight data source using the AWS account ID, and data source ID separated by a slash (/
). For example:
% terraform import aws_quicksight_data_source.example 123456789123/my-data-source-id