Scaleway v1.26.0, Mar 28 25

Scaleway v1.26.0 published on Friday, Mar 28, 2025 by pulumiverse

scaleway.redis.getCluster

Explore with Pulumi AI

Scaleway v1.26.0 published on Friday, Mar 28, 2025 by pulumiverse

Using getCluster

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.

TypeScript
Python
Go
C#
Java
YAML

function getCluster(args: GetClusterArgs, opts?: InvokeOptions): Promise<GetClusterResult>
function getClusterOutput(args: GetClusterOutputArgs, opts?: InvokeOptions): Output<GetClusterResult>

def get_cluster(cluster_id: Optional[str] = None,
                name: Optional[str] = None,
                project_id: Optional[str] = None,
                zone: Optional[str] = None,
                opts: Optional[InvokeOptions] = None) -> GetClusterResult
def get_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[GetClusterResult]

func LookupCluster(ctx *Context, args *LookupClusterArgs, opts ...InvokeOption) (*LookupClusterResult, error)
func LookupClusterOutput(ctx *Context, args *LookupClusterOutputArgs, opts ...InvokeOption) LookupClusterResultOutput

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

public static class GetCluster 
{
    public static Task<GetClusterResult> InvokeAsync(GetClusterArgs args, InvokeOptions? opts = null)
    public static Output<GetClusterResult> Invoke(GetClusterInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetClusterResult> getCluster(GetClusterArgs args, InvokeOptions options)
public static Output<GetClusterResult> getCluster(GetClusterArgs args, InvokeOptions options)

fn::invoke:
  function: scaleway:redis/getCluster:getCluster
  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.

getCluster Result

The following output properties are available:

Acls List<Pulumiverse.Scaleway.Redis.Outputs.GetClusterAcl>: 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.Redis.Outputs.GetClusterPrivateNetwork>: List of private networks endpoints of the Redis Cluster.
PublicNetworks List<Pulumiverse.Scaleway.Redis.Outputs.GetClusterPublicNetwork>: 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 []GetClusterAcl: 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 []GetClusterPrivateNetwork: List of private networks endpoints of the Redis Cluster.
PublicNetworks []GetClusterPublicNetwork: 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<GetClusterAcl>: 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<GetClusterPrivateNetwork>: List of private networks endpoints of the Redis Cluster.
publicNetworks List<GetClusterPublicNetwork>: 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 GetClusterAcl[]: 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 GetClusterPrivateNetwork[]: List of private networks endpoints of the Redis Cluster.
publicNetworks GetClusterPublicNetwork[]: 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[GetClusterAcl]: 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[GetClusterPrivateNetwork]: List of private networks endpoints of the Redis Cluster.
public_networks Sequence[GetClusterPublicNetwork]: 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

GetClusterAcl

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).

GetClusterPrivateNetwork

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.

GetClusterPublicNetwork

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 v1.26.0 published on Friday, Mar 28, 2025 by pulumiverse

pulumiverse/pulumi-scaleway

scaleway.redis.getCluster

On this page

On this page

Using getCluster

getCluster Result

Supporting Types

GetClusterAcl

GetClusterPrivateNetwork

GetClusterPublicNetwork

Package Details

On this page

On this page