scaleway.opensearch.getDeployment

Scaleway v1.48.0, Apr 29 26

Viewing docs for Scaleway v1.48.0
published on Wednesday, Apr 29, 2026 by pulumiverse

Schema (JSON)

pulumiverse/pulumi-scaleway

Viewing docs for Scaleway v1.48.0
published on Wednesday, Apr 29, 2026 by pulumiverse

Schema (JSON)

pulumiverse/pulumi-scaleway

Example Usage

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

// Get info by name
const byName = scaleway.opensearch.getDeployment({
    name: "my-opensearch-cluster",
});
// Get info by deployment ID
const byId = scaleway.opensearch.getDeployment({
    deploymentId: "11111111-1111-1111-1111-111111111111",
});

import pulumi
import pulumi_scaleway as scaleway

# Get info by name
by_name = scaleway.opensearch.get_deployment(name="my-opensearch-cluster")
# Get info by deployment ID
by_id = scaleway.opensearch.get_deployment(deployment_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/opensearch"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		// Get info by name
		_, err := opensearch.LookupDeployment(ctx, &opensearch.LookupDeploymentArgs{
			Name: pulumi.StringRef("my-opensearch-cluster"),
		}, nil)
		if err != nil {
			return err
		}
		// Get info by deployment ID
		_, err = opensearch.LookupDeployment(ctx, &opensearch.LookupDeploymentArgs{
			DeploymentId: 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 = Pulumiverse.Scaleway;

return await Deployment.RunAsync(() => 
{
    // Get info by name
    var byName = Scaleway.Opensearch.GetDeployment.Invoke(new()
    {
        Name = "my-opensearch-cluster",
    });

    // Get info by deployment ID
    var byId = Scaleway.Opensearch.GetDeployment.Invoke(new()
    {
        DeploymentId = "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.opensearch.OpensearchFunctions;
import com.pulumi.scaleway.opensearch.inputs.GetDeploymentArgs;
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) {
        // Get info by name
        final var byName = OpensearchFunctions.getDeployment(GetDeploymentArgs.builder()
            .name("my-opensearch-cluster")
            .build());

        // Get info by deployment ID
        final var byId = OpensearchFunctions.getDeployment(GetDeploymentArgs.builder()
            .deploymentId("11111111-1111-1111-1111-111111111111")
            .build());

    }
}

variables:
  # Get info by name
  byName:
    fn::invoke:
      function: scaleway:opensearch:getDeployment
      arguments:
        name: my-opensearch-cluster
  # Get info by deployment ID
  byId:
    fn::invoke:
      function: scaleway:opensearch:getDeployment
      arguments:
        deploymentId: 11111111-1111-1111-1111-111111111111

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?: InvokeOptions): 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: 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[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 CompletableFuture<GetDeploymentResult> getDeployment(GetDeploymentArgs args, InvokeOptions options)
public static Output<GetDeploymentResult> getDeployment(GetDeploymentArgs args, InvokeOptions options)

fn::invoke:
  function: scaleway:opensearch/getDeployment:getDeployment
  arguments:
    # arguments dictionary

The following arguments are supported:

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

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

deploymentId String: The ID of the OpenSearch deployment. Only one of name and deploymentId should be specified.
name String: The name of the OpenSearch deployment. Only one of name and deploymentId should be specified.
projectId String: The ID of the project the OpenSearch deployment is associated with.
region String: region) The region in which the deployment exists.

deploymentId string: The ID of the OpenSearch deployment. Only one of name and deploymentId should be specified.
name string: The name of the OpenSearch deployment. Only one of name and deploymentId should be specified.
projectId string: The ID of the project the OpenSearch deployment is associated with.
region string: region) The region in which the deployment exists.

deployment_id str: The ID of the OpenSearch deployment. Only one of name and deploymentId should be specified.
name str: The name of the OpenSearch deployment. Only one of name and deploymentId should be specified.
project_id str: The ID of the project the OpenSearch deployment is associated with.
region str: region) The region in which the deployment exists.

deploymentId String: The ID of the OpenSearch deployment. Only one of name and deploymentId should be specified.
name String: The name of the OpenSearch deployment. Only one of name and deploymentId should be specified.
projectId String: The ID of the project the OpenSearch deployment is associated with.
region String: region) The region in which the deployment exists.

getDeployment Result

The following output properties are available:

CreatedAt string
Endpoints List<Pulumiverse.Scaleway.Opensearch.Outputs.GetDeploymentEndpoint>
Id string: The provider-assigned unique ID for this managed resource.
NodeAmount int
NodeType string
Password string
PrivateNetworks List<Pulumiverse.Scaleway.Opensearch.Outputs.GetDeploymentPrivateNetwork>
PublicDashboardUrl string
Status string
Tags List<string>
UpdatedAt string
UserName string
Version string
Volumes List<Pulumiverse.Scaleway.Opensearch.Outputs.GetDeploymentVolume>
DeploymentId string
Name string
ProjectId string
Region string

CreatedAt string
Endpoints []GetDeploymentEndpoint
Id string: The provider-assigned unique ID for this managed resource.
NodeAmount int
NodeType string
Password string
PrivateNetworks []GetDeploymentPrivateNetwork
PublicDashboardUrl string
Status string
Tags []string
UpdatedAt string
UserName string
Version string
Volumes []GetDeploymentVolume
DeploymentId string
Name string
ProjectId string
Region string

createdAt String
endpoints List<GetDeploymentEndpoint>
id String: The provider-assigned unique ID for this managed resource.
nodeAmount Integer
nodeType String
password String
privateNetworks List<GetDeploymentPrivateNetwork>
publicDashboardUrl String
status String
tags List<String>
updatedAt String
userName String
version String
volumes List<GetDeploymentVolume>
deploymentId String
name String
projectId String
region String

createdAt string
endpoints GetDeploymentEndpoint[]
id string: The provider-assigned unique ID for this managed resource.
nodeAmount number
nodeType string
password string
privateNetworks GetDeploymentPrivateNetwork[]
publicDashboardUrl string
status string
tags string[]
updatedAt string
userName string
version string
volumes GetDeploymentVolume[]
deploymentId string
name string
projectId string
region string

created_at str
endpoints Sequence[GetDeploymentEndpoint]
id str: The provider-assigned unique ID for this managed resource.
node_amount int
node_type str
password str
private_networks Sequence[GetDeploymentPrivateNetwork]
public_dashboard_url str
status str
tags Sequence[str]
updated_at str
user_name str
version str
volumes Sequence[GetDeploymentVolume]
deployment_id str
name str
project_id str
region str

createdAt String
endpoints List<Property Map>
id String: The provider-assigned unique ID for this managed resource.
nodeAmount Number
nodeType String
password String
privateNetworks List<Property Map>
publicDashboardUrl String
status String
tags List<String>
updatedAt String
userName String
version String
volumes List<Property Map>
deploymentId String
name String
projectId String
region String

Supporting Types

GetDeploymentEndpoint

Id string: Endpoint ID
PrivateNetworkId string: Private network ID if applicable
Public bool: Whether the endpoint is public
Services List<Pulumiverse.Scaleway.Opensearch.Inputs.GetDeploymentEndpointService>: List of services

Id string: Endpoint ID
PrivateNetworkId string: Private network ID if applicable
Public bool: Whether the endpoint is public
Services []GetDeploymentEndpointService: List of services

id String: Endpoint ID
privateNetworkId String: Private network ID if applicable
public_ Boolean: Whether the endpoint is public
services List<GetDeploymentEndpointService>: List of services

id string: Endpoint ID
privateNetworkId string: Private network ID if applicable
public boolean: Whether the endpoint is public
services GetDeploymentEndpointService[]: List of services

id str: Endpoint ID
private_network_id str: Private network ID if applicable
public bool: Whether the endpoint is public
services Sequence[GetDeploymentEndpointService]: List of services

id String: Endpoint ID
privateNetworkId String: Private network ID if applicable
public Boolean: Whether the endpoint is public
services List<Property Map>: List of services

GetDeploymentEndpointService

Name string: The name of the OpenSearch deployment. Only one of name and deploymentId should be specified.
Port int: Service port
Url string: Service URL

Name string: The name of the OpenSearch deployment. Only one of name and deploymentId should be specified.
Port int: Service port
Url string: Service URL

name String: The name of the OpenSearch deployment. Only one of name and deploymentId should be specified.
port Integer: Service port
url String: Service URL

name string: The name of the OpenSearch deployment. Only one of name and deploymentId should be specified.
port number: Service port
url string: Service URL

name str: The name of the OpenSearch deployment. Only one of name and deploymentId should be specified.
port int: Service port
url str: Service URL

name String: The name of the OpenSearch deployment. Only one of name and deploymentId should be specified.
port Number: Service port
url String: Service URL

GetDeploymentPrivateNetwork

PrivateNetworkId string: UUID of the Private Network

PrivateNetworkId string: UUID of the Private Network

privateNetworkId String: UUID of the Private Network

privateNetworkId string: UUID of the Private Network

private_network_id str: UUID of the Private Network

privateNetworkId String: UUID of the Private Network

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)

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.

Viewing docs for Scaleway v1.48.0
published on Wednesday, Apr 29, 2026 by pulumiverse

Schema (JSON)

pulumiverse/pulumi-scaleway

scaleway.opensearch.getDeployment

On this page

On this page

Example Usage

Using getDeployment

getDeployment Result

Supporting Types

GetDeploymentEndpoint

GetDeploymentEndpointService

GetDeploymentPrivateNetwork

GetDeploymentVolume

Package Details

On this page

On this page