Docs Home
scaleway.redis.Cluster
Explore with Pulumi AI
Creates and manages Scaleway Redis™ clusters. For more information refer to the API documentation.
Example Usage
Basic
import * as pulumi from "@pulumi/pulumi";
import * as scaleway from "@pulumiverse/scaleway";
const main = new scaleway.redis.Cluster("main", {
name: "test_redis_basic",
version: "6.2.7",
nodeType: "RED1-MICRO",
userName: "my_initial_user",
password: "thiZ_is_v&ry_s3cret",
tags: [
"test",
"redis",
],
clusterSize: 1,
tlsEnabled: true,
acls: [{
ip: "0.0.0.0/0",
description: "Allow all",
}],
});
import pulumi
import pulumiverse_scaleway as scaleway
main = scaleway.redis.Cluster("main",
name="test_redis_basic",
version="6.2.7",
node_type="RED1-MICRO",
user_name="my_initial_user",
password="thiZ_is_v&ry_s3cret",
tags=[
"test",
"redis",
],
cluster_size=1,
tls_enabled=True,
acls=[{
"ip": "0.0.0.0/0",
"description": "Allow all",
}])
package main
import (
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
"github.com/pulumiverse/pulumi-scaleway/sdk/go/scaleway/redis"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := redis.NewCluster(ctx, "main", &redis.ClusterArgs{
Name: pulumi.String("test_redis_basic"),
Version: pulumi.String("6.2.7"),
NodeType: pulumi.String("RED1-MICRO"),
UserName: pulumi.String("my_initial_user"),
Password: pulumi.String("thiZ_is_v&ry_s3cret"),
Tags: pulumi.StringArray{
pulumi.String("test"),
pulumi.String("redis"),
},
ClusterSize: pulumi.Int(1),
TlsEnabled: pulumi.Bool(true),
Acls: redis.ClusterAclArray{
&redis.ClusterAclArgs{
Ip: pulumi.String("0.0.0.0/0"),
Description: pulumi.String("Allow all"),
},
},
})
if err != nil {
return err
}
return nil
})
}
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Scaleway = Pulumiverse.Scaleway;
return await Deployment.RunAsync(() =>
{
var main = new Scaleway.Redis.Cluster("main", new()
{
Name = "test_redis_basic",
Version = "6.2.7",
NodeType = "RED1-MICRO",
UserName = "my_initial_user",
Password = "thiZ_is_v&ry_s3cret",
Tags = new[]
{
"test",
"redis",
},
ClusterSize = 1,
TlsEnabled = true,
Acls = new[]
{
new Scaleway.Redis.Inputs.ClusterAclArgs
{
Ip = "0.0.0.0/0",
Description = "Allow all",
},
},
});
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.scaleway.redis.Cluster;
import com.pulumi.scaleway.redis.ClusterArgs;
import com.pulumi.scaleway.redis.inputs.ClusterAclArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
public static void main(String[] args) {
Pulumi.run(App::stack);
}
public static void stack(Context ctx) {
var main = new Cluster("main", ClusterArgs.builder()
.name("test_redis_basic")
.version("6.2.7")
.nodeType("RED1-MICRO")
.userName("my_initial_user")
.password("thiZ_is_v&ry_s3cret")
.tags(
"test",
"redis")
.clusterSize(1)
.tlsEnabled("true")
.acls(ClusterAclArgs.builder()
.ip("0.0.0.0/0")
.description("Allow all")
.build())
.build());
}
}
resources:
main:
type: scaleway:redis:Cluster
properties:
name: test_redis_basic
version: 6.2.7
nodeType: RED1-MICRO
userName: my_initial_user
password: thiZ_is_v&ry_s3cret
tags:
- test
- redis
clusterSize: 1
tlsEnabled: 'true'
acls:
- ip: 0.0.0.0/0
description: Allow all
With settings
import * as pulumi from "@pulumi/pulumi";
import * as scaleway from "@pulumiverse/scaleway";
const main = new scaleway.redis.Cluster("main", {
name: "test_redis_basic",
version: "6.2.7",
nodeType: "RED1-MICRO",
userName: "my_initial_user",
password: "thiZ_is_v&ry_s3cret",
settings: {
maxclients: "1000",
"tcp-keepalive": "120",
},
});
import pulumi
import pulumiverse_scaleway as scaleway
main = scaleway.redis.Cluster("main",
name="test_redis_basic",
version="6.2.7",
node_type="RED1-MICRO",
user_name="my_initial_user",
password="thiZ_is_v&ry_s3cret",
settings={
"maxclients": "1000",
"tcp-keepalive": "120",
})
package main
import (
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
"github.com/pulumiverse/pulumi-scaleway/sdk/go/scaleway/redis"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := redis.NewCluster(ctx, "main", &redis.ClusterArgs{
Name: pulumi.String("test_redis_basic"),
Version: pulumi.String("6.2.7"),
NodeType: pulumi.String("RED1-MICRO"),
UserName: pulumi.String("my_initial_user"),
Password: pulumi.String("thiZ_is_v&ry_s3cret"),
Settings: pulumi.StringMap{
"maxclients": pulumi.String("1000"),
"tcp-keepalive": pulumi.String("120"),
},
})
if err != nil {
return err
}
return nil
})
}
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Scaleway = Pulumiverse.Scaleway;
return await Deployment.RunAsync(() =>
{
var main = new Scaleway.Redis.Cluster("main", new()
{
Name = "test_redis_basic",
Version = "6.2.7",
NodeType = "RED1-MICRO",
UserName = "my_initial_user",
Password = "thiZ_is_v&ry_s3cret",
Settings =
{
{ "maxclients", "1000" },
{ "tcp-keepalive", "120" },
},
});
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.scaleway.redis.Cluster;
import com.pulumi.scaleway.redis.ClusterArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
public static void main(String[] args) {
Pulumi.run(App::stack);
}
public static void stack(Context ctx) {
var main = new Cluster("main", ClusterArgs.builder()
.name("test_redis_basic")
.version("6.2.7")
.nodeType("RED1-MICRO")
.userName("my_initial_user")
.password("thiZ_is_v&ry_s3cret")
.settings(Map.ofEntries(
Map.entry("maxclients", "1000"),
Map.entry("tcp-keepalive", "120")
))
.build());
}
}
resources:
main:
type: scaleway:redis:Cluster
properties:
name: test_redis_basic
version: 6.2.7
nodeType: RED1-MICRO
userName: my_initial_user
password: thiZ_is_v&ry_s3cret
settings:
maxclients: '1000'
tcp-keepalive: '120'
With a Private Network
import * as pulumi from "@pulumi/pulumi";
import * as scaleway from "@pulumiverse/scaleway";
const pn = new scaleway.network.PrivateNetwork("pn", {name: "private-network"});
const main = new scaleway.redis.Cluster("main", {
name: "test_redis_endpoints",
version: "6.2.7",
nodeType: "RED1-MICRO",
userName: "my_initial_user",
password: "thiZ_is_v&ry_s3cret",
clusterSize: 1,
privateNetworks: [{
id: pn.id,
serviceIps: ["10.12.1.1/20"],
}],
}, {
dependsOn: [pn],
});
import pulumi
import pulumiverse_scaleway as scaleway
pn = scaleway.network.PrivateNetwork("pn", name="private-network")
main = scaleway.redis.Cluster("main",
name="test_redis_endpoints",
version="6.2.7",
node_type="RED1-MICRO",
user_name="my_initial_user",
password="thiZ_is_v&ry_s3cret",
cluster_size=1,
private_networks=[{
"id": pn.id,
"service_ips": ["10.12.1.1/20"],
}],
opts = pulumi.ResourceOptions(depends_on=[pn]))
package main
import (
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
"github.com/pulumiverse/pulumi-scaleway/sdk/go/scaleway/network"
"github.com/pulumiverse/pulumi-scaleway/sdk/go/scaleway/redis"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
pn, err := network.NewPrivateNetwork(ctx, "pn", &network.PrivateNetworkArgs{
Name: pulumi.String("private-network"),
})
if err != nil {
return err
}
_, err = redis.NewCluster(ctx, "main", &redis.ClusterArgs{
Name: pulumi.String("test_redis_endpoints"),
Version: pulumi.String("6.2.7"),
NodeType: pulumi.String("RED1-MICRO"),
UserName: pulumi.String("my_initial_user"),
Password: pulumi.String("thiZ_is_v&ry_s3cret"),
ClusterSize: pulumi.Int(1),
PrivateNetworks: redis.ClusterPrivateNetworkArray{
&redis.ClusterPrivateNetworkArgs{
Id: pn.ID(),
ServiceIps: pulumi.StringArray{
pulumi.String("10.12.1.1/20"),
},
},
},
}, pulumi.DependsOn([]pulumi.Resource{
pn,
}))
if err != nil {
return err
}
return nil
})
}
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Scaleway = Pulumiverse.Scaleway;
return await Deployment.RunAsync(() =>
{
var pn = new Scaleway.Network.PrivateNetwork("pn", new()
{
Name = "private-network",
});
var main = new Scaleway.Redis.Cluster("main", new()
{
Name = "test_redis_endpoints",
Version = "6.2.7",
NodeType = "RED1-MICRO",
UserName = "my_initial_user",
Password = "thiZ_is_v&ry_s3cret",
ClusterSize = 1,
PrivateNetworks = new[]
{
new Scaleway.Redis.Inputs.ClusterPrivateNetworkArgs
{
Id = pn.Id,
ServiceIps = new[]
{
"10.12.1.1/20",
},
},
},
}, new CustomResourceOptions
{
DependsOn =
{
pn,
},
});
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.scaleway.network.PrivateNetwork;
import com.pulumi.scaleway.network.PrivateNetworkArgs;
import com.pulumi.scaleway.redis.Cluster;
import com.pulumi.scaleway.redis.ClusterArgs;
import com.pulumi.scaleway.redis.inputs.ClusterPrivateNetworkArgs;
import com.pulumi.resources.CustomResourceOptions;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
public static void main(String[] args) {
Pulumi.run(App::stack);
}
public static void stack(Context ctx) {
var pn = new PrivateNetwork("pn", PrivateNetworkArgs.builder()
.name("private-network")
.build());
var main = new Cluster("main", ClusterArgs.builder()
.name("test_redis_endpoints")
.version("6.2.7")
.nodeType("RED1-MICRO")
.userName("my_initial_user")
.password("thiZ_is_v&ry_s3cret")
.clusterSize(1)
.privateNetworks(ClusterPrivateNetworkArgs.builder()
.id(pn.id())
.serviceIps("10.12.1.1/20")
.build())
.build(), CustomResourceOptions.builder()
.dependsOn(pn)
.build());
}
}
resources:
pn:
type: scaleway:network:PrivateNetwork
properties:
name: private-network
main:
type: scaleway:redis:Cluster
properties:
name: test_redis_endpoints
version: 6.2.7
nodeType: RED1-MICRO
userName: my_initial_user
password: thiZ_is_v&ry_s3cret
clusterSize: 1
privateNetworks:
- id: ${pn.id}
serviceIps:
- 10.12.1.1/20
options:
dependsOn:
- ${pn}
Create Cluster Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new Cluster(name: string, args: ClusterArgs, opts?: CustomResourceOptions);@overload
def Cluster(resource_name: str,
args: ClusterArgs,
opts: Optional[ResourceOptions] = None)
@overload
def Cluster(resource_name: str,
opts: Optional[ResourceOptions] = None,
password: Optional[str] = None,
version: Optional[str] = None,
user_name: Optional[str] = None,
node_type: Optional[str] = None,
project_id: Optional[str] = None,
private_networks: Optional[Sequence[ClusterPrivateNetworkArgs]] = None,
acls: Optional[Sequence[ClusterAclArgs]] = None,
public_network: Optional[ClusterPublicNetworkArgs] = None,
settings: Optional[Mapping[str, str]] = None,
tags: Optional[Sequence[str]] = None,
tls_enabled: Optional[bool] = None,
name: Optional[str] = None,
cluster_size: Optional[int] = None,
zone: Optional[str] = None)func NewCluster(ctx *Context, name string, args ClusterArgs, opts ...ResourceOption) (*Cluster, error)public Cluster(string name, ClusterArgs args, CustomResourceOptions? opts = null)
public Cluster(String name, ClusterArgs args)
public Cluster(String name, ClusterArgs args, CustomResourceOptions options)
type: scaleway:redis:Cluster
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
Parameters
- name string
- The unique name of the resource.
- args ClusterArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name str
- The unique name of the resource.
- args ClusterArgs
- The arguments to resource properties.
- opts ResourceOptions
- Bag of options to control resource's behavior.
- ctx Context
- Context object for the current deployment.
- name string
- The unique name of the resource.
- args ClusterArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args ClusterArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args ClusterArgs
- The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
Constructor example
The following reference example uses placeholder values for all input properties.
var scalewayClusterResource = new Scaleway.Redis.Cluster("scalewayClusterResource", new()
{
Password = "string",
Version = "string",
UserName = "string",
NodeType = "string",
ProjectId = "string",
PrivateNetworks = new[]
{
new Scaleway.Redis.Inputs.ClusterPrivateNetworkArgs
{
Id = "string",
EndpointId = "string",
ServiceIps = new[]
{
"string",
},
Zone = "string",
},
},
Acls = new[]
{
new Scaleway.Redis.Inputs.ClusterAclArgs
{
Ip = "string",
Description = "string",
Id = "string",
},
},
PublicNetwork = new Scaleway.Redis.Inputs.ClusterPublicNetworkArgs
{
Id = "string",
Ips = new[]
{
"string",
},
Port = 0,
},
Settings =
{
{ "string", "string" },
},
Tags = new[]
{
"string",
},
TlsEnabled = false,
Name = "string",
ClusterSize = 0,
Zone = "string",
});
example, err := redis.NewCluster(ctx, "scalewayClusterResource", &redis.ClusterArgs{
Password: pulumi.String("string"),
Version: pulumi.String("string"),
UserName: pulumi.String("string"),
NodeType: pulumi.String("string"),
ProjectId: pulumi.String("string"),
PrivateNetworks: redis.ClusterPrivateNetworkArray{
&redis.ClusterPrivateNetworkArgs{
Id: pulumi.String("string"),
EndpointId: pulumi.String("string"),
ServiceIps: pulumi.StringArray{
pulumi.String("string"),
},
Zone: pulumi.String("string"),
},
},
Acls: redis.ClusterAclArray{
&redis.ClusterAclArgs{
Ip: pulumi.String("string"),
Description: pulumi.String("string"),
Id: pulumi.String("string"),
},
},
PublicNetwork: &redis.ClusterPublicNetworkArgs{
Id: pulumi.String("string"),
Ips: pulumi.StringArray{
pulumi.String("string"),
},
Port: pulumi.Int(0),
},
Settings: pulumi.StringMap{
"string": pulumi.String("string"),
},
Tags: pulumi.StringArray{
pulumi.String("string"),
},
TlsEnabled: pulumi.Bool(false),
Name: pulumi.String("string"),
ClusterSize: pulumi.Int(0),
Zone: pulumi.String("string"),
})
var scalewayClusterResource = new Cluster("scalewayClusterResource", ClusterArgs.builder()
.password("string")
.version("string")
.userName("string")
.nodeType("string")
.projectId("string")
.privateNetworks(ClusterPrivateNetworkArgs.builder()
.id("string")
.endpointId("string")
.serviceIps("string")
.zone("string")
.build())
.acls(ClusterAclArgs.builder()
.ip("string")
.description("string")
.id("string")
.build())
.publicNetwork(ClusterPublicNetworkArgs.builder()
.id("string")
.ips("string")
.port(0)
.build())
.settings(Map.of("string", "string"))
.tags("string")
.tlsEnabled(false)
.name("string")
.clusterSize(0)
.zone("string")
.build());
scaleway_cluster_resource = scaleway.redis.Cluster("scalewayClusterResource",
password="string",
version="string",
user_name="string",
node_type="string",
project_id="string",
private_networks=[{
"id": "string",
"endpoint_id": "string",
"service_ips": ["string"],
"zone": "string",
}],
acls=[{
"ip": "string",
"description": "string",
"id": "string",
}],
public_network={
"id": "string",
"ips": ["string"],
"port": 0,
},
settings={
"string": "string",
},
tags=["string"],
tls_enabled=False,
name="string",
cluster_size=0,
zone="string")
const scalewayClusterResource = new scaleway.redis.Cluster("scalewayClusterResource", {
password: "string",
version: "string",
userName: "string",
nodeType: "string",
projectId: "string",
privateNetworks: [{
id: "string",
endpointId: "string",
serviceIps: ["string"],
zone: "string",
}],
acls: [{
ip: "string",
description: "string",
id: "string",
}],
publicNetwork: {
id: "string",
ips: ["string"],
port: 0,
},
settings: {
string: "string",
},
tags: ["string"],
tlsEnabled: false,
name: "string",
clusterSize: 0,
zone: "string",
});
type: scaleway:redis:Cluster
properties:
acls:
- description: string
id: string
ip: string
clusterSize: 0
name: string
nodeType: string
password: string
privateNetworks:
- endpointId: string
id: string
serviceIps:
- string
zone: string
projectId: string
publicNetwork:
id: string
ips:
- string
port: 0
settings:
string: string
tags:
- string
tlsEnabled: false
userName: string
version: string
zone: string
Cluster Resource Properties
To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.
Inputs
In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.
The Cluster resource accepts the following input properties:
- Node
Type string The type of Redis™ cluster you want to create (e.g.
RED1-M).Important: Updates to
node_typewill migrate the Redis™ cluster to the desirednode_type. Keep in mind that you cannot downgrade a Redis™ cluster.- Password string
- Password for the first user of the Redis™ cluster.
- User
Name string - Identifier for the first user of the Redis™ cluster.
- Version string
Redis™ cluster's version (e.g.
6.2.7).Important: Updates to
versionwill migrate the Redis™ cluster to the desiredversion. Keep in mind that you cannot downgrade a Redis™ cluster.- Acls
List<Pulumiverse.
Scaleway. Redis. Inputs. Cluster Acl> - List of acl rules, this is cluster's authorized IPs. More details on the ACL section.
- Cluster
Size int The number of nodes in the Redis™ cluster.
Important:
Cluster_size = 1 for Standalone mode (single node).
Cluster_size = 2 for High Availability (HA) mode, with 1 main node and 1 standby node.
Cluster_size >= 3 for Cluster mode, which requires a minimum of 1 main node and 2 secondary nodes.
Important: If you are using the cluster mode (>=3 nodes), you can set a bigger
cluster_sizethan you initially did, it will migrate the Redis™ cluster but keep in mind that you cannot downgrade a Redis™ cluster, so setting a smallercluster_sizewill destroy and recreate your cluster.Important: If you are using the Standalone mode (1 node), setting a bigger
cluster_sizewill destroy and recreate your cluster as you will be switching to the cluster mode.- Name string
- The name of the Redis™ cluster.
- Private
Networks List<Pulumiverse.Scaleway. Redis. Inputs. Cluster Private Network> - Describes the Private Network you want to connect to your cluster. If not set, a public network will be provided. More details on the Private Network section
- Project
Id string project_id) The ID of the project the Redis™ cluster is associated with.- Public
Network Pulumiverse.Scaleway. Redis. Inputs. Cluster Public Network (Optional) Public network details. Only one of
private_networkandpublic_networkmay be set.The
public_networkblock exports:- Settings Dictionary<string, string>
- Map of settings for Redis™ cluster. Available settings can be found by listing Redis™ versions with scaleway API or CLI
- List<string>
- The tags associated with the Redis™ cluster.
- Tls
Enabled bool Whether TLS is enabled or not.
The changes on
tls_enabledwill force the resource creation.- Zone string
zone) The zone in which the Redis™ cluster should be created.
- Node
Type string The type of Redis™ cluster you want to create (e.g.
RED1-M).Important: Updates to
node_typewill migrate the Redis™ cluster to the desirednode_type. Keep in mind that you cannot downgrade a Redis™ cluster.- Password string
- Password for the first user of the Redis™ cluster.
- User
Name string - Identifier for the first user of the Redis™ cluster.
- Version string
Redis™ cluster's version (e.g.
6.2.7).Important: Updates to
versionwill migrate the Redis™ cluster to the desiredversion. Keep in mind that you cannot downgrade a Redis™ cluster.- Acls
[]Cluster
Acl Args - List of acl rules, this is cluster's authorized IPs. More details on the ACL section.
- Cluster
Size int The number of nodes in the Redis™ cluster.
Important:
Cluster_size = 1 for Standalone mode (single node).
Cluster_size = 2 for High Availability (HA) mode, with 1 main node and 1 standby node.
Cluster_size >= 3 for Cluster mode, which requires a minimum of 1 main node and 2 secondary nodes.
Important: If you are using the cluster mode (>=3 nodes), you can set a bigger
cluster_sizethan you initially did, it will migrate the Redis™ cluster but keep in mind that you cannot downgrade a Redis™ cluster, so setting a smallercluster_sizewill destroy and recreate your cluster.Important: If you are using the Standalone mode (1 node), setting a bigger
cluster_sizewill destroy and recreate your cluster as you will be switching to the cluster mode.- Name string
- The name of the Redis™ cluster.
- Private
Networks []ClusterPrivate Network Args - Describes the Private Network you want to connect to your cluster. If not set, a public network will be provided. More details on the Private Network section
- Project
Id string project_id) The ID of the project the Redis™ cluster is associated with.- Public
Network ClusterPublic Network Args (Optional) Public network details. Only one of
private_networkandpublic_networkmay be set.The
public_networkblock exports:- Settings map[string]string
- Map of settings for Redis™ cluster. Available settings can be found by listing Redis™ versions with scaleway API or CLI
- []string
- The tags associated with the Redis™ cluster.
- Tls
Enabled bool Whether TLS is enabled or not.
The changes on
tls_enabledwill force the resource creation.- Zone string
zone) The zone in which the Redis™ cluster should be created.
- node
Type String The type of Redis™ cluster you want to create (e.g.
RED1-M).Important: Updates to
node_typewill migrate the Redis™ cluster to the desirednode_type. Keep in mind that you cannot downgrade a Redis™ cluster.- password String
- Password for the first user of the Redis™ cluster.
- user
Name String - Identifier for the first user of the Redis™ cluster.
- version String
Redis™ cluster's version (e.g.
6.2.7).Important: Updates to
versionwill migrate the Redis™ cluster to the desiredversion. Keep in mind that you cannot downgrade a Redis™ cluster.- acls
List<Cluster
Acl> - List of acl rules, this is cluster's authorized IPs. More details on the ACL section.
- cluster
Size Integer The number of nodes in the Redis™ cluster.
Important:
Cluster_size = 1 for Standalone mode (single node).
Cluster_size = 2 for High Availability (HA) mode, with 1 main node and 1 standby node.
Cluster_size >= 3 for Cluster mode, which requires a minimum of 1 main node and 2 secondary nodes.
Important: If you are using the cluster mode (>=3 nodes), you can set a bigger
cluster_sizethan you initially did, it will migrate the Redis™ cluster but keep in mind that you cannot downgrade a Redis™ cluster, so setting a smallercluster_sizewill destroy and recreate your cluster.Important: If you are using the Standalone mode (1 node), setting a bigger
cluster_sizewill destroy and recreate your cluster as you will be switching to the cluster mode.- name String
- The name of the Redis™ cluster.
- private
Networks List<ClusterPrivate Network> - Describes the Private Network you want to connect to your cluster. If not set, a public network will be provided. More details on the Private Network section
- project
Id String project_id) The ID of the project the Redis™ cluster is associated with.- public
Network ClusterPublic Network (Optional) Public network details. Only one of
private_networkandpublic_networkmay be set.The
public_networkblock exports:- settings Map<String,String>
- Map of settings for Redis™ cluster. Available settings can be found by listing Redis™ versions with scaleway API or CLI
- List<String>
- The tags associated with the Redis™ cluster.
- tls
Enabled Boolean Whether TLS is enabled or not.
The changes on
tls_enabledwill force the resource creation.- zone String
zone) The zone in which the Redis™ cluster should be created.
- node
Type string The type of Redis™ cluster you want to create (e.g.
RED1-M).Important: Updates to
node_typewill migrate the Redis™ cluster to the desirednode_type. Keep in mind that you cannot downgrade a Redis™ cluster.- password string
- Password for the first user of the Redis™ cluster.
- user
Name string - Identifier for the first user of the Redis™ cluster.
- version string
Redis™ cluster's version (e.g.
6.2.7).Important: Updates to
versionwill migrate the Redis™ cluster to the desiredversion. Keep in mind that you cannot downgrade a Redis™ cluster.- acls
Cluster
Acl[] - List of acl rules, this is cluster's authorized IPs. More details on the ACL section.
- cluster
Size number The number of nodes in the Redis™ cluster.
Important:
Cluster_size = 1 for Standalone mode (single node).
Cluster_size = 2 for High Availability (HA) mode, with 1 main node and 1 standby node.
Cluster_size >= 3 for Cluster mode, which requires a minimum of 1 main node and 2 secondary nodes.
Important: If you are using the cluster mode (>=3 nodes), you can set a bigger
cluster_sizethan you initially did, it will migrate the Redis™ cluster but keep in mind that you cannot downgrade a Redis™ cluster, so setting a smallercluster_sizewill destroy and recreate your cluster.Important: If you are using the Standalone mode (1 node), setting a bigger
cluster_sizewill destroy and recreate your cluster as you will be switching to the cluster mode.- name string
- The name of the Redis™ cluster.
- private
Networks ClusterPrivate Network[] - Describes the Private Network you want to connect to your cluster. If not set, a public network will be provided. More details on the Private Network section
- project
Id string project_id) The ID of the project the Redis™ cluster is associated with.- public
Network ClusterPublic Network (Optional) Public network details. Only one of
private_networkandpublic_networkmay be set.The
public_networkblock exports:- settings {[key: string]: string}
- Map of settings for Redis™ cluster. Available settings can be found by listing Redis™ versions with scaleway API or CLI
- string[]
- The tags associated with the Redis™ cluster.
- tls
Enabled boolean Whether TLS is enabled or not.
The changes on
tls_enabledwill force the resource creation.- zone string
zone) The zone in which the Redis™ cluster should be created.
- node_
type str The type of Redis™ cluster you want to create (e.g.
RED1-M).Important: Updates to
node_typewill migrate the Redis™ cluster to the desirednode_type. Keep in mind that you cannot downgrade a Redis™ cluster.- password str
- Password for the first user of the Redis™ cluster.
- user_
name str - Identifier for the first user of the Redis™ cluster.
- version str
Redis™ cluster's version (e.g.
6.2.7).Important: Updates to
versionwill migrate the Redis™ cluster to the desiredversion. Keep in mind that you cannot downgrade a Redis™ cluster.- acls
Sequence[Cluster
Acl Args] - List of acl rules, this is cluster's authorized IPs. More details on the ACL section.
- cluster_
size int The number of nodes in the Redis™ cluster.
Important:
Cluster_size = 1 for Standalone mode (single node).
Cluster_size = 2 for High Availability (HA) mode, with 1 main node and 1 standby node.
Cluster_size >= 3 for Cluster mode, which requires a minimum of 1 main node and 2 secondary nodes.
Important: If you are using the cluster mode (>=3 nodes), you can set a bigger
cluster_sizethan you initially did, it will migrate the Redis™ cluster but keep in mind that you cannot downgrade a Redis™ cluster, so setting a smallercluster_sizewill destroy and recreate your cluster.Important: If you are using the Standalone mode (1 node), setting a bigger
cluster_sizewill destroy and recreate your cluster as you will be switching to the cluster mode.- name str
- The name of the Redis™ cluster.
- private_
networks Sequence[ClusterPrivate Network Args] - Describes the Private Network you want to connect to your cluster. If not set, a public network will be provided. More details on the Private Network section
- project_
id str project_id) The ID of the project the Redis™ cluster is associated with.- public_
network ClusterPublic Network Args (Optional) Public network details. Only one of
private_networkandpublic_networkmay be set.The
public_networkblock exports:- settings Mapping[str, str]
- Map of settings for Redis™ cluster. Available settings can be found by listing Redis™ versions with scaleway API or CLI
- Sequence[str]
- The tags associated with the Redis™ cluster.
- tls_
enabled bool Whether TLS is enabled or not.
The changes on
tls_enabledwill force the resource creation.- zone str
zone) The zone in which the Redis™ cluster should be created.
- node
Type String The type of Redis™ cluster you want to create (e.g.
RED1-M).Important: Updates to
node_typewill migrate the Redis™ cluster to the desirednode_type. Keep in mind that you cannot downgrade a Redis™ cluster.- password String
- Password for the first user of the Redis™ cluster.
- user
Name String - Identifier for the first user of the Redis™ cluster.
- version String
Redis™ cluster's version (e.g.
6.2.7).Important: Updates to
versionwill migrate the Redis™ cluster to the desiredversion. Keep in mind that you cannot downgrade a Redis™ cluster.- acls List<Property Map>
- List of acl rules, this is cluster's authorized IPs. More details on the ACL section.
- cluster
Size Number The number of nodes in the Redis™ cluster.
Important:
Cluster_size = 1 for Standalone mode (single node).
Cluster_size = 2 for High Availability (HA) mode, with 1 main node and 1 standby node.
Cluster_size >= 3 for Cluster mode, which requires a minimum of 1 main node and 2 secondary nodes.
Important: If you are using the cluster mode (>=3 nodes), you can set a bigger
cluster_sizethan you initially did, it will migrate the Redis™ cluster but keep in mind that you cannot downgrade a Redis™ cluster, so setting a smallercluster_sizewill destroy and recreate your cluster.Important: If you are using the Standalone mode (1 node), setting a bigger
cluster_sizewill destroy and recreate your cluster as you will be switching to the cluster mode.- name String
- The name of the Redis™ cluster.
- private
Networks List<Property Map> - Describes the Private Network you want to connect to your cluster. If not set, a public network will be provided. More details on the Private Network section
- project
Id String project_id) The ID of the project the Redis™ cluster is associated with.- public
Network Property Map (Optional) Public network details. Only one of
private_networkandpublic_networkmay be set.The
public_networkblock exports:- settings Map<String>
- Map of settings for Redis™ cluster. Available settings can be found by listing Redis™ versions with scaleway API or CLI
- List<String>
- The tags associated with the Redis™ cluster.
- tls
Enabled Boolean Whether TLS is enabled or not.
The changes on
tls_enabledwill force the resource creation.- zone String
zone) The zone in which the Redis™ cluster should be created.
Outputs
All input properties are implicitly available as output properties. Additionally, the Cluster resource produces the following output properties:
- Certificate string
- The PEM of the certificate used by redis, only when
tls_enabledis true - Created
At string - The date and time of creation of the Redis™ cluster.
- Id string
- The provider-assigned unique ID for this managed resource.
- Updated
At string - The date and time of the last update of the Redis™ cluster.
- Certificate string
- The PEM of the certificate used by redis, only when
tls_enabledis true - Created
At string - The date and time of creation of the Redis™ cluster.
- Id string
- The provider-assigned unique ID for this managed resource.
- Updated
At string - The date and time of the last update of the Redis™ cluster.
- certificate String
- The PEM of the certificate used by redis, only when
tls_enabledis true - created
At String - The date and time of creation of the Redis™ cluster.
- id String
- The provider-assigned unique ID for this managed resource.
- updated
At String - The date and time of the last update of the Redis™ cluster.
- certificate string
- The PEM of the certificate used by redis, only when
tls_enabledis true - created
At string - The date and time of creation of the Redis™ cluster.
- id string
- The provider-assigned unique ID for this managed resource.
- updated
At string - The date and time of the last update of the Redis™ cluster.
- certificate str
- The PEM of the certificate used by redis, only when
tls_enabledis true - created_
at str - The date and time of creation of the Redis™ cluster.
- id str
- The provider-assigned unique ID for this managed resource.
- updated_
at str - The date and time of the last update of the Redis™ cluster.
- certificate String
- The PEM of the certificate used by redis, only when
tls_enabledis true - created
At String - The date and time of creation of the Redis™ cluster.
- id String
- The provider-assigned unique ID for this managed resource.
- updated
At String - The date and time of the last update of the Redis™ cluster.
Look up Existing Cluster Resource
Get an existing Cluster resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.
public static get(name: string, id: Input<ID>, state?: ClusterState, opts?: CustomResourceOptions): Cluster@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
acls: Optional[Sequence[ClusterAclArgs]] = None,
certificate: Optional[str] = None,
cluster_size: Optional[int] = None,
created_at: Optional[str] = None,
name: Optional[str] = None,
node_type: Optional[str] = None,
password: Optional[str] = None,
private_networks: Optional[Sequence[ClusterPrivateNetworkArgs]] = None,
project_id: Optional[str] = None,
public_network: Optional[ClusterPublicNetworkArgs] = None,
settings: Optional[Mapping[str, str]] = None,
tags: Optional[Sequence[str]] = None,
tls_enabled: Optional[bool] = None,
updated_at: Optional[str] = None,
user_name: Optional[str] = None,
version: Optional[str] = None,
zone: Optional[str] = None) -> Clusterfunc GetCluster(ctx *Context, name string, id IDInput, state *ClusterState, opts ...ResourceOption) (*Cluster, error)public static Cluster Get(string name, Input<string> id, ClusterState? state, CustomResourceOptions? opts = null)public static Cluster get(String name, Output<String> id, ClusterState state, CustomResourceOptions options)resources: _: type: scaleway:redis:Cluster get: id: ${id}- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- resource_name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- Acls
List<Pulumiverse.
Scaleway. Redis. Inputs. Cluster Acl> - List of acl rules, this is cluster's authorized IPs. More details on the ACL section.
- Certificate string
- The PEM of the certificate used by redis, only when
tls_enabledis true - Cluster
Size int The number of nodes in the Redis™ cluster.
Important:
Cluster_size = 1 for Standalone mode (single node).
Cluster_size = 2 for High Availability (HA) mode, with 1 main node and 1 standby node.
Cluster_size >= 3 for Cluster mode, which requires a minimum of 1 main node and 2 secondary nodes.
Important: If you are using the cluster mode (>=3 nodes), you can set a bigger
cluster_sizethan you initially did, it will migrate the Redis™ cluster but keep in mind that you cannot downgrade a Redis™ cluster, so setting a smallercluster_sizewill destroy and recreate your cluster.Important: If you are using the Standalone mode (1 node), setting a bigger
cluster_sizewill destroy and recreate your cluster as you will be switching to the cluster mode.- Created
At string - The date and time of creation of the Redis™ cluster.
- Name string
- The name of the Redis™ cluster.
- Node
Type string The type of Redis™ cluster you want to create (e.g.
RED1-M).Important: Updates to
node_typewill migrate the Redis™ cluster to the desirednode_type. Keep in mind that you cannot downgrade a Redis™ cluster.- Password string
- Password for the first user of the Redis™ cluster.
- Private
Networks List<Pulumiverse.Scaleway. Redis. Inputs. Cluster Private Network> - Describes the Private Network you want to connect to your cluster. If not set, a public network will be provided. More details on the Private Network section
- Project
Id string project_id) The ID of the project the Redis™ cluster is associated with.- Public
Network Pulumiverse.Scaleway. Redis. Inputs. Cluster Public Network (Optional) Public network details. Only one of
private_networkandpublic_networkmay be set.The
public_networkblock exports:- Settings Dictionary<string, string>
- Map of settings for Redis™ cluster. Available settings can be found by listing Redis™ versions with scaleway API or CLI
- List<string>
- The tags associated with the Redis™ cluster.
- Tls
Enabled bool Whether TLS is enabled or not.
The changes on
tls_enabledwill force the resource creation.- Updated
At string - The date and time of the last update of the Redis™ cluster.
- User
Name string - Identifier for the first user of the Redis™ cluster.
- Version string
Redis™ cluster's version (e.g.
6.2.7).Important: Updates to
versionwill migrate the Redis™ cluster to the desiredversion. Keep in mind that you cannot downgrade a Redis™ cluster.- Zone string
zone) The zone in which the Redis™ cluster should be created.
- Acls
[]Cluster
Acl Args - List of acl rules, this is cluster's authorized IPs. More details on the ACL section.
- Certificate string
- The PEM of the certificate used by redis, only when
tls_enabledis true - Cluster
Size int The number of nodes in the Redis™ cluster.
Important:
Cluster_size = 1 for Standalone mode (single node).
Cluster_size = 2 for High Availability (HA) mode, with 1 main node and 1 standby node.
Cluster_size >= 3 for Cluster mode, which requires a minimum of 1 main node and 2 secondary nodes.
Important: If you are using the cluster mode (>=3 nodes), you can set a bigger
cluster_sizethan you initially did, it will migrate the Redis™ cluster but keep in mind that you cannot downgrade a Redis™ cluster, so setting a smallercluster_sizewill destroy and recreate your cluster.Important: If you are using the Standalone mode (1 node), setting a bigger
cluster_sizewill destroy and recreate your cluster as you will be switching to the cluster mode.- Created
At string - The date and time of creation of the Redis™ cluster.
- Name string
- The name of the Redis™ cluster.
- Node
Type string The type of Redis™ cluster you want to create (e.g.
RED1-M).Important: Updates to
node_typewill migrate the Redis™ cluster to the desirednode_type. Keep in mind that you cannot downgrade a Redis™ cluster.- Password string
- Password for the first user of the Redis™ cluster.
- Private
Networks []ClusterPrivate Network Args - Describes the Private Network you want to connect to your cluster. If not set, a public network will be provided. More details on the Private Network section
- Project
Id string project_id) The ID of the project the Redis™ cluster is associated with.- Public
Network ClusterPublic Network Args (Optional) Public network details. Only one of
private_networkandpublic_networkmay be set.The
public_networkblock exports:- Settings map[string]string
- Map of settings for Redis™ cluster. Available settings can be found by listing Redis™ versions with scaleway API or CLI
- []string
- The tags associated with the Redis™ cluster.
- Tls
Enabled bool Whether TLS is enabled or not.
The changes on
tls_enabledwill force the resource creation.- Updated
At string - The date and time of the last update of the Redis™ cluster.
- User
Name string - Identifier for the first user of the Redis™ cluster.
- Version string
Redis™ cluster's version (e.g.
6.2.7).Important: Updates to
versionwill migrate the Redis™ cluster to the desiredversion. Keep in mind that you cannot downgrade a Redis™ cluster.- Zone string
zone) The zone in which the Redis™ cluster should be created.
- acls
List<Cluster
Acl> - List of acl rules, this is cluster's authorized IPs. More details on the ACL section.
- certificate String
- The PEM of the certificate used by redis, only when
tls_enabledis true - cluster
Size Integer The number of nodes in the Redis™ cluster.
Important:
Cluster_size = 1 for Standalone mode (single node).
Cluster_size = 2 for High Availability (HA) mode, with 1 main node and 1 standby node.
Cluster_size >= 3 for Cluster mode, which requires a minimum of 1 main node and 2 secondary nodes.
Important: If you are using the cluster mode (>=3 nodes), you can set a bigger
cluster_sizethan you initially did, it will migrate the Redis™ cluster but keep in mind that you cannot downgrade a Redis™ cluster, so setting a smallercluster_sizewill destroy and recreate your cluster.Important: If you are using the Standalone mode (1 node), setting a bigger
cluster_sizewill destroy and recreate your cluster as you will be switching to the cluster mode.- created
At String - The date and time of creation of the Redis™ cluster.
- name String
- The name of the Redis™ cluster.
- node
Type String The type of Redis™ cluster you want to create (e.g.
RED1-M).Important: Updates to
node_typewill migrate the Redis™ cluster to the desirednode_type. Keep in mind that you cannot downgrade a Redis™ cluster.- password String
- Password for the first user of the Redis™ cluster.
- private
Networks List<ClusterPrivate Network> - Describes the Private Network you want to connect to your cluster. If not set, a public network will be provided. More details on the Private Network section
- project
Id String project_id) The ID of the project the Redis™ cluster is associated with.- public
Network ClusterPublic Network (Optional) Public network details. Only one of
private_networkandpublic_networkmay be set.The
public_networkblock exports:- settings Map<String,String>
- Map of settings for Redis™ cluster. Available settings can be found by listing Redis™ versions with scaleway API or CLI
- List<String>
- The tags associated with the Redis™ cluster.
- tls
Enabled Boolean Whether TLS is enabled or not.
The changes on
tls_enabledwill force the resource creation.- updated
At String - The date and time of the last update of the Redis™ cluster.
- user
Name String - Identifier for the first user of the Redis™ cluster.
- version String
Redis™ cluster's version (e.g.
6.2.7).Important: Updates to
versionwill migrate the Redis™ cluster to the desiredversion. Keep in mind that you cannot downgrade a Redis™ cluster.- zone String
zone) The zone in which the Redis™ cluster should be created.
- acls
Cluster
Acl[] - List of acl rules, this is cluster's authorized IPs. More details on the ACL section.
- certificate string
- The PEM of the certificate used by redis, only when
tls_enabledis true - cluster
Size number The number of nodes in the Redis™ cluster.
Important:
Cluster_size = 1 for Standalone mode (single node).
Cluster_size = 2 for High Availability (HA) mode, with 1 main node and 1 standby node.
Cluster_size >= 3 for Cluster mode, which requires a minimum of 1 main node and 2 secondary nodes.
Important: If you are using the cluster mode (>=3 nodes), you can set a bigger
cluster_sizethan you initially did, it will migrate the Redis™ cluster but keep in mind that you cannot downgrade a Redis™ cluster, so setting a smallercluster_sizewill destroy and recreate your cluster.Important: If you are using the Standalone mode (1 node), setting a bigger
cluster_sizewill destroy and recreate your cluster as you will be switching to the cluster mode.- created
At string - The date and time of creation of the Redis™ cluster.
- name string
- The name of the Redis™ cluster.
- node
Type string The type of Redis™ cluster you want to create (e.g.
RED1-M).Important: Updates to
node_typewill migrate the Redis™ cluster to the desirednode_type. Keep in mind that you cannot downgrade a Redis™ cluster.- password string
- Password for the first user of the Redis™ cluster.
- private
Networks ClusterPrivate Network[] - Describes the Private Network you want to connect to your cluster. If not set, a public network will be provided. More details on the Private Network section
- project
Id string project_id) The ID of the project the Redis™ cluster is associated with.- public
Network ClusterPublic Network (Optional) Public network details. Only one of
private_networkandpublic_networkmay be set.The
public_networkblock exports:- settings {[key: string]: string}
- Map of settings for Redis™ cluster. Available settings can be found by listing Redis™ versions with scaleway API or CLI
- string[]
- The tags associated with the Redis™ cluster.
- tls
Enabled boolean Whether TLS is enabled or not.
The changes on
tls_enabledwill force the resource creation.- updated
At string - The date and time of the last update of the Redis™ cluster.
- user
Name string - Identifier for the first user of the Redis™ cluster.
- version string
Redis™ cluster's version (e.g.
6.2.7).Important: Updates to
versionwill migrate the Redis™ cluster to the desiredversion. Keep in mind that you cannot downgrade a Redis™ cluster.- zone string
zone) The zone in which the Redis™ cluster should be created.
- acls
Sequence[Cluster
Acl Args] - List of acl rules, this is cluster's authorized IPs. More details on the ACL section.
- certificate str
- The PEM of the certificate used by redis, only when
tls_enabledis true - cluster_
size int The number of nodes in the Redis™ cluster.
Important:
Cluster_size = 1 for Standalone mode (single node).
Cluster_size = 2 for High Availability (HA) mode, with 1 main node and 1 standby node.
Cluster_size >= 3 for Cluster mode, which requires a minimum of 1 main node and 2 secondary nodes.
Important: If you are using the cluster mode (>=3 nodes), you can set a bigger
cluster_sizethan you initially did, it will migrate the Redis™ cluster but keep in mind that you cannot downgrade a Redis™ cluster, so setting a smallercluster_sizewill destroy and recreate your cluster.Important: If you are using the Standalone mode (1 node), setting a bigger
cluster_sizewill destroy and recreate your cluster as you will be switching to the cluster mode.- created_
at str - The date and time of creation of the Redis™ cluster.
- name str
- The name of the Redis™ cluster.
- node_
type str The type of Redis™ cluster you want to create (e.g.
RED1-M).Important: Updates to
node_typewill migrate the Redis™ cluster to the desirednode_type. Keep in mind that you cannot downgrade a Redis™ cluster.- password str
- Password for the first user of the Redis™ cluster.
- private_
networks Sequence[ClusterPrivate Network Args] - Describes the Private Network you want to connect to your cluster. If not set, a public network will be provided. More details on the Private Network section
- project_
id str project_id) The ID of the project the Redis™ cluster is associated with.- public_
network ClusterPublic Network Args (Optional) Public network details. Only one of
private_networkandpublic_networkmay be set.The
public_networkblock exports:- settings Mapping[str, str]
- Map of settings for Redis™ cluster. Available settings can be found by listing Redis™ versions with scaleway API or CLI
- Sequence[str]
- The tags associated with the Redis™ cluster.
- tls_
enabled bool Whether TLS is enabled or not.
The changes on
tls_enabledwill force the resource creation.- updated_
at str - The date and time of the last update of the Redis™ cluster.
- user_
name str - Identifier for the first user of the Redis™ cluster.
- version str
Redis™ cluster's version (e.g.
6.2.7).Important: Updates to
versionwill migrate the Redis™ cluster to the desiredversion. Keep in mind that you cannot downgrade a Redis™ cluster.- zone str
zone) The zone in which the Redis™ cluster should be created.
- acls List<Property Map>
- List of acl rules, this is cluster's authorized IPs. More details on the ACL section.
- certificate String
- The PEM of the certificate used by redis, only when
tls_enabledis true - cluster
Size Number The number of nodes in the Redis™ cluster.
Important:
Cluster_size = 1 for Standalone mode (single node).
Cluster_size = 2 for High Availability (HA) mode, with 1 main node and 1 standby node.
Cluster_size >= 3 for Cluster mode, which requires a minimum of 1 main node and 2 secondary nodes.
Important: If you are using the cluster mode (>=3 nodes), you can set a bigger
cluster_sizethan you initially did, it will migrate the Redis™ cluster but keep in mind that you cannot downgrade a Redis™ cluster, so setting a smallercluster_sizewill destroy and recreate your cluster.Important: If you are using the Standalone mode (1 node), setting a bigger
cluster_sizewill destroy and recreate your cluster as you will be switching to the cluster mode.- created
At String - The date and time of creation of the Redis™ cluster.
- name String
- The name of the Redis™ cluster.
- node
Type String The type of Redis™ cluster you want to create (e.g.
RED1-M).Important: Updates to
node_typewill migrate the Redis™ cluster to the desirednode_type. Keep in mind that you cannot downgrade a Redis™ cluster.- password String
- Password for the first user of the Redis™ cluster.
- private
Networks List<Property Map> - Describes the Private Network you want to connect to your cluster. If not set, a public network will be provided. More details on the Private Network section
- project
Id String project_id) The ID of the project the Redis™ cluster is associated with.- public
Network Property Map (Optional) Public network details. Only one of
private_networkandpublic_networkmay be set.The
public_networkblock exports:- settings Map<String>
- Map of settings for Redis™ cluster. Available settings can be found by listing Redis™ versions with scaleway API or CLI
- List<String>
- The tags associated with the Redis™ cluster.
- tls
Enabled Boolean Whether TLS is enabled or not.
The changes on
tls_enabledwill force the resource creation.- updated
At String - The date and time of the last update of the Redis™ cluster.
- user
Name String - Identifier for the first user of the Redis™ cluster.
- version String
Redis™ cluster's version (e.g.
6.2.7).Important: Updates to
versionwill migrate the Redis™ cluster to the desiredversion. Keep in mind that you cannot downgrade a Redis™ cluster.- zone String
zone) The zone in which the Redis™ cluster should be created.
Supporting Types
ClusterAcl, ClusterAclArgs
- Ip string
- The IP range to whitelist in CIDR notation
- Description string
A text describing this rule. Default description:
Allow IPThe
aclconflict withprivate_network. Only one should be specified.- Id string
- (Required) The UUID of the endpoint.
- Ip string
- The IP range to whitelist in CIDR notation
- Description string
A text describing this rule. Default description:
Allow IPThe
aclconflict withprivate_network. Only one should be specified.- Id string
- (Required) The UUID of the endpoint.
- ip String
- The IP range to whitelist in CIDR notation
- description String
A text describing this rule. Default description:
Allow IPThe
aclconflict withprivate_network. Only one should be specified.- id String
- (Required) The UUID of the endpoint.
- ip string
- The IP range to whitelist in CIDR notation
- description string
A text describing this rule. Default description:
Allow IPThe
aclconflict withprivate_network. Only one should be specified.- id string
- (Required) The UUID of the endpoint.
- ip str
- The IP range to whitelist in CIDR notation
- description str
A text describing this rule. Default description:
Allow IPThe
aclconflict withprivate_network. Only one should be specified.- id str
- (Required) The UUID of the endpoint.
- ip String
- The IP range to whitelist in CIDR notation
- description String
A text describing this rule. Default description:
Allow IPThe
aclconflict withprivate_network. Only one should be specified.- id String
- (Required) The UUID of the endpoint.
ClusterPrivateNetwork, ClusterPrivateNetworkArgs
- Id string
- The UUID of the Private Network resource.
- Endpoint
Id string - The ID of the endpoint.
- Service
Ips List<string> Endpoint IPv4 addresses in CIDR notation. You must provide at least one IP per node. Keep in mind that in cluster mode you cannot edit your Private Network after its creation so if you want to be able to scale your cluster horizontally (adding nodes) later, you should provide more IPs than nodes. If not set, the IP network address within the private subnet is determined by the IP Address Management (IPAM) service.
Important: When IPAM is enabled, the IPs specified here will be ignored and should not be provided.
The
private_networkconflicts withacl. Only one should be specified.Important: The way to use Private Networks differs whether you are using Redis™ in Standalone or cluster mode.
Standalone mode (
cluster_size= 1) : you can attach as many Private Networks as you want (each must be a separate block). If you detach your only Private Network, your cluster won't be reachable until you define a new Private or Public Network. You can modify yourprivate_networkand its specs, you can have both a Private and Public Network side by side.Cluster mode (
cluster_size> 2) : you can define a single Private Network as you create your cluster, you won't be able to edit or detach it afterward, unless you create another cluster. This also means that, if you are using a static configuration (service_ips), you won't be able to scale your cluster horizontally (add more nodes) since it would require updating the Private Network to add IPs. Yourservice_ipsmust be listed as follows:
- Zone string
zone) The zone in which the Redis™ cluster should be created.
- Id string
- The UUID of the Private Network resource.
- Endpoint
Id string - The ID of the endpoint.
- Service
Ips []string Endpoint IPv4 addresses in CIDR notation. You must provide at least one IP per node. Keep in mind that in cluster mode you cannot edit your Private Network after its creation so if you want to be able to scale your cluster horizontally (adding nodes) later, you should provide more IPs than nodes. If not set, the IP network address within the private subnet is determined by the IP Address Management (IPAM) service.
Important: When IPAM is enabled, the IPs specified here will be ignored and should not be provided.
The
private_networkconflicts withacl. Only one should be specified.Important: The way to use Private Networks differs whether you are using Redis™ in Standalone or cluster mode.
Standalone mode (
cluster_size= 1) : you can attach as many Private Networks as you want (each must be a separate block). If you detach your only Private Network, your cluster won't be reachable until you define a new Private or Public Network. You can modify yourprivate_networkand its specs, you can have both a Private and Public Network side by side.Cluster mode (
cluster_size> 2) : you can define a single Private Network as you create your cluster, you won't be able to edit or detach it afterward, unless you create another cluster. This also means that, if you are using a static configuration (service_ips), you won't be able to scale your cluster horizontally (add more nodes) since it would require updating the Private Network to add IPs. Yourservice_ipsmust be listed as follows:
- Zone string
zone) The zone in which the Redis™ cluster should be created.
- id String
- The UUID of the Private Network resource.
- endpoint
Id String - The ID of the endpoint.
- service
Ips List<String> Endpoint IPv4 addresses in CIDR notation. You must provide at least one IP per node. Keep in mind that in cluster mode you cannot edit your Private Network after its creation so if you want to be able to scale your cluster horizontally (adding nodes) later, you should provide more IPs than nodes. If not set, the IP network address within the private subnet is determined by the IP Address Management (IPAM) service.
Important: When IPAM is enabled, the IPs specified here will be ignored and should not be provided.
The
private_networkconflicts withacl. Only one should be specified.Important: The way to use Private Networks differs whether you are using Redis™ in Standalone or cluster mode.
Standalone mode (
cluster_size= 1) : you can attach as many Private Networks as you want (each must be a separate block). If you detach your only Private Network, your cluster won't be reachable until you define a new Private or Public Network. You can modify yourprivate_networkand its specs, you can have both a Private and Public Network side by side.Cluster mode (
cluster_size> 2) : you can define a single Private Network as you create your cluster, you won't be able to edit or detach it afterward, unless you create another cluster. This also means that, if you are using a static configuration (service_ips), you won't be able to scale your cluster horizontally (add more nodes) since it would require updating the Private Network to add IPs. Yourservice_ipsmust be listed as follows:
- zone String
zone) The zone in which the Redis™ cluster should be created.
- id string
- The UUID of the Private Network resource.
- endpoint
Id string - The ID of the endpoint.
- service
Ips string[] Endpoint IPv4 addresses in CIDR notation. You must provide at least one IP per node. Keep in mind that in cluster mode you cannot edit your Private Network after its creation so if you want to be able to scale your cluster horizontally (adding nodes) later, you should provide more IPs than nodes. If not set, the IP network address within the private subnet is determined by the IP Address Management (IPAM) service.
Important: When IPAM is enabled, the IPs specified here will be ignored and should not be provided.
The
private_networkconflicts withacl. Only one should be specified.Important: The way to use Private Networks differs whether you are using Redis™ in Standalone or cluster mode.
Standalone mode (
cluster_size= 1) : you can attach as many Private Networks as you want (each must be a separate block). If you detach your only Private Network, your cluster won't be reachable until you define a new Private or Public Network. You can modify yourprivate_networkand its specs, you can have both a Private and Public Network side by side.Cluster mode (
cluster_size> 2) : you can define a single Private Network as you create your cluster, you won't be able to edit or detach it afterward, unless you create another cluster. This also means that, if you are using a static configuration (service_ips), you won't be able to scale your cluster horizontally (add more nodes) since it would require updating the Private Network to add IPs. Yourservice_ipsmust be listed as follows:
- zone string
zone) The zone in which the Redis™ cluster should be created.
- id str
- The UUID of the Private Network resource.
- endpoint_
id str - The ID of the endpoint.
- service_
ips Sequence[str] Endpoint IPv4 addresses in CIDR notation. You must provide at least one IP per node. Keep in mind that in cluster mode you cannot edit your Private Network after its creation so if you want to be able to scale your cluster horizontally (adding nodes) later, you should provide more IPs than nodes. If not set, the IP network address within the private subnet is determined by the IP Address Management (IPAM) service.
Important: When IPAM is enabled, the IPs specified here will be ignored and should not be provided.
The
private_networkconflicts withacl. Only one should be specified.Important: The way to use Private Networks differs whether you are using Redis™ in Standalone or cluster mode.
Standalone mode (
cluster_size= 1) : you can attach as many Private Networks as you want (each must be a separate block). If you detach your only Private Network, your cluster won't be reachable until you define a new Private or Public Network. You can modify yourprivate_networkand its specs, you can have both a Private and Public Network side by side.Cluster mode (
cluster_size> 2) : you can define a single Private Network as you create your cluster, you won't be able to edit or detach it afterward, unless you create another cluster. This also means that, if you are using a static configuration (service_ips), you won't be able to scale your cluster horizontally (add more nodes) since it would require updating the Private Network to add IPs. Yourservice_ipsmust be listed as follows:
- zone str
zone) The zone in which the Redis™ cluster should be created.
- id String
- The UUID of the Private Network resource.
- endpoint
Id String - The ID of the endpoint.
- service
Ips List<String> Endpoint IPv4 addresses in CIDR notation. You must provide at least one IP per node. Keep in mind that in cluster mode you cannot edit your Private Network after its creation so if you want to be able to scale your cluster horizontally (adding nodes) later, you should provide more IPs than nodes. If not set, the IP network address within the private subnet is determined by the IP Address Management (IPAM) service.
Important: When IPAM is enabled, the IPs specified here will be ignored and should not be provided.
The
private_networkconflicts withacl. Only one should be specified.Important: The way to use Private Networks differs whether you are using Redis™ in Standalone or cluster mode.
Standalone mode (
cluster_size= 1) : you can attach as many Private Networks as you want (each must be a separate block). If you detach your only Private Network, your cluster won't be reachable until you define a new Private or Public Network. You can modify yourprivate_networkand its specs, you can have both a Private and Public Network side by side.Cluster mode (
cluster_size> 2) : you can define a single Private Network as you create your cluster, you won't be able to edit or detach it afterward, unless you create another cluster. This also means that, if you are using a static configuration (service_ips), you won't be able to scale your cluster horizontally (add more nodes) since it would require updating the Private Network to add IPs. Yourservice_ipsmust be listed as follows:
- zone String
zone) The zone in which the Redis™ cluster should be created.
ClusterPublicNetwork, ClusterPublicNetworkArgs
Import
Redis™ cluster can be imported using the {zone}/{id}, e.g.
bash
$ pulumi import scaleway:redis/cluster:Cluster main fr-par-1/11111111-1111-1111-1111-111111111111
To learn more about importing existing cloud resources, see Importing resources.
Package Details
- Repository
- scaleway pulumiverse/pulumi-scaleway
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
scalewayTerraform Provider.