Scaleway Redis
@sntxrr/scaleway-redisv2026.07.19.1
01README
Manage a Scaleway Managed Database for Redis cluster — sync state, create, update, and delete Redis clusters, and discover clusters in a zone, via the Redis API with X-Auth-Token auth.
02Models
@sntxrr/scaleway-redisv2026.07.19.1scaleway_redis.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| secretKey | string | Scaleway API secret key. Wire with ${{ vault.get(scaleway, SCW_SECRET_KEY) }}. |
| projectId | string | Scaleway Project ID that owns the Redis cluster. |
| zone | string | Availability zone, e.g. fr-par-1, nl-ams-1, pl-waw-1. |
| clusterId? | string | ID of the Managed Redis cluster this model manages. Optional — `create` |
| endpoint? | string | Override the API host. Defaults to https://api.scaleway.com. |
fn sync()
Fetch the Redis cluster's current state (GetCluster).
fn create(name: string, version: string, nodeType: string, userName: string, password: string, clusterSize?: number, tlsEnabled: boolean, tags?: array)
Provision a new Redis cluster (CreateCluster) and snapshot it.
| Argument | Type | Description |
|---|---|---|
| name | string | Name of the new Redis cluster. |
| version | string | Redis engine version, e.g. 7.0.5. |
| nodeType | string | Node type (commercial size), e.g. RED1-MICRO. |
| userName | string | Identifier of the default Redis user. |
| password | string | Password for the default user. Sent only to provision; never stored. |
| clusterSize? | number | Number of nodes (1 for standalone; 3-6 for a cluster). Optional. |
| tlsEnabled | boolean | Whether to generate a TLS certificate for secure connections. |
| tags? | array | Tags to attach to the new cluster. |
fn update(name?: string, tags?: array)
Mutate a Redis cluster's mutable fields (UpdateCluster).
| Argument | Type | Description |
|---|---|---|
| name? | string | New name for the cluster. |
| tags? | array | Replacement set of tags for the cluster. |
fn delete()
Deprovision the Redis cluster (DeleteCluster).
fn list()
Discover all Redis clusters in the zone (factory).
Resources
cluster(infinite)— Snapshot of the Managed Redis cluster's state
03Previous Versions
2026.07.18.1
04Stats
A
100 / 100
Downloads
0
Archive size
10.1 KB
- 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
Repository
https://github.com/sntxrr/swamp-scaleway05Platforms
06Labels