Database

Provides a PolarDB database resource. A DB database deployed in a DB cluster. A DB cluster can own multiple databases.

NOTE: Available in v1.66.0+.

Example Usage

using Pulumi;
using AliCloud = Pulumi.AliCloud;

class MyStack : Stack
{
    public MyStack()
    {
        var cluster = new AliCloud.PolarDB.Cluster("cluster", new AliCloud.PolarDB.ClusterArgs
        {
            DbNodeClass = @var.Clusterclass,
            DbType = "MySQL",
            DbVersion = "8.0",
            Description = "testDB",
            PayType = "PostPaid",
            VswitchId = "polar.mysql.x4.large",
        });
        var @default = new AliCloud.PolarDB.Database("default", new AliCloud.PolarDB.DatabaseArgs
        {
            DbClusterId = cluster.Id,
            DbName = "tftestdatabase",
        });
    }

}

Coming soon!

import pulumi
import pulumi_alicloud as alicloud

cluster = alicloud.polardb.Cluster("cluster",
    db_node_class=var["clusterclass"],
    db_type="MySQL",
    db_version="8.0",
    description="testDB",
    pay_type="PostPaid",
    vswitch_id="polar.mysql.x4.large")
default = alicloud.polardb.Database("default",
    db_cluster_id=cluster.id,
    db_name="tftestdatabase")

import * as pulumi from "@pulumi/pulumi";
import * as alicloud from "@pulumi/alicloud";

const cluster = new alicloud.polardb.Cluster("cluster", {
    dbNodeClass: var_clusterclass,
    dbType: "MySQL",
    dbVersion: "8.0",
    description: "testDB",
    payType: "PostPaid",
    vswitchId: "polar.mysql.x4.large",
});
const defaultDatabase = new alicloud.polardb.Database("default", {
    dbClusterId: cluster.id,
    dbName: "tftestdatabase",
});

Create a Database Resource

new Database(name: string, args: DatabaseArgs, opts?: CustomResourceOptions);

def Database(resource_name, opts=None, character_set_name=None, db_cluster_id=None, db_description=None, db_name=None, __props__=None);

func NewDatabase(ctx *Context, name string, args DatabaseArgs, opts ...ResourceOption) (*Database, error)

