1. Packages
  2. Scaleway
  3. API Docs
  4. SdbDatabase
Scaleway v1.14.0 published on Thursday, Jun 6, 2024 by pulumiverse

scaleway.SdbDatabase

Explore with Pulumi AI

scaleway logo
Scaleway v1.14.0 published on Thursday, Jun 6, 2024 by pulumiverse

    Creates and manages Scaleway Serverless SQL Databases. For more information, see the documentation.

    Example Usage

    Basic

    import * as pulumi from "@pulumi/pulumi";
    import * as scaleway from "@pulumiverse/scaleway";
    
    const database = new scaleway.SdbDatabase("database", {
        maxCpu: 8,
        minCpu: 0,
    });
    
    import pulumi
    import pulumiverse_scaleway as scaleway
    
    database = scaleway.SdbDatabase("database",
        max_cpu=8,
        min_cpu=0)
    
    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.NewSdbDatabase(ctx, "database", &scaleway.SdbDatabaseArgs{
    			MaxCpu: pulumi.Int(8),
    			MinCpu: pulumi.Int(0),
    		})
    		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 database = new Scaleway.SdbDatabase("database", new()
        {
            MaxCpu = 8,
            MinCpu = 0,
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.scaleway.SdbDatabase;
    import com.pulumi.scaleway.SdbDatabaseArgs;
    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 database = new SdbDatabase("database", SdbDatabaseArgs.builder()        
                .maxCpu(8)
                .minCpu(0)
                .build());
    
        }
    }
    
    resources:
      database:
        type: scaleway:SdbDatabase
        properties:
          maxCpu: 8
          minCpu: 0
    

    Create SdbDatabase Resource

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

    Constructor syntax

    new SdbDatabase(name: string, args?: SdbDatabaseArgs, opts?: CustomResourceOptions);
    @overload
    def SdbDatabase(resource_name: str,
                    args: Optional[SdbDatabaseArgs] = None,
                    opts: Optional[ResourceOptions] = None)
    
    @overload
    def SdbDatabase(resource_name: str,
                    opts: Optional[ResourceOptions] = None,
                    max_cpu: Optional[int] = None,
                    min_cpu: Optional[int] = None,
                    name: Optional[str] = None,
                    project_id: Optional[str] = None,
                    region: Optional[str] = None)
    func NewSdbDatabase(ctx *Context, name string, args *SdbDatabaseArgs, opts ...ResourceOption) (*SdbDatabase, error)
    public SdbDatabase(string name, SdbDatabaseArgs? args = null, CustomResourceOptions? opts = null)
    public SdbDatabase(String name, SdbDatabaseArgs args)
    public SdbDatabase(String name, SdbDatabaseArgs args, CustomResourceOptions options)
    
    type: scaleway:SdbDatabase
    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 SdbDatabaseArgs
    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 SdbDatabaseArgs
    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 SdbDatabaseArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args SdbDatabaseArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args SdbDatabaseArgs
    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 sdbDatabaseResource = new Scaleway.SdbDatabase("sdbDatabaseResource", new()
    {
        MaxCpu = 0,
        MinCpu = 0,
        Name = "string",
        ProjectId = "string",
        Region = "string",
    });
    
    example, err := scaleway.NewSdbDatabase(ctx, "sdbDatabaseResource", &scaleway.SdbDatabaseArgs{
    	MaxCpu:    pulumi.Int(0),
    	MinCpu:    pulumi.Int(0),
    	Name:      pulumi.String("string"),
    	ProjectId: pulumi.String("string"),
    	Region:    pulumi.String("string"),
    })
    
    var sdbDatabaseResource = new SdbDatabase("sdbDatabaseResource", SdbDatabaseArgs.builder()
        .maxCpu(0)
        .minCpu(0)
        .name("string")
        .projectId("string")
        .region("string")
        .build());
    
    sdb_database_resource = scaleway.SdbDatabase("sdbDatabaseResource",
        max_cpu=0,
        min_cpu=0,
        name="string",
        project_id="string",
        region="string")
    
    const sdbDatabaseResource = new scaleway.SdbDatabase("sdbDatabaseResource", {
        maxCpu: 0,
        minCpu: 0,
        name: "string",
        projectId: "string",
        region: "string",
    });
    
    type: scaleway:SdbDatabase
    properties:
        maxCpu: 0
        minCpu: 0
        name: string
        projectId: string
        region: string
    

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

    MaxCpu int
    The maximum number of CPU units for your database. Defaults to 15.
    MinCpu int
    The minimum number of CPU units for your database. Defaults to 0.
    Name string

    Name of the database (e.g. my-new-database).

    Important: Updates to name will recreate the database.

    ProjectId string
    The project_id you want to attach the resource to
    Region string
    region) The region in which the resource exists.
    MaxCpu int
    The maximum number of CPU units for your database. Defaults to 15.
    MinCpu int
    The minimum number of CPU units for your database. Defaults to 0.
    Name string

    Name of the database (e.g. my-new-database).

    Important: Updates to name will recreate the database.

    ProjectId string
    The project_id you want to attach the resource to
    Region string
    region) The region in which the resource exists.
    maxCpu Integer
    The maximum number of CPU units for your database. Defaults to 15.
    minCpu Integer
    The minimum number of CPU units for your database. Defaults to 0.
    name String

    Name of the database (e.g. my-new-database).

    Important: Updates to name will recreate the database.

    projectId String
    The project_id you want to attach the resource to
    region String
    region) The region in which the resource exists.
    maxCpu number
    The maximum number of CPU units for your database. Defaults to 15.
    minCpu number
    The minimum number of CPU units for your database. Defaults to 0.
    name string

    Name of the database (e.g. my-new-database).

    Important: Updates to name will recreate the database.

    projectId string
    The project_id you want to attach the resource to
    region string
    region) The region in which the resource exists.
    max_cpu int
    The maximum number of CPU units for your database. Defaults to 15.
    min_cpu int
    The minimum number of CPU units for your database. Defaults to 0.
    name str

    Name of the database (e.g. my-new-database).

    Important: Updates to name will recreate the database.

    project_id str
    The project_id you want to attach the resource to
    region str
    region) The region in which the resource exists.
    maxCpu Number
    The maximum number of CPU units for your database. Defaults to 15.
    minCpu Number
    The minimum number of CPU units for your database. Defaults to 0.
    name String

    Name of the database (e.g. my-new-database).

    Important: Updates to name will recreate the database.

    projectId String
    The project_id you want to attach the resource to
    region String
    region) The region in which the resource exists.

    Outputs

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

    Endpoint string
    Endpoint of the database
    Id string
    The provider-assigned unique ID for this managed resource.
    Endpoint string
    Endpoint of the database
    Id string
    The provider-assigned unique ID for this managed resource.
    endpoint String
    Endpoint of the database
    id String
    The provider-assigned unique ID for this managed resource.
    endpoint string
    Endpoint of the database
    id string
    The provider-assigned unique ID for this managed resource.
    endpoint str
    Endpoint of the database
    id str
    The provider-assigned unique ID for this managed resource.
    endpoint String
    Endpoint of the database
    id String
    The provider-assigned unique ID for this managed resource.

    Look up Existing SdbDatabase Resource

    Get an existing SdbDatabase 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?: SdbDatabaseState, opts?: CustomResourceOptions): SdbDatabase
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            endpoint: Optional[str] = None,
            max_cpu: Optional[int] = None,
            min_cpu: Optional[int] = None,
            name: Optional[str] = None,
            project_id: Optional[str] = None,
            region: Optional[str] = None) -> SdbDatabase
    func GetSdbDatabase(ctx *Context, name string, id IDInput, state *SdbDatabaseState, opts ...ResourceOption) (*SdbDatabase, error)
    public static SdbDatabase Get(string name, Input<string> id, SdbDatabaseState? state, CustomResourceOptions? opts = null)
    public static SdbDatabase get(String name, Output<String> id, SdbDatabaseState 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:
    Endpoint string
    Endpoint of the database
    MaxCpu int
    The maximum number of CPU units for your database. Defaults to 15.
    MinCpu int
    The minimum number of CPU units for your database. Defaults to 0.
    Name string

    Name of the database (e.g. my-new-database).

    Important: Updates to name will recreate the database.

    ProjectId string
    The project_id you want to attach the resource to
    Region string
    region) The region in which the resource exists.
    Endpoint string
    Endpoint of the database
    MaxCpu int
    The maximum number of CPU units for your database. Defaults to 15.
    MinCpu int
    The minimum number of CPU units for your database. Defaults to 0.
    Name string

    Name of the database (e.g. my-new-database).

    Important: Updates to name will recreate the database.

    ProjectId string
    The project_id you want to attach the resource to
    Region string
    region) The region in which the resource exists.
    endpoint String
    Endpoint of the database
    maxCpu Integer
    The maximum number of CPU units for your database. Defaults to 15.
    minCpu Integer
    The minimum number of CPU units for your database. Defaults to 0.
    name String

    Name of the database (e.g. my-new-database).

    Important: Updates to name will recreate the database.

    projectId String
    The project_id you want to attach the resource to
    region String
    region) The region in which the resource exists.
    endpoint string
    Endpoint of the database
    maxCpu number
    The maximum number of CPU units for your database. Defaults to 15.
    minCpu number
    The minimum number of CPU units for your database. Defaults to 0.
    name string

    Name of the database (e.g. my-new-database).

    Important: Updates to name will recreate the database.

    projectId string
    The project_id you want to attach the resource to
    region string
    region) The region in which the resource exists.
    endpoint str
    Endpoint of the database
    max_cpu int
    The maximum number of CPU units for your database. Defaults to 15.
    min_cpu int
    The minimum number of CPU units for your database. Defaults to 0.
    name str

    Name of the database (e.g. my-new-database).

    Important: Updates to name will recreate the database.

    project_id str
    The project_id you want to attach the resource to
    region str
    region) The region in which the resource exists.
    endpoint String
    Endpoint of the database
    maxCpu Number
    The maximum number of CPU units for your database. Defaults to 15.
    minCpu Number
    The minimum number of CPU units for your database. Defaults to 0.
    name String

    Name of the database (e.g. my-new-database).

    Important: Updates to name will recreate the database.

    projectId String
    The project_id you want to attach the resource to
    region String
    region) The region in which the resource exists.

    Import

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

    bash

    $ pulumi import scaleway:index/sdbDatabase:SdbDatabase database 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.14.0 published on Thursday, Jun 6, 2024 by pulumiverse