getCluster

Scaleway v1.44.1, Mar 9 26

Viewing docs for Scaleway v1.44.1
published on Monday, Mar 9, 2026 by pulumiverse

Schema (JSON)

pulumiverse/pulumi-scaleway

Viewing docs for Scaleway v1.44.1
published on Monday, Mar 9, 2026 by pulumiverse

Schema (JSON)

pulumiverse/pulumi-scaleway

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.

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,
                region: 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,
                region: 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:kafka/getCluster:getCluster
  arguments:
    # arguments dictionary

The following arguments are supported:

ClusterId string: The ID of the Kafka cluster
Name string: Name of the Kafka cluster
ProjectId string: The project_id you want to attach the resource to
Region string: The region you want to attach the resource to

ClusterId string: The ID of the Kafka cluster
Name string: Name of the Kafka cluster
ProjectId string: The project_id you want to attach the resource to
Region string: The region you want to attach the resource to

clusterId String: The ID of the Kafka cluster
name String: Name of the Kafka cluster
projectId String: The project_id you want to attach the resource to
region String: The region you want to attach the resource to

clusterId string: The ID of the Kafka cluster
name string: Name of the Kafka cluster
projectId string: The project_id you want to attach the resource to
region string: The region you want to attach the resource to

cluster_id str: The ID of the Kafka cluster
name str: Name of the Kafka cluster
project_id str: The project_id you want to attach the resource to
region str: The region you want to attach the resource to

clusterId String: The ID of the Kafka cluster
name String: Name of the Kafka cluster
projectId String: The project_id you want to attach the resource to
region String: The region you want to attach the resource to

getCluster Result

The following output properties are available:

CreatedAt string: Date and time of cluster creation (RFC 3339 format)
Id string: The provider-assigned unique ID for this managed resource.
NodeAmount int: Number of nodes in the cluster
NodeType string: Node type to use for the cluster
Password string: Password for the Kafka user
PrivateNetworks List<Pulumiverse.Scaleway.Kafka.Outputs.GetClusterPrivateNetwork>: Private network to expose your Kafka cluster
PublicNetworks List<Pulumiverse.Scaleway.Kafka.Outputs.GetClusterPublicNetwork>: Public endpoint configuration
Status string: The status of the cluster
Tags List<string>: List of tags to apply
UpdatedAt string: Date and time of cluster last update (RFC 3339 format)
UserName string: Username for the Kafka user
Version string: Kafka version to use
VolumeSizeInGb int: Volume size in GB
VolumeType string: Type of volume where data is stored
ClusterId string: The ID of the Kafka cluster
Name string: Name of the Kafka cluster
ProjectId string: The project_id you want to attach the resource to
Region string: The region you want to attach the resource to

CreatedAt string: Date and time of cluster creation (RFC 3339 format)
Id string: The provider-assigned unique ID for this managed resource.
NodeAmount int: Number of nodes in the cluster
NodeType string: Node type to use for the cluster
Password string: Password for the Kafka user
PrivateNetworks []GetClusterPrivateNetwork: Private network to expose your Kafka cluster
PublicNetworks []GetClusterPublicNetwork: Public endpoint configuration
Status string: The status of the cluster
Tags []string: List of tags to apply
UpdatedAt string: Date and time of cluster last update (RFC 3339 format)
UserName string: Username for the Kafka user
Version string: Kafka version to use
VolumeSizeInGb int: Volume size in GB
VolumeType string: Type of volume where data is stored
ClusterId string: The ID of the Kafka cluster
Name string: Name of the Kafka cluster
ProjectId string: The project_id you want to attach the resource to
Region string: The region you want to attach the resource to

createdAt String: Date and time of cluster creation (RFC 3339 format)
id String: The provider-assigned unique ID for this managed resource.
nodeAmount Integer: Number of nodes in the cluster
nodeType String: Node type to use for the cluster
password String: Password for the Kafka user
privateNetworks List<GetClusterPrivateNetwork>: Private network to expose your Kafka cluster
publicNetworks List<GetClusterPublicNetwork>: Public endpoint configuration
status String: The status of the cluster
tags List<String>: List of tags to apply
updatedAt String: Date and time of cluster last update (RFC 3339 format)
userName String: Username for the Kafka user
version String: Kafka version to use
volumeSizeInGb Integer: Volume size in GB
volumeType String: Type of volume where data is stored
clusterId String: The ID of the Kafka cluster
name String: Name of the Kafka cluster
projectId String: The project_id you want to attach the resource to
region String: The region you want to attach the resource to

