memorydb
This component provisions an AWS MemoryDB cluster. MemoryDB is a fully managed, Redis-compatible, in-memory database service.
While Redis is commonly used as a cache, MemoryDB is designed to also function well as a vector database. This makes it appropriate for AI model backends.
Usage
Stack Level: Regional
Example
Here's an example snippet for how to use this component:
components:
terraform:
vpc:
vars:
availability_zones:
- "a"
- "b"
- "c"
ipv4_primary_cidr_block: "10.111.0.0/18"
memorydb:
vars: {}
Variables
Required Variables
Optional Variables
admin_username
(string
) optionalThe username for the MemoryDB admin
Default value:
"admin"
auto_minor_version_upgrade
(bool
) optionalIndicates that minor engine upgrades will be applied automatically to the cluster during the maintenance window
Default value:
true
engine_version
(string
) optionalThe version of the Redis engine to use
Default value:
"6.2"
maintenance_window
(string
) optionalThe weekly time range during which system maintenance can occur
Default value:
null
node_type
(string
) optionalThe compute and memory capacity of the nodes in the cluster
Default value:
"db.r6g.large"
num_replicas_per_shard
(number
) optionalThe number of replicas per shard
Default value:
1
num_shards
(number
) optionalThe number of shards in the cluster
Default value:
1
parameter_group_family
(string
) optionalThe name of the parameter group family
Default value:
"memorydb_redis6"
parameters
(map(string)
) optionalKey-value mapping of parameters to apply to the parameter group
Default value:
{ }
port
(number
) optionalThe port on which the cluster accepts connections
Default value:
6379
security_group_ids
(list(string)
) optionalList of security group IDs to associate with the MemoryDB cluster
Default value:
[ ]
snapshot_arns
(list(string)
) optionalList of ARNs for the snapshots to be restored. NOTE: destroys the existing cluster. Use for restoring.
Default value:
[ ]
snapshot_retention_limit
(number
) optionalThe number of days for which MemoryDB retains automatic snapshots before deleting them
Default value:
null
snapshot_window
(string
) optionalThe daily time range during which MemoryDB begins taking daily snapshots
Default value:
null
sns_topic_arn
(string
) optionalThe ARN of the SNS topic to send notifications to
Default value:
null
ssm_kms_key_id
(string
) optionalThe KMS key ID to use for SSM parameter encryption. If not specified, the default key will be used.
Default value:
null
ssm_parameter_name
(string
) optionalThe name of the SSM parameter to store the password in. If not specified, the password will be stored in
/{context.id}/admin_password
Default value:
""
tls_enabled
(bool
) optionalIndicates whether Transport Layer Security (TLS) encryption is enabled for the cluster
Default value:
true
vpc_component_name
(string
) optionalThe name of the VPC component. This is used to pick out subnets for the MemoryDB cluster
Default value:
"vpc"