1. Registry
  2. Packages
  3. Scaleway
  4. API Docs
  5. messageq
  6. getDeployment
Viewing docs for Scaleway v1.60.0
published on Saturday, Oct 24, 2026 by pulumiverse
scaleway logo
Viewing docs for Scaleway v1.60.0
published on Saturday, Oct 24, 2026 by pulumiverse

    Gets information about a Scaleway MessageQ deployment.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as scaleway from "@pulumiverse/scaleway";
    
    const main = new scaleway.messageq.Deployment("main", {
        name: "my-messageq",
        version: "4.0",
        nodeCount: 1,
        nodeType: "MESSAGEQ-SHARED-2C-8G",
        userName: "admin",
        password: "ThisIsASecurePassword123!",
        volume: {
            type: "sbs_5k",
            sizeInGb: 5,
        },
    });
    const byName = scaleway.messageq.getDeploymentOutput({
        name: main.name,
    });
    
    import pulumi
    import pulumi_scaleway as scaleway
    import pulumiverse_scaleway as scaleway
    
    main = scaleway.messageq.Deployment("main",
        name="my-messageq",
        version="4.0",
        node_count=1,
        node_type="MESSAGEQ-SHARED-2C-8G",
        user_name="admin",
        password="ThisIsASecurePassword123!",
        volume={
            "type": "sbs_5k",
            "size_in_gb": 5,
        })
    by_name = scaleway.messageq.get_deployment_output(name=main.name)
    
    package main
    
    import (
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    	"github.com/pulumiverse/pulumi-scaleway/sdk/go/scaleway/messageq"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		main, err := messageq.NewDeployment(ctx, "main", &messageq.DeploymentArgs{
    			Name:      pulumi.String("my-messageq"),
    			Version:   pulumi.String("4.0"),
    			NodeCount: pulumi.Int(1),
    			NodeType:  pulumi.String("MESSAGEQ-SHARED-2C-8G"),
    			UserName:  pulumi.String("admin"),
    			Password:  pulumi.String("ThisIsASecurePassword123!"),
    			Volume: &messageq.DeploymentVolumeArgs{
    				Type:     pulumi.String("sbs_5k"),
    				SizeInGb: pulumi.Int(5),
    			},
    		})
    		if err != nil {
    			return err
    		}
    		_ = messageq.LookupDeploymentOutput(ctx, messageq.GetDeploymentOutputArgs{
    			Name: main.Name,
    		}, nil)
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Scaleway = Pulumiverse.Scaleway;
    
    return await Deployment.RunAsync(() => 
    {
        var main = new Scaleway.Messageq.Deployment("main", new()
        {
            Name = "my-messageq",
            Version = "4.0",
            NodeCount = 1,
            NodeType = "MESSAGEQ-SHARED-2C-8G",
            UserName = "admin",
            Password = "ThisIsASecurePassword123!",
            Volume = new Scaleway.Messageq.Inputs.DeploymentVolumeArgs
            {
                Type = "sbs_5k",
                SizeInGb = 5,
            },
        });
    
        var byName = Scaleway.Messageq.GetDeployment.Invoke(new()
        {
            Name = main.Name,
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.scaleway.messageq.Deployment;
    import com.pulumi.scaleway.messageq.DeploymentArgs;
    import com.pulumi.scaleway.messageq.inputs.DeploymentVolumeArgs;
    import com.pulumi.scaleway.messageq.MessageqFunctions;
    import com.pulumi.scaleway.messageq.inputs.GetDeploymentArgs;
    import java.util.ArrayList;
    import java.util.Arrays;
    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 Deployment("main", DeploymentArgs.builder()
                .name("my-messageq")
                .version("4.0")
                .nodeCount(1)
                .nodeType("MESSAGEQ-SHARED-2C-8G")
                .userName("admin")
                .password("ThisIsASecurePassword123!")
                .volume(DeploymentVolumeArgs.builder()
                    .type("sbs_5k")
                    .sizeInGb(5)
                    .build())
                .build());
    
            final var byName = MessageqFunctions.getDeployment(GetDeploymentArgs.builder()
                .name(main.name())
                .build());
    
        }
    }
    
    resources:
      main:
        type: scaleway:messageq:Deployment
        properties:
          name: my-messageq
          version: '4.0'
          nodeCount: 1
          nodeType: MESSAGEQ-SHARED-2C-8G
          userName: admin
          password: ThisIsASecurePassword123!
          volume:
            type: sbs_5k
            sizeInGb: 5
    variables:
      byName:
        fn::invoke:
          function: scaleway:messageq:getDeployment
          arguments:
            name: ${main.name}
    
    pulumi {
      required_providers {
        scaleway = {
          source = "pulumi/scaleway"
        }
      }
    }
    
    data "scaleway_messageq_getdeployment" "byName" {
      name = scaleway_messageq_deployment.main.name
    }
    
    resource "scaleway_messageq_deployment" "main" {
      name       = "my-messageq"
      version    = "4.0"
      node_count = 1
      node_type  = "MESSAGEQ-SHARED-2C-8G"
      user_name  = "admin"
      password   = "ThisIsASecurePassword123!"
      volume = {
        type       = "sbs_5k"
        size_in_gb = 5
      }
    }
    

    Using getDeployment

    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 getDeployment(args: GetDeploymentArgs, opts?: InvokeOptions): Promise<GetDeploymentResult>
    function getDeploymentOutput(args: GetDeploymentOutputArgs, opts?: InvokeOutputOptions): Output<GetDeploymentResult>
    def get_deployment(deployment_id: Optional[str] = None,
                       name: Optional[str] = None,
                       project_id: Optional[str] = None,
                       region: Optional[str] = None,
                       opts: Optional[InvokeOptions] = None) -> GetDeploymentResult
    def get_deployment_output(deployment_id: pulumi.Input[Optional[str]] = None,
                       name: pulumi.Input[Optional[str]] = None,
                       project_id: pulumi.Input[Optional[str]] = None,
                       region: pulumi.Input[Optional[str]] = None,
                       opts: Optional[InvokeOutputOptions] = None) -> Output[GetDeploymentResult]
    func LookupDeployment(ctx *Context, args *LookupDeploymentArgs, opts ...InvokeOption) (*LookupDeploymentResult, error)
    func LookupDeploymentOutput(ctx *Context, args *LookupDeploymentOutputArgs, opts ...InvokeOption) LookupDeploymentResultOutput

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

    public static class GetDeployment 
    {
        public static Task<GetDeploymentResult> InvokeAsync(GetDeploymentArgs args, InvokeOptions? opts = null)
        public static Output<GetDeploymentResult> Invoke(GetDeploymentInvokeArgs args, InvokeOptions? opts = null)
        public static Output<GetDeploymentResult> Invoke(GetDeploymentInvokeArgs args, InvokeOutputOptions opts)
    }
    public static CompletableFuture<GetDeploymentResult> getDeployment(GetDeploymentArgs args, InvokeOptions options)
    public static Output<GetDeploymentResult> getDeployment(GetDeploymentArgs args, InvokeOptions options)
    public static Output<GetDeploymentResult> getDeployment(GetDeploymentArgs args, InvokeOutputOptions options)
    
    fn::invoke:
      function: scaleway:messageq/getDeployment:getDeployment
      arguments:
        # arguments dictionary
    data "scaleway_messageq_get_deployment" "name" {
        # arguments
    }

    The following arguments are supported:

    DeploymentId string
    The ID of the deployment. Only one of name and deploymentId should be specified.
    Name string
    The name of the deployment. Only one of name and deploymentId should be specified.
    ProjectId string
    The ID of the project the deployment is associated with.
    Region string
    region) The region in which the deployment exists.
    DeploymentId string
    The ID of the deployment. Only one of name and deploymentId should be specified.
    Name string
    The name of the deployment. Only one of name and deploymentId should be specified.
    ProjectId string
    The ID of the project the deployment is associated with.
    Region string
    region) The region in which the deployment exists.
    deployment_id string
    The ID of the deployment. Only one of name and deploymentId should be specified.
    name string
    The name of the deployment. Only one of name and deploymentId should be specified.
    project_id string
    The ID of the project the deployment is associated with.
    region string
    region) The region in which the deployment exists.
    deploymentId String
    The ID of the deployment. Only one of name and deploymentId should be specified.
    name String
    The name of the deployment. Only one of name and deploymentId should be specified.
    projectId String
    The ID of the project the deployment is associated with.
    region String
    region) The region in which the deployment exists.
    deploymentId string
    The ID of the deployment. Only one of name and deploymentId should be specified.
    name string
    The name of the deployment. Only one of name and deploymentId should be specified.
    projectId string
    The ID of the project the deployment is associated with.
    region string
    region) The region in which the deployment exists.
    deployment_id str
    The ID of the deployment. Only one of name and deploymentId should be specified.
    name str
    The name of the deployment. Only one of name and deploymentId should be specified.
    project_id str
    The ID of the project the deployment is associated with.
    region str
    region) The region in which the deployment exists.
    deploymentId String
    The ID of the deployment. Only one of name and deploymentId should be specified.
    name String
    The name of the deployment. Only one of name and deploymentId should be specified.
    projectId String
    The ID of the project the deployment is associated with.
    region String
    region) The region in which the deployment exists.

    getDeployment Result

    The following output properties are available:

    CreatedAt string
    Creation date (RFC 3339).
    Endpoints List<Pulumiverse.Scaleway.Messageq.Outputs.GetDeploymentEndpoint>
    All endpoints returned by the API for the deployment (public and private when both exist).
    Id string
    The ID of the endpoint.
    Name string
    Service name.
    NodeCount int
    Number of nodes.
    NodeType string
    Type of node.
    ProjectId string
    Project ID the deployment belongs to.
    Region string
    Status string
    Status of the deployment.
    Tags List<string>
    Tags of the deployment.
    UpdatedAt string
    Last update date (RFC 3339).
    Version string
    MessageQ version.
    Volume Pulumiverse.Scaleway.Messageq.Outputs.GetDeploymentVolume
    Volume configuration (type, sizeInGb).
    DeploymentId string
    CreatedAt string
    Creation date (RFC 3339).
    Endpoints []GetDeploymentEndpoint
    All endpoints returned by the API for the deployment (public and private when both exist).
    Id string
    The ID of the endpoint.
    Name string
    Service name.
    NodeCount int
    Number of nodes.
    NodeType string
    Type of node.
    ProjectId string
    Project ID the deployment belongs to.
    Region string
    Status string
    Status of the deployment.
    Tags []string
    Tags of the deployment.
    UpdatedAt string
    Last update date (RFC 3339).
    Version string
    MessageQ version.
    Volume GetDeploymentVolume
    Volume configuration (type, sizeInGb).
    DeploymentId string
    created_at string
    Creation date (RFC 3339).
    endpoints list(object)
    All endpoints returned by the API for the deployment (public and private when both exist).
    id string
    The ID of the endpoint.
    name string
    Service name.
    node_count number
    Number of nodes.
    node_type string
    Type of node.
    project_id string
    Project ID the deployment belongs to.
    region string
    status string
    Status of the deployment.
    tags list(string)
    Tags of the deployment.
    updated_at string
    Last update date (RFC 3339).
    version string
    MessageQ version.
    volume object
    Volume configuration (type, sizeInGb).
    deployment_id string
    createdAt String
    Creation date (RFC 3339).
    endpoints List<GetDeploymentEndpoint>
    All endpoints returned by the API for the deployment (public and private when both exist).
    id String
    The ID of the endpoint.
    name String
    Service name.
    nodeCount Integer
    Number of nodes.
    nodeType String
    Type of node.
    projectId String
    Project ID the deployment belongs to.
    region String
    status String
    Status of the deployment.
    tags List<String>
    Tags of the deployment.
    updatedAt String
    Last update date (RFC 3339).
    version String
    MessageQ version.
    volume GetDeploymentVolume
    Volume configuration (type, sizeInGb).
    deploymentId String
    createdAt string
    Creation date (RFC 3339).
    endpoints GetDeploymentEndpoint[]
    All endpoints returned by the API for the deployment (public and private when both exist).
    id string
    The ID of the endpoint.
    name string
    Service name.
    nodeCount number
    Number of nodes.
    nodeType string
    Type of node.
    projectId string
    Project ID the deployment belongs to.
    region string
    status string
    Status of the deployment.
    tags string[]
    Tags of the deployment.
    updatedAt string
    Last update date (RFC 3339).
    version string
    MessageQ version.
    volume GetDeploymentVolume
    Volume configuration (type, sizeInGb).
    deploymentId string
    created_at str
    Creation date (RFC 3339).
    endpoints Sequence[GetDeploymentEndpoint]
    All endpoints returned by the API for the deployment (public and private when both exist).
    id str
    The ID of the endpoint.
    name str
    Service name.
    node_count int
    Number of nodes.
    node_type str
    Type of node.
    project_id str
    Project ID the deployment belongs to.
    region str
    status str
    Status of the deployment.
    tags Sequence[str]
    Tags of the deployment.
    updated_at str
    Last update date (RFC 3339).
    version str
    MessageQ version.
    volume GetDeploymentVolume
    Volume configuration (type, sizeInGb).
    deployment_id str
    createdAt String
    Creation date (RFC 3339).
    endpoints List<Property Map>
    All endpoints returned by the API for the deployment (public and private when both exist).
    id String
    The ID of the endpoint.
    name String
    Service name.
    nodeCount Number
    Number of nodes.
    nodeType String
    Type of node.
    projectId String
    Project ID the deployment belongs to.
    region String
    status String
    Status of the deployment.
    tags List<String>
    Tags of the deployment.
    updatedAt String
    Last update date (RFC 3339).
    version String
    MessageQ version.
    volume Property Map
    Volume configuration (type, sizeInGb).
    deploymentId String

    Supporting Types

    GetDeploymentEndpoint

    Id string
    The ID of the endpoint.
    PrivateNetworkId string
    Private network ID if the endpoint is private.
    Public bool
    Whether the endpoint is public (true) or private (false).
    Services List<Pulumiverse.Scaleway.Messageq.Inputs.GetDeploymentEndpointService>
    List of services exposed on the endpoint.
    Id string
    The ID of the endpoint.
    PrivateNetworkId string
    Private network ID if the endpoint is private.
    Public bool
    Whether the endpoint is public (true) or private (false).
    Services []GetDeploymentEndpointService
    List of services exposed on the endpoint.
    id string
    The ID of the endpoint.
    private_network_id string
    Private network ID if the endpoint is private.
    public bool
    Whether the endpoint is public (true) or private (false).
    services list(object)
    List of services exposed on the endpoint.
    id String
    The ID of the endpoint.
    privateNetworkId String
    Private network ID if the endpoint is private.
    public_ Boolean
    Whether the endpoint is public (true) or private (false).
    services List<GetDeploymentEndpointService>
    List of services exposed on the endpoint.
    id string
    The ID of the endpoint.
    privateNetworkId string
    Private network ID if the endpoint is private.
    public boolean
    Whether the endpoint is public (true) or private (false).
    services GetDeploymentEndpointService[]
    List of services exposed on the endpoint.
    id str
    The ID of the endpoint.
    private_network_id str
    Private network ID if the endpoint is private.
    public bool
    Whether the endpoint is public (true) or private (false).
    services Sequence[GetDeploymentEndpointService]
    List of services exposed on the endpoint.
    id String
    The ID of the endpoint.
    privateNetworkId String
    Private network ID if the endpoint is private.
    public Boolean
    Whether the endpoint is public (true) or private (false).
    services List<Property Map>
    List of services exposed on the endpoint.

    GetDeploymentEndpointService

    Name string
    The name of the deployment. Only one of name and deploymentId should be specified.
    Port int
    Service port.
    Url string
    Service URL.
    Name string
    The name of the deployment. Only one of name and deploymentId should be specified.
    Port int
    Service port.
    Url string
    Service URL.
    name string
    The name of the deployment. Only one of name and deploymentId should be specified.
    port number
    Service port.
    url string
    Service URL.
    name String
    The name of the deployment. Only one of name and deploymentId should be specified.
    port Integer
    Service port.
    url String
    Service URL.
    name string
    The name of the deployment. Only one of name and deploymentId should be specified.
    port number
    Service port.
    url string
    Service URL.
    name str
    The name of the deployment. Only one of name and deploymentId should be specified.
    port int
    Service port.
    url str
    Service URL.
    name String
    The name of the deployment. Only one of name and deploymentId should be specified.
    port Number
    Service port.
    url String
    Service URL.

    GetDeploymentVolume

    SizeInGb int
    Volume size in GB
    Type string
    Volume type (sbs_5k, sbs_15k)
    SizeInGb int
    Volume size in GB
    Type string
    Volume type (sbs_5k, sbs_15k)
    size_in_gb number
    Volume size in GB
    type string
    Volume type (sbs_5k, sbs_15k)
    sizeInGb Integer
    Volume size in GB
    type String
    Volume type (sbs_5k, sbs_15k)
    sizeInGb number
    Volume size in GB
    type string
    Volume type (sbs_5k, sbs_15k)
    size_in_gb int
    Volume size in GB
    type str
    Volume type (sbs_5k, sbs_15k)
    sizeInGb Number
    Volume size in GB
    type String
    Volume type (sbs_5k, sbs_15k)

    Package Details

    Repository
    scaleway pulumiverse/pulumi-scaleway
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the scaleway Terraform Provider.
    scaleway logo
    Viewing docs for Scaleway v1.60.0
    published on Saturday, Oct 24, 2026 by pulumiverse

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial