Resource: awsQuicksightDataSource
Resource for managing QuickSight Data Source
Example Usage
/*Provider bindings are generated by running cdktf get.
See https://cdk.tf/provider-generation for more details.*/
import * as aws from "./.gen/providers/aws";
new aws.quicksightDataSource.QuicksightDataSource(this, "default", {
dataSourceId: "example-id",
name: "My Cool Data in S3",
parameters: {
s3: {
manifestFileLocation: {
bucket: "my-bucket",
key: "path/to/manifest.json",
},
},
},
type: "S3",
});
Argument Reference
The following arguments are required:
dataSourceId
- (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:
awsAccountId
- (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.sslProperties
- (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 providerdefaultTags
configuration block present, tags with matching keys will overwrite those defined at the provider-level.vpcConnectionProperties
- (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.
credentials Argument Reference
copySourceArn
(Optional, Conflicts withcredentialPair
) - 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, thecredentialPair
from the data source in the ARN is used.credentialPair
(Optional, Conflicts withcopySourceArn
) - Credential pair. See Credential Pair below for more details.
credential_pair Argument Reference
password
- (Required) Password, maximum length of 1024 characters.username
- (Required) User name, maximum length of 64 characters.
parameters Argument Reference
To specify data source connection parameters, exactly one of the following sub-objects must be provided.
amazonElasticsearch
- (Optional) Parameters for connecting to Amazon Elasticsearch.athena
- (Optional) Parameters for connecting to Athena.aurora
- (Optional) Parameters for connecting to Aurora MySQL.auroraPostgresql
- (Optional) Parameters for connecting to Aurora Postgresql.awsIotAnalytics
- (Optional) Parameters for connecting to AWS IOT Analytics.jira
- (Optional) Parameters for connecting to Jira.mariaDb
- (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.serviceNow
- (Optional) Parameters for connecting to ServiceNow.snowflake
- (Optional) Parameters for connecting to Snowflake.spark
- (Optional) Parameters for connecting to Spark.sqlServer
- (Optional) Parameters for connecting to SQL Server.teradata
- (Optional) Parameters for connecting to Teradata.twitter
- (Optional) Parameters for connecting to Twitter.
permission Argument Reference
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.
ssl_properties Argument Reference
disableSsl
- (Required) A Boolean option to control whether SSL should be disabled.
vpc_connection_properties Argument Reference
vpcConnectionArn
- (Required) The Amazon Resource Name (ARN) for the VPC connection.
amazon_elasticsearch Argument Reference
domain
- (Required) The OpenSearch domain.
athena Argument Reference
workGroup
- (Optional) The work-group to which to connect.
aurora Argument Reference
database
- (Required) The database to which to connect.host
- (Required) The host to which to connect.port
- (Required) The port to which to connect.
aurora_postgresql Argument Reference
database
- (Required) The database to which to connect.host
- (Required) The host to which to connect.port
- (Required) The port to which to connect.
aws_iot_analytics Argument Reference
dataSetName
- (Required) The name of the data set to which to connect.
jira fArgument Reference
siteBaseUrl
- (Required) The base URL of the Jira instance's site to which to connect.
maria_db Argument Reference
database
- (Required) The database to which to connect.host
- (Required) The host to which to connect.port
- (Required) The port to which to connect.
mysql Argument Reference
database
- (Required) The database to which to connect.host
- (Required) The host to which to connect.port
- (Required) The port to which to connect.
oracle Argument Reference
database
- (Required) The database to which to connect.host
- (Required) The host to which to connect.port
- (Required) The port to which to connect.
postgresql Argument Reference
database
- (Required) The database to which to connect.host
- (Required) The host to which to connect.port
- (Required) The port to which to connect.
presto Argument Reference
catalog
- (Required) The catalog to which to connect.host
- (Required) The host to which to connect.port
- (Required) The port to which to connect.
rds Argument Reference
database
- (Required) The database to which to connect.instanceId
- (Optional) The instance ID to which to connect.
redshift Argument Reference
clusterId
- (Optional, Required ifhost
andport
are not provided) The ID of the cluster to which to connect.database
- (Required) The database to which to connect.host
- (Optional, Required ifclusterId
is not provided) The host to which to connect.port
- (Optional, Required ifclusterId
is not provided) The port to which to connect.
s3 Argument Reference
manifestFileLocation
- (Required) An object containing the S3 location of the S3 manifest file.
manifest_file_location Argument Reference
bucket
- (Required) The name of the bucket that contains the manifest file.key
- (Required) The key of the manifest file within the bucket.
service_now Argument Reference
siteBaseUrl
- (Required) The base URL of the Jira instance's site to which to connect.
snowflake Argument Reference
database
- (Required) The database to which to connect.host
- (Required) The host to which to connect.warehouse
- (Required) The warehouse to which to connect.
spark Argument Reference
host
- (Required) The host to which to connect.port
- (Required) The warehouse to which to connect.
sql_server Argument Reference
database
- (Required) The database to which to connect.host
- (Required) The host to which to connect.port
- (Required) The warehouse to which to connect.
teradata Argument Reference
database
- (Required) The database to which to connect.host
- (Required) The host to which to connect.port
- (Required) The warehouse to which to connect.
twitter Argument Reference
maxRows
- (Required) The maximum number of rows to query.query
- (Required) The Twitter query to retrieve the data.
Attributes Reference
In addition to all arguments above, the following attributes are exported:
arn
- Amazon Resource Name (ARN) of the data sourcetagsAll
- A map of tags assigned to the resource, including those inherited from the providerdefaultTags
configuration block.
Import
A QuickSight data source can be imported using the AWS account ID, and data source ID name separated by a slash (/
) e.g.,