public Database(string name, DatabaseArgs args, 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:

DbClusterId string: The Id of cluster that can run database.
DbName string: Name of the database requiring a uniqueness check. It may consist of lower case letters, numbers, and underlines, and must start with a letterand have no more than 64 characters.
CharacterSetName string: Character set. The value range is limited to the following: [ utf8, gbk, latin1, utf8mb4, Chinese_PRC_CI_AS, Chinese_PRC_CS_AS, SQL_Latin1_General_CP1_CI_AS, SQL_Latin1_General_CP1_CS_AS, Chinese_PRC_BIN ], default is “utf8” (utf8mb4 only supports versions 5.5 and 5.6).
DbDescription string: Database description. It cannot begin with https://. It must start with a Chinese character or English letter. It can include Chinese and English characters, underlines (_), hyphens (-), and numbers. The length may be 2-256 characters.

DbClusterId string: The Id of cluster that can run database.
DbName string: Name of the database requiring a uniqueness check. It may consist of lower case letters, numbers, and underlines, and must start with a letterand have no more than 64 characters.
CharacterSetName string: Character set. The value range is limited to the following: [ utf8, gbk, latin1, utf8mb4, Chinese_PRC_CI_AS, Chinese_PRC_CS_AS, SQL_Latin1_General_CP1_CI_AS, SQL_Latin1_General_CP1_CS_AS, Chinese_PRC_BIN ], default is “utf8” (utf8mb4 only supports versions 5.5 and 5.6).
DbDescription string: Database description. It cannot begin with https://. It must start with a Chinese character or English letter. It can include Chinese and English characters, underlines (_), hyphens (-), and numbers. The length may be 2-256 characters.

dbClusterId string: The Id of cluster that can run database.
dbName string: Name of the database requiring a uniqueness check. It may consist of lower case letters, numbers, and underlines, and must start with a letterand have no more than 64 characters.
characterSetName string: Character set. The value range is limited to the following: [ utf8, gbk, latin1, utf8mb4, Chinese_PRC_CI_AS, Chinese_PRC_CS_AS, SQL_Latin1_General_CP1_CI_AS, SQL_Latin1_General_CP1_CS_AS, Chinese_PRC_BIN ], default is “utf8” (utf8mb4 only supports versions 5.5 and 5.6).
dbDescription string: Database description. It cannot begin with https://. It must start with a Chinese character or English letter. It can include Chinese and English characters, underlines (_), hyphens (-), and numbers. The length may be 2-256 characters.

db_cluster_id str: The Id of cluster that can run database.
db_name str: Name of the database requiring a uniqueness check. It may consist of lower case letters, numbers, and underlines, and must start with a letterand have no more than 64 characters.
character_set_name str: Character set. The value range is limited to the following: [ utf8, gbk, latin1, utf8mb4, Chinese_PRC_CI_AS, Chinese_PRC_CS_AS, SQL_Latin1_General_CP1_CI_AS, SQL_Latin1_General_CP1_CS_AS, Chinese_PRC_BIN ], default is “utf8” (utf8mb4 only supports versions 5.5 and 5.6).
db_description str: Database description. It cannot begin with https://. It must start with a Chinese character or English letter. It can include Chinese and English characters, underlines (_), hyphens (-), and numbers. The length may be 2-256 characters.

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

static get(resource_name, id, opts=None, character_set_name=None, db_cluster_id=None, db_description=None, db_name=None, __props__=None);

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:

CharacterSetName string: Character set. The value range is limited to the following: [ utf8, gbk, latin1, utf8mb4, Chinese_PRC_CI_AS, Chinese_PRC_CS_AS, SQL_Latin1_General_CP1_CI_AS, SQL_Latin1_General_CP1_CS_AS, Chinese_PRC_BIN ], default is “utf8” (utf8mb4 only supports versions 5.5 and 5.6).
DbClusterId string: The Id of cluster that can run database.
DbDescription string: Database description. It cannot begin with https://. It must start with a Chinese character or English letter. It can include Chinese and English characters, underlines (_), hyphens (-), and numbers. The length may be 2-256 characters.
DbName string: Name of the database requiring a uniqueness check. It may consist of lower case letters, numbers, and underlines, and must start with a letterand have no more than 64 characters.

CharacterSetName string: Character set. The value range is limited to the following: [ utf8, gbk, latin1, utf8mb4, Chinese_PRC_CI_AS, Chinese_PRC_CS_AS, SQL_Latin1_General_CP1_CI_AS, SQL_Latin1_General_CP1_CS_AS, Chinese_PRC_BIN ], default is “utf8” (utf8mb4 only supports versions 5.5 and 5.6).
DbClusterId string: The Id of cluster that can run database.
DbDescription string: Database description. It cannot begin with https://. It must start with a Chinese character or English letter. It can include Chinese and English characters, underlines (_), hyphens (-), and numbers. The length may be 2-256 characters.
DbName string: Name of the database requiring a uniqueness check. It may consist of lower case letters, numbers, and underlines, and must start with a letterand have no more than 64 characters.

characterSetName string: Character set. The value range is limited to the following: [ utf8, gbk, latin1, utf8mb4, Chinese_PRC_CI_AS, Chinese_PRC_CS_AS, SQL_Latin1_General_CP1_CI_AS, SQL_Latin1_General_CP1_CS_AS, Chinese_PRC_BIN ], default is “utf8” (utf8mb4 only supports versions 5.5 and 5.6).
dbClusterId string: The Id of cluster that can run database.
dbDescription string: Database description. It cannot begin with https://. It must start with a Chinese character or English letter. It can include Chinese and English characters, underlines (_), hyphens (-), and numbers. The length may be 2-256 characters.
dbName string: Name of the database requiring a uniqueness check. It may consist of lower case letters, numbers, and underlines, and must start with a letterand have no more than 64 characters.

character_set_name str: Character set. The value range is limited to the following: [ utf8, gbk, latin1, utf8mb4, Chinese_PRC_CI_AS, Chinese_PRC_CS_AS, SQL_Latin1_General_CP1_CI_AS, SQL_Latin1_General_CP1_CS_AS, Chinese_PRC_BIN ], default is “utf8” (utf8mb4 only supports versions 5.5 and 5.6).
db_cluster_id str: The Id of cluster that can run database.
db_description str: Database description. It cannot begin with https://. It must start with a Chinese character or English letter. It can include Chinese and English characters, underlines (_), hyphens (-), and numbers. The length may be 2-256 characters.
db_name str: Name of the database requiring a uniqueness check. It may consist of lower case letters, numbers, and underlines, and must start with a letterand have no more than 64 characters.

Package Details

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

The Pulumi Platform

Get Started

Migrate to Pulumi

Solutions for All Teams and Engineers

Any Code

Any Cloud