Skip to main content

@swamp/aws/memorydb

v2026.04.23.3

AWS MEMORYDB infrastructure models

Repository

https://github.com/systeminit/swamp-extensions

Labels

awsmemorydbcloudinfrastructure

Contents

Quality score

Verified by Swamp

How well-documented and verifiable this extension is.

100%

Grade A

  • Has README or module doc2/2earned
  • README has a code example1/1earned
  • README is substantive1/1earned
  • Most symbols documented1/1earned
  • No slow types1/1earned
  • Has description1/1earned
  • At least one platform tag (or universal)1/1earned
  • Two or more platform tags (or universal)1/1earned
  • License declared1/1earned
  • Verified public repository2/2earned

Install

$ swamp extension pull @swamp/aws/memorydb

@swamp/aws/memorydb/aclv2026.04.23.2acl.ts

Global Arguments

ArgumentTypeDescription
ACLNamestringThe name of the acl.
UserNames?arrayList of users associated to this acl.
Tags?arrayAn array of key-value pairs to apply to this cluster.
createCreate a MemoryDB ACL
getGet a MemoryDB ACL
ArgumentTypeDescription
identifierstringThe primary identifier of the MemoryDB ACL
updateUpdate a MemoryDB ACL
deleteDelete a MemoryDB ACL
ArgumentTypeDescription
identifierstringThe primary identifier of the MemoryDB ACL
syncSync MemoryDB ACL state from AWS

Resources

state(infinite)— MemoryDB ACL resource state
@swamp/aws/memorydb/clusterv2026.04.23.2cluster.ts

Global Arguments

ArgumentTypeDescription
ClusterNamestringThe name of the cluster. This value must be unique as it also serves as the cluster identifier.
Description?stringAn optional description of the cluster.
MultiRegionClusterName?stringThe name of the Global Datastore, it is generated by MemoryDB adding a prefix to MultiRegionClusterNameSuffix.
NodeTypestringThe compute and memory capacity of the nodes in the cluster.
NumShards?numberThe number of shards the cluster will contain.
NumReplicasPerShard?numberThe number of replicas to apply to each shard. The limit is 5.
SubnetGroupName?stringThe name of the subnet group to be used for the cluster.
SecurityGroupIds?arrayOne or more Amazon VPC security groups associated with this cluster.
MaintenanceWindow?stringSpecifies 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 (24H Clock UTC). The minimum maintenance window is a 60 minute period.
ParameterGroupName?stringThe name of the parameter group associated with the cluster.
SnapshotRetentionLimit?numberThe number of days for which MemoryDB retains automatic snapshots before deleting them. For example, if you set SnapshotRetentionLimit to 5, a snapshot that was taken today is retained for 5 days before being deleted.
SnapshotWindow?stringThe daily time range (in UTC) during which MemoryDB begins taking a daily snapshot of your cluster.
ACLNamestringThe name of the Access Control List to associate with the cluster.
SnsTopicArn?stringThe Amazon Resource Name (ARN) of the Amazon Simple Notification Service (SNS) topic to which notifications are sent.
SnsTopicStatus?stringThe status of the Amazon SNS notification topic. Notifications are sent only if the status is enabled.
TLSEnabled?booleanA flag that enables in-transit encryption when set to true. You cannot modify the value of TransitEncryptionEnabled after the cluster is created. To enable in-transit encryption on a cluster you must set TransitEncryptionEnabled to true when you create a cluster.
DataTiering?stringEnables data tiering. Data tiering is only supported for clusters using the r6gd node type. This parameter must be set when using r6gd nodes.
NetworkType?stringMust be either ipv4 | ipv6 | dual_stack.
IpDiscovery?stringFor clusters wth dual stack NetworkType, IpDiscovery controls the Ip protocol (ipv4 or ipv6) returned by the engine commands such as `cluster info` and `cluster nodes` which are used by clients to connect to the nodes in the cluster.
KmsKeyId?stringThe ID of the KMS key used to encrypt the cluster.
SnapshotArns?arrayA list of Amazon Resource Names (ARN) that uniquely identify the RDB snapshot files stored in Amazon S3. The snapshot files are used to populate the new cluster. The Amazon S3 object name in the ARN cannot contain any commas.
SnapshotName?stringThe name of a snapshot from which to restore data into the new cluster. The snapshot status changes to restoring while the new cluster is being created.
FinalSnapshotName?stringThe user-supplied name of a final cluster snapshot. This is the unique name that identifies the snapshot. MemoryDB creates the snapshot, and then deletes the cluster immediately afterward.
Engine?stringThe engine type used by the cluster.
EngineVersion?stringThe Redis engine version used by the cluster.
AutoMinorVersionUpgrade?booleanA flag that enables automatic minor version upgrade when set to true. You cannot modify the value of AutoMinorVersionUpgrade after the cluster is created. To enable AutoMinorVersionUpgrade on a cluster you must set AutoMinorVersionUpgrade to true when you create a cluster.
Tags?arrayAn array of key-value pairs to apply to this cluster.
createCreate a MemoryDB Cluster
getGet a MemoryDB Cluster
ArgumentTypeDescription
identifierstringThe primary identifier of the MemoryDB Cluster
updateUpdate a MemoryDB Cluster
deleteDelete a MemoryDB Cluster
ArgumentTypeDescription
identifierstringThe primary identifier of the MemoryDB Cluster
syncSync MemoryDB Cluster state from AWS

