1. Packages
  2. Scaleway
  3. API Docs
  4. getRedisCluster
Scaleway v1.12.1 published on Monday, Apr 15, 2024 by pulumiverse

scaleway.getRedisCluster

Explore with Pulumi AI

scaleway logo
Scaleway v1.12.1 published on Monday, Apr 15, 2024 by pulumiverse

    Gets information about a Redis cluster. For further information check our 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. Only one of the name and cluster_id should be specified.
    Name string
    The name of the Redis cluster. Only one of the name and cluster_id should be specified.
    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. Only one of the name and cluster_id should be specified.
    Name string
    The name of the Redis cluster. Only one of the name and cluster_id should be specified.
    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. Only one of the name and cluster_id should be specified.
    name String
    The name of the Redis cluster. Only one of the name and cluster_id should be specified.
    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. Only one of the name and cluster_id should be specified.
    name string
    The name of the Redis cluster. Only one of the name and cluster_id should be specified.
    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. Only one of the name and cluster_id should be specified.
    name str
    The name of the Redis cluster. Only one of the name and cluster_id should be specified.
    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. Only one of the name and cluster_id should be specified.
    name String
    The name of the Redis cluster. Only one of the name and cluster_id should be specified.
    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 []GetRedisClusterAcl
    Certificate string
    ClusterSize int
    CreatedAt string
    Id string
    The provider-assigned unique ID for this managed resource.
    NodeType string
    Password string
    PrivateNetworks []GetRedisClusterPrivateNetwork
    PublicNetworks []GetRedisClusterPublicNetwork
    Settings map[string]string
    Tags []string
    TlsEnabled bool
    UpdatedAt string
    UserName string
    Version string
    ClusterId string
    Name string
    ProjectId string
    Zone string
    acls List<GetRedisClusterAcl>
    certificate String
    clusterSize Integer
    createdAt String
    id String
    The provider-assigned unique ID for this managed resource.
    nodeType String
    password String
    privateNetworks List<GetRedisClusterPrivateNetwork>
    publicNetworks List<GetRedisClusterPublicNetwork>
    settings Map<String,String>
    tags List<String>
    tlsEnabled Boolean
    updatedAt String
    userName String
    version String
    clusterId String
    name String
    projectId String
    zone String
    acls GetRedisClusterAcl[]
    certificate string
    clusterSize number
    createdAt string
    id string
    The provider-assigned unique ID for this managed resource.
    nodeType string
    password string
    privateNetworks GetRedisClusterPrivateNetwork[]
    publicNetworks GetRedisClusterPublicNetwork[]
    settings {[key: string]: string}
    tags string[]
    tlsEnabled boolean
    updatedAt string
    userName string
    version string
    clusterId string
    name string
    projectId string
    zone string
    acls List<Property Map>
    certificate String
    clusterSize Number
    createdAt String
    id String
    The provider-assigned unique ID for this managed resource.
    nodeType String
    password String
    privateNetworks List<Property Map>
    publicNetworks List<Property Map>
    settings Map<String>
    tags List<String>
    tlsEnabled Boolean
    updatedAt String
    userName String
    version String
    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
    UUID of the endpoint to be connected to the cluster
    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
    UUID of the endpoint to be connected to the cluster
    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
    UUID of the endpoint to be connected to the cluster
    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
    UUID of the endpoint to be connected to the cluster
    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
    UUID of the endpoint to be connected to the cluster
    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
    UUID of the endpoint to be connected to the cluster
    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.12.1 published on Monday, Apr 15, 2024 by pulumiverse