1. Packages
  2. Scaleway
  3. API Docs
  4. RedisCluster
Scaleway v1.15.0 published on Tuesday, Jul 30, 2024 by pulumiverse

scaleway.RedisCluster

Explore with Pulumi AI

scaleway logo
Scaleway v1.15.0 published on Tuesday, Jul 30, 2024 by pulumiverse

    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.RedisCluster("main", {
        acls: [{
            description: "Allow all",
            ip: "0.0.0.0/0",
        }],
        clusterSize: 1,
        nodeType: "RED1-MICRO",
        password: "thiZ_is_v&ry_s3cret",
        tags: [
            "test",
            "redis",
        ],
        tlsEnabled: true,
        userName: "my_initial_user",
        version: "6.2.7",
    });
    
    import pulumi
    import pulumiverse_scaleway as scaleway
    
    main = scaleway.RedisCluster("main",
        acls=[scaleway.RedisClusterAclArgs(
            description="Allow all",
            ip="0.0.0.0/0",
        )],
        cluster_size=1,
        node_type="RED1-MICRO",
        password="thiZ_is_v&ry_s3cret",
        tags=[
            "test",
            "redis",
        ],
        tls_enabled=True,
        user_name="my_initial_user",
        version="6.2.7")
    
    package main
    
    import (
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    	"github.com/pulumiverse/pulumi-scaleway/sdk/go/scaleway"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := scaleway.NewRedisCluster(ctx, "main", &scaleway.RedisClusterArgs{
    			Acls: scaleway.RedisClusterAclArray{
    				&scaleway.RedisClusterAclArgs{
    					Description: pulumi.String("Allow all"),
    					Ip:          pulumi.String("0.0.0.0/0"),
    				},
    			},
    			ClusterSize: pulumi.Int(1),
    			NodeType:    pulumi.String("RED1-MICRO"),
    			Password:    pulumi.String("thiZ_is_v&ry_s3cret"),
    			Tags: pulumi.StringArray{
    				pulumi.String("test"),
    				pulumi.String("redis"),
    			},
    			TlsEnabled: pulumi.Bool(true),
    			UserName:   pulumi.String("my_initial_user"),
    			Version:    pulumi.String("6.2.7"),
    		})
    		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.RedisCluster("main", new()
        {
            Acls = new[]
            {
                new Scaleway.Inputs.RedisClusterAclArgs
                {
                    Description = "Allow all",
                    Ip = "0.0.0.0/0",
                },
            },
            ClusterSize = 1,
            NodeType = "RED1-MICRO",
            Password = "thiZ_is_v&ry_s3cret",
            Tags = new[]
            {
                "test",
                "redis",
            },
            TlsEnabled = true,
            UserName = "my_initial_user",
            Version = "6.2.7",
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.scaleway.RedisCluster;
    import com.pulumi.scaleway.RedisClusterArgs;
    import com.pulumi.scaleway.inputs.RedisClusterAclArgs;
    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 RedisCluster("main", RedisClusterArgs.builder()
                .acls(RedisClusterAclArgs.builder()
                    .description("Allow all")
                    .ip("0.0.0.0/0")
                    .build())
                .clusterSize(1)
                .nodeType("RED1-MICRO")
                .password("thiZ_is_v&ry_s3cret")
                .tags(            
                    "test",
                    "redis")
                .tlsEnabled("true")
                .userName("my_initial_user")
                .version("6.2.7")
                .build());
    
        }
    }
    
    resources:
      main:
        type: scaleway:RedisCluster
        properties:
          acls:
            - description: Allow all
              ip: 0.0.0.0/0
          clusterSize: 1
          nodeType: RED1-MICRO
          password: thiZ_is_v&ry_s3cret
          tags:
            - test
            - redis
          tlsEnabled: 'true'
          userName: my_initial_user
          version: 6.2.7
    

    With settings

    import * as pulumi from "@pulumi/pulumi";
    import * as scaleway from "@pulumiverse/scaleway";
    
    const main = new scaleway.RedisCluster("main", {
        nodeType: "RED1-MICRO",
        password: "thiZ_is_v&ry_s3cret",
        settings: {
            maxclients: "1000",
            "tcp-keepalive": "120",
        },
        userName: "my_initial_user",
        version: "6.2.7",
    });
    
    import pulumi
    import pulumiverse_scaleway as scaleway
    
    main = scaleway.RedisCluster("main",
        node_type="RED1-MICRO",
        password="thiZ_is_v&ry_s3cret",
        settings={
            "maxclients": "1000",
            "tcp-keepalive": "120",
        },
        user_name="my_initial_user",
        version="6.2.7")
    
    package main
    
    import (
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    	"github.com/pulumiverse/pulumi-scaleway/sdk/go/scaleway"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := scaleway.NewRedisCluster(ctx, "main", &scaleway.RedisClusterArgs{
    			NodeType: pulumi.String("RED1-MICRO"),
    			Password: pulumi.String("thiZ_is_v&ry_s3cret"),
    			Settings: pulumi.StringMap{
    				"maxclients":    pulumi.String("1000"),
    				"tcp-keepalive": pulumi.String("120"),
    			},
    			UserName: pulumi.String("my_initial_user"),
    			Version:  pulumi.String("6.2.7"),
    		})
    		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.RedisCluster("main", new()
        {
            NodeType = "RED1-MICRO",
            Password = "thiZ_is_v&ry_s3cret",
            Settings = 
            {
                { "maxclients", "1000" },
                { "tcp-keepalive", "120" },
            },
            UserName = "my_initial_user",
            Version = "6.2.7",
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.scaleway.RedisCluster;
    import com.pulumi.scaleway.RedisClusterArgs;
    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 RedisCluster("main", RedisClusterArgs.builder()
                .nodeType("RED1-MICRO")
                .password("thiZ_is_v&ry_s3cret")
                .settings(Map.ofEntries(
                    Map.entry("maxclients", "1000"),
                    Map.entry("tcp-keepalive", "120")
                ))
                .userName("my_initial_user")
                .version("6.2.7")
                .build());
    
        }
    }
    
    resources:
      main:
        type: scaleway:RedisCluster
        properties:
          nodeType: RED1-MICRO
          password: thiZ_is_v&ry_s3cret
          settings:
            maxclients: '1000'
            tcp-keepalive: '120'
          userName: my_initial_user
          version: 6.2.7
    

    With a Private Network

    import * as pulumi from "@pulumi/pulumi";
    import * as scaleway from "@pulumiverse/scaleway";
    
    const pn = new scaleway.VpcPrivateNetwork("pn", {});
    const main = new scaleway.RedisCluster("main", {
        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.VpcPrivateNetwork("pn")
    main = scaleway.RedisCluster("main",
        version="6.2.7",
        node_type="RED1-MICRO",
        user_name="my_initial_user",
        password="thiZ_is_v&ry_s3cret",
        cluster_size=1,
        private_networks=[scaleway.RedisClusterPrivateNetworkArgs(
            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"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		pn, err := scaleway.NewVpcPrivateNetwork(ctx, "pn", nil)
    		if err != nil {
    			return err
    		}
    		_, err = scaleway.NewRedisCluster(ctx, "main", &scaleway.RedisClusterArgs{
    			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: scaleway.RedisClusterPrivateNetworkArray{
    				&scaleway.RedisClusterPrivateNetworkArgs{
    					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.VpcPrivateNetwork("pn");
    
        var main = new Scaleway.RedisCluster("main", new()
        {
            Version = "6.2.7",
            NodeType = "RED1-MICRO",
            UserName = "my_initial_user",
            Password = "thiZ_is_v&ry_s3cret",
            ClusterSize = 1,
            PrivateNetworks = new[]
            {
                new Scaleway.Inputs.RedisClusterPrivateNetworkArgs
                {
                    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.VpcPrivateNetwork;
    import com.pulumi.scaleway.RedisCluster;
    import com.pulumi.scaleway.RedisClusterArgs;
    import com.pulumi.scaleway.inputs.RedisClusterPrivateNetworkArgs;
    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 VpcPrivateNetwork("pn");
    
            var main = new RedisCluster("main", RedisClusterArgs.builder()
                .version("6.2.7")
                .nodeType("RED1-MICRO")
                .userName("my_initial_user")
                .password("thiZ_is_v&ry_s3cret")
                .clusterSize(1)
                .privateNetworks(RedisClusterPrivateNetworkArgs.builder()
                    .id(pn.id())
                    .serviceIps("10.12.1.1/20")
                    .build())
                .build(), CustomResourceOptions.builder()
                    .dependsOn(pn)
                    .build());
    
        }
    }
    
    resources:
      pn:
        type: scaleway:VpcPrivateNetwork
      main:
        type: scaleway:RedisCluster
        properties:
          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 RedisCluster Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new RedisCluster(name: string, args: RedisClusterArgs, opts?: CustomResourceOptions);
    @overload
    def RedisCluster(resource_name: str,
                     args: RedisClusterArgs,
                     opts: Optional[ResourceOptions] = None)
    
    @overload
    def RedisCluster(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[RedisClusterPrivateNetworkArgs]] = None,
                     acls: Optional[Sequence[RedisClusterAclArgs]] = None,
                     public_network: Optional[RedisClusterPublicNetworkArgs] = 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 NewRedisCluster(ctx *Context, name string, args RedisClusterArgs, opts ...ResourceOption) (*RedisCluster, error)
    public RedisCluster(string name, RedisClusterArgs args, CustomResourceOptions? opts = null)
    public RedisCluster(String name, RedisClusterArgs args)
    public RedisCluster(String name, RedisClusterArgs args, CustomResourceOptions options)
    
    type: scaleway:RedisCluster
    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 RedisClusterArgs
    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 RedisClusterArgs
    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 RedisClusterArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args RedisClusterArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args RedisClusterArgs
    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 redisClusterResource = new Scaleway.RedisCluster("redisClusterResource", new()
    {
        Password = "string",
        Version = "string",
        UserName = "string",
        NodeType = "string",
        ProjectId = "string",
        PrivateNetworks = new[]
        {
            new Scaleway.Inputs.RedisClusterPrivateNetworkArgs
            {
                Id = "string",
                EndpointId = "string",
                ServiceIps = new[]
                {
                    "string",
                },
                Zone = "string",
            },
        },
        Acls = new[]
        {
            new Scaleway.Inputs.RedisClusterAclArgs
            {
                Ip = "string",
                Description = "string",
                Id = "string",
            },
        },
        PublicNetwork = new Scaleway.Inputs.RedisClusterPublicNetworkArgs
        {
            Id = "string",
            Ips = new[]
            {
                "string",
            },
            Port = 0,
        },
        Settings = 
        {
            { "string", "string" },
        },
        Tags = new[]
        {
            "string",
        },
        TlsEnabled = false,
        Name = "string",
        ClusterSize = 0,
        Zone = "string",
    });
    
    example, err := scaleway.NewRedisCluster(ctx, "redisClusterResource", &scaleway.RedisClusterArgs{
    	Password:  pulumi.String("string"),
    	Version:   pulumi.String("string"),
    	UserName:  pulumi.String("string"),
    	NodeType:  pulumi.String("string"),
    	ProjectId: pulumi.String("string"),
    	PrivateNetworks: scaleway.RedisClusterPrivateNetworkArray{
    		&scaleway.RedisClusterPrivateNetworkArgs{
    			Id:         pulumi.String("string"),
    			EndpointId: pulumi.String("string"),
    			ServiceIps: pulumi.StringArray{
    				pulumi.String("string"),
    			},
    			Zone: pulumi.String("string"),
    		},
    	},
    	Acls: scaleway.RedisClusterAclArray{
    		&scaleway.RedisClusterAclArgs{
    			Ip:          pulumi.String("string"),
    			Description: pulumi.String("string"),
    			Id:          pulumi.String("string"),
    		},
    	},
    	PublicNetwork: &scaleway.RedisClusterPublicNetworkArgs{
    		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 redisClusterResource = new RedisCluster("redisClusterResource", RedisClusterArgs.builder()
        .password("string")
        .version("string")
        .userName("string")
        .nodeType("string")
        .projectId("string")
        .privateNetworks(RedisClusterPrivateNetworkArgs.builder()
            .id("string")
            .endpointId("string")
            .serviceIps("string")
            .zone("string")
            .build())
        .acls(RedisClusterAclArgs.builder()
            .ip("string")
            .description("string")
            .id("string")
            .build())
        .publicNetwork(RedisClusterPublicNetworkArgs.builder()
            .id("string")
            .ips("string")
            .port(0)
            .build())
        .settings(Map.of("string", "string"))
        .tags("string")
        .tlsEnabled(false)
        .name("string")
        .clusterSize(0)
        .zone("string")
        .build());
    
    redis_cluster_resource = scaleway.RedisCluster("redisClusterResource",
        password="string",
        version="string",
        user_name="string",
        node_type="string",
        project_id="string",
        private_networks=[scaleway.RedisClusterPrivateNetworkArgs(
            id="string",
            endpoint_id="string",
            service_ips=["string"],
            zone="string",
        )],
        acls=[scaleway.RedisClusterAclArgs(
            ip="string",
            description="string",
            id="string",
        )],
        public_network=scaleway.RedisClusterPublicNetworkArgs(
            id="string",
            ips=["string"],
            port=0,
        ),
        settings={
            "string": "string",
        },
        tags=["string"],
        tls_enabled=False,
        name="string",
        cluster_size=0,
        zone="string")
    
    const redisClusterResource = new scaleway.RedisCluster("redisClusterResource", {
        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:RedisCluster
    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
    

    RedisCluster Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    The RedisCluster resource accepts the following input properties:

    NodeType string

    The type of Redis™ cluster you want to create (e.g. RED1-M).

    Important: Updates to node_type will migrate the Redis™ cluster to the desired node_type. Keep in mind that you cannot downgrade a Redis™ cluster.

    Password string
    Password for the first user of the Redis™ cluster.
    UserName string
    Identifier for the first user of the Redis™ cluster.
    Version string

    Redis™ cluster's version (e.g. 6.2.7).

    Important: Updates to version will migrate the Redis™ cluster to the desired version. Keep in mind that you cannot downgrade a Redis™ cluster.

    Acls List<Pulumiverse.Scaleway.Inputs.RedisClusterAcl>
    List of acl rules, this is cluster's authorized IPs. More details on the ACL section.
    ClusterSize int

    The number of nodes in the Redis™ cluster.

    Important: You cannot set cluster_size to 2, you either have to choose Standalone mode (1 node) or cluster mode which is minimum 3 (1 main node + 2 secondary nodes)

    Important: If you are using the cluster mode (>=3 nodes), you can set a bigger cluster_size than you initially did, it will migrate the Redis™ cluster but keep in mind that you cannot downgrade a Redis™ cluster, so setting a smaller cluster_size will destroy and recreate your cluster.

    Important: If you are using the Standalone mode (1 node), setting a bigger cluster_size will destroy and recreate your cluster as you will be switching to the cluster mode.

    Name string
    The name of the Redis™ cluster.
    PrivateNetworks List<Pulumiverse.Scaleway.Inputs.RedisClusterPrivateNetwork>
    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
    ProjectId string
    project_id) The ID of the project the Redis™ cluster is associated with.
    PublicNetwork Pulumiverse.Scaleway.Inputs.RedisClusterPublicNetwork

    (Optional) Public network details. Only one of private_network and public_network may be set.

    The public_network block 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
    Tags List<string>
    The tags associated with the Redis™ cluster.
    TlsEnabled bool

    Whether TLS is enabled or not.

    The changes on tls_enabled will force the resource creation.

    Zone string
    zone) The zone in which the Redis™ cluster should be created.
    NodeType string

    The type of Redis™ cluster you want to create (e.g. RED1-M).

    Important: Updates to node_type will migrate the Redis™ cluster to the desired node_type. Keep in mind that you cannot downgrade a Redis™ cluster.

    Password string
    Password for the first user of the Redis™ cluster.
    UserName string
    Identifier for the first user of the Redis™ cluster.
    Version string

    Redis™ cluster's version (e.g. 6.2.7).

    Important: Updates to version will migrate the Redis™ cluster to the desired version. Keep in mind that you cannot downgrade a Redis™ cluster.

    Acls []RedisClusterAclArgs
    List of acl rules, this is cluster's authorized IPs. More details on the ACL section.
    ClusterSize int

    The number of nodes in the Redis™ cluster.

    Important: You cannot set cluster_size to 2, you either have to choose Standalone mode (1 node) or cluster mode which is minimum 3 (1 main node + 2 secondary nodes)

    Important: If you are using the cluster mode (>=3 nodes), you can set a bigger cluster_size than you initially did, it will migrate the Redis™ cluster but keep in mind that you cannot downgrade a Redis™ cluster, so setting a smaller cluster_size will destroy and recreate your cluster.

    Important: If you are using the Standalone mode (1 node), setting a bigger cluster_size will destroy and recreate your cluster as you will be switching to the cluster mode.

    Name string
    The name of the Redis™ cluster.
    PrivateNetworks []RedisClusterPrivateNetworkArgs
    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
    ProjectId string
    project_id) The ID of the project the Redis™ cluster is associated with.
    PublicNetwork RedisClusterPublicNetworkArgs

    (Optional) Public network details. Only one of private_network and public_network may be set.

    The public_network block 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
    Tags []string
    The tags associated with the Redis™ cluster.
    TlsEnabled bool

    Whether TLS is enabled or not.

    The changes on tls_enabled will force the resource creation.

    Zone string
    zone) The zone in which the Redis™ cluster should be created.
    nodeType String

    The type of Redis™ cluster you want to create (e.g. RED1-M).

    Important: Updates to node_type will migrate the Redis™ cluster to the desired node_type. Keep in mind that you cannot downgrade a Redis™ cluster.

    password String
    Password for the first user of the Redis™ cluster.
    userName String
    Identifier for the first user of the Redis™ cluster.
    version String

    Redis™ cluster's version (e.g. 6.2.7).

    Important: Updates to version will migrate the Redis™ cluster to the desired version. Keep in mind that you cannot downgrade a Redis™ cluster.

    acls List<RedisClusterAcl>
    List of acl rules, this is cluster's authorized IPs. More details on the ACL section.
    clusterSize Integer

    The number of nodes in the Redis™ cluster.

    Important: You cannot set cluster_size to 2, you either have to choose Standalone mode (1 node) or cluster mode which is minimum 3 (1 main node + 2 secondary nodes)

    Important: If you are using the cluster mode (>=3 nodes), you can set a bigger cluster_size than you initially did, it will migrate the Redis™ cluster but keep in mind that you cannot downgrade a Redis™ cluster, so setting a smaller cluster_size will destroy and recreate your cluster.

    Important: If you are using the Standalone mode (1 node), setting a bigger cluster_size will destroy and recreate your cluster as you will be switching to the cluster mode.

    name String
    The name of the Redis™ cluster.
    privateNetworks List<RedisClusterPrivateNetwork>
    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
    projectId String
    project_id) The ID of the project the Redis™ cluster is associated with.
    publicNetwork RedisClusterPublicNetwork

    (Optional) Public network details. Only one of private_network and public_network may be set.

    The public_network block 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
    tags List<String>
    The tags associated with the Redis™ cluster.
    tlsEnabled Boolean

    Whether TLS is enabled or not.

    The changes on tls_enabled will force the resource creation.

    zone String
    zone) The zone in which the Redis™ cluster should be created.
    nodeType string

    The type of Redis™ cluster you want to create (e.g. RED1-M).

    Important: Updates to node_type will migrate the Redis™ cluster to the desired node_type. Keep in mind that you cannot downgrade a Redis™ cluster.

    password string
    Password for the first user of the Redis™ cluster.
    userName string
    Identifier for the first user of the Redis™ cluster.
    version string

    Redis™ cluster's version (e.g. 6.2.7).

    Important: Updates to version will migrate the Redis™ cluster to the desired version. Keep in mind that you cannot downgrade a Redis™ cluster.

    acls RedisClusterAcl[]
    List of acl rules, this is cluster's authorized IPs. More details on the ACL section.
    clusterSize number

    The number of nodes in the Redis™ cluster.

    Important: You cannot set cluster_size to 2, you either have to choose Standalone mode (1 node) or cluster mode which is minimum 3 (1 main node + 2 secondary nodes)

    Important: If you are using the cluster mode (>=3 nodes), you can set a bigger cluster_size than you initially did, it will migrate the Redis™ cluster but keep in mind that you cannot downgrade a Redis™ cluster, so setting a smaller cluster_size will destroy and recreate your cluster.

    Important: If you are using the Standalone mode (1 node), setting a bigger cluster_size will destroy and recreate your cluster as you will be switching to the cluster mode.

    name string
    The name of the Redis™ cluster.
    privateNetworks RedisClusterPrivateNetwork[]
    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
    projectId string
    project_id) The ID of the project the Redis™ cluster is associated with.
    publicNetwork RedisClusterPublicNetwork

    (Optional) Public network details. Only one of private_network and public_network may be set.

    The public_network block 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
    tags string[]
    The tags associated with the Redis™ cluster.
    tlsEnabled boolean

    Whether TLS is enabled or not.

    The changes on tls_enabled will 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_type will migrate the Redis™ cluster to the desired node_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 version will migrate the Redis™ cluster to the desired version. Keep in mind that you cannot downgrade a Redis™ cluster.

    acls Sequence[RedisClusterAclArgs]
    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: You cannot set cluster_size to 2, you either have to choose Standalone mode (1 node) or cluster mode which is minimum 3 (1 main node + 2 secondary nodes)

    Important: If you are using the cluster mode (>=3 nodes), you can set a bigger cluster_size than you initially did, it will migrate the Redis™ cluster but keep in mind that you cannot downgrade a Redis™ cluster, so setting a smaller cluster_size will destroy and recreate your cluster.

    Important: If you are using the Standalone mode (1 node), setting a bigger cluster_size will 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[RedisClusterPrivateNetworkArgs]
    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 RedisClusterPublicNetworkArgs

    (Optional) Public network details. Only one of private_network and public_network may be set.

    The public_network block 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
    tags Sequence[str]
    The tags associated with the Redis™ cluster.
    tls_enabled bool

    Whether TLS is enabled or not.

    The changes on tls_enabled will force the resource creation.

    zone str
    zone) The zone in which the Redis™ cluster should be created.
    nodeType String

    The type of Redis™ cluster you want to create (e.g. RED1-M).

    Important: Updates to node_type will migrate the Redis™ cluster to the desired node_type. Keep in mind that you cannot downgrade a Redis™ cluster.

    password String
    Password for the first user of the Redis™ cluster.
    userName String
    Identifier for the first user of the Redis™ cluster.
    version String

    Redis™ cluster's version (e.g. 6.2.7).

    Important: Updates to version will migrate the Redis™ cluster to the desired version. 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.
    clusterSize Number

    The number of nodes in the Redis™ cluster.

    Important: You cannot set cluster_size to 2, you either have to choose Standalone mode (1 node) or cluster mode which is minimum 3 (1 main node + 2 secondary nodes)

    Important: If you are using the cluster mode (>=3 nodes), you can set a bigger cluster_size than you initially did, it will migrate the Redis™ cluster but keep in mind that you cannot downgrade a Redis™ cluster, so setting a smaller cluster_size will destroy and recreate your cluster.

    Important: If you are using the Standalone mode (1 node), setting a bigger cluster_size will destroy and recreate your cluster as you will be switching to the cluster mode.

    name String
    The name of the Redis™ cluster.
    privateNetworks 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
    projectId String
    project_id) The ID of the project the Redis™ cluster is associated with.
    publicNetwork Property Map

    (Optional) Public network details. Only one of private_network and public_network may be set.

    The public_network block exports:

    settings Map<String>
    Map of settings for Redis™ cluster. Available settings can be found by listing Redis™ versions with scaleway API or CLI
    tags List<String>
    The tags associated with the Redis™ cluster.
    tlsEnabled Boolean

    Whether TLS is enabled or not.

    The changes on tls_enabled will 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 RedisCluster resource produces the following output properties:

    Certificate string
    The PEM of the certificate used by redis, only when tls_enabled is true
    CreatedAt string
    The date and time of creation of the Redis™ cluster.
    Id string
    The provider-assigned unique ID for this managed resource.
    UpdatedAt 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_enabled is true
    CreatedAt string
    The date and time of creation of the Redis™ cluster.
    Id string
    The provider-assigned unique ID for this managed resource.
    UpdatedAt 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_enabled is true
    createdAt String
    The date and time of creation of the Redis™ cluster.
    id String
    The provider-assigned unique ID for this managed resource.
    updatedAt 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_enabled is true
    createdAt string
    The date and time of creation of the Redis™ cluster.
    id string
    The provider-assigned unique ID for this managed resource.
    updatedAt 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_enabled is 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_enabled is true
    createdAt String
    The date and time of creation of the Redis™ cluster.
    id String
    The provider-assigned unique ID for this managed resource.
    updatedAt String
    The date and time of the last update of the Redis™ cluster.

    Look up Existing RedisCluster Resource

    Get an existing RedisCluster 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?: RedisClusterState, opts?: CustomResourceOptions): RedisCluster
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            acls: Optional[Sequence[RedisClusterAclArgs]] = 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[RedisClusterPrivateNetworkArgs]] = None,
            project_id: Optional[str] = None,
            public_network: Optional[RedisClusterPublicNetworkArgs] = 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) -> RedisCluster
    func GetRedisCluster(ctx *Context, name string, id IDInput, state *RedisClusterState, opts ...ResourceOption) (*RedisCluster, error)
    public static RedisCluster Get(string name, Input<string> id, RedisClusterState? state, CustomResourceOptions? opts = null)
    public static RedisCluster get(String name, Output<String> id, RedisClusterState state, CustomResourceOptions options)
    Resource lookup is not supported in YAML
    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.
    The following state arguments are supported:
    Acls List<Pulumiverse.Scaleway.Inputs.RedisClusterAcl>
    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_enabled is true
    ClusterSize int

    The number of nodes in the Redis™ cluster.

    Important: You cannot set cluster_size to 2, you either have to choose Standalone mode (1 node) or cluster mode which is minimum 3 (1 main node + 2 secondary nodes)

    Important: If you are using the cluster mode (>=3 nodes), you can set a bigger cluster_size than you initially did, it will migrate the Redis™ cluster but keep in mind that you cannot downgrade a Redis™ cluster, so setting a smaller cluster_size will destroy and recreate your cluster.

    Important: If you are using the Standalone mode (1 node), setting a bigger cluster_size will destroy and recreate your cluster as you will be switching to the cluster mode.

    CreatedAt string
    The date and time of creation of the Redis™ cluster.
    Name string
    The name of the Redis™ cluster.
    NodeType string

    The type of Redis™ cluster you want to create (e.g. RED1-M).

    Important: Updates to node_type will migrate the Redis™ cluster to the desired node_type. Keep in mind that you cannot downgrade a Redis™ cluster.

    Password string
    Password for the first user of the Redis™ cluster.
    PrivateNetworks List<Pulumiverse.Scaleway.Inputs.RedisClusterPrivateNetwork>
    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
    ProjectId string
    project_id) The ID of the project the Redis™ cluster is associated with.
    PublicNetwork Pulumiverse.Scaleway.Inputs.RedisClusterPublicNetwork

    (Optional) Public network details. Only one of private_network and public_network may be set.

    The public_network block 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
    Tags List<string>
    The tags associated with the Redis™ cluster.
    TlsEnabled bool

    Whether TLS is enabled or not.

    The changes on tls_enabled will force the resource creation.

    UpdatedAt string
    The date and time of the last update of the Redis™ cluster.
    UserName string
    Identifier for the first user of the Redis™ cluster.
    Version string

    Redis™ cluster's version (e.g. 6.2.7).

    Important: Updates to version will migrate the Redis™ cluster to the desired version. Keep in mind that you cannot downgrade a Redis™ cluster.

    Zone string
    zone) The zone in which the Redis™ cluster should be created.
    Acls []RedisClusterAclArgs
    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_enabled is true
    ClusterSize int

    The number of nodes in the Redis™ cluster.

    Important: You cannot set cluster_size to 2, you either have to choose Standalone mode (1 node) or cluster mode which is minimum 3 (1 main node + 2 secondary nodes)

    Important: If you are using the cluster mode (>=3 nodes), you can set a bigger cluster_size than you initially did, it will migrate the Redis™ cluster but keep in mind that you cannot downgrade a Redis™ cluster, so setting a smaller cluster_size will destroy and recreate your cluster.

    Important: If you are using the Standalone mode (1 node), setting a bigger cluster_size will destroy and recreate your cluster as you will be switching to the cluster mode.

    CreatedAt string
    The date and time of creation of the Redis™ cluster.
    Name string
    The name of the Redis™ cluster.
    NodeType string

    The type of Redis™ cluster you want to create (e.g. RED1-M).

    Important: Updates to node_type will migrate the Redis™ cluster to the desired node_type. Keep in mind that you cannot downgrade a Redis™ cluster.

    Password string
    Password for the first user of the Redis™ cluster.
    PrivateNetworks []RedisClusterPrivateNetworkArgs
    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
    ProjectId string
    project_id) The ID of the project the Redis™ cluster is associated with.
    PublicNetwork RedisClusterPublicNetworkArgs

    (Optional) Public network details. Only one of private_network and public_network may be set.

    The public_network block 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
    Tags []string
    The tags associated with the Redis™ cluster.
    TlsEnabled bool

    Whether TLS is enabled or not.

    The changes on tls_enabled will force the resource creation.

    UpdatedAt string
    The date and time of the last update of the Redis™ cluster.
    UserName string
    Identifier for the first user of the Redis™ cluster.
    Version string

    Redis™ cluster's version (e.g. 6.2.7).

    Important: Updates to version will migrate the Redis™ cluster to the desired version. 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<RedisClusterAcl>
    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_enabled is true
    clusterSize Integer

    The number of nodes in the Redis™ cluster.

    Important: You cannot set cluster_size to 2, you either have to choose Standalone mode (1 node) or cluster mode which is minimum 3 (1 main node + 2 secondary nodes)

    Important: If you are using the cluster mode (>=3 nodes), you can set a bigger cluster_size than you initially did, it will migrate the Redis™ cluster but keep in mind that you cannot downgrade a Redis™ cluster, so setting a smaller cluster_size will destroy and recreate your cluster.

    Important: If you are using the Standalone mode (1 node), setting a bigger cluster_size will destroy and recreate your cluster as you will be switching to the cluster mode.

    createdAt String
    The date and time of creation of the Redis™ cluster.
    name String
    The name of the Redis™ cluster.
    nodeType String

    The type of Redis™ cluster you want to create (e.g. RED1-M).

    Important: Updates to node_type will migrate the Redis™ cluster to the desired node_type. Keep in mind that you cannot downgrade a Redis™ cluster.

    password String
    Password for the first user of the Redis™ cluster.
    privateNetworks List<RedisClusterPrivateNetwork>
    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
    projectId String
    project_id) The ID of the project the Redis™ cluster is associated with.
    publicNetwork RedisClusterPublicNetwork

    (Optional) Public network details. Only one of private_network and public_network may be set.

    The public_network block 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
    tags List<String>
    The tags associated with the Redis™ cluster.
    tlsEnabled Boolean

    Whether TLS is enabled or not.

    The changes on tls_enabled will force the resource creation.

    updatedAt String
    The date and time of the last update of the Redis™ cluster.
    userName String
    Identifier for the first user of the Redis™ cluster.
    version String

    Redis™ cluster's version (e.g. 6.2.7).

    Important: Updates to version will migrate the Redis™ cluster to the desired version. Keep in mind that you cannot downgrade a Redis™ cluster.

    zone String
    zone) The zone in which the Redis™ cluster should be created.
    acls RedisClusterAcl[]
    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_enabled is true
    clusterSize number

    The number of nodes in the Redis™ cluster.

    Important: You cannot set cluster_size to 2, you either have to choose Standalone mode (1 node) or cluster mode which is minimum 3 (1 main node + 2 secondary nodes)

    Important: If you are using the cluster mode (>=3 nodes), you can set a bigger cluster_size than you initially did, it will migrate the Redis™ cluster but keep in mind that you cannot downgrade a Redis™ cluster, so setting a smaller cluster_size will destroy and recreate your cluster.

    Important: If you are using the Standalone mode (1 node), setting a bigger cluster_size will destroy and recreate your cluster as you will be switching to the cluster mode.

    createdAt string
    The date and time of creation of the Redis™ cluster.
    name string
    The name of the Redis™ cluster.
    nodeType string

    The type of Redis™ cluster you want to create (e.g. RED1-M).

    Important: Updates to node_type will migrate the Redis™ cluster to the desired node_type. Keep in mind that you cannot downgrade a Redis™ cluster.

    password string
    Password for the first user of the Redis™ cluster.
    privateNetworks RedisClusterPrivateNetwork[]
    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
    projectId string
    project_id) The ID of the project the Redis™ cluster is associated with.
    publicNetwork RedisClusterPublicNetwork

    (Optional) Public network details. Only one of private_network and public_network may be set.

    The public_network block 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
    tags string[]
    The tags associated with the Redis™ cluster.
    tlsEnabled boolean

    Whether TLS is enabled or not.

    The changes on tls_enabled will force the resource creation.

    updatedAt string
    The date and time of the last update of the Redis™ cluster.
    userName string
    Identifier for the first user of the Redis™ cluster.
    version string

    Redis™ cluster's version (e.g. 6.2.7).

    Important: Updates to version will migrate the Redis™ cluster to the desired version. 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[RedisClusterAclArgs]
    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_enabled is true
    cluster_size int

    The number of nodes in the Redis™ cluster.

    Important: You cannot set cluster_size to 2, you either have to choose Standalone mode (1 node) or cluster mode which is minimum 3 (1 main node + 2 secondary nodes)

    Important: If you are using the cluster mode (>=3 nodes), you can set a bigger cluster_size than you initially did, it will migrate the Redis™ cluster but keep in mind that you cannot downgrade a Redis™ cluster, so setting a smaller cluster_size will destroy and recreate your cluster.

    Important: If you are using the Standalone mode (1 node), setting a bigger cluster_size will 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_type will migrate the Redis™ cluster to the desired node_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[RedisClusterPrivateNetworkArgs]
    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 RedisClusterPublicNetworkArgs

    (Optional) Public network details. Only one of private_network and public_network may be set.

    The public_network block 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
    tags Sequence[str]
    The tags associated with the Redis™ cluster.
    tls_enabled bool

    Whether TLS is enabled or not.

    The changes on tls_enabled will 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 version will migrate the Redis™ cluster to the desired version. 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_enabled is true
    clusterSize Number

    The number of nodes in the Redis™ cluster.

    Important: You cannot set cluster_size to 2, you either have to choose Standalone mode (1 node) or cluster mode which is minimum 3 (1 main node + 2 secondary nodes)

    Important: If you are using the cluster mode (>=3 nodes), you can set a bigger cluster_size than you initially did, it will migrate the Redis™ cluster but keep in mind that you cannot downgrade a Redis™ cluster, so setting a smaller cluster_size will destroy and recreate your cluster.

    Important: If you are using the Standalone mode (1 node), setting a bigger cluster_size will destroy and recreate your cluster as you will be switching to the cluster mode.

    createdAt String
    The date and time of creation of the Redis™ cluster.
    name String
    The name of the Redis™ cluster.
    nodeType String

    The type of Redis™ cluster you want to create (e.g. RED1-M).

    Important: Updates to node_type will migrate the Redis™ cluster to the desired node_type. Keep in mind that you cannot downgrade a Redis™ cluster.

    password String
    Password for the first user of the Redis™ cluster.
    privateNetworks 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
    projectId String
    project_id) The ID of the project the Redis™ cluster is associated with.
    publicNetwork Property Map

    (Optional) Public network details. Only one of private_network and public_network may be set.

    The public_network block exports:

    settings Map<String>
    Map of settings for Redis™ cluster. Available settings can be found by listing Redis™ versions with scaleway API or CLI
    tags List<String>
    The tags associated with the Redis™ cluster.
    tlsEnabled Boolean

    Whether TLS is enabled or not.

    The changes on tls_enabled will force the resource creation.

    updatedAt String
    The date and time of the last update of the Redis™ cluster.
    userName String
    Identifier for the first user of the Redis™ cluster.
    version String

    Redis™ cluster's version (e.g. 6.2.7).

    Important: Updates to version will migrate the Redis™ cluster to the desired version. 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

    RedisClusterAcl, RedisClusterAclArgs

    Ip string
    The IP range to whitelist in CIDR notation
    Description string

    A text describing this rule. Default description: Allow IP

    The acl conflict with private_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 IP

    The acl conflict with private_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 IP

    The acl conflict with private_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 IP

    The acl conflict with private_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 IP

    The acl conflict with private_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 IP

    The acl conflict with private_network. Only one should be specified.

    id String
    (Required) The UUID of the endpoint.

    RedisClusterPrivateNetwork, RedisClusterPrivateNetworkArgs

    Id string
    The UUID of the Private Network resource.
    EndpointId string
    The ID of the endpoint.
    ServiceIps 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.

    The private_network conflicts with acl. 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 your private_network and 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. Your service_ips must be listed as follows:

    import * as pulumi from "@pulumi/pulumi";
    
    import pulumi
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    

    return await Deployment.RunAsync(() => { });

    package main
    
    import (
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		return nil
    	})
    }
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    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) {
        }
    }
    
    {}
    
    Zone string
    zone) The zone in which the Redis™ cluster should be created.
    Id string
    The UUID of the Private Network resource.
    EndpointId string
    The ID of the endpoint.
    ServiceIps []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.

    The private_network conflicts with acl. 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 your private_network and 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. Your service_ips must be listed as follows:

    import * as pulumi from "@pulumi/pulumi";
    
    import pulumi
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    

    return await Deployment.RunAsync(() => { });

    package main
    
    import (
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		return nil
    	})
    }
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    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) {
        }
    }
    
    {}
    
    Zone string
    zone) The zone in which the Redis™ cluster should be created.
    id String
    The UUID of the Private Network resource.
    endpointId String
    The ID of the endpoint.
    serviceIps 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.

    The private_network conflicts with acl. 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 your private_network and 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. Your service_ips must be listed as follows:

    import * as pulumi from "@pulumi/pulumi";
    
    import pulumi
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    

    return await Deployment.RunAsync(() => { });

    package main
    
    import (
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		return nil
    	})
    }
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    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) {
        }
    }
    
    {}
    
    zone String
    zone) The zone in which the Redis™ cluster should be created.
    id string
    The UUID of the Private Network resource.
    endpointId string
    The ID of the endpoint.
    serviceIps 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.

    The private_network conflicts with acl. 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 your private_network and 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. Your service_ips must be listed as follows:

    import * as pulumi from "@pulumi/pulumi";
    
    import pulumi
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    

    return await Deployment.RunAsync(() => { });

    package main
    
    import (
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		return nil
    	})
    }
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    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) {
        }
    }
    
    {}
    
    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.

    The private_network conflicts with acl. 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 your private_network and 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. Your service_ips must be listed as follows:

    import * as pulumi from "@pulumi/pulumi";
    
    import pulumi
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    

    return await Deployment.RunAsync(() => { });

    package main
    
    import (
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		return nil
    	})
    }
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    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) {
        }
    }
    
    {}
    
    zone str
    zone) The zone in which the Redis™ cluster should be created.
    id String
    The UUID of the Private Network resource.
    endpointId String
    The ID of the endpoint.
    serviceIps 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.

    The private_network conflicts with acl. 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 your private_network and 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. Your service_ips must be listed as follows:

    import * as pulumi from "@pulumi/pulumi";
    
    import pulumi
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    

    return await Deployment.RunAsync(() => { });

    package main
    
    import (
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		return nil
    	})
    }
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    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) {
        }
    }
    
    {}
    
    zone String
    zone) The zone in which the Redis™ cluster should be created.

    RedisClusterPublicNetwork, RedisClusterPublicNetworkArgs

    Id string
    (Required) The UUID of the endpoint.
    Ips List<string>
    Lis of IPv4 address of the endpoint (IP address).
    Port int
    TCP port of the endpoint.
    Id string
    (Required) The UUID of the endpoint.
    Ips []string
    Lis of IPv4 address of the endpoint (IP address).
    Port int
    TCP port of the endpoint.
    id String
    (Required) The UUID of the endpoint.
    ips List<String>
    Lis of IPv4 address of the endpoint (IP address).
    port Integer
    TCP port of the endpoint.
    id string
    (Required) The UUID of the endpoint.
    ips string[]
    Lis of IPv4 address of the endpoint (IP address).
    port number
    TCP port of the endpoint.
    id str
    (Required) The UUID of the endpoint.
    ips Sequence[str]
    Lis of IPv4 address of the endpoint (IP address).
    port int
    TCP port of the endpoint.
    id String
    (Required) The UUID of the endpoint.
    ips List<String>
    Lis of IPv4 address of the endpoint (IP address).
    port Number
    TCP port of the endpoint.

    Import

    Redis™ cluster can be imported using the {zone}/{id}, e.g.

    bash

    $ pulumi import scaleway:index/redisCluster:RedisCluster 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 scaleway Terraform Provider.
    scaleway logo
    Scaleway v1.15.0 published on Tuesday, Jul 30, 2024 by pulumiverse