Aws/memorydb
@swamp/aws/memorydbv2026.07.25.1
01README
AWS MEMORYDB infrastructure models
02Models
acl.tsv2026.06.15.1
Global Arguments
| Argument | Type | Description |
|---|---|---|
| accessKeyId? | string | AWS access key ID; overrides AWS_ACCESS_KEY_ID environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| secretAccessKey? | string | AWS secret access key; overrides AWS_SECRET_ACCESS_KEY environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| sessionToken? | string | AWS session token for temporary credentials; overrides AWS_SESSION_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| region? | string | AWS region; overrides AWS_REGION / AWS_DEFAULT_REGION environment variables and ~/.aws/config profile region. Defaults to us-east-1. |
| ACLName | string | The name of the acl. |
| UserNames? | array | List of users associated to this acl. |
| Tags? | array | An array of key-value pairs to apply to this cluster. |
fn create()
Create a MemoryDB ACL
fn get(identifier: string)
Get a MemoryDB ACL
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the MemoryDB ACL |
fn update()
Update a MemoryDB ACL
fn delete(identifier: string)
Delete a MemoryDB ACL
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the MemoryDB ACL |
fn sync()
Sync MemoryDB ACL state from AWS
cluster.tsv2026.06.15.1
Global Arguments
| Argument | Type | Description |
|---|---|---|
| accessKeyId? | string | AWS access key ID; overrides AWS_ACCESS_KEY_ID environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| secretAccessKey? | string | AWS secret access key; overrides AWS_SECRET_ACCESS_KEY environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| sessionToken? | string | AWS session token for temporary credentials; overrides AWS_SESSION_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| region? | string | AWS region; overrides AWS_REGION / AWS_DEFAULT_REGION environment variables and ~/.aws/config profile region. Defaults to us-east-1. |
| ClusterName | string | The name of the cluster. This value must be unique as it also serves as the cluster identifier. |
| Description? | string | An optional description of the cluster. |
| MultiRegionClusterName? | string | The name of the Global Datastore, it is generated by MemoryDB adding a prefix to MultiRegionClusterNameSuffix. |
| NodeType | string | The compute and memory capacity of the nodes in the cluster. |
| NumShards? | number | The number of shards the cluster will contain. |
| NumReplicasPerShard? | number | The number of replicas to apply to each shard. The limit is 5. |
| SubnetGroupName? | string | The name of the subnet group to be used for the cluster. |
| SecurityGroupIds? | array | One or more Amazon VPC security groups associated with this cluster. |
| MaintenanceWindow? | string | 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 (24H Clock UTC). The minimum maintenance window is a 60 minute period. |
| ParameterGroupName? | string | The name of the parameter group associated with the cluster. |
| SnapshotRetentionLimit? | number | The 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? | string | The daily time range (in UTC) during which MemoryDB begins taking a daily snapshot of your cluster. |
| ACLName | string | The name of the Access Control List to associate with the cluster. |
| SnsTopicArn? | string | The Amazon Resource Name (ARN) of the Amazon Simple Notification Service (SNS) topic to which notifications are sent. |
| SnsTopicStatus? | string | The status of the Amazon SNS notification topic. Notifications are sent only if the status is enabled. |
| TLSEnabled? | boolean | A 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? | record | Enables data tiering. Data tiering is only supported for clusters using the r6gd node type. This parameter must be set when using r6gd nodes. |
| NetworkType? | record | Must be either ipv4 | ipv6 | dual_stack. |
| IpDiscovery? | record | For 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? | string | The ID of the KMS key used to encrypt the cluster. |
| SnapshotArns? | array | A 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? | string | The 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? | string | The 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? | string | The engine type used by the cluster. |
| EngineVersion? | string | The Redis engine version used by the cluster. |
| AutoMinorVersionUpgrade? | boolean | A 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? | array | An array of key-value pairs to apply to this cluster. |
fn create()
Create a MemoryDB Cluster
fn get(identifier: string)
Get a MemoryDB Cluster
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the MemoryDB Cluster |
fn update()
Update a MemoryDB Cluster
fn delete(identifier: string)
Delete a MemoryDB Cluster
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the MemoryDB Cluster |
fn sync()
Sync MemoryDB Cluster state from AWS
multi_region_cluster.tsv2026.06.15.1
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
| accessKeyId? | string | AWS access key ID; overrides AWS_ACCESS_KEY_ID environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| secretAccessKey? | string | AWS secret access key; overrides AWS_SECRET_ACCESS_KEY environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| sessionToken? | string | AWS session token for temporary credentials; overrides AWS_SESSION_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| region? | string | AWS region; overrides AWS_REGION / AWS_DEFAULT_REGION environment variables and ~/.aws/config profile region. Defaults to us-east-1. |
| MultiRegionClusterNameSuffix? | string | The name of the Multi Region cluster. This value must be unique as it also serves as the multi region cluster identifier. |
| Description? | string | Description of the multi region cluster. |
| NodeType | string | The compute and memory capacity of the nodes in the multi region cluster. |
| NumShards? | number | The number of shards the multi region cluster will contain. |
| MultiRegionParameterGroupName? | string | The name of the parameter group associated with the multi region cluster. |
| TLSEnabled? | boolean | A 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? | string | The engine type used by the multi region cluster. |
| EngineVersion? | string | The Redis engine version used by the multi region cluster. |
| Tags? | array | An array of key-value pairs to apply to this multi region cluster. |
| UpdateStrategy? | enum | An enum string value that determines the update strategy for scaling. Possible values are 'COORDINATED' and 'UNCOORDINATED'. Default is 'COORDINATED'. |
fn create()
Create a MemoryDB MultiRegionCluster
fn get(identifier: string)
Get a MemoryDB MultiRegionCluster
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the MemoryDB MultiRegionCluster |
fn update()
Update a MemoryDB MultiRegionCluster
fn delete(identifier: string)
Delete a MemoryDB MultiRegionCluster
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the MemoryDB MultiRegionCluster |
fn sync()
Sync MemoryDB MultiRegionCluster state from AWS
multi_region_parameter_group.tsv2026.07.24.1
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
| accessKeyId? | string | AWS access key ID; overrides AWS_ACCESS_KEY_ID environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| secretAccessKey? | string | AWS secret access key; overrides AWS_SECRET_ACCESS_KEY environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| sessionToken? | string | AWS session token for temporary credentials; overrides AWS_SESSION_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| region? | string | AWS region; overrides AWS_REGION / AWS_DEFAULT_REGION environment variables and ~/.aws/config profile region. Defaults to us-east-1. |
fn get(identifier: string)
Get a MemoryDB MultiRegionParameterGroup
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the MemoryDB MultiRegionParameterGroup |
fn sync()
Sync MemoryDB MultiRegionParameterGroup state from AWS
parameter_group.tsv2026.06.15.1
Global Arguments
| Argument | Type | Description |
|---|---|---|
| accessKeyId? | string | AWS access key ID; overrides AWS_ACCESS_KEY_ID environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| secretAccessKey? | string | AWS secret access key; overrides AWS_SECRET_ACCESS_KEY environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| sessionToken? | string | AWS session token for temporary credentials; overrides AWS_SESSION_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| region? | string | AWS region; overrides AWS_REGION / AWS_DEFAULT_REGION environment variables and ~/.aws/config profile region. Defaults to us-east-1. |
| ParameterGroupName | string | The name of the parameter group. |
| Family | string | The name of the parameter group family that this parameter group is compatible with. |
| Description? | string | A description of the parameter group. |
| Tags? | array | An array of key-value pairs to apply to this parameter group. |
| Parameters? | record | An map of parameter names and values for the parameter update. You must supply at least one parameter name and value; subsequent arguments are optional. |
fn create()
Create a MemoryDB ParameterGroup
fn get(identifier: string)
Get a MemoryDB ParameterGroup
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the MemoryDB ParameterGroup |
fn update()
Update a MemoryDB ParameterGroup
fn delete(identifier: string)
Delete a MemoryDB ParameterGroup
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the MemoryDB ParameterGroup |
fn sync()
Sync MemoryDB ParameterGroup state from AWS
reserved_node.tsv2026.07.24.1
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
| accessKeyId? | string | AWS access key ID; overrides AWS_ACCESS_KEY_ID environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| secretAccessKey? | string | AWS secret access key; overrides AWS_SECRET_ACCESS_KEY environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| sessionToken? | string | AWS session token for temporary credentials; overrides AWS_SESSION_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| region? | string | AWS region; overrides AWS_REGION / AWS_DEFAULT_REGION environment variables and ~/.aws/config profile region. Defaults to us-east-1. |
fn get(identifier: string)
Get a MemoryDB ReservedNode
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the MemoryDB ReservedNode |
fn sync()
Sync MemoryDB ReservedNode state from AWS
subnet_group.tsv2026.06.15.1
Global Arguments
| Argument | Type | Description |
|---|---|---|
| accessKeyId? | string | AWS access key ID; overrides AWS_ACCESS_KEY_ID environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| secretAccessKey? | string | AWS secret access key; overrides AWS_SECRET_ACCESS_KEY environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| sessionToken? | string | AWS session token for temporary credentials; overrides AWS_SESSION_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| region? | string | AWS region; overrides AWS_REGION / AWS_DEFAULT_REGION environment variables and ~/.aws/config profile region. Defaults to us-east-1. |
| SubnetGroupName | string | The name of the subnet group. This value must be unique as it also serves as the subnet group identifier. |
| Description? | string | An optional description of the subnet group. |
| SubnetIds | array | A list of VPC subnet IDs for the subnet group. |
| Tags? | array | An array of key-value pairs to apply to this subnet group. |
fn create()
Create a MemoryDB SubnetGroup
fn get(identifier: string)
Get a MemoryDB SubnetGroup
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the MemoryDB SubnetGroup |
fn update()
Update a MemoryDB SubnetGroup
fn delete(identifier: string)
Delete a MemoryDB SubnetGroup
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the MemoryDB SubnetGroup |
fn sync()
Sync MemoryDB SubnetGroup state from AWS
user.tsv2026.06.15.1
Global Arguments
| Argument | Type | Description |
|---|---|---|
| accessKeyId? | string | AWS access key ID; overrides AWS_ACCESS_KEY_ID environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| secretAccessKey? | string | AWS secret access key; overrides AWS_SECRET_ACCESS_KEY environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| sessionToken? | string | AWS session token for temporary credentials; overrides AWS_SESSION_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| region? | string | AWS region; overrides AWS_REGION / AWS_DEFAULT_REGION environment variables and ~/.aws/config profile region. Defaults to us-east-1. |
| UserName | string | The name of the user. |
| AccessString? | string | Access permissions string used for this user account. |
| AuthenticationMode? | object | Type of authentication strategy for this user. |
| Tags? | array | An array of key-value pairs to apply to this user. |
fn create()
Create a MemoryDB User
fn get(identifier: string)
Get a MemoryDB User
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the MemoryDB User |
fn update()
Update a MemoryDB User
fn delete(identifier: string)
Delete a MemoryDB User
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the MemoryDB User |
fn sync()
Sync MemoryDB User state from AWS
03Previous Versions
2026.07.24.1
- Added: multi_region_parameter_group, reserved_node
2026.07.20.1
2026.07.18.3
2026.07.18.2
2026.06.15.1
- Updated: acl, cluster, multi_region_cluster, parameter_group, subnet_group, user
2026.06.08.2
- Updated: acl, cluster, multi_region_cluster, parameter_group, subnet_group, user
2026.06.06.1
- Updated: acl, cluster, multi_region_cluster, parameter_group, subnet_group, user
Added 1, removed 6 models
2026.05.27.1
- Updated: cluster, parameter_group
2026.04.23.3
2026.04.23.2
- Updated: acl, cluster, multi_region_cluster, parameter_group, subnet_group, user
2026.04.03.2
- Updated: acl, cluster, multi_region_cluster, parameter_group, subnet_group, user
2026.03.19.1
- Updated: acl, cluster, multi_region_cluster, parameter_group, subnet_group, user
2026.03.16.1
- Updated: acl, cluster, multi_region_cluster, parameter_group, subnet_group, user
2026.03.10.5
04Stats
A
100 / 100
Downloads
1
Archive size
1.8 MB
Verified by Swamp
- Has README or module doc2/2earned
- README has a code example1/1earned
- README is substantive1/1earned
- Most symbols documented1/1earned
- No slow types (deprecated)1/1earned
- Dependencies pass trust audit2/2earned
- Has description1/1earned
- Platform support declared (or universal)2/2earned
- License declared1/1earned
- Verified public repository2/2earned
05Platforms
06Labels