Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Scaleway
  3. API Docs
  4. getRedisCluster
Scaleway v1.15.0 published on Tuesday, Jul 30, 2024 by pulumiverse
pulumiverse/pulumi-scaleway

scaleway.getRedisCluster

Explore with Pulumi AI

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

    Gets information about a Redis™ cluster.

    For further information refer to the Managed Database for Redis™ API documentation.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
import * as scaleway from "@pulumi/scaleway";

const myCluster = scaleway.getRedisCluster({
    clusterId: "11111111-1111-1111-1111-111111111111",
});

    import pulumi
import pulumi_scaleway as scaleway

my_cluster = scaleway.get_redis_cluster(cluster_id="11111111-1111-1111-1111-111111111111")

    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.LookupRedisCluster(ctx, &scaleway.LookupRedisClusterArgs{
			ClusterId: pulumi.StringRef("11111111-1111-1111-1111-111111111111"),
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Scaleway = Pulumi.Scaleway;

return await Deployment.RunAsync(() => 
{
    var myCluster = Scaleway.GetRedisCluster.Invoke(new()
    {
        ClusterId = "11111111-1111-1111-1111-111111111111",
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.scaleway.ScalewayFunctions;
import com.pulumi.scaleway.inputs.GetRedisClusterArgs;
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) {
        final var myCluster = ScalewayFunctions.getRedisCluster(GetRedisClusterArgs.builder()
            .clusterId("11111111-1111-1111-1111-111111111111")
            .build());

    }
}

    variables:
  myCluster:
    fn::invoke:
      Function: scaleway:getRedisCluster
      Arguments:
        clusterId: 11111111-1111-1111-1111-111111111111

    Using getRedisCluster

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getRedisCluster(args: GetRedisClusterArgs, opts?: InvokeOptions): Promise<GetRedisClusterResult>
function getRedisClusterOutput(args: GetRedisClusterOutputArgs, opts?: InvokeOptions): Output<GetRedisClusterResult>
    def get_redis_cluster(cluster_id: Optional[str] = None,
                      name: Optional[str] = None,
                      project_id: Optional[str] = None,
                      zone: Optional[str] = None,
                      opts: Optional[InvokeOptions] = None) -> GetRedisClusterResult
def get_redis_cluster_output(cluster_id: Optional[pulumi.Input[str]] = None,
                      name: Optional[pulumi.Input[str]] = None,
                      project_id: Optional[pulumi.Input[str]] = None,
                      zone: Optional[pulumi.Input[str]] = None,
                      opts: Optional[InvokeOptions] = None) -> Output[GetRedisClusterResult]
    func LookupRedisCluster(ctx *Context, args *LookupRedisClusterArgs, opts ...InvokeOption) (*LookupRedisClusterResult, error)
func LookupRedisClusterOutput(ctx *Context, args *LookupRedisClusterOutputArgs, opts ...InvokeOption) LookupRedisClusterResultOutput

    > Note: This function is named LookupRedisCluster in the Go SDK.

    public static class GetRedisCluster 
{
    public static Task<GetRedisClusterResult> InvokeAsync(GetRedisClusterArgs args, InvokeOptions? opts = null)
    public static Output<GetRedisClusterResult> Invoke(GetRedisClusterInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetRedisClusterResult> getRedisCluster(GetRedisClusterArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet

    fn::invoke:
  function: scaleway:index/getRedisCluster:getRedisCluster
  arguments:
    # arguments dictionary

    The following arguments are supported:

    ClusterId string

    The Redis cluster ID.

    Note You must specify at least one: name and/or cluster_id.

    Name string
    The name of the Redis cluster.
    ProjectId string
    The ID of the project the Redis cluster is associated with.
    Zone string
    region) The zone in which the server exists.
    ClusterId string

    The Redis cluster ID.

    Note You must specify at least one: name and/or cluster_id.

    Name string
    The name of the Redis cluster.
    ProjectId string
    The ID of the project the Redis cluster is associated with.
    Zone string
    region) The zone in which the server exists.
    clusterId String

    The Redis cluster ID.

    Note You must specify at least one: name and/or cluster_id.

    name String
    The name of the Redis cluster.
    projectId String
    The ID of the project the Redis cluster is associated with.
    zone String
    region) The zone in which the server exists.
    clusterId string

    The Redis cluster ID.

    Note You must specify at least one: name and/or cluster_id.

    name string
    The name of the Redis cluster.
    projectId string
    The ID of the project the Redis cluster is associated with.
    zone string
    region) The zone in which the server exists.
    cluster_id str

    The Redis cluster ID.

    Note You must specify at least one: name and/or cluster_id.

    name str
    The name of the Redis cluster.
    project_id str
    The ID of the project the Redis cluster is associated with.
    zone str
    region) The zone in which the server exists.
    clusterId String

    The Redis cluster ID.

    Note You must specify at least one: name and/or cluster_id.

    name String
    The name of the Redis cluster.
    projectId String
    The ID of the project the Redis cluster is associated with.
    zone String
    region) The zone in which the server exists.

    getRedisCluster Result

    The following output properties are available:

    Acls List<Pulumiverse.Scaleway.Outputs.GetRedisClusterAcl>
    List of acl rules.
    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.
    CreatedAt string
    The date and time of creation of the Redis Cluster.
    Id string
    The provider-assigned unique ID for this managed resource.
    NodeType string
    The type of Redis Cluster (e.g. RED1-M).
    Password string
    Password of the first user of the Redis Cluster.
    PrivateNetworks List<Pulumiverse.Scaleway.Outputs.GetRedisClusterPrivateNetwork>
    List of private networks endpoints of the Redis Cluster.
    PublicNetworks List<Pulumiverse.Scaleway.Outputs.GetRedisClusterPublicNetwork>
    Public network details.
    Settings Dictionary<string, string>
    Map of settings for redis cluster.
    Tags List<string>
    The tags associated with the Redis Cluster.
    TlsEnabled bool
    Whether TLS is enabled or not.
    UpdatedAt string
    The date and time of the last update of the Redis Cluster.
    UserName string
    The first user of the Redis Cluster.
    Version string
    Redis's Cluster version (e.g. 6.2.7).
    ClusterId string
    Name string
    ProjectId string
    Zone string
    Acls []GetRedisClusterAcl
    List of acl rules.
    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.
    CreatedAt string
    The date and time of creation of the Redis Cluster.
    Id string
    The provider-assigned unique ID for this managed resource.
    NodeType string
    The type of Redis Cluster (e.g. RED1-M).
    Password string
    Password of the first user of the Redis Cluster.
    PrivateNetworks []GetRedisClusterPrivateNetwork
    List of private networks endpoints of the Redis Cluster.
    PublicNetworks []GetRedisClusterPublicNetwork
    Public network details.
    Settings map[string]string
    Map of settings for redis cluster.
    Tags []string
    The tags associated with the Redis Cluster.
    TlsEnabled bool
    Whether TLS is enabled or not.
    UpdatedAt string
    The date and time of the last update of the Redis Cluster.
    UserName string
    The first user of the Redis Cluster.
    Version string
    Redis's Cluster version (e.g. 6.2.7).
    ClusterId string
    Name string
    ProjectId string
    Zone string
    acls List<GetRedisClusterAcl>
    List of acl rules.
    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.
    createdAt String
    The date and time of creation of the Redis Cluster.
    id String
    The provider-assigned unique ID for this managed resource.
    nodeType String
    The type of Redis Cluster (e.g. RED1-M).
    password String
    Password of the first user of the Redis Cluster.
    privateNetworks List<GetRedisClusterPrivateNetwork>
    List of private networks endpoints of the Redis Cluster.
    publicNetworks List<GetRedisClusterPublicNetwork>
    Public network details.
    settings Map<String,String>
    Map of settings for redis cluster.
    tags List<String>
    The tags associated with the Redis Cluster.
    tlsEnabled Boolean
    Whether TLS is enabled or not.
    updatedAt String
    The date and time of the last update of the Redis Cluster.
    userName String
    The first user of the Redis Cluster.
    version String
    Redis's Cluster version (e.g. 6.2.7).
    clusterId String
    name String
    projectId String
    zone String
    acls GetRedisClusterAcl[]
    List of acl rules.
    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.
    createdAt string
    The date and time of creation of the Redis Cluster.
    id string
    The provider-assigned unique ID for this managed resource.
    nodeType string
    The type of Redis Cluster (e.g. RED1-M).
    password string
    Password of the first user of the Redis Cluster.
    privateNetworks GetRedisClusterPrivateNetwork[]
    List of private networks endpoints of the Redis Cluster.
    publicNetworks GetRedisClusterPublicNetwork[]
    Public network details.
    settings {[key: string]: string}
    Map of settings for redis cluster.
    tags string[]
    The tags associated with the Redis Cluster.
    tlsEnabled boolean
    Whether TLS is enabled or not.
    updatedAt string
    The date and time of the last update of the Redis Cluster.
    userName string
    The first user of the Redis Cluster.
    version string
    Redis's Cluster version (e.g. 6.2.7).
    clusterId string
    name string
    projectId string
    zone string
    acls Sequence[GetRedisClusterAcl]
    List of acl rules.
    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.
    created_at str
    The date and time of creation of the Redis Cluster.
    id str
    The provider-assigned unique ID for this managed resource.
    node_type str
    The type of Redis Cluster (e.g. RED1-M).
    password str
    Password of the first user of the Redis Cluster.
    private_networks Sequence[GetRedisClusterPrivateNetwork]
    List of private networks endpoints of the Redis Cluster.
    public_networks Sequence[GetRedisClusterPublicNetwork]
    Public network details.
    settings Mapping[str, str]
    Map of settings for redis cluster.
    tags Sequence[str]
    The tags associated with the Redis Cluster.
    tls_enabled bool
    Whether TLS is enabled or not.
    updated_at str
    The date and time of the last update of the Redis Cluster.
    user_name str
    The first user of the Redis Cluster.
    version str
    Redis's Cluster version (e.g. 6.2.7).
    cluster_id str
    name str
    project_id str
    zone str
    acls List<Property Map>
    List of acl rules.
    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.
    createdAt String
    The date and time of creation of the Redis Cluster.
    id String
    The provider-assigned unique ID for this managed resource.
    nodeType String
    The type of Redis Cluster (e.g. RED1-M).
    password String
    Password of the first user of the Redis Cluster.
    privateNetworks List<Property Map>
    List of private networks endpoints of the Redis Cluster.
    publicNetworks List<Property Map>
    Public network details.
    settings Map<String>
    Map of settings for redis cluster.
    tags List<String>
    The tags associated with the Redis Cluster.
    tlsEnabled Boolean
    Whether TLS is enabled or not.
    updatedAt String
    The date and time of the last update of the Redis Cluster.
    userName String
    The first user of the Redis Cluster.
    version String
    Redis's Cluster version (e.g. 6.2.7).
    clusterId String
    name String
    projectId String
    zone String

    Supporting Types

    GetRedisClusterAcl

    Description string
    Description of the rule.
    Id string
    The ID of the Redis cluster.
    Ip string
    IPv4 network address of the rule (IP network in a CIDR format).
    Description string
    Description of the rule.
    Id string
    The ID of the Redis cluster.
    Ip string
    IPv4 network address of the rule (IP network in a CIDR format).
    description String
    Description of the rule.
    id String
    The ID of the Redis cluster.
    ip String
    IPv4 network address of the rule (IP network in a CIDR format).
    description string
    Description of the rule.
    id string
    The ID of the Redis cluster.
    ip string
    IPv4 network address of the rule (IP network in a CIDR format).
    description str
    Description of the rule.
    id str
    The ID of the Redis cluster.
    ip str
    IPv4 network address of the rule (IP network in a CIDR format).
    description String
    Description of the rule.
    id String
    The ID of the Redis cluster.
    ip String
    IPv4 network address of the rule (IP network in a CIDR format).

    GetRedisClusterPrivateNetwork

    EndpointId string
    The ID of the endpoint.
    Id string
    The ID of the Redis cluster.
    ServiceIps List<string>
    List of IPv4 addresses of the private network with a CIDR notation
    Zone string
    region) The zone in which the server exists.
    EndpointId string
    The ID of the endpoint.
    Id string
    The ID of the Redis cluster.
    ServiceIps []string
    List of IPv4 addresses of the private network with a CIDR notation
    Zone string
    region) The zone in which the server exists.
    endpointId String
    The ID of the endpoint.
    id String
    The ID of the Redis cluster.
    serviceIps List<String>
    List of IPv4 addresses of the private network with a CIDR notation
    zone String
    region) The zone in which the server exists.
    endpointId string
    The ID of the endpoint.
    id string
    The ID of the Redis cluster.
    serviceIps string[]
    List of IPv4 addresses of the private network with a CIDR notation
    zone string
    region) The zone in which the server exists.
    endpoint_id str
    The ID of the endpoint.
    id str
    The ID of the Redis cluster.
    service_ips Sequence[str]
    List of IPv4 addresses of the private network with a CIDR notation
    zone str
    region) The zone in which the server exists.
    endpointId String
    The ID of the endpoint.
    id String
    The ID of the Redis cluster.
    serviceIps List<String>
    List of IPv4 addresses of the private network with a CIDR notation
    zone String
    region) The zone in which the server exists.

    GetRedisClusterPublicNetwork

    Id string
    The ID of the Redis cluster.
    Ips List<string>
    Port int
    TCP port of the endpoint
    Id string
    The ID of the Redis cluster.
    Ips []string
    Port int
    TCP port of the endpoint
    id String
    The ID of the Redis cluster.
    ips List<String>
    port Integer
    TCP port of the endpoint
    id string
    The ID of the Redis cluster.
    ips string[]
    port number
    TCP port of the endpoint
    id str
    The ID of the Redis cluster.
    ips Sequence[str]
    port int
    TCP port of the endpoint
    id String
    The ID of the Redis cluster.
    ips List<String>
    port Number
    TCP port of the endpoint

    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
    pulumiverse/pulumi-scaleway