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

scaleway.DocumentdbUser

Explore with Pulumi AI

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

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

    Example Usage

    Basic

    import * as pulumi from "@pulumi/pulumi";
    import * as random from "@pulumi/random";
    import * as scaleway from "@pulumiverse/scaleway";
    
    const dbPassword = new random.RandomPassword("dbPassword", {
        length: 16,
        special: true,
    });
    const dbAdmin = new scaleway.DocumentdbUser("dbAdmin", {
        instanceId: "11111111-1111-1111-1111-111111111111",
        password: dbPassword.result,
        isAdmin: true,
    });
    
    import pulumi
    import pulumi_random as random
    import pulumiverse_scaleway as scaleway
    
    db_password = random.RandomPassword("dbPassword",
        length=16,
        special=True)
    db_admin = scaleway.DocumentdbUser("dbAdmin",
        instance_id="11111111-1111-1111-1111-111111111111",
        password=db_password.result,
        is_admin=True)
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-random/sdk/v4/go/random"
    	"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 {
    		dbPassword, err := random.NewRandomPassword(ctx, "dbPassword", &random.RandomPasswordArgs{
    			Length:  pulumi.Int(16),
    			Special: pulumi.Bool(true),
    		})
    		if err != nil {
    			return err
    		}
    		_, err = scaleway.NewDocumentdbUser(ctx, "dbAdmin", &scaleway.DocumentdbUserArgs{
    			InstanceId: pulumi.String("11111111-1111-1111-1111-111111111111"),
    			Password:   dbPassword.Result,
    			IsAdmin:    pulumi.Bool(true),
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Random = Pulumi.Random;
    using Scaleway = Pulumiverse.Scaleway;
    
    return await Deployment.RunAsync(() => 
    {
        var dbPassword = new Random.RandomPassword("dbPassword", new()
        {
            Length = 16,
            Special = true,
        });
    
        var dbAdmin = new Scaleway.DocumentdbUser("dbAdmin", new()
        {
            InstanceId = "11111111-1111-1111-1111-111111111111",
            Password = dbPassword.Result,
            IsAdmin = true,
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.random.RandomPassword;
    import com.pulumi.random.RandomPasswordArgs;
    import com.pulumi.scaleway.DocumentdbUser;
    import com.pulumi.scaleway.DocumentdbUserArgs;
    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 dbPassword = new RandomPassword("dbPassword", RandomPasswordArgs.builder()        
                .length(16)
                .special(true)
                .build());
    
            var dbAdmin = new DocumentdbUser("dbAdmin", DocumentdbUserArgs.builder()        
                .instanceId("11111111-1111-1111-1111-111111111111")
                .password(dbPassword.result())
                .isAdmin(true)
                .build());
    
        }
    }
    
    resources:
      dbPassword:
        type: random:RandomPassword
        properties:
          length: 16
          special: true
      dbAdmin:
        type: scaleway:DocumentdbUser
        properties:
          instanceId: 11111111-1111-1111-1111-111111111111
          password: ${dbPassword.result}
          isAdmin: true
    

    Create DocumentdbUser Resource

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

    Constructor syntax

    new DocumentdbUser(name: string, args: DocumentdbUserArgs, opts?: CustomResourceOptions);
    @overload
    def DocumentdbUser(resource_name: str,
                       args: DocumentdbUserArgs,
                       opts: Optional[ResourceOptions] = None)
    
    @overload
    def DocumentdbUser(resource_name: str,
                       opts: Optional[ResourceOptions] = None,
                       instance_id: Optional[str] = None,
                       password: Optional[str] = None,
                       is_admin: Optional[bool] = None,
                       name: Optional[str] = None,
                       region: Optional[str] = None)
    func NewDocumentdbUser(ctx *Context, name string, args DocumentdbUserArgs, opts ...ResourceOption) (*DocumentdbUser, error)
    public DocumentdbUser(string name, DocumentdbUserArgs args, CustomResourceOptions? opts = null)
    public DocumentdbUser(String name, DocumentdbUserArgs args)
    public DocumentdbUser(String name, DocumentdbUserArgs args, CustomResourceOptions options)
    
    type: scaleway:DocumentdbUser
    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 DocumentdbUserArgs
    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 DocumentdbUserArgs
    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 DocumentdbUserArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args DocumentdbUserArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args DocumentdbUserArgs
    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 documentdbUserResource = new Scaleway.DocumentdbUser("documentdbUserResource", new()
    {
        InstanceId = "string",
        Password = "string",
        IsAdmin = false,
        Name = "string",
        Region = "string",
    });
    
    example, err := scaleway.NewDocumentdbUser(ctx, "documentdbUserResource", &scaleway.DocumentdbUserArgs{
    	InstanceId: pulumi.String("string"),
    	Password:   pulumi.String("string"),
    	IsAdmin:    pulumi.Bool(false),
    	Name:       pulumi.String("string"),
    	Region:     pulumi.String("string"),
    })
    
    var documentdbUserResource = new DocumentdbUser("documentdbUserResource", DocumentdbUserArgs.builder()        
        .instanceId("string")
        .password("string")
        .isAdmin(false)
        .name("string")
        .region("string")
        .build());
    
    documentdb_user_resource = scaleway.DocumentdbUser("documentdbUserResource",
        instance_id="string",
        password="string",
        is_admin=False,
        name="string",
        region="string")
    
    const documentdbUserResource = new scaleway.DocumentdbUser("documentdbUserResource", {
        instanceId: "string",
        password: "string",
        isAdmin: false,
        name: "string",
        region: "string",
    });
    
    type: scaleway:DocumentdbUser
    properties:
        instanceId: string
        isAdmin: false
        name: string
        password: string
        region: string
    

    DocumentdbUser 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 DocumentdbUser resource accepts the following input properties:

    InstanceId string

    UUID of the documentDB instance.

    Important: Updates to instance_id will recreate the Database User.

    Password string
    Database User password.
    IsAdmin bool
    Grant admin permissions to the Database User.
    Name string

    Database Username.

    Important: Updates to name will recreate the Database User.

    Region string
    The Scaleway region this resource resides in.
    InstanceId string

    UUID of the documentDB instance.

    Important: Updates to instance_id will recreate the Database User.

    Password string
    Database User password.
    IsAdmin bool
    Grant admin permissions to the Database User.
    Name string

    Database Username.

    Important: Updates to name will recreate the Database User.

    Region string
    The Scaleway region this resource resides in.
    instanceId String

    UUID of the documentDB instance.

    Important: Updates to instance_id will recreate the Database User.

    password String
    Database User password.
    isAdmin Boolean
    Grant admin permissions to the Database User.
    name String

    Database Username.

    Important: Updates to name will recreate the Database User.

    region String
    The Scaleway region this resource resides in.
    instanceId string

    UUID of the documentDB instance.

    Important: Updates to instance_id will recreate the Database User.

    password string
    Database User password.
    isAdmin boolean
    Grant admin permissions to the Database User.
    name string

    Database Username.

    Important: Updates to name will recreate the Database User.

    region string
    The Scaleway region this resource resides in.
    instance_id str

    UUID of the documentDB instance.

    Important: Updates to instance_id will recreate the Database User.

    password str
    Database User password.
    is_admin bool
    Grant admin permissions to the Database User.
    name str

    Database Username.

    Important: Updates to name will recreate the Database User.

    region str
    The Scaleway region this resource resides in.
    instanceId String

    UUID of the documentDB instance.

    Important: Updates to instance_id will recreate the Database User.

    password String
    Database User password.
    isAdmin Boolean
    Grant admin permissions to the Database User.
    name String

    Database Username.

    Important: Updates to name will recreate the Database User.

    region String
    The Scaleway region this resource resides in.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the DocumentdbUser 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 DocumentdbUser Resource

    Get an existing DocumentdbUser 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?: DocumentdbUserState, opts?: CustomResourceOptions): DocumentdbUser
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            instance_id: Optional[str] = None,
            is_admin: Optional[bool] = None,
            name: Optional[str] = None,
            password: Optional[str] = None,
            region: Optional[str] = None) -> DocumentdbUser
    func GetDocumentdbUser(ctx *Context, name string, id IDInput, state *DocumentdbUserState, opts ...ResourceOption) (*DocumentdbUser, error)
    public static DocumentdbUser Get(string name, Input<string> id, DocumentdbUserState? state, CustomResourceOptions? opts = null)
    public static DocumentdbUser get(String name, Output<String> id, DocumentdbUserState 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:
    InstanceId string

    UUID of the documentDB instance.

    Important: Updates to instance_id will recreate the Database User.

    IsAdmin bool
    Grant admin permissions to the Database User.
    Name string

    Database Username.

    Important: Updates to name will recreate the Database User.

    Password string
    Database User password.
    Region string
    The Scaleway region this resource resides in.
    InstanceId string

    UUID of the documentDB instance.

    Important: Updates to instance_id will recreate the Database User.

    IsAdmin bool
    Grant admin permissions to the Database User.
    Name string

    Database Username.

    Important: Updates to name will recreate the Database User.

    Password string
    Database User password.
    Region string
    The Scaleway region this resource resides in.
    instanceId String

    UUID of the documentDB instance.

    Important: Updates to instance_id will recreate the Database User.

    isAdmin Boolean
    Grant admin permissions to the Database User.
    name String

    Database Username.

    Important: Updates to name will recreate the Database User.

    password String
    Database User password.
    region String
    The Scaleway region this resource resides in.
    instanceId string

    UUID of the documentDB instance.

    Important: Updates to instance_id will recreate the Database User.

    isAdmin boolean
    Grant admin permissions to the Database User.
    name string

    Database Username.

    Important: Updates to name will recreate the Database User.

    password string
    Database User password.
    region string
    The Scaleway region this resource resides in.
    instance_id str

    UUID of the documentDB instance.

    Important: Updates to instance_id will recreate the Database User.

    is_admin bool
    Grant admin permissions to the Database User.
    name str

    Database Username.

    Important: Updates to name will recreate the Database User.

    password str
    Database User password.
    region str
    The Scaleway region this resource resides in.
    instanceId String

    UUID of the documentDB instance.

    Important: Updates to instance_id will recreate the Database User.

    isAdmin Boolean
    Grant admin permissions to the Database User.
    name String

    Database Username.

    Important: Updates to name will recreate the Database User.

    password String
    Database User password.
    region String
    The Scaleway region this resource resides in.

    Import

    Database User can be imported using {region}/{instance_id}/{user_name}, e.g.

    bash

    $ pulumi import scaleway:index/documentdbUser:DocumentdbUser admin fr-par/11111111-1111-1111-1111-111111111111/admin
    

    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