Resources

state(infinite)— MemoryDB Cluster resource state
@swamp/aws/memorydb/multi-region-clusterv2026.04.23.2multi_region_cluster.ts

Global Arguments

ArgumentTypeDescription
namestringInstance name for this resource (used as the unique identifier in the factory pattern)
MultiRegionClusterNameSuffix?stringThe name of the Multi Region cluster. This value must be unique as it also serves as the multi region cluster identifier.
Description?stringDescription of the multi region cluster.
NodeTypestringThe compute and memory capacity of the nodes in the multi region cluster.
NumShards?numberThe number of shards the multi region cluster will contain.
MultiRegionParameterGroupName?stringThe name of the parameter group associated with the multi region cluster.
TLSEnabled?booleanA flag that enables in-transit encryption when set to true. You cannot modify the value of TransitEncryptionEnabled after the cluster is created. To enable in-transit encryption on a cluster you must set TransitEncryptionEnabled to true when you create a cluster.
Engine?stringThe engine type used by the multi region cluster.
EngineVersion?stringThe Redis engine version used by the multi region cluster.
Tags?arrayAn array of key-value pairs to apply to this multi region cluster.
UpdateStrategy?enumAn enum string value that determines the update strategy for scaling. Possible values are 'COORDINATED' and 'UNCOORDINATED'. Default is 'COORDINATED'.
createCreate a MemoryDB MultiRegionCluster
getGet a MemoryDB MultiRegionCluster
ArgumentTypeDescription
identifierstringThe primary identifier of the MemoryDB MultiRegionCluster
updateUpdate a MemoryDB MultiRegionCluster
deleteDelete a MemoryDB MultiRegionCluster
ArgumentTypeDescription
identifierstringThe primary identifier of the MemoryDB MultiRegionCluster
syncSync MemoryDB MultiRegionCluster state from AWS

Resources

state(infinite)— MemoryDB MultiRegionCluster resource state
@swamp/aws/memorydb/parameter-groupv2026.04.23.2parameter_group.ts

Global Arguments

ArgumentTypeDescription
ParameterGroupNamestringThe name of the parameter group.
FamilystringThe name of the parameter group family that this parameter group is compatible with.
Description?stringA description of the parameter group.
Tags?arrayAn array of key-value pairs to apply to this parameter group.
Parameters?stringAn map of parameter names and values for the parameter update. You must supply at least one parameter name and value; subsequent arguments are optional.
createCreate a MemoryDB ParameterGroup
getGet a MemoryDB ParameterGroup
ArgumentTypeDescription
identifierstringThe primary identifier of the MemoryDB ParameterGroup
updateUpdate a MemoryDB ParameterGroup
deleteDelete a MemoryDB ParameterGroup
ArgumentTypeDescription
identifierstringThe primary identifier of the MemoryDB ParameterGroup
syncSync MemoryDB ParameterGroup state from AWS

Resources

state(infinite)— MemoryDB ParameterGroup resource state
@swamp/aws/memorydb/subnet-groupv2026.04.23.2subnet_group.ts

Global Arguments

ArgumentTypeDescription
SubnetGroupNamestringThe name of the subnet group. This value must be unique as it also serves as the subnet group identifier.
Description?stringAn optional description of the subnet group.
SubnetIdsarrayA list of VPC subnet IDs for the subnet group.
Tags?arrayAn array of key-value pairs to apply to this subnet group.
createCreate a MemoryDB SubnetGroup
getGet a MemoryDB SubnetGroup
ArgumentTypeDescription
identifierstringThe primary identifier of the MemoryDB SubnetGroup
updateUpdate a MemoryDB SubnetGroup
deleteDelete a MemoryDB SubnetGroup
ArgumentTypeDescription
identifierstringThe primary identifier of the MemoryDB SubnetGroup
syncSync MemoryDB SubnetGroup state from AWS

Resources

state(infinite)— MemoryDB SubnetGroup resource state
@swamp/aws/memorydb/userv2026.04.23.2user.ts

Global Arguments

ArgumentTypeDescription
UserNamestringThe name of the user.
AccessString?stringAccess permissions string used for this user account.
AuthenticationMode?object
Tags?arrayAn array of key-value pairs to apply to this user.
createCreate a MemoryDB User
getGet a MemoryDB User
ArgumentTypeDescription
identifierstringThe primary identifier of the MemoryDB User
updateUpdate a MemoryDB User
deleteDelete a MemoryDB User
ArgumentTypeDescription
identifierstringThe primary identifier of the MemoryDB User
syncSync MemoryDB User state from AWS

Resources

state(infinite)— MemoryDB User resource state