Module library

MemoryDB

Terraform module to create AWS MemoryDB resources

Inputs

40 / 47
acl_nameoptionalstring

Name of ACL to be created if `create_acl` is `true`, otherwise its the name of an existing ACL to use if `create_acl` is `false`

Defaultnull
acl_tagsoptionalmap(string)

Additional tags for the ACL created

Default{}
acl_use_name_prefixoptionalbool

Determines whether `acl_name` is used as a prefix

Defaultfalse
acl_user_namesoptionallist(string)

List of externally created user names to associate with the ACL

Default[]
auto_minor_version_upgradeoptionalbool

When set to `true`, the cluster will automatically receive minor engine version upgrades after launch. Defaults to `true`

Defaultnull
createoptionalbool

Determines whether resources will be created - affects all resources

Defaulttrue
create_acloptionalbool

Determines whether to create ACL specified

Defaulttrue
create_parameter_groupoptionalbool

Determines whether to create parameter group specified

Defaulttrue
create_subnet_groupoptionalbool

Determines whether to create subnet group specified

Defaulttrue
create_usersoptionalbool

Determines whether to create users specified

Defaulttrue
data_tieringoptionalbool

Must be set to `true` when using a data tiering node type

Defaultnull
descriptionoptionalstring

Description for the cluster. Defaults to `Managed by Terraform`

Defaultnull
engineoptionalstring

The engine that will run on your nodes. Supported values are `redis` and `valkey`

Defaultnull
engine_versionoptionalstring

Version number of the engine to be used for the cluster. Downgrades are not supported

Defaultnull
final_snapshot_nameoptionalstring

Name of the final cluster snapshot to be created when this resource is deleted. If omitted, no final snapshot will be made

Defaultnull
ip_discoveryoptionalstring

Mechanism that the cluster uses to discover IP addresses. Valid values are ipv4 and ipv6. Defaults to ipv4. To specify ipv6, network_type must be ipv6 or dual_stack

Defaultnull
kms_key_arnoptionalstring

ARN of the KMS key used to encrypt the cluster at rest

Defaultnull
maintenance_windowoptionalstring

Specifies the weekly time range during which maintenance on the cluster is performed. It is specified as a range in the format `ddd:hh24:mi-ddd:hh24:mi`

Defaultnull
multi_region_cluster_nameoptionalstring

The multi region cluster identifier if part of a multi region cluster

Defaultnull
nameoptionalstring

Cluster name - also default name used on all resources if more specific resource names are not provided

Default""
network_typeoptionalstring

IP address type for the cluster. Valid values are ipv4, ipv6 and dual_stack. Defaults to ipv4

Defaultnull
node_typeoptionalstring

The compute and memory capacity of the nodes in the cluster. See AWS documentation on [supported node types](https://docs.aws.amazon.com/memorydb/latest/devguide/nodes.supportedtypes.html) as well as [vertical scaling](https://docs.aws.amazon.com/memorydb/latest/devguide/cluster-vertical-scaling.htm…

Defaultnull
num_replicas_per_shardoptionalnumber

The number of replicas to apply to each shard, up to a maximum of 5. Defaults to `1` (i.e. 2 nodes per shard)

Defaultnull
num_shardsoptionalnumber

The number of shards in the cluster. Defaults to `1`

Defaultnull
parameter_group_descriptionoptionalstring

Description for the parameter group. Defaults to `Managed by Terraform`

Defaultnull
parameter_group_familyoptionalstring

The engine version that the parameter group can be used with

Defaultnull
parameter_group_nameoptionalstring

Name of parameter group to be created if `create_parameter_group` is `true`, otherwise its the name of an existing parameter group to use if `create_parameter_group` is `false`

Defaultnull
parameter_group_parametersoptionallist(map(string))

A list of parameter maps to apply

Default[]
parameter_group_tagsoptionalmap(string)

Additional tags for the parameter group created

Default{}
parameter_group_use_name_prefixoptionalbool

Determines whether `parameter_group_name` is used as a prefix

Defaultfalse
portoptionalnumber

The port number on which each of the nodes accepts connections. Defaults to `6379`

Defaultnull
regionoptionalstring

Region where this resource will be managed. Defaults to the Region set in the provider configuration

Defaultnull
security_group_idsoptionallist(string)

Set of VPC Security Group ID-s to associate with this cluster

Defaultnull
snapshot_arnsoptionallist(string)

List of ARN-s that uniquely identify RDB snapshot files stored in S3. The snapshot files will be used to populate the new cluster

Defaultnull
snapshot_nameoptionalstring

The name of a snapshot from which to restore data into the new cluster

Defaultnull
snapshot_retention_limitoptionalnumber

The number of days for which MemoryDB retains automatic snapshots before deleting them. When set to `0`, automatic backups are disabled. Defaults to `0`

Defaultnull
snapshot_windowoptionalstring

The daily time range (in UTC) during which MemoryDB begins taking a daily snapshot of your shard. Example: `05:00-09:00`

Defaultnull
sns_topic_arnoptionalstring

ARN of the SNS topic to which cluster notifications are sent

Defaultnull
subnet_group_descriptionoptionalstring

Description for the subnet group. Defaults to `Managed by Terraform`

Defaultnull
subnet_group_nameoptionalstring

Name of subnet group to be created if `create_subnet_group` is `true`, otherwise its the name of an existing subnet group to use if `create_subnet_group` is `false`

Defaultnull

All 47 are optional — the module deploys with none of them set. Showing 40, so the site stays a static download — the remaining 7 are in the source.

Outputs

15
acl_arn

The ARN of the ACL

acl_id

Name of the ACL

acl_minimum_engine_version

The minimum engine version supported by the ACL

cluster_arn

The ARN of the cluster

cluster_endpoint_address

DNS hostname of the cluster configuration endpoint

cluster_endpoint_port

Port number that the cluster configuration endpoint is listening on

cluster_engine_patch_version

Patch version number of the Redis engine used by the cluster

cluster_id

Cluster name

cluster_shards

Set of shards in this cluster

parameter_group_arn

The ARN of the parameter group

parameter_group_id

Name of the parameter group

subnet_group_arn

ARN of the subnet group

subnet_group_id

Name of the subnet group

subnet_group_vpc_id

The VPC in which the subnet group exists

users

Map of attributes for the users created

What the agent wires into the next module. An edge on the architecture diagram is one of these consumed by something else.