createdAt string: Date and time of cluster creation (RFC 3339 format)
id string: The provider-assigned unique ID for this managed resource.
nodeAmount number: Number of nodes in the cluster
nodeType string: Node type to use for the cluster
password string: Password for the Kafka user
privateNetworks GetClusterPrivateNetwork[]: Private network to expose your Kafka cluster
publicNetworks GetClusterPublicNetwork[]: Public endpoint configuration
status string: The status of the cluster
tags string[]: List of tags to apply
updatedAt string: Date and time of cluster last update (RFC 3339 format)
userName string: Username for the Kafka user
version string: Kafka version to use
volumeSizeInGb number: Volume size in GB
volumeType string: Type of volume where data is stored
clusterId string: The ID of the Kafka cluster
name string: Name of the Kafka cluster
projectId string: The project_id you want to attach the resource to
region string: The region you want to attach the resource to

created_at str: Date and time of cluster creation (RFC 3339 format)
id str: The provider-assigned unique ID for this managed resource.
node_amount int: Number of nodes in the cluster
node_type str: Node type to use for the cluster
password str: Password for the Kafka user
private_networks Sequence[GetClusterPrivateNetwork]: Private network to expose your Kafka cluster
public_networks Sequence[GetClusterPublicNetwork]: Public endpoint configuration
status str: The status of the cluster
tags Sequence[str]: List of tags to apply
updated_at str: Date and time of cluster last update (RFC 3339 format)
user_name str: Username for the Kafka user
version str: Kafka version to use
volume_size_in_gb int: Volume size in GB
volume_type str: Type of volume where data is stored
cluster_id str: The ID of the Kafka cluster
name str: Name of the Kafka cluster
project_id str: The project_id you want to attach the resource to
region str: The region you want to attach the resource to

createdAt String: Date and time of cluster creation (RFC 3339 format)
id String: The provider-assigned unique ID for this managed resource.
nodeAmount Number: Number of nodes in the cluster
nodeType String: Node type to use for the cluster
password String: Password for the Kafka user
privateNetworks List<Property Map>: Private network to expose your Kafka cluster
publicNetworks List<Property Map>: Public endpoint configuration
status String: The status of the cluster
tags List<String>: List of tags to apply
updatedAt String: Date and time of cluster last update (RFC 3339 format)
userName String: Username for the Kafka user
version String: Kafka version to use
volumeSizeInGb Number: Volume size in GB
volumeType String: Type of volume where data is stored
clusterId String: The ID of the Kafka cluster
name String: Name of the Kafka cluster
projectId String: The project_id you want to attach the resource to
region String: The region you want to attach the resource to

Supporting Types

GetClusterPrivateNetwork

DnsRecords List<string>: DNS records for the private endpoint
Id string: The endpoint ID
PnId string: The private network ID
Port int: TCP port number

DnsRecords []string: DNS records for the private endpoint
Id string: The endpoint ID
PnId string: The private network ID
Port int: TCP port number

dnsRecords List<String>: DNS records for the private endpoint
id String: The endpoint ID
pnId String: The private network ID
port Integer: TCP port number

dnsRecords string[]: DNS records for the private endpoint
id string: The endpoint ID
pnId string: The private network ID
port number: TCP port number

dns_records Sequence[str]: DNS records for the private endpoint
id str: The endpoint ID
pn_id str: The private network ID
port int: TCP port number

dnsRecords List<String>: DNS records for the private endpoint
id String: The endpoint ID
pnId String: The private network ID
port Number: TCP port number

GetClusterPublicNetwork

DnsRecords List<string>: DNS records for the public endpoint
Id string: ID of the public endpoint
Port int: TCP port number

DnsRecords []string: DNS records for the public endpoint
Id string: ID of the public endpoint
Port int: TCP port number

dnsRecords List<String>: DNS records for the public endpoint
id String: ID of the public endpoint
port Integer: TCP port number

dnsRecords string[]: DNS records for the public endpoint
id string: ID of the public endpoint
port number: TCP port number

dns_records Sequence[str]: DNS records for the public endpoint
id str: ID of the public endpoint
port int: TCP port number

dnsRecords List<String>: DNS records for the public endpoint
id String: ID of the public endpoint
port Number: TCP port number

Package Details

Repository: scaleway pulumiverse/pulumi-scaleway
License: Apache-2.0
Notes: This Pulumi package is based on the scaleway Terraform Provider.

Viewing docs for Scaleway v1.44.1
published on Monday, Mar 9, 2026 by pulumiverse

Schema (JSON)

pulumiverse/pulumi-scaleway

scaleway.kafka.getCluster

On this page

On this page

Using getCluster

getCluster Result

Supporting Types

GetClusterPrivateNetwork

GetClusterPublicNetwork

Package Details

On this page

On this page