1. Packages
  2. Scaleway
  3. API Docs
  4. DocumentdbInstance
Scaleway v1.12.0 published on Monday, Mar 11, 2024 by pulumiverse

scaleway.DocumentdbInstance

Explore with Pulumi AI

scaleway logo
Scaleway v1.12.0 published on Monday, Mar 11, 2024 by pulumiverse

    Creates and manages Scaleway Database Instances. For more information, see the documentation.

    Example Usage

    Example Basic

    import * as pulumi from "@pulumi/pulumi";
    import * as scaleway from "@pulumiverse/scaleway";
    
    const main = new scaleway.DocumentdbInstance("main", {
        engine: "FerretDB-1",
        nodeType: "docdb-play2-pico",
        password: "thiZ_is_v&ry_s3cret",
        tags: [
            "terraform-test",
            "scaleway_documentdb_instance",
            "minimal",
        ],
        userName: "my_initial_user",
        volumeSizeInGb: 20,
    });
    
    import pulumi
    import pulumiverse_scaleway as scaleway
    
    main = scaleway.DocumentdbInstance("main",
        engine="FerretDB-1",
        node_type="docdb-play2-pico",
        password="thiZ_is_v&ry_s3cret",
        tags=[
            "terraform-test",
            "scaleway_documentdb_instance",
            "minimal",
        ],
        user_name="my_initial_user",
        volume_size_in_gb=20)
    
    package main
    
    import (
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    	"github.com/pulumiverse/pulumi-scaleway/sdk/go/scaleway"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := scaleway.NewDocumentdbInstance(ctx, "main", &scaleway.DocumentdbInstanceArgs{
    			Engine:   pulumi.String("FerretDB-1"),
    			NodeType: pulumi.String("docdb-play2-pico"),
    			Password: pulumi.String("thiZ_is_v&ry_s3cret"),
    			Tags: pulumi.StringArray{
    				pulumi.String("terraform-test"),
    				pulumi.String("scaleway_documentdb_instance"),
    				pulumi.String("minimal"),
    			},
    			UserName:       pulumi.String("my_initial_user"),
    			VolumeSizeInGb: pulumi.Int(20),
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Scaleway = Pulumiverse.Scaleway;
    
    return await Deployment.RunAsync(() => 
    {
        var main = new Scaleway.DocumentdbInstance("main", new()
        {
            Engine = "FerretDB-1",
            NodeType = "docdb-play2-pico",
            Password = "thiZ_is_v&ry_s3cret",
            Tags = new[]
            {
                "terraform-test",
                "scaleway_documentdb_instance",
                "minimal",
            },
            UserName = "my_initial_user",
            VolumeSizeInGb = 20,
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.scaleway.DocumentdbInstance;
    import com.pulumi.scaleway.DocumentdbInstanceArgs;
    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) {
            var main = new DocumentdbInstance("main", DocumentdbInstanceArgs.builder()        
                .engine("FerretDB-1")
                .nodeType("docdb-play2-pico")
                .password("thiZ_is_v&ry_s3cret")
                .tags(            
                    "terraform-test",
                    "scaleway_documentdb_instance",
                    "minimal")
                .userName("my_initial_user")
                .volumeSizeInGb(20)
                .build());
    
        }
    }
    
    resources:
      main:
        type: scaleway:DocumentdbInstance
        properties:
          engine: FerretDB-1
          nodeType: docdb-play2-pico
          password: thiZ_is_v&ry_s3cret
          tags:
            - terraform-test
            - scaleway_documentdb_instance
            - minimal
          userName: my_initial_user
          volumeSizeInGb: 20
    

    Create DocumentdbInstance Resource

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

    Constructor syntax

    new DocumentdbInstance(name: string, args: DocumentdbInstanceArgs, opts?: CustomResourceOptions);
    @overload
    def DocumentdbInstance(resource_name: str,
                           args: DocumentdbInstanceArgs,
                           opts: Optional[ResourceOptions] = None)
    
    @overload
    def DocumentdbInstance(resource_name: str,
                           opts: Optional[ResourceOptions] = None,
                           engine: Optional[str] = None,
                           node_type: Optional[str] = None,
                           is_ha_cluster: Optional[bool] = None,
                           name: Optional[str] = None,
                           password: Optional[str] = None,
                           project_id: Optional[str] = None,
                           region: Optional[str] = None,
                           tags: Optional[Sequence[str]] = None,
                           telemetry_enabled: Optional[bool] = None,
                           user_name: Optional[str] = None,
                           volume_size_in_gb: Optional[int] = None,
                           volume_type: Optional[str] = None)
    func NewDocumentdbInstance(ctx *Context, name string, args DocumentdbInstanceArgs, opts ...ResourceOption) (*DocumentdbInstance, error)
    public DocumentdbInstance(string name, DocumentdbInstanceArgs args, CustomResourceOptions? opts = null)
    public DocumentdbInstance(String name, DocumentdbInstanceArgs args)
    public DocumentdbInstance(String name, DocumentdbInstanceArgs args, CustomResourceOptions options)
    
    type: scaleway:DocumentdbInstance
    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 DocumentdbInstanceArgs
    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 DocumentdbInstanceArgs
    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 DocumentdbInstanceArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args DocumentdbInstanceArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args DocumentdbInstanceArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Example

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

    var documentdbInstanceResource = new Scaleway.DocumentdbInstance("documentdbInstanceResource", new()
    {
        Engine = "string",
        NodeType = "string",
        IsHaCluster = false,
        Name = "string",
        Password = "string",
        ProjectId = "string",
        Region = "string",
        Tags = new[]
        {
            "string",
        },
        TelemetryEnabled = false,
        UserName = "string",
        VolumeSizeInGb = 0,
        VolumeType = "string",
    });
    
    example, err := scaleway.NewDocumentdbInstance(ctx, "documentdbInstanceResource", &scaleway.DocumentdbInstanceArgs{
    	Engine:      pulumi.String("string"),
    	NodeType:    pulumi.String("string"),
    	IsHaCluster: pulumi.Bool(false),
    	Name:        pulumi.String("string"),
    	Password:    pulumi.String("string"),
    	ProjectId:   pulumi.String("string"),
    	Region:      pulumi.String("string"),
    	Tags: pulumi.StringArray{
    		pulumi.String("string"),
    	},
    	TelemetryEnabled: pulumi.Bool(false),
    	UserName:         pulumi.String("string"),
    	VolumeSizeInGb:   pulumi.Int(0),
    	VolumeType:       pulumi.String("string"),
    })
    
    var documentdbInstanceResource = new DocumentdbInstance("documentdbInstanceResource", DocumentdbInstanceArgs.builder()        
        .engine("string")
        .nodeType("string")
        .isHaCluster(false)
        .name("string")
        .password("string")
        .projectId("string")
        .region("string")
        .tags("string")
        .telemetryEnabled(false)
        .userName("string")
        .volumeSizeInGb(0)
        .volumeType("string")
        .build());
    
    documentdb_instance_resource = scaleway.DocumentdbInstance("documentdbInstanceResource",
        engine="string",
        node_type="string",
        is_ha_cluster=False,
        name="string",
        password="string",
        project_id="string",
        region="string",
        tags=["string"],
        telemetry_enabled=False,
        user_name="string",
        volume_size_in_gb=0,
        volume_type="string")
    
    const documentdbInstanceResource = new scaleway.DocumentdbInstance("documentdbInstanceResource", {
        engine: "string",
        nodeType: "string",
        isHaCluster: false,
        name: "string",
        password: "string",
        projectId: "string",
        region: "string",
        tags: ["string"],
        telemetryEnabled: false,
        userName: "string",
        volumeSizeInGb: 0,
        volumeType: "string",
    });
    
    type: scaleway:DocumentdbInstance
    properties:
        engine: string
        isHaCluster: false
        name: string
        nodeType: string
        password: string
        projectId: string
        region: string
        tags:
            - string
        telemetryEnabled: false
        userName: string
        volumeSizeInGb: 0
        volumeType: string
    

    DocumentdbInstance Resource Properties

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

    Inputs

    The DocumentdbInstance resource accepts the following input properties:

    Engine string

    Database Instance's engine version (e.g. FerretDB-1).

    Important: Updates to engine will recreate the Database Instance.

    NodeType string

    The type of database instance you want to create (e.g. docdb-play2-pico).

    Important: Updates to node_type will upgrade the Database Instance to the desired node_type without any interruption. Keep in mind that you cannot downgrade a Database Instance.

    IsHaCluster bool
    Enable or disable high availability for the database instance.
    Name string
    The name of the Database Instance.
    Password string
    Password for the first user of the database instance.
    ProjectId string
    project_id) The ID of the project the Database Instance is associated with.
    Region string
    region) The region in which the Database Instance should be created.
    Tags List<string>
    The tags associated with the Database Instance.
    TelemetryEnabled bool

    Enable telemetry to collects basic anonymous usage data and sends them to FerretDB telemetry service. More about the telemetry here.

    Important: Updates to is_ha_cluster will recreate the Database Instance.

    UserName string

    Identifier for the first user of the database instance.

    Important: Updates to user_name will recreate the Database Instance.

    VolumeSizeInGb int
    Volume size (in GB) when volume_type is set to bssd.
    VolumeType string
    Type of volume where data are stored (bssd or lssd).
    Engine string

    Database Instance's engine version (e.g. FerretDB-1).

    Important: Updates to engine will recreate the Database Instance.

    NodeType string

    The type of database instance you want to create (e.g. docdb-play2-pico).

    Important: Updates to node_type will upgrade the Database Instance to the desired node_type without any interruption. Keep in mind that you cannot downgrade a Database Instance.

    IsHaCluster bool
    Enable or disable high availability for the database instance.
    Name string
    The name of the Database Instance.
    Password string
    Password for the first user of the database instance.
    ProjectId string
    project_id) The ID of the project the Database Instance is associated with.
    Region string
    region) The region in which the Database Instance should be created.
    Tags []string
    The tags associated with the Database Instance.
    TelemetryEnabled bool

    Enable telemetry to collects basic anonymous usage data and sends them to FerretDB telemetry service. More about the telemetry here.

    Important: Updates to is_ha_cluster will recreate the Database Instance.

    UserName string

    Identifier for the first user of the database instance.

    Important: Updates to user_name will recreate the Database Instance.

    VolumeSizeInGb int
    Volume size (in GB) when volume_type is set to bssd.
    VolumeType string
    Type of volume where data are stored (bssd or lssd).
    engine String

    Database Instance's engine version (e.g. FerretDB-1).

    Important: Updates to engine will recreate the Database Instance.

    nodeType String

    The type of database instance you want to create (e.g. docdb-play2-pico).

    Important: Updates to node_type will upgrade the Database Instance to the desired node_type without any interruption. Keep in mind that you cannot downgrade a Database Instance.

    isHaCluster Boolean
    Enable or disable high availability for the database instance.
    name String
    The name of the Database Instance.
    password String
    Password for the first user of the database instance.
    projectId String
    project_id) The ID of the project the Database Instance is associated with.
    region String
    region) The region in which the Database Instance should be created.
    tags List<String>
    The tags associated with the Database Instance.
    telemetryEnabled Boolean

    Enable telemetry to collects basic anonymous usage data and sends them to FerretDB telemetry service. More about the telemetry here.

    Important: Updates to is_ha_cluster will recreate the Database Instance.

    userName String

    Identifier for the first user of the database instance.

    Important: Updates to user_name will recreate the Database Instance.

    volumeSizeInGb Integer
    Volume size (in GB) when volume_type is set to bssd.
    volumeType String
    Type of volume where data are stored (bssd or lssd).
    engine string

    Database Instance's engine version (e.g. FerretDB-1).

    Important: Updates to engine will recreate the Database Instance.

    nodeType string

    The type of database instance you want to create (e.g. docdb-play2-pico).

    Important: Updates to node_type will upgrade the Database Instance to the desired node_type without any interruption. Keep in mind that you cannot downgrade a Database Instance.

    isHaCluster boolean
    Enable or disable high availability for the database instance.
    name string
    The name of the Database Instance.
    password string
    Password for the first user of the database instance.
    projectId string
    project_id) The ID of the project the Database Instance is associated with.
    region string
    region) The region in which the Database Instance should be created.
    tags string[]
    The tags associated with the Database Instance.
    telemetryEnabled boolean

    Enable telemetry to collects basic anonymous usage data and sends them to FerretDB telemetry service. More about the telemetry here.

    Important: Updates to is_ha_cluster will recreate the Database Instance.

    userName string

    Identifier for the first user of the database instance.

    Important: Updates to user_name will recreate the Database Instance.

    volumeSizeInGb number
    Volume size (in GB) when volume_type is set to bssd.
    volumeType string
    Type of volume where data are stored (bssd or lssd).
    engine str

    Database Instance's engine version (e.g. FerretDB-1).

    Important: Updates to engine will recreate the Database Instance.

    node_type str

    The type of database instance you want to create (e.g. docdb-play2-pico).

    Important: Updates to node_type will upgrade the Database Instance to the desired node_type without any interruption. Keep in mind that you cannot downgrade a Database Instance.

    is_ha_cluster bool
    Enable or disable high availability for the database instance.
    name str
    The name of the Database Instance.
    password str
    Password for the first user of the database instance.
    project_id str
    project_id) The ID of the project the Database Instance is associated with.
    region str
    region) The region in which the Database Instance should be created.
    tags Sequence[str]
    The tags associated with the Database Instance.
    telemetry_enabled bool

    Enable telemetry to collects basic anonymous usage data and sends them to FerretDB telemetry service. More about the telemetry here.

    Important: Updates to is_ha_cluster will recreate the Database Instance.

    user_name str

    Identifier for the first user of the database instance.

    Important: Updates to user_name will recreate the Database Instance.

    volume_size_in_gb int
    Volume size (in GB) when volume_type is set to bssd.
    volume_type str
    Type of volume where data are stored (bssd or lssd).
    engine String

    Database Instance's engine version (e.g. FerretDB-1).

    Important: Updates to engine will recreate the Database Instance.

    nodeType String

    The type of database instance you want to create (e.g. docdb-play2-pico).

    Important: Updates to node_type will upgrade the Database Instance to the desired node_type without any interruption. Keep in mind that you cannot downgrade a Database Instance.

    isHaCluster Boolean
    Enable or disable high availability for the database instance.
    name String
    The name of the Database Instance.
    password String
    Password for the first user of the database instance.
    projectId String
    project_id) The ID of the project the Database Instance is associated with.
    region String
    region) The region in which the Database Instance should be created.
    tags List<String>
    The tags associated with the Database Instance.
    telemetryEnabled Boolean

    Enable telemetry to collects basic anonymous usage data and sends them to FerretDB telemetry service. More about the telemetry here.

    Important: Updates to is_ha_cluster will recreate the Database Instance.

    userName String

    Identifier for the first user of the database instance.

    Important: Updates to user_name will recreate the Database Instance.

    volumeSizeInGb Number
    Volume size (in GB) when volume_type is set to bssd.
    volumeType String
    Type of volume where data are stored (bssd or lssd).

    Outputs

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

    Id string
    The provider-assigned unique ID for this managed resource.
    Id string
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.
    id string
    The provider-assigned unique ID for this managed resource.
    id str
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.

    Look up Existing DocumentdbInstance Resource

    Get an existing DocumentdbInstance 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?: DocumentdbInstanceState, opts?: CustomResourceOptions): DocumentdbInstance
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            engine: Optional[str] = None,
            is_ha_cluster: Optional[bool] = None,
            name: Optional[str] = None,
            node_type: Optional[str] = None,
            password: Optional[str] = None,
            project_id: Optional[str] = None,
            region: Optional[str] = None,
            tags: Optional[Sequence[str]] = None,
            telemetry_enabled: Optional[bool] = None,
            user_name: Optional[str] = None,
            volume_size_in_gb: Optional[int] = None,
            volume_type: Optional[str] = None) -> DocumentdbInstance
    func GetDocumentdbInstance(ctx *Context, name string, id IDInput, state *DocumentdbInstanceState, opts ...ResourceOption) (*DocumentdbInstance, error)
    public static DocumentdbInstance Get(string name, Input<string> id, DocumentdbInstanceState? state, CustomResourceOptions? opts = null)
    public static DocumentdbInstance get(String name, Output<String> id, DocumentdbInstanceState state, CustomResourceOptions options)
    Resource lookup is not supported in YAML
    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:
    Engine string

    Database Instance's engine version (e.g. FerretDB-1).

    Important: Updates to engine will recreate the Database Instance.

    IsHaCluster bool
    Enable or disable high availability for the database instance.
    Name string
    The name of the Database Instance.
    NodeType string

    The type of database instance you want to create (e.g. docdb-play2-pico).

    Important: Updates to node_type will upgrade the Database Instance to the desired node_type without any interruption. Keep in mind that you cannot downgrade a Database Instance.

    Password string
    Password for the first user of the database instance.
    ProjectId string
    project_id) The ID of the project the Database Instance is associated with.
    Region string
    region) The region in which the Database Instance should be created.
    Tags List<string>
    The tags associated with the Database Instance.
    TelemetryEnabled bool

    Enable telemetry to collects basic anonymous usage data and sends them to FerretDB telemetry service. More about the telemetry here.

    Important: Updates to is_ha_cluster will recreate the Database Instance.

    UserName string

    Identifier for the first user of the database instance.

    Important: Updates to user_name will recreate the Database Instance.

    VolumeSizeInGb int
    Volume size (in GB) when volume_type is set to bssd.
    VolumeType string
    Type of volume where data are stored (bssd or lssd).
    Engine string

    Database Instance's engine version (e.g. FerretDB-1).

    Important: Updates to engine will recreate the Database Instance.

    IsHaCluster bool
    Enable or disable high availability for the database instance.
    Name string
    The name of the Database Instance.
    NodeType string

    The type of database instance you want to create (e.g. docdb-play2-pico).

    Important: Updates to node_type will upgrade the Database Instance to the desired node_type without any interruption. Keep in mind that you cannot downgrade a Database Instance.

    Password string
    Password for the first user of the database instance.
    ProjectId string
    project_id) The ID of the project the Database Instance is associated with.
    Region string
    region) The region in which the Database Instance should be created.
    Tags []string
    The tags associated with the Database Instance.
    TelemetryEnabled bool

    Enable telemetry to collects basic anonymous usage data and sends them to FerretDB telemetry service. More about the telemetry here.

    Important: Updates to is_ha_cluster will recreate the Database Instance.

    UserName string

    Identifier for the first user of the database instance.

    Important: Updates to user_name will recreate the Database Instance.

    VolumeSizeInGb int
    Volume size (in GB) when volume_type is set to bssd.
    VolumeType string
    Type of volume where data are stored (bssd or lssd).
    engine String

    Database Instance's engine version (e.g. FerretDB-1).

    Important: Updates to engine will recreate the Database Instance.

    isHaCluster Boolean
    Enable or disable high availability for the database instance.
    name String
    The name of the Database Instance.
    nodeType String

    The type of database instance you want to create (e.g. docdb-play2-pico).

    Important: Updates to node_type will upgrade the Database Instance to the desired node_type without any interruption. Keep in mind that you cannot downgrade a Database Instance.

    password String
    Password for the first user of the database instance.
    projectId String
    project_id) The ID of the project the Database Instance is associated with.
    region String
    region) The region in which the Database Instance should be created.
    tags List<String>
    The tags associated with the Database Instance.
    telemetryEnabled Boolean

    Enable telemetry to collects basic anonymous usage data and sends them to FerretDB telemetry service. More about the telemetry here.

    Important: Updates to is_ha_cluster will recreate the Database Instance.

    userName String

    Identifier for the first user of the database instance.

    Important: Updates to user_name will recreate the Database Instance.

    volumeSizeInGb Integer
    Volume size (in GB) when volume_type is set to bssd.
    volumeType String
    Type of volume where data are stored (bssd or lssd).
    engine string

    Database Instance's engine version (e.g. FerretDB-1).

    Important: Updates to engine will recreate the Database Instance.

    isHaCluster boolean
    Enable or disable high availability for the database instance.
    name string
    The name of the Database Instance.
    nodeType string

    The type of database instance you want to create (e.g. docdb-play2-pico).

    Important: Updates to node_type will upgrade the Database Instance to the desired node_type without any interruption. Keep in mind that you cannot downgrade a Database Instance.

    password string
    Password for the first user of the database instance.
    projectId string
    project_id) The ID of the project the Database Instance is associated with.
    region string
    region) The region in which the Database Instance should be created.
    tags string[]
    The tags associated with the Database Instance.
    telemetryEnabled boolean

    Enable telemetry to collects basic anonymous usage data and sends them to FerretDB telemetry service. More about the telemetry here.

    Important: Updates to is_ha_cluster will recreate the Database Instance.

    userName string

    Identifier for the first user of the database instance.

    Important: Updates to user_name will recreate the Database Instance.

    volumeSizeInGb number
    Volume size (in GB) when volume_type is set to bssd.
    volumeType string
    Type of volume where data are stored (bssd or lssd).
    engine str

    Database Instance's engine version (e.g. FerretDB-1).

    Important: Updates to engine will recreate the Database Instance.

    is_ha_cluster bool
    Enable or disable high availability for the database instance.
    name str
    The name of the Database Instance.
    node_type str

    The type of database instance you want to create (e.g. docdb-play2-pico).

    Important: Updates to node_type will upgrade the Database Instance to the desired node_type without any interruption. Keep in mind that you cannot downgrade a Database Instance.

    password str
    Password for the first user of the database instance.
    project_id str
    project_id) The ID of the project the Database Instance is associated with.
    region str
    region) The region in which the Database Instance should be created.
    tags Sequence[str]
    The tags associated with the Database Instance.
    telemetry_enabled bool

    Enable telemetry to collects basic anonymous usage data and sends them to FerretDB telemetry service. More about the telemetry here.

    Important: Updates to is_ha_cluster will recreate the Database Instance.

    user_name str

    Identifier for the first user of the database instance.

    Important: Updates to user_name will recreate the Database Instance.

    volume_size_in_gb int
    Volume size (in GB) when volume_type is set to bssd.
    volume_type str
    Type of volume where data are stored (bssd or lssd).
    engine String

    Database Instance's engine version (e.g. FerretDB-1).

    Important: Updates to engine will recreate the Database Instance.

    isHaCluster Boolean
    Enable or disable high availability for the database instance.
    name String
    The name of the Database Instance.
    nodeType String

    The type of database instance you want to create (e.g. docdb-play2-pico).

    Important: Updates to node_type will upgrade the Database Instance to the desired node_type without any interruption. Keep in mind that you cannot downgrade a Database Instance.

    password String
    Password for the first user of the database instance.
    projectId String
    project_id) The ID of the project the Database Instance is associated with.
    region String
    region) The region in which the Database Instance should be created.
    tags List<String>
    The tags associated with the Database Instance.
    telemetryEnabled Boolean

    Enable telemetry to collects basic anonymous usage data and sends them to FerretDB telemetry service. More about the telemetry here.

    Important: Updates to is_ha_cluster will recreate the Database Instance.

    userName String

    Identifier for the first user of the database instance.

    Important: Updates to user_name will recreate the Database Instance.

    volumeSizeInGb Number
    Volume size (in GB) when volume_type is set to bssd.
    volumeType String
    Type of volume where data are stored (bssd or lssd).

    Import

    Database Instance can be imported using the {region}/{id}, e.g.

    bash

    $ pulumi import scaleway:index/documentdbInstance:DocumentdbInstance db fr-par/11111111-1111-1111-1111-111111111111
    

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    scaleway pulumiverse/pulumi-scaleway
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the scaleway Terraform Provider.
    scaleway logo
    Scaleway v1.12.0 published on Monday, Mar 11, 2024 by pulumiverse