Amazon Athena Redis connector

Deploy the connector to your Amazon Web Services account using the Athena console or the Amazon Serverless Application Repository. For more information, see Deploying a data source connector or Using the Amazon Serverless Application Repository to deploy a data source connector.

Set up a VPC and a security group before you use this connector. For more information, see Creating a VPC for a data source connector.

spill_bucket – Specifies the Amazon S3 bucket for data that exceeds Lambda function limits.

spill_prefix – (Optional) Defaults to a subfolder in the specified spill_bucket called athena-federation-spill. We recommend that you configure an Amazon S3 storage lifecycle on this location to delete spills older than a predetermined number of days or hours.

spill_put_request_headers – (Optional) A JSON encoded map of request headers and values for the Amazon S3 putObject request that is used for spilling (for example, {"x-amz-server-side-encryption" : "AES256"}). For other possible headers, see PutObject in the Amazon Simple Storage Service API Reference.

kms_key_id – (Optional) By default, any data that is spilled to Amazon S3 is encrypted using the AES-GCM authenticated encryption mode and a randomly generated key. To have your Lambda function use stronger encryption keys generated by KMS like a7e63k4b-8loc-40db-a2a1-4d0en2cd8331, you can specify a KMS key ID.

disable_spill_encryption – (Optional) When set to True, disables spill encryption. Defaults to False so that data that is spilled to S3 is encrypted using AES-GCM – either using a randomly generated key or KMS to generate keys. Disabling spill encryption can improve performance, especially if your spill location uses server-side encryption.

glue_catalog – (Optional) Use this option to specify a cross-account Amazon Glue catalog. By default, the connector attempts to get metadata from its own Amazon Glue account.

redis-endpoint – (Required) The hostname:port:password of the Redis server that contains data for this table (for example, athena-federation-demo.cache.amazonaws.com:6379) Alternatively, you can store the endpoint, or part of the endpoint, in Amazon Secrets Manager by using ${Secret_Name} as the table property value.

redis-keys-zset – (Required if redis-key-prefix is not used) A comma-separated list of keys whose value is a zset (for example, active-orders,pending-orders). Each of the values in the zset is treated as a key that is part of the table. Either the redis-keys-zset property or the redis-key-prefix property must be set.

redis-key-prefix – (Required if redis-keys-zset is not used) A comma separated list of key prefixes to scan for values in the table (for example, accounts-*,acct-). Either the redis-key-prefix property or the redis-keys-zset property must be set.

redis-value-type – (Required) Defines how the values for the keys defined by either redis-key-prefix or redis-keys-zset are mapped to your table. A literal maps to a single column. A zset also maps to a single column, but each key can store many rows. A hash enables each key to be a row with multiple columns (for example, a hash, literal, or zset.)

redis-ssl-flag – (Optional) When True, creates a Redis connection that uses SSL/TLS. The default is False.

redis-cluster-flag – (Optional) When True, enables support for clustered Redis instances. The default is False.

redis-db-number – (Optional) Applies only to standalone, non-clustered instances.) Set this number (for example 1, 2, or 3) to read from a non-default Redis database. The default is Redis logical database 0. This number does not refer to a database in Athena or Amazon Glue, but to a Redis logical database. For more information, see SELECT index in the Redis documentation.

String

Hash

Sorted Set (ZSet)

Amazon S3 write access – The connector requires write access to a location in Amazon S3 in order to spill results from large queries.

Athena GetQueryExecution – The connector uses this permission to fast-fail when the upstream Athena query has terminated.

Amazon Glue Data Catalog – The Redis connector requires read only access to the Amazon Glue Data Catalog to obtain schema information.

CloudWatch Logs – The connector requires access to CloudWatch Logs for storing logs.

Amazon Secrets Manager read access – If you choose to store Redis endpoint details in Secrets Manager, you must grant the connector access to those secrets.

VPC access – The connector requires the ability to attach and detach interfaces to your VPC so that it can connect to it and communicate with your Redis instances.