1. Packages
  2. Scaleway
  3. API Docs
  4. opensearch
  5. Deployment
Viewing docs for Scaleway v1.44.1
published on Monday, Mar 9, 2026 by pulumiverse
scaleway logo
Viewing docs for Scaleway v1.44.1
published on Monday, Mar 9, 2026 by pulumiverse

    Import

    OpenSearch deployments can be imported using the {region}/{id}, e.g.

    bash

    $ pulumi import scaleway:opensearch/deployment:Deployment main fr-par/11111111-1111-1111-1111-111111111111
    

    Create Deployment Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new Deployment(name: string, args: DeploymentArgs, opts?: CustomResourceOptions);
    @overload
    def Deployment(resource_name: str,
                   args: DeploymentArgs,
                   opts: Optional[ResourceOptions] = None)
    
    @overload
    def Deployment(resource_name: str,
                   opts: Optional[ResourceOptions] = None,
                   node_amount: Optional[int] = None,
                   node_type: Optional[str] = None,
                   version: Optional[str] = None,
                   name: Optional[str] = None,
                   password: Optional[str] = None,
                   private_network: Optional[DeploymentPrivateNetworkArgs] = None,
                   project_id: Optional[str] = None,
                   region: Optional[str] = None,
                   tags: Optional[Sequence[str]] = None,
                   user_name: Optional[str] = None,
                   volume: Optional[DeploymentVolumeArgs] = None)
    func NewDeployment(ctx *Context, name string, args DeploymentArgs, opts ...ResourceOption) (*Deployment, error)
    public Deployment(string name, DeploymentArgs args, CustomResourceOptions? opts = null)
    public Deployment(String name, DeploymentArgs args)
    public Deployment(String name, DeploymentArgs args, CustomResourceOptions options)
    
    type: scaleway:opensearch:Deployment
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    

    Parameters

    name string
    The unique name of the resource.
    args DeploymentArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args DeploymentArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args DeploymentArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args DeploymentArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args DeploymentArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var exampledeploymentResourceResourceFromOpensearchdeployment = new Scaleway.Opensearch.Deployment("exampledeploymentResourceResourceFromOpensearchdeployment", new()
    {
        NodeAmount = 0,
        NodeType = "string",
        Version = "string",
        Name = "string",
        Password = "string",
        PrivateNetwork = new Scaleway.Opensearch.Inputs.DeploymentPrivateNetworkArgs
        {
            PrivateNetworkId = "string",
        },
        ProjectId = "string",
        Region = "string",
        Tags = new[]
        {
            "string",
        },
        UserName = "string",
        Volume = new Scaleway.Opensearch.Inputs.DeploymentVolumeArgs
        {
            SizeInGb = 0,
            Type = "string",
        },
    });
    
    example, err := opensearch.NewDeployment(ctx, "exampledeploymentResourceResourceFromOpensearchdeployment", &opensearch.DeploymentArgs{
    	NodeAmount: pulumi.Int(0),
    	NodeType:   pulumi.String("string"),
    	Version:    pulumi.String("string"),
    	Name:       pulumi.String("string"),
    	Password:   pulumi.String("string"),
    	PrivateNetwork: &opensearch.DeploymentPrivateNetworkArgs{
    		PrivateNetworkId: pulumi.String("string"),
    	},
    	ProjectId: pulumi.String("string"),
    	Region:    pulumi.String("string"),
    	Tags: pulumi.StringArray{
    		pulumi.String("string"),
    	},
    	UserName: pulumi.String("string"),
    	Volume: &opensearch.DeploymentVolumeArgs{
    		SizeInGb: pulumi.Int(0),
    		Type:     pulumi.String("string"),
    	},
    })
    
    var exampledeploymentResourceResourceFromOpensearchdeployment = new com.pulumi.scaleway.opensearch.Deployment("exampledeploymentResourceResourceFromOpensearchdeployment", com.pulumi.scaleway.opensearch.DeploymentArgs.builder()
        .nodeAmount(0)
        .nodeType("string")
        .version("string")
        .name("string")
        .password("string")
        .privateNetwork(DeploymentPrivateNetworkArgs.builder()
            .privateNetworkId("string")
            .build())
        .projectId("string")
        .region("string")
        .tags("string")
        .userName("string")
        .volume(DeploymentVolumeArgs.builder()
            .sizeInGb(0)
            .type("string")
            .build())
        .build());
    
    exampledeployment_resource_resource_from_opensearchdeployment = scaleway.opensearch.Deployment("exampledeploymentResourceResourceFromOpensearchdeployment",
        node_amount=0,
        node_type="string",
        version="string",
        name="string",
        password="string",
        private_network={
            "private_network_id": "string",
        },
        project_id="string",
        region="string",
        tags=["string"],
        user_name="string",
        volume={
            "size_in_gb": 0,
            "type": "string",
        })
    
    const exampledeploymentResourceResourceFromOpensearchdeployment = new scaleway.opensearch.Deployment("exampledeploymentResourceResourceFromOpensearchdeployment", {
        nodeAmount: 0,
        nodeType: "string",
        version: "string",
        name: "string",
        password: "string",
        privateNetwork: {
            privateNetworkId: "string",
        },
        projectId: "string",
        region: "string",
        tags: ["string"],
        userName: "string",
        volume: {
            sizeInGb: 0,
            type: "string",
        },
    });
    
    type: scaleway:opensearch:Deployment
    properties:
        name: string
        nodeAmount: 0
        nodeType: string
        password: string
        privateNetwork:
            privateNetworkId: string
        projectId: string
        region: string
        tags:
            - string
        userName: string
        version: string
        volume:
            sizeInGb: 0
            type: string
    

    Deployment Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The Deployment resource accepts the following input properties:

    NodeAmount int
    Number of nodes in the cluster. Changing this forces recreation of the deployment.
    NodeType string
    Type of node to use (e.g., "SEARCHDB-SHARED-2C-8G", "SEARCHDB-DEDICATED-2C-8G"). Changing this forces recreation of the deployment.
    Version string
    OpenSearch version to use (e.g., "2.0"). Changing this forces recreation of the deployment.
    Name string
    Name of the OpenSearch deployment. If not specified, a random name will be generated.
    Password string
    Password for the OpenSearch user. Must be at least 12 characters long. If not specified, you will need to reset the password through the API or console. Changing this forces recreation of the deployment.
    PrivateNetwork Pulumiverse.Scaleway.Opensearch.Inputs.DeploymentPrivateNetwork
    Private network configuration
    ProjectId string

    project_id) The ID of the project the deployment is associated with.

    Important: A public endpoint is automatically created by default. Private network endpoints can be added using a separate endpoint resource (coming soon).

    Important: The password must be at least 12 characters long. If not provided, you will need to reset it through the Scaleway console or API.

    Region string
    region) The region in which the deployment should be created.
    Tags List<string>
    List of tags to apply to the deployment.
    UserName string
    Username for the deployment. If not specified, the default username will be used. Changing this forces recreation of the deployment.
    Volume Pulumiverse.Scaleway.Opensearch.Inputs.DeploymentVolume
    Volume configuration for the cluster.
    NodeAmount int
    Number of nodes in the cluster. Changing this forces recreation of the deployment.
    NodeType string
    Type of node to use (e.g., "SEARCHDB-SHARED-2C-8G", "SEARCHDB-DEDICATED-2C-8G"). Changing this forces recreation of the deployment.
    Version string
    OpenSearch version to use (e.g., "2.0"). Changing this forces recreation of the deployment.
    Name string
    Name of the OpenSearch deployment. If not specified, a random name will be generated.
    Password string
    Password for the OpenSearch user. Must be at least 12 characters long. If not specified, you will need to reset the password through the API or console. Changing this forces recreation of the deployment.
    PrivateNetwork DeploymentPrivateNetworkArgs
    Private network configuration
    ProjectId string

    project_id) The ID of the project the deployment is associated with.

    Important: A public endpoint is automatically created by default. Private network endpoints can be added using a separate endpoint resource (coming soon).

    Important: The password must be at least 12 characters long. If not provided, you will need to reset it through the Scaleway console or API.

    Region string
    region) The region in which the deployment should be created.
    Tags []string
    List of tags to apply to the deployment.
    UserName string
    Username for the deployment. If not specified, the default username will be used. Changing this forces recreation of the deployment.
    Volume DeploymentVolumeArgs
    Volume configuration for the cluster.
    nodeAmount Integer
    Number of nodes in the cluster. Changing this forces recreation of the deployment.
    nodeType String
    Type of node to use (e.g., "SEARCHDB-SHARED-2C-8G", "SEARCHDB-DEDICATED-2C-8G"). Changing this forces recreation of the deployment.
    version String
    OpenSearch version to use (e.g., "2.0"). Changing this forces recreation of the deployment.
    name String
    Name of the OpenSearch deployment. If not specified, a random name will be generated.
    password String
    Password for the OpenSearch user. Must be at least 12 characters long. If not specified, you will need to reset the password through the API or console. Changing this forces recreation of the deployment.
    privateNetwork DeploymentPrivateNetwork
    Private network configuration
    projectId String

    project_id) The ID of the project the deployment is associated with.

    Important: A public endpoint is automatically created by default. Private network endpoints can be added using a separate endpoint resource (coming soon).

    Important: The password must be at least 12 characters long. If not provided, you will need to reset it through the Scaleway console or API.

    region String
    region) The region in which the deployment should be created.
    tags List<String>
    List of tags to apply to the deployment.
    userName String
    Username for the deployment. If not specified, the default username will be used. Changing this forces recreation of the deployment.
    volume DeploymentVolume
    Volume configuration for the cluster.
    nodeAmount number
    Number of nodes in the cluster. Changing this forces recreation of the deployment.
    nodeType string
    Type of node to use (e.g., "SEARCHDB-SHARED-2C-8G", "SEARCHDB-DEDICATED-2C-8G"). Changing this forces recreation of the deployment.
    version string
    OpenSearch version to use (e.g., "2.0"). Changing this forces recreation of the deployment.
    name string
    Name of the OpenSearch deployment. If not specified, a random name will be generated.
    password string
    Password for the OpenSearch user. Must be at least 12 characters long. If not specified, you will need to reset the password through the API or console. Changing this forces recreation of the deployment.
    privateNetwork DeploymentPrivateNetwork
    Private network configuration
    projectId string

    project_id) The ID of the project the deployment is associated with.

    Important: A public endpoint is automatically created by default. Private network endpoints can be added using a separate endpoint resource (coming soon).

    Important: The password must be at least 12 characters long. If not provided, you will need to reset it through the Scaleway console or API.

    region string
    region) The region in which the deployment should be created.
    tags string[]
    List of tags to apply to the deployment.
    userName string
    Username for the deployment. If not specified, the default username will be used. Changing this forces recreation of the deployment.
    volume DeploymentVolume
    Volume configuration for the cluster.
    node_amount int
    Number of nodes in the cluster. Changing this forces recreation of the deployment.
    node_type str
    Type of node to use (e.g., "SEARCHDB-SHARED-2C-8G", "SEARCHDB-DEDICATED-2C-8G"). Changing this forces recreation of the deployment.
    version str
    OpenSearch version to use (e.g., "2.0"). Changing this forces recreation of the deployment.
    name str
    Name of the OpenSearch deployment. If not specified, a random name will be generated.
    password str
    Password for the OpenSearch user. Must be at least 12 characters long. If not specified, you will need to reset the password through the API or console. Changing this forces recreation of the deployment.
    private_network DeploymentPrivateNetworkArgs
    Private network configuration
    project_id str

    project_id) The ID of the project the deployment is associated with.

    Important: A public endpoint is automatically created by default. Private network endpoints can be added using a separate endpoint resource (coming soon).

    Important: The password must be at least 12 characters long. If not provided, you will need to reset it through the Scaleway console or API.

    region str
    region) The region in which the deployment should be created.
    tags Sequence[str]
    List of tags to apply to the deployment.
    user_name str
    Username for the deployment. If not specified, the default username will be used. Changing this forces recreation of the deployment.
    volume DeploymentVolumeArgs
    Volume configuration for the cluster.
    nodeAmount Number
    Number of nodes in the cluster. Changing this forces recreation of the deployment.
    nodeType String
    Type of node to use (e.g., "SEARCHDB-SHARED-2C-8G", "SEARCHDB-DEDICATED-2C-8G"). Changing this forces recreation of the deployment.
    version String
    OpenSearch version to use (e.g., "2.0"). Changing this forces recreation of the deployment.
    name String
    Name of the OpenSearch deployment. If not specified, a random name will be generated.
    password String
    Password for the OpenSearch user. Must be at least 12 characters long. If not specified, you will need to reset the password through the API or console. Changing this forces recreation of the deployment.
    privateNetwork Property Map
    Private network configuration
    projectId String

    project_id) The ID of the project the deployment is associated with.

    Important: A public endpoint is automatically created by default. Private network endpoints can be added using a separate endpoint resource (coming soon).

    Important: The password must be at least 12 characters long. If not provided, you will need to reset it through the Scaleway console or API.

    region String
    region) The region in which the deployment should be created.
    tags List<String>
    List of tags to apply to the deployment.
    userName String
    Username for the deployment. If not specified, the default username will be used. Changing this forces recreation of the deployment.
    volume Property Map
    Volume configuration for the cluster.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the Deployment resource produces the following output properties:

    CreatedAt string
    Date and time of deployment creation (RFC 3339 format).
    Endpoints List<Pulumiverse.Scaleway.Opensearch.Outputs.DeploymentEndpoint>
    List of endpoints for accessing the deployment.
    Id string
    The provider-assigned unique ID for this managed resource.
    Status string
    The status of the deployment (e.g., "ready", "creating", "upgrading").
    UpdatedAt string
    Date and time of deployment last update (RFC 3339 format).
    CreatedAt string
    Date and time of deployment creation (RFC 3339 format).
    Endpoints []DeploymentEndpoint
    List of endpoints for accessing the deployment.
    Id string
    The provider-assigned unique ID for this managed resource.
    Status string
    The status of the deployment (e.g., "ready", "creating", "upgrading").
    UpdatedAt string
    Date and time of deployment last update (RFC 3339 format).
    createdAt String
    Date and time of deployment creation (RFC 3339 format).
    endpoints List<DeploymentEndpoint>
    List of endpoints for accessing the deployment.
    id String
    The provider-assigned unique ID for this managed resource.
    status String
    The status of the deployment (e.g., "ready", "creating", "upgrading").
    updatedAt String
    Date and time of deployment last update (RFC 3339 format).
    createdAt string
    Date and time of deployment creation (RFC 3339 format).
    endpoints DeploymentEndpoint[]
    List of endpoints for accessing the deployment.
    id string
    The provider-assigned unique ID for this managed resource.
    status string
    The status of the deployment (e.g., "ready", "creating", "upgrading").
    updatedAt string
    Date and time of deployment last update (RFC 3339 format).
    created_at str
    Date and time of deployment creation (RFC 3339 format).
    endpoints Sequence[DeploymentEndpoint]
    List of endpoints for accessing the deployment.
    id str
    The provider-assigned unique ID for this managed resource.
    status str
    The status of the deployment (e.g., "ready", "creating", "upgrading").
    updated_at str
    Date and time of deployment last update (RFC 3339 format).
    createdAt String
    Date and time of deployment creation (RFC 3339 format).
    endpoints List<Property Map>
    List of endpoints for accessing the deployment.
    id String
    The provider-assigned unique ID for this managed resource.
    status String
    The status of the deployment (e.g., "ready", "creating", "upgrading").
    updatedAt String
    Date and time of deployment last update (RFC 3339 format).

    Look up Existing Deployment Resource

    Get an existing Deployment resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: DeploymentState, opts?: CustomResourceOptions): Deployment
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            created_at: Optional[str] = None,
            endpoints: Optional[Sequence[DeploymentEndpointArgs]] = None,
            name: Optional[str] = None,
            node_amount: Optional[int] = None,
            node_type: Optional[str] = None,
            password: Optional[str] = None,
            private_network: Optional[DeploymentPrivateNetworkArgs] = None,
            project_id: Optional[str] = None,
            region: Optional[str] = None,
            status: Optional[str] = None,
            tags: Optional[Sequence[str]] = None,
            updated_at: Optional[str] = None,
            user_name: Optional[str] = None,
            version: Optional[str] = None,
            volume: Optional[DeploymentVolumeArgs] = None) -> Deployment
    func GetDeployment(ctx *Context, name string, id IDInput, state *DeploymentState, opts ...ResourceOption) (*Deployment, error)
    public static Deployment Get(string name, Input<string> id, DeploymentState? state, CustomResourceOptions? opts = null)
    public static Deployment get(String name, Output<String> id, DeploymentState state, CustomResourceOptions options)
    resources:  _:    type: scaleway:opensearch:Deployment    get:      id: ${id}
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    CreatedAt string
    Date and time of deployment creation (RFC 3339 format).
    Endpoints List<Pulumiverse.Scaleway.Opensearch.Inputs.DeploymentEndpoint>
    List of endpoints for accessing the deployment.
    Name string
    Name of the OpenSearch deployment. If not specified, a random name will be generated.
    NodeAmount int
    Number of nodes in the cluster. Changing this forces recreation of the deployment.
    NodeType string
    Type of node to use (e.g., "SEARCHDB-SHARED-2C-8G", "SEARCHDB-DEDICATED-2C-8G"). Changing this forces recreation of the deployment.
    Password string
    Password for the OpenSearch user. Must be at least 12 characters long. If not specified, you will need to reset the password through the API or console. Changing this forces recreation of the deployment.
    PrivateNetwork Pulumiverse.Scaleway.Opensearch.Inputs.DeploymentPrivateNetwork
    Private network configuration
    ProjectId string

    project_id) The ID of the project the deployment is associated with.

    Important: A public endpoint is automatically created by default. Private network endpoints can be added using a separate endpoint resource (coming soon).

    Important: The password must be at least 12 characters long. If not provided, you will need to reset it through the Scaleway console or API.

    Region string
    region) The region in which the deployment should be created.
    Status string
    The status of the deployment (e.g., "ready", "creating", "upgrading").
    Tags List<string>
    List of tags to apply to the deployment.
    UpdatedAt string
    Date and time of deployment last update (RFC 3339 format).
    UserName string
    Username for the deployment. If not specified, the default username will be used. Changing this forces recreation of the deployment.
    Version string
    OpenSearch version to use (e.g., "2.0"). Changing this forces recreation of the deployment.
    Volume Pulumiverse.Scaleway.Opensearch.Inputs.DeploymentVolume
    Volume configuration for the cluster.
    CreatedAt string
    Date and time of deployment creation (RFC 3339 format).
    Endpoints []DeploymentEndpointArgs
    List of endpoints for accessing the deployment.
    Name string
    Name of the OpenSearch deployment. If not specified, a random name will be generated.
    NodeAmount int
    Number of nodes in the cluster. Changing this forces recreation of the deployment.
    NodeType string
    Type of node to use (e.g., "SEARCHDB-SHARED-2C-8G", "SEARCHDB-DEDICATED-2C-8G"). Changing this forces recreation of the deployment.
    Password string
    Password for the OpenSearch user. Must be at least 12 characters long. If not specified, you will need to reset the password through the API or console. Changing this forces recreation of the deployment.
    PrivateNetwork DeploymentPrivateNetworkArgs
    Private network configuration
    ProjectId string

    project_id) The ID of the project the deployment is associated with.

    Important: A public endpoint is automatically created by default. Private network endpoints can be added using a separate endpoint resource (coming soon).

    Important: The password must be at least 12 characters long. If not provided, you will need to reset it through the Scaleway console or API.

    Region string
    region) The region in which the deployment should be created.
    Status string
    The status of the deployment (e.g., "ready", "creating", "upgrading").
    Tags []string
    List of tags to apply to the deployment.
    UpdatedAt string
    Date and time of deployment last update (RFC 3339 format).
    UserName string
    Username for the deployment. If not specified, the default username will be used. Changing this forces recreation of the deployment.
    Version string
    OpenSearch version to use (e.g., "2.0"). Changing this forces recreation of the deployment.
    Volume DeploymentVolumeArgs
    Volume configuration for the cluster.
    createdAt String
    Date and time of deployment creation (RFC 3339 format).
    endpoints List<DeploymentEndpoint>
    List of endpoints for accessing the deployment.
    name String
    Name of the OpenSearch deployment. If not specified, a random name will be generated.
    nodeAmount Integer
    Number of nodes in the cluster. Changing this forces recreation of the deployment.
    nodeType String
    Type of node to use (e.g., "SEARCHDB-SHARED-2C-8G", "SEARCHDB-DEDICATED-2C-8G"). Changing this forces recreation of the deployment.
    password String
    Password for the OpenSearch user. Must be at least 12 characters long. If not specified, you will need to reset the password through the API or console. Changing this forces recreation of the deployment.
    privateNetwork DeploymentPrivateNetwork
    Private network configuration
    projectId String

    project_id) The ID of the project the deployment is associated with.

    Important: A public endpoint is automatically created by default. Private network endpoints can be added using a separate endpoint resource (coming soon).

    Important: The password must be at least 12 characters long. If not provided, you will need to reset it through the Scaleway console or API.

    region String
    region) The region in which the deployment should be created.
    status String
    The status of the deployment (e.g., "ready", "creating", "upgrading").
    tags List<String>
    List of tags to apply to the deployment.
    updatedAt String
    Date and time of deployment last update (RFC 3339 format).
    userName String
    Username for the deployment. If not specified, the default username will be used. Changing this forces recreation of the deployment.
    version String
    OpenSearch version to use (e.g., "2.0"). Changing this forces recreation of the deployment.
    volume DeploymentVolume
    Volume configuration for the cluster.
    createdAt string
    Date and time of deployment creation (RFC 3339 format).
    endpoints DeploymentEndpoint[]
    List of endpoints for accessing the deployment.
    name string
    Name of the OpenSearch deployment. If not specified, a random name will be generated.
    nodeAmount number
    Number of nodes in the cluster. Changing this forces recreation of the deployment.
    nodeType string
    Type of node to use (e.g., "SEARCHDB-SHARED-2C-8G", "SEARCHDB-DEDICATED-2C-8G"). Changing this forces recreation of the deployment.
    password string
    Password for the OpenSearch user. Must be at least 12 characters long. If not specified, you will need to reset the password through the API or console. Changing this forces recreation of the deployment.
    privateNetwork DeploymentPrivateNetwork
    Private network configuration
    projectId string

    project_id) The ID of the project the deployment is associated with.

    Important: A public endpoint is automatically created by default. Private network endpoints can be added using a separate endpoint resource (coming soon).

    Important: The password must be at least 12 characters long. If not provided, you will need to reset it through the Scaleway console or API.

    region string
    region) The region in which the deployment should be created.
    status string
    The status of the deployment (e.g., "ready", "creating", "upgrading").
    tags string[]
    List of tags to apply to the deployment.
    updatedAt string
    Date and time of deployment last update (RFC 3339 format).
    userName string
    Username for the deployment. If not specified, the default username will be used. Changing this forces recreation of the deployment.
    version string
    OpenSearch version to use (e.g., "2.0"). Changing this forces recreation of the deployment.
    volume DeploymentVolume
    Volume configuration for the cluster.
    created_at str
    Date and time of deployment creation (RFC 3339 format).
    endpoints Sequence[DeploymentEndpointArgs]
    List of endpoints for accessing the deployment.
    name str
    Name of the OpenSearch deployment. If not specified, a random name will be generated.
    node_amount int
    Number of nodes in the cluster. Changing this forces recreation of the deployment.
    node_type str
    Type of node to use (e.g., "SEARCHDB-SHARED-2C-8G", "SEARCHDB-DEDICATED-2C-8G"). Changing this forces recreation of the deployment.
    password str
    Password for the OpenSearch user. Must be at least 12 characters long. If not specified, you will need to reset the password through the API or console. Changing this forces recreation of the deployment.
    private_network DeploymentPrivateNetworkArgs
    Private network configuration
    project_id str

    project_id) The ID of the project the deployment is associated with.

    Important: A public endpoint is automatically created by default. Private network endpoints can be added using a separate endpoint resource (coming soon).

    Important: The password must be at least 12 characters long. If not provided, you will need to reset it through the Scaleway console or API.

    region str
    region) The region in which the deployment should be created.
    status str
    The status of the deployment (e.g., "ready", "creating", "upgrading").
    tags Sequence[str]
    List of tags to apply to the deployment.
    updated_at str
    Date and time of deployment last update (RFC 3339 format).
    user_name str
    Username for the deployment. If not specified, the default username will be used. Changing this forces recreation of the deployment.
    version str
    OpenSearch version to use (e.g., "2.0"). Changing this forces recreation of the deployment.
    volume DeploymentVolumeArgs
    Volume configuration for the cluster.
    createdAt String
    Date and time of deployment creation (RFC 3339 format).
    endpoints List<Property Map>
    List of endpoints for accessing the deployment.
    name String
    Name of the OpenSearch deployment. If not specified, a random name will be generated.
    nodeAmount Number
    Number of nodes in the cluster. Changing this forces recreation of the deployment.
    nodeType String
    Type of node to use (e.g., "SEARCHDB-SHARED-2C-8G", "SEARCHDB-DEDICATED-2C-8G"). Changing this forces recreation of the deployment.
    password String
    Password for the OpenSearch user. Must be at least 12 characters long. If not specified, you will need to reset the password through the API or console. Changing this forces recreation of the deployment.
    privateNetwork Property Map
    Private network configuration
    projectId String

    project_id) The ID of the project the deployment is associated with.

    Important: A public endpoint is automatically created by default. Private network endpoints can be added using a separate endpoint resource (coming soon).

    Important: The password must be at least 12 characters long. If not provided, you will need to reset it through the Scaleway console or API.

    region String
    region) The region in which the deployment should be created.
    status String
    The status of the deployment (e.g., "ready", "creating", "upgrading").
    tags List<String>
    List of tags to apply to the deployment.
    updatedAt String
    Date and time of deployment last update (RFC 3339 format).
    userName String
    Username for the deployment. If not specified, the default username will be used. Changing this forces recreation of the deployment.
    version String
    OpenSearch version to use (e.g., "2.0"). Changing this forces recreation of the deployment.
    volume Property Map
    Volume configuration for the cluster.

    Supporting Types

    DeploymentEndpoint, DeploymentEndpointArgs

    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.Opensearch.Inputs.DeploymentEndpointService>
    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 []DeploymentEndpointService
    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<DeploymentEndpointService>
    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 DeploymentEndpointService[]
    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[DeploymentEndpointService]
    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.

    DeploymentEndpointService, DeploymentEndpointServiceArgs

    Name string
    Name of the OpenSearch deployment. If not specified, a random name will be generated.
    Port int
    Service port number.
    Url string
    Full URL to access the service (e.g., "https://abc-123.searchdb.fr-par.scw.cloud:9200").
    Name string
    Name of the OpenSearch deployment. If not specified, a random name will be generated.
    Port int
    Service port number.
    Url string
    Full URL to access the service (e.g., "https://abc-123.searchdb.fr-par.scw.cloud:9200").
    name String
    Name of the OpenSearch deployment. If not specified, a random name will be generated.
    port Integer
    Service port number.
    url String
    Full URL to access the service (e.g., "https://abc-123.searchdb.fr-par.scw.cloud:9200").
    name string
    Name of the OpenSearch deployment. If not specified, a random name will be generated.
    port number
    Service port number.
    url string
    Full URL to access the service (e.g., "https://abc-123.searchdb.fr-par.scw.cloud:9200").
    name str
    Name of the OpenSearch deployment. If not specified, a random name will be generated.
    port int
    Service port number.
    url str
    Full URL to access the service (e.g., "https://abc-123.searchdb.fr-par.scw.cloud:9200").
    name String
    Name of the OpenSearch deployment. If not specified, a random name will be generated.
    port Number
    Service port number.
    url String
    Full URL to access the service (e.g., "https://abc-123.searchdb.fr-par.scw.cloud:9200").

    DeploymentPrivateNetwork, DeploymentPrivateNetworkArgs

    PrivateNetworkId string
    Private network ID if the endpoint is private.
    PrivateNetworkId string
    Private network ID if the endpoint is private.
    privateNetworkId String
    Private network ID if the endpoint is private.
    privateNetworkId string
    Private network ID if the endpoint is private.
    private_network_id str
    Private network ID if the endpoint is private.
    privateNetworkId String
    Private network ID if the endpoint is private.

    DeploymentVolume, DeploymentVolumeArgs

    SizeInGb int
    Volume size in GB. Changing this forces recreation of the deployment.
    Type string
    Volume type. Valid values are sbs_5k (5K IOPS) or sbs_15k (15K IOPS). Changing this forces recreation of the deployment.
    SizeInGb int
    Volume size in GB. Changing this forces recreation of the deployment.
    Type string
    Volume type. Valid values are sbs_5k (5K IOPS) or sbs_15k (15K IOPS). Changing this forces recreation of the deployment.
    sizeInGb Integer
    Volume size in GB. Changing this forces recreation of the deployment.
    type String
    Volume type. Valid values are sbs_5k (5K IOPS) or sbs_15k (15K IOPS). Changing this forces recreation of the deployment.
    sizeInGb number
    Volume size in GB. Changing this forces recreation of the deployment.
    type string
    Volume type. Valid values are sbs_5k (5K IOPS) or sbs_15k (15K IOPS). Changing this forces recreation of the deployment.
    size_in_gb int
    Volume size in GB. Changing this forces recreation of the deployment.
    type str
    Volume type. Valid values are sbs_5k (5K IOPS) or sbs_15k (15K IOPS). Changing this forces recreation of the deployment.
    sizeInGb Number
    Volume size in GB. Changing this forces recreation of the deployment.
    type String
    Volume type. Valid values are sbs_5k (5K IOPS) or sbs_15k (15K IOPS). Changing this forces recreation of the deployment.

    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.44.1
    published on Monday, Mar 9, 2026 by pulumiverse
      Try Pulumi Cloud free. Your team will thank you.