Ready to level-up your engineering skills? Join a Pulumi Workshop. Register Now

Database

The mysql.Database resource creates and manages a database on a MySQL server.

Example Usage

using Pulumi;
using MySql = Pulumi.MySql;

class MyStack : Stack
{
    public MyStack()
    {
        var app = new MySql.Database("app", new MySql.DatabaseArgs
        {
        });
    }

}
package main

import (
    "github.com/pulumi/pulumi-mysql/sdk/v2/go/mysql"
    "github.com/pulumi/pulumi/sdk/v2/go/pulumi"
)

func main() {
    pulumi.Run(func(ctx *pulumi.Context) error {
        _, err := mysql.NewDatabase(ctx, "app", nil)
        if err != nil {
            return err
        }
        return nil
    })
}
import pulumi
import pulumi_mysql as mysql

app = mysql.Database("app")
import * as pulumi from "@pulumi/pulumi";
import * as mysql from "@pulumi/mysql";

const app = new mysql.Database("app", {});

Create a Database Resource

new Database(name: string, args?: DatabaseArgs, opts?: CustomResourceOptions);
def Database(resource_name: str, opts: Optional[ResourceOptions] = None, default_character_set: Optional[str] = None, default_collation: Optional[str] = None, name: Optional[str] = None)
func NewDatabase(ctx *Context, name string, args *DatabaseArgs, opts ...ResourceOption) (*Database, error)
public Database(string name, DatabaseArgs? args = null, CustomResourceOptions? opts = null)
name string
The unique name of the resource.
args DatabaseArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name str
The unique name of the resource.
opts ResourceOptions
A bag of options that control this resource's behavior.
ctx Context
Context object for the current deployment.
name string
The unique name of the resource.
args DatabaseArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name string
The unique name of the resource.
args DatabaseArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.

Database Resource Properties

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

Inputs

The Database resource accepts the following input properties:

DefaultCharacterSet string

The default character set to use when a table is created without specifying an explicit character set. Defaults to “utf8”.

DefaultCollation string

The default collation to use when a table is created without specifying an explicit collation. Defaults to utf8_general_ci. Each character set has its own set of collations, so changing the character set requires also changing the collation.

Name string

The name of the database. This must be unique within a given MySQL server and may or may not be case-sensitive depending on the operating system on which the MySQL server is running.

DefaultCharacterSet string

The default character set to use when a table is created without specifying an explicit character set. Defaults to “utf8”.

DefaultCollation string

The default collation to use when a table is created without specifying an explicit collation. Defaults to utf8_general_ci. Each character set has its own set of collations, so changing the character set requires also changing the collation.

Name string

The name of the database. This must be unique within a given MySQL server and may or may not be case-sensitive depending on the operating system on which the MySQL server is running.

defaultCharacterSet string

The default character set to use when a table is created without specifying an explicit character set. Defaults to “utf8”.

defaultCollation string

The default collation to use when a table is created without specifying an explicit collation. Defaults to utf8_general_ci. Each character set has its own set of collations, so changing the character set requires also changing the collation.

name string

The name of the database. This must be unique within a given MySQL server and may or may not be case-sensitive depending on the operating system on which the MySQL server is running.

default_character_set str

The default character set to use when a table is created without specifying an explicit character set. Defaults to “utf8”.

default_collation str

The default collation to use when a table is created without specifying an explicit collation. Defaults to utf8_general_ci. Each character set has its own set of collations, so changing the character set requires also changing the collation.

name str

The name of the database. This must be unique within a given MySQL server and may or may not be case-sensitive depending on the operating system on which the MySQL server is running.

Outputs

All input properties are implicitly available as output properties. Additionally, the Database 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 str
The provider-assigned unique ID for this managed resource.

Look up an Existing Database Resource

Get an existing Database 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?: DatabaseState, opts?: CustomResourceOptions): Database
@staticmethod
def get(resource_name: str, id: str, opts: Optional[ResourceOptions] = None, default_character_set: Optional[str] = None, default_collation: Optional[str] = None, name: Optional[str] = None) -> Database
func GetDatabase(ctx *Context, name string, id IDInput, state *DatabaseState, opts ...ResourceOption) (*Database, error)
public static Database Get(string name, Input<string> id, DatabaseState? state, CustomResourceOptions? opts = null)
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.

The following state arguments are supported:

DefaultCharacterSet string

The default character set to use when a table is created without specifying an explicit character set. Defaults to “utf8”.

DefaultCollation string

The default collation to use when a table is created without specifying an explicit collation. Defaults to utf8_general_ci. Each character set has its own set of collations, so changing the character set requires also changing the collation.

Name string

The name of the database. This must be unique within a given MySQL server and may or may not be case-sensitive depending on the operating system on which the MySQL server is running.

DefaultCharacterSet string

The default character set to use when a table is created without specifying an explicit character set. Defaults to “utf8”.

DefaultCollation string

The default collation to use when a table is created without specifying an explicit collation. Defaults to utf8_general_ci. Each character set has its own set of collations, so changing the character set requires also changing the collation.

Name string

The name of the database. This must be unique within a given MySQL server and may or may not be case-sensitive depending on the operating system on which the MySQL server is running.

defaultCharacterSet string

The default character set to use when a table is created without specifying an explicit character set. Defaults to “utf8”.

defaultCollation string

The default collation to use when a table is created without specifying an explicit collation. Defaults to utf8_general_ci. Each character set has its own set of collations, so changing the character set requires also changing the collation.

name string

The name of the database. This must be unique within a given MySQL server and may or may not be case-sensitive depending on the operating system on which the MySQL server is running.

default_character_set str

The default character set to use when a table is created without specifying an explicit character set. Defaults to “utf8”.

default_collation str

The default collation to use when a table is created without specifying an explicit collation. Defaults to utf8_general_ci. Each character set has its own set of collations, so changing the character set requires also changing the collation.

name str

The name of the database. This must be unique within a given MySQL server and may or may not be case-sensitive depending on the operating system on which the MySQL server is running.

Import

Databases can be imported using their name, e.g.

 $ pulumi import mysql:index/database:Database example my-example-database

Package Details

Repository
https://github.com/pulumi/pulumi-mysql
License
Apache-2.0
Notes
This Pulumi package is based on the mysql Terraform Provider.