Docs Home
alicloud.rds.Database
Explore with Pulumi AI
Provides an RDS database resource. A DB database deployed in a DB instance. A DB instance can own multiple databases, see What is DB Database.
NOTE: Available since v1.5.0.
Example Usage
import * as pulumi from "@pulumi/pulumi";
import * as alicloud from "@pulumi/alicloud";
const config = new pulumi.Config();
const name = config.get("name") || "tf-example";
const default = alicloud.rds.getZones({
engine: "MySQL",
engineVersion: "5.6",
});
const defaultNetwork = new alicloud.vpc.Network("default", {
vpcName: name,
cidrBlock: "172.16.0.0/16",
});
const defaultSwitch = new alicloud.vpc.Switch("default", {
vpcId: defaultNetwork.id,
cidrBlock: "172.16.0.0/24",
zoneId: _default.then(_default => _default.zones?.[0]?.id),
vswitchName: name,
});
const defaultInstance = new alicloud.rds.Instance("default", {
engine: "MySQL",
engineVersion: "5.6",
instanceType: "rds.mysql.s1.small",
instanceStorage: 10,
vswitchId: defaultSwitch.id,
instanceName: name,
});
const defaultDatabase = new alicloud.rds.Database("default", {
instanceId: defaultInstance.id,
name: name,
});
import pulumi
import pulumi_alicloud as alicloud
config = pulumi.Config()
name = config.get("name")
if name is None:
name = "tf-example"
default = alicloud.rds.get_zones(engine="MySQL",
engine_version="5.6")
default_network = alicloud.vpc.Network("default",
vpc_name=name,
cidr_block="172.16.0.0/16")
default_switch = alicloud.vpc.Switch("default",
vpc_id=default_network.id,
cidr_block="172.16.0.0/24",
zone_id=default.zones[0].id,
vswitch_name=name)
default_instance = alicloud.rds.Instance("default",
engine="MySQL",
engine_version="5.6",
instance_type="rds.mysql.s1.small",
instance_storage=10,
vswitch_id=default_switch.id,
instance_name=name)
default_database = alicloud.rds.Database("default",
instance_id=default_instance.id,
name=name)
package main
import (
"github.com/pulumi/pulumi-alicloud/sdk/v3/go/alicloud/rds"
"github.com/pulumi/pulumi-alicloud/sdk/v3/go/alicloud/vpc"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi/config"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
cfg := config.New(ctx, "")
name := "tf-example"
if param := cfg.Get("name"); param != "" {
name = param
}
_default, err := rds.GetZones(ctx, &rds.GetZonesArgs{
Engine: pulumi.StringRef("MySQL"),
EngineVersion: pulumi.StringRef("5.6"),
}, nil)
if err != nil {
return err
}
defaultNetwork, err := vpc.NewNetwork(ctx, "default", &vpc.NetworkArgs{
VpcName: pulumi.String(name),
CidrBlock: pulumi.String("172.16.0.0/16"),
})
if err != nil {
return err
}
defaultSwitch, err := vpc.NewSwitch(ctx, "default", &vpc.SwitchArgs{
VpcId: defaultNetwork.ID(),
CidrBlock: pulumi.String("172.16.0.0/24"),
ZoneId: pulumi.String(_default.Zones[0].Id),
VswitchName: pulumi.String(name),
})
if err != nil {
return err
}
defaultInstance, err := rds.NewInstance(ctx, "default", &rds.InstanceArgs{
Engine: pulumi.String("MySQL"),
EngineVersion: pulumi.String("5.6"),
InstanceType: pulumi.String("rds.mysql.s1.small"),
InstanceStorage: pulumi.Int(10),
VswitchId: defaultSwitch.ID(),
InstanceName: pulumi.String(name),
})
if err != nil {
return err
}
_, err = rds.NewDatabase(ctx, "default", &rds.DatabaseArgs{
InstanceId: defaultInstance.ID(),
Name: pulumi.String(name),
})
if err != nil {
return err
}
return nil
})
}
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using AliCloud = Pulumi.AliCloud;
return await Deployment.RunAsync(() =>
{
var config = new Config();
var name = config.Get("name") ?? "tf-example";
var @default = AliCloud.Rds.GetZones.Invoke(new()
{
Engine = "MySQL",
EngineVersion = "5.6",
});
var defaultNetwork = new AliCloud.Vpc.Network("default", new()
{
VpcName = name,
CidrBlock = "172.16.0.0/16",
});
var defaultSwitch = new AliCloud.Vpc.Switch("default", new()
{
VpcId = defaultNetwork.Id,
CidrBlock = "172.16.0.0/24",
ZoneId = @default.Apply(@default => @default.Apply(getZonesResult => getZonesResult.Zones[0]?.Id)),
VswitchName = name,
});
var defaultInstance = new AliCloud.Rds.Instance("default", new()
{
Engine = "MySQL",
EngineVersion = "5.6",
InstanceType = "rds.mysql.s1.small",
InstanceStorage = 10,
VswitchId = defaultSwitch.Id,
InstanceName = name,
});
var defaultDatabase = new AliCloud.Rds.Database("default", new()
{
InstanceId = defaultInstance.Id,
Name = name,
});
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.alicloud.rds.RdsFunctions;
import com.pulumi.alicloud.rds.inputs.GetZonesArgs;
import com.pulumi.alicloud.vpc.Network;
import com.pulumi.alicloud.vpc.NetworkArgs;
import com.pulumi.alicloud.vpc.Switch;
import com.pulumi.alicloud.vpc.SwitchArgs;
import com.pulumi.alicloud.rds.Instance;
import com.pulumi.alicloud.rds.InstanceArgs;
import com.pulumi.alicloud.rds.Database;
import com.pulumi.alicloud.rds.DatabaseArgs;
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) {
final var config = ctx.config();
final var name = config.get("name").orElse("tf-example");
final var default = RdsFunctions.getZones(GetZonesArgs.builder()
.engine("MySQL")
.engineVersion("5.6")
.build());
var defaultNetwork = new Network("defaultNetwork", NetworkArgs.builder()
.vpcName(name)
.cidrBlock("172.16.0.0/16")
.build());
var defaultSwitch = new Switch("defaultSwitch", SwitchArgs.builder()
.vpcId(defaultNetwork.id())
.cidrBlock("172.16.0.0/24")
.zoneId(default_.zones()[0].id())
.vswitchName(name)
.build());
var defaultInstance = new Instance("defaultInstance", InstanceArgs.builder()
.engine("MySQL")
.engineVersion("5.6")
.instanceType("rds.mysql.s1.small")
.instanceStorage("10")
.vswitchId(defaultSwitch.id())
.instanceName(name)
.build());
var defaultDatabase = new Database("defaultDatabase", DatabaseArgs.builder()
.instanceId(defaultInstance.id())
.name(name)
.build());
}
}
configuration:
name:
type: string
default: tf-example
resources:
defaultNetwork:
type: alicloud:vpc:Network
name: default
properties:
vpcName: ${name}
cidrBlock: 172.16.0.0/16
defaultSwitch:
type: alicloud:vpc:Switch
name: default
properties:
vpcId: ${defaultNetwork.id}
cidrBlock: 172.16.0.0/24
zoneId: ${default.zones[0].id}
vswitchName: ${name}
defaultInstance:
type: alicloud:rds:Instance
name: default
properties:
engine: MySQL
engineVersion: '5.6'
instanceType: rds.mysql.s1.small
instanceStorage: '10'
vswitchId: ${defaultSwitch.id}
instanceName: ${name}
defaultDatabase:
type: alicloud:rds:Database
name: default
properties:
instanceId: ${defaultInstance.id}
name: ${name}
variables:
default:
fn::invoke:
Function: alicloud:rds:getZones
Arguments:
engine: MySQL
engineVersion: '5.6'
Create Database Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new Database(name: string, args: DatabaseArgs, opts?: CustomResourceOptions);@overload
def Database(resource_name: str,
args: DatabaseArgs,
opts: Optional[ResourceOptions] = None)
@overload
def Database(resource_name: str,
opts: Optional[ResourceOptions] = None,
instance_id: Optional[str] = None,
character_set: Optional[str] = None,
description: 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, CustomResourceOptions? opts = null)
public Database(String name, DatabaseArgs args)
public Database(String name, DatabaseArgs args, CustomResourceOptions options)
type: alicloud:rds:Database
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 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.
- args DatabaseArgs
- 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 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.
- name String
- The unique name of the resource.
- args DatabaseArgs
- 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 exampledatabaseResourceResourceFromRdsdatabase = new AliCloud.Rds.Database("exampledatabaseResourceResourceFromRdsdatabase", new()
{
InstanceId = "string",
CharacterSet = "string",
Description = "string",
Name = "string",
});
example, err := rds.NewDatabase(ctx, "exampledatabaseResourceResourceFromRdsdatabase", &rds.DatabaseArgs{
InstanceId: pulumi.String("string"),
CharacterSet: pulumi.String("string"),
Description: pulumi.String("string"),
Name: pulumi.String("string"),
})
var exampledatabaseResourceResourceFromRdsdatabase = new Database("exampledatabaseResourceResourceFromRdsdatabase", DatabaseArgs.builder()
.instanceId("string")
.characterSet("string")
.description("string")
.name("string")
.build());
exampledatabase_resource_resource_from_rdsdatabase = alicloud.rds.Database("exampledatabaseResourceResourceFromRdsdatabase",
instance_id="string",
character_set="string",
description="string",
name="string")
const exampledatabaseResourceResourceFromRdsdatabase = new alicloud.rds.Database("exampledatabaseResourceResourceFromRdsdatabase", {
instanceId: "string",
characterSet: "string",
description: "string",
name: "string",
});
type: alicloud:rds:Database
properties:
characterSet: string
description: string
instanceId: string
name: string
Database Resource Properties
To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.
Inputs
In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.
The Database resource accepts the following input properties:
- Instance
Id string - The Id of instance that can run database.
- Character
Set string Character set. The value range is limited to the following:
- MySQL: [ utf8, gbk, latin1, utf8mb4 ] (
utf8mb4only supports versions 5.5 and 5.6). - SQLServer: [ Chinese_PRC_CI_AS, Chinese_PRC_CS_AS, SQL_Latin1_General_CP1_CI_AS, SQL_Latin1_General_CP1_CS_AS, Chinese_PRC_BIN ]
- PostgreSQL: Valid values for PostgreSQL databases: a value in the
character set,<Collate>,<Ctype>format. Example:UTF8,C,en_US.utf8.
- Valid values for the character set : [ KOI8U, UTF8, WIN866, WIN874, WIN1250, WIN1251, WIN1252, WIN1253, WIN1254, WIN1255, WIN1256, WIN1257, WIN1258, EUC_CN, EUC_KR, EUC_TW, EUC_JP, EUC_JIS_2004, KOI8R, MULE_INTERNAL, LATIN1, LATIN2, LATIN3, LATIN4, LATIN5, LATIN6, LATIN7, LATIN8, LATIN9, LATIN10, ISO_8859_5, ISO_8859_6, ISO_8859_7, ISO_8859_8, SQL_ASCII ]
- Valid values for the Collate field: You can execute the
SELECT DISTINCT collname FROM pg_collation;statement to obtain the field value. The default value isC. - Valid values for the Ctype field: You can execute the
SELECT DISTINCT collctype FROM pg_collation;statement to obtain the field value. The default value isen_US.utf8.
- MariaDB: [ utf8, gbk, latin1, utf8mb4 ]
More details refer to API Docs
- MySQL: [ utf8, gbk, latin1, utf8mb4 ] (
- Description 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.
NOTE: The value of "name" or "character_set" does not support modification.
- Name string
The name of the database.
NOTE: The name must be 2 to 64 characters in length. The name must start with a lowercase letter and end with a lowercase letter or digit. The name can contain lowercase letters, digits, underscores (_), and hyphens (-). The name must be unique within the instance. For more information about invalid characters, see Forbidden keywords table.
- Instance
Id string - The Id of instance that can run database.
- Character
Set string Character set. The value range is limited to the following:
- MySQL: [ utf8, gbk, latin1, utf8mb4 ] (
utf8mb4only supports versions 5.5 and 5.6). - SQLServer: [ Chinese_PRC_CI_AS, Chinese_PRC_CS_AS, SQL_Latin1_General_CP1_CI_AS, SQL_Latin1_General_CP1_CS_AS, Chinese_PRC_BIN ]
- PostgreSQL: Valid values for PostgreSQL databases: a value in the
character set,<Collate>,<Ctype>format. Example:UTF8,C,en_US.utf8.
- Valid values for the character set : [ KOI8U, UTF8, WIN866, WIN874, WIN1250, WIN1251, WIN1252, WIN1253, WIN1254, WIN1255, WIN1256, WIN1257, WIN1258, EUC_CN, EUC_KR, EUC_TW, EUC_JP, EUC_JIS_2004, KOI8R, MULE_INTERNAL, LATIN1, LATIN2, LATIN3, LATIN4, LATIN5, LATIN6, LATIN7, LATIN8, LATIN9, LATIN10, ISO_8859_5, ISO_8859_6, ISO_8859_7, ISO_8859_8, SQL_ASCII ]
- Valid values for the Collate field: You can execute the
SELECT DISTINCT collname FROM pg_collation;statement to obtain the field value. The default value isC. - Valid values for the Ctype field: You can execute the
SELECT DISTINCT collctype FROM pg_collation;statement to obtain the field value. The default value isen_US.utf8.
- MariaDB: [ utf8, gbk, latin1, utf8mb4 ]
More details refer to API Docs
- MySQL: [ utf8, gbk, latin1, utf8mb4 ] (
- Description 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.
NOTE: The value of "name" or "character_set" does not support modification.
- Name string
The name of the database.
NOTE: The name must be 2 to 64 characters in length. The name must start with a lowercase letter and end with a lowercase letter or digit. The name can contain lowercase letters, digits, underscores (_), and hyphens (-). The name must be unique within the instance. For more information about invalid characters, see Forbidden keywords table.
- instance
Id String - The Id of instance that can run database.
- character
Set String Character set. The value range is limited to the following:
- MySQL: [ utf8, gbk, latin1, utf8mb4 ] (
utf8mb4only supports versions 5.5 and 5.6). - SQLServer: [ Chinese_PRC_CI_AS, Chinese_PRC_CS_AS, SQL_Latin1_General_CP1_CI_AS, SQL_Latin1_General_CP1_CS_AS, Chinese_PRC_BIN ]
- PostgreSQL: Valid values for PostgreSQL databases: a value in the
character set,<Collate>,<Ctype>format. Example:UTF8,C,en_US.utf8.
- Valid values for the character set : [ KOI8U, UTF8, WIN866, WIN874, WIN1250, WIN1251, WIN1252, WIN1253, WIN1254, WIN1255, WIN1256, WIN1257, WIN1258, EUC_CN, EUC_KR, EUC_TW, EUC_JP, EUC_JIS_2004, KOI8R, MULE_INTERNAL, LATIN1, LATIN2, LATIN3, LATIN4, LATIN5, LATIN6, LATIN7, LATIN8, LATIN9, LATIN10, ISO_8859_5, ISO_8859_6, ISO_8859_7, ISO_8859_8, SQL_ASCII ]
- Valid values for the Collate field: You can execute the
SELECT DISTINCT collname FROM pg_collation;statement to obtain the field value. The default value isC. - Valid values for the Ctype field: You can execute the
SELECT DISTINCT collctype FROM pg_collation;statement to obtain the field value. The default value isen_US.utf8.
- MariaDB: [ utf8, gbk, latin1, utf8mb4 ]
More details refer to API Docs
- MySQL: [ utf8, gbk, latin1, utf8mb4 ] (
- description 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.
NOTE: The value of "name" or "character_set" does not support modification.
- name String
The name of the database.
NOTE: The name must be 2 to 64 characters in length. The name must start with a lowercase letter and end with a lowercase letter or digit. The name can contain lowercase letters, digits, underscores (_), and hyphens (-). The name must be unique within the instance. For more information about invalid characters, see Forbidden keywords table.
- instance
Id string - The Id of instance that can run database.
- character
Set string Character set. The value range is limited to the following:
- MySQL: [ utf8, gbk, latin1, utf8mb4 ] (
utf8mb4only supports versions 5.5 and 5.6). - SQLServer: [ Chinese_PRC_CI_AS, Chinese_PRC_CS_AS, SQL_Latin1_General_CP1_CI_AS, SQL_Latin1_General_CP1_CS_AS, Chinese_PRC_BIN ]
- PostgreSQL: Valid values for PostgreSQL databases: a value in the
character set,<Collate>,<Ctype>format. Example:UTF8,C,en_US.utf8.
- Valid values for the character set : [ KOI8U, UTF8, WIN866, WIN874, WIN1250, WIN1251, WIN1252, WIN1253, WIN1254, WIN1255, WIN1256, WIN1257, WIN1258, EUC_CN, EUC_KR, EUC_TW, EUC_JP, EUC_JIS_2004, KOI8R, MULE_INTERNAL, LATIN1, LATIN2, LATIN3, LATIN4, LATIN5, LATIN6, LATIN7, LATIN8, LATIN9, LATIN10, ISO_8859_5, ISO_8859_6, ISO_8859_7, ISO_8859_8, SQL_ASCII ]
- Valid values for the Collate field: You can execute the
SELECT DISTINCT collname FROM pg_collation;statement to obtain the field value. The default value isC. - Valid values for the Ctype field: You can execute the
SELECT DISTINCT collctype FROM pg_collation;statement to obtain the field value. The default value isen_US.utf8.
- MariaDB: [ utf8, gbk, latin1, utf8mb4 ]
More details refer to API Docs
- MySQL: [ utf8, gbk, latin1, utf8mb4 ] (
- description 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.
NOTE: The value of "name" or "character_set" does not support modification.
- name string
The name of the database.
NOTE: The name must be 2 to 64 characters in length. The name must start with a lowercase letter and end with a lowercase letter or digit. The name can contain lowercase letters, digits, underscores (_), and hyphens (-). The name must be unique within the instance. For more information about invalid characters, see Forbidden keywords table.
- instance_
id str - The Id of instance that can run database.
- character_
set str Character set. The value range is limited to the following:
- MySQL: [ utf8, gbk, latin1, utf8mb4 ] (
utf8mb4only supports versions 5.5 and 5.6). - SQLServer: [ Chinese_PRC_CI_AS, Chinese_PRC_CS_AS, SQL_Latin1_General_CP1_CI_AS, SQL_Latin1_General_CP1_CS_AS, Chinese_PRC_BIN ]
- PostgreSQL: Valid values for PostgreSQL databases: a value in the
character set,<Collate>,<Ctype>format. Example:UTF8,C,en_US.utf8.
- Valid values for the character set : [ KOI8U, UTF8, WIN866, WIN874, WIN1250, WIN1251, WIN1252, WIN1253, WIN1254, WIN1255, WIN1256, WIN1257, WIN1258, EUC_CN, EUC_KR, EUC_TW, EUC_JP, EUC_JIS_2004, KOI8R, MULE_INTERNAL, LATIN1, LATIN2, LATIN3, LATIN4, LATIN5, LATIN6, LATIN7, LATIN8, LATIN9, LATIN10, ISO_8859_5, ISO_8859_6, ISO_8859_7, ISO_8859_8, SQL_ASCII ]
- Valid values for the Collate field: You can execute the
SELECT DISTINCT collname FROM pg_collation;statement to obtain the field value. The default value isC. - Valid values for the Ctype field: You can execute the
SELECT DISTINCT collctype FROM pg_collation;statement to obtain the field value. The default value isen_US.utf8.
- MariaDB: [ utf8, gbk, latin1, utf8mb4 ]
More details refer to API Docs
- MySQL: [ utf8, gbk, latin1, utf8mb4 ] (
- 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.
NOTE: The value of "name" or "character_set" does not support modification.
- name str
The name of the database.
NOTE: The name must be 2 to 64 characters in length. The name must start with a lowercase letter and end with a lowercase letter or digit. The name can contain lowercase letters, digits, underscores (_), and hyphens (-). The name must be unique within the instance. For more information about invalid characters, see Forbidden keywords table.
- instance
Id String - The Id of instance that can run database.
- character
Set String Character set. The value range is limited to the following:
- MySQL: [ utf8, gbk, latin1, utf8mb4 ] (
utf8mb4only supports versions 5.5 and 5.6). - SQLServer: [ Chinese_PRC_CI_AS, Chinese_PRC_CS_AS, SQL_Latin1_General_CP1_CI_AS, SQL_Latin1_General_CP1_CS_AS, Chinese_PRC_BIN ]
- PostgreSQL: Valid values for PostgreSQL databases: a value in the
character set,<Collate>,<Ctype>format. Example:UTF8,C,en_US.utf8.
- Valid values for the character set : [ KOI8U, UTF8, WIN866, WIN874, WIN1250, WIN1251, WIN1252, WIN1253, WIN1254, WIN1255, WIN1256, WIN1257, WIN1258, EUC_CN, EUC_KR, EUC_TW, EUC_JP, EUC_JIS_2004, KOI8R, MULE_INTERNAL, LATIN1, LATIN2, LATIN3, LATIN4, LATIN5, LATIN6, LATIN7, LATIN8, LATIN9, LATIN10, ISO_8859_5, ISO_8859_6, ISO_8859_7, ISO_8859_8, SQL_ASCII ]
- Valid values for the Collate field: You can execute the
SELECT DISTINCT collname FROM pg_collation;statement to obtain the field value. The default value isC. - Valid values for the Ctype field: You can execute the
SELECT DISTINCT collctype FROM pg_collation;statement to obtain the field value. The default value isen_US.utf8.
- MariaDB: [ utf8, gbk, latin1, utf8mb4 ]
More details refer to API Docs
- MySQL: [ utf8, gbk, latin1, utf8mb4 ] (
- description 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.
NOTE: The value of "name" or "character_set" does not support modification.
- name String
The name of the database.
NOTE: The name must be 2 to 64 characters in length. The name must start with a lowercase letter and end with a lowercase letter or digit. The name can contain lowercase letters, digits, underscores (_), and hyphens (-). The name must be unique within the instance. For more information about invalid characters, see Forbidden keywords table.
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 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 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,
character_set: Optional[str] = None,
description: Optional[str] = None,
instance_id: Optional[str] = None,
name: Optional[str] = None) -> Databasefunc 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)public static Database get(String name, Output<String> id, DatabaseState 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.
- Character
Set string Character set. The value range is limited to the following:
- MySQL: [ utf8, gbk, latin1, utf8mb4 ] (
utf8mb4only supports versions 5.5 and 5.6). - SQLServer: [ Chinese_PRC_CI_AS, Chinese_PRC_CS_AS, SQL_Latin1_General_CP1_CI_AS, SQL_Latin1_General_CP1_CS_AS, Chinese_PRC_BIN ]
- PostgreSQL: Valid values for PostgreSQL databases: a value in the
character set,<Collate>,<Ctype>format. Example:UTF8,C,en_US.utf8.
- Valid values for the character set : [ KOI8U, UTF8, WIN866, WIN874, WIN1250, WIN1251, WIN1252, WIN1253, WIN1254, WIN1255, WIN1256, WIN1257, WIN1258, EUC_CN, EUC_KR, EUC_TW, EUC_JP, EUC_JIS_2004, KOI8R, MULE_INTERNAL, LATIN1, LATIN2, LATIN3, LATIN4, LATIN5, LATIN6, LATIN7, LATIN8, LATIN9, LATIN10, ISO_8859_5, ISO_8859_6, ISO_8859_7, ISO_8859_8, SQL_ASCII ]
- Valid values for the Collate field: You can execute the
SELECT DISTINCT collname FROM pg_collation;statement to obtain the field value. The default value isC. - Valid values for the Ctype field: You can execute the
SELECT DISTINCT collctype FROM pg_collation;statement to obtain the field value. The default value isen_US.utf8.
- MariaDB: [ utf8, gbk, latin1, utf8mb4 ]
More details refer to API Docs
- MySQL: [ utf8, gbk, latin1, utf8mb4 ] (
- Description 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.
NOTE: The value of "name" or "character_set" does not support modification.
- Instance
Id string - The Id of instance that can run database.
- Name string
The name of the database.
NOTE: The name must be 2 to 64 characters in length. The name must start with a lowercase letter and end with a lowercase letter or digit. The name can contain lowercase letters, digits, underscores (_), and hyphens (-). The name must be unique within the instance. For more information about invalid characters, see Forbidden keywords table.
- Character
Set string Character set. The value range is limited to the following:
- MySQL: [ utf8, gbk, latin1, utf8mb4 ] (
utf8mb4only supports versions 5.5 and 5.6). - SQLServer: [ Chinese_PRC_CI_AS, Chinese_PRC_CS_AS, SQL_Latin1_General_CP1_CI_AS, SQL_Latin1_General_CP1_CS_AS, Chinese_PRC_BIN ]
- PostgreSQL: Valid values for PostgreSQL databases: a value in the
character set,<Collate>,<Ctype>format. Example:UTF8,C,en_US.utf8.
- Valid values for the character set : [ KOI8U, UTF8, WIN866, WIN874, WIN1250, WIN1251, WIN1252, WIN1253, WIN1254, WIN1255, WIN1256, WIN1257, WIN1258, EUC_CN, EUC_KR, EUC_TW, EUC_JP, EUC_JIS_2004, KOI8R, MULE_INTERNAL, LATIN1, LATIN2, LATIN3, LATIN4, LATIN5, LATIN6, LATIN7, LATIN8, LATIN9, LATIN10, ISO_8859_5, ISO_8859_6, ISO_8859_7, ISO_8859_8, SQL_ASCII ]
- Valid values for the Collate field: You can execute the
SELECT DISTINCT collname FROM pg_collation;statement to obtain the field value. The default value isC. - Valid values for the Ctype field: You can execute the
SELECT DISTINCT collctype FROM pg_collation;statement to obtain the field value. The default value isen_US.utf8.
- MariaDB: [ utf8, gbk, latin1, utf8mb4 ]
More details refer to API Docs
- MySQL: [ utf8, gbk, latin1, utf8mb4 ] (
- Description 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.
NOTE: The value of "name" or "character_set" does not support modification.
- Instance
Id string - The Id of instance that can run database.
- Name string
The name of the database.
NOTE: The name must be 2 to 64 characters in length. The name must start with a lowercase letter and end with a lowercase letter or digit. The name can contain lowercase letters, digits, underscores (_), and hyphens (-). The name must be unique within the instance. For more information about invalid characters, see Forbidden keywords table.
- character
Set String Character set. The value range is limited to the following:
- MySQL: [ utf8, gbk, latin1, utf8mb4 ] (
utf8mb4only supports versions 5.5 and 5.6). - SQLServer: [ Chinese_PRC_CI_AS, Chinese_PRC_CS_AS, SQL_Latin1_General_CP1_CI_AS, SQL_Latin1_General_CP1_CS_AS, Chinese_PRC_BIN ]
- PostgreSQL: Valid values for PostgreSQL databases: a value in the
character set,<Collate>,<Ctype>format. Example:UTF8,C,en_US.utf8.
- Valid values for the character set : [ KOI8U, UTF8, WIN866, WIN874, WIN1250, WIN1251, WIN1252, WIN1253, WIN1254, WIN1255, WIN1256, WIN1257, WIN1258, EUC_CN, EUC_KR, EUC_TW, EUC_JP, EUC_JIS_2004, KOI8R, MULE_INTERNAL, LATIN1, LATIN2, LATIN3, LATIN4, LATIN5, LATIN6, LATIN7, LATIN8, LATIN9, LATIN10, ISO_8859_5, ISO_8859_6, ISO_8859_7, ISO_8859_8, SQL_ASCII ]
- Valid values for the Collate field: You can execute the
SELECT DISTINCT collname FROM pg_collation;statement to obtain the field value. The default value isC. - Valid values for the Ctype field: You can execute the
SELECT DISTINCT collctype FROM pg_collation;statement to obtain the field value. The default value isen_US.utf8.
- MariaDB: [ utf8, gbk, latin1, utf8mb4 ]
More details refer to API Docs
- MySQL: [ utf8, gbk, latin1, utf8mb4 ] (
- description 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.
NOTE: The value of "name" or "character_set" does not support modification.
- instance
Id String - The Id of instance that can run database.
- name String
The name of the database.
NOTE: The name must be 2 to 64 characters in length. The name must start with a lowercase letter and end with a lowercase letter or digit. The name can contain lowercase letters, digits, underscores (_), and hyphens (-). The name must be unique within the instance. For more information about invalid characters, see Forbidden keywords table.
- character
Set string Character set. The value range is limited to the following:
- MySQL: [ utf8, gbk, latin1, utf8mb4 ] (
utf8mb4only supports versions 5.5 and 5.6). - SQLServer: [ Chinese_PRC_CI_AS, Chinese_PRC_CS_AS, SQL_Latin1_General_CP1_CI_AS, SQL_Latin1_General_CP1_CS_AS, Chinese_PRC_BIN ]
- PostgreSQL: Valid values for PostgreSQL databases: a value in the
character set,<Collate>,<Ctype>format. Example:UTF8,C,en_US.utf8.
- Valid values for the character set : [ KOI8U, UTF8, WIN866, WIN874, WIN1250, WIN1251, WIN1252, WIN1253, WIN1254, WIN1255, WIN1256, WIN1257, WIN1258, EUC_CN, EUC_KR, EUC_TW, EUC_JP, EUC_JIS_2004, KOI8R, MULE_INTERNAL, LATIN1, LATIN2, LATIN3, LATIN4, LATIN5, LATIN6, LATIN7, LATIN8, LATIN9, LATIN10, ISO_8859_5, ISO_8859_6, ISO_8859_7, ISO_8859_8, SQL_ASCII ]
- Valid values for the Collate field: You can execute the
SELECT DISTINCT collname FROM pg_collation;statement to obtain the field value. The default value isC. - Valid values for the Ctype field: You can execute the
SELECT DISTINCT collctype FROM pg_collation;statement to obtain the field value. The default value isen_US.utf8.
- MariaDB: [ utf8, gbk, latin1, utf8mb4 ]
More details refer to API Docs
- MySQL: [ utf8, gbk, latin1, utf8mb4 ] (
- description 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.
NOTE: The value of "name" or "character_set" does not support modification.
- instance
Id string - The Id of instance that can run database.
- name string
The name of the database.
NOTE: The name must be 2 to 64 characters in length. The name must start with a lowercase letter and end with a lowercase letter or digit. The name can contain lowercase letters, digits, underscores (_), and hyphens (-). The name must be unique within the instance. For more information about invalid characters, see Forbidden keywords table.
- character_
set str Character set. The value range is limited to the following:
- MySQL: [ utf8, gbk, latin1, utf8mb4 ] (
utf8mb4only supports versions 5.5 and 5.6). - SQLServer: [ Chinese_PRC_CI_AS, Chinese_PRC_CS_AS, SQL_Latin1_General_CP1_CI_AS, SQL_Latin1_General_CP1_CS_AS, Chinese_PRC_BIN ]
- PostgreSQL: Valid values for PostgreSQL databases: a value in the
character set,<Collate>,<Ctype>format. Example:UTF8,C,en_US.utf8.
- Valid values for the character set : [ KOI8U, UTF8, WIN866, WIN874, WIN1250, WIN1251, WIN1252, WIN1253, WIN1254, WIN1255, WIN1256, WIN1257, WIN1258, EUC_CN, EUC_KR, EUC_TW, EUC_JP, EUC_JIS_2004, KOI8R, MULE_INTERNAL, LATIN1, LATIN2, LATIN3, LATIN4, LATIN5, LATIN6, LATIN7, LATIN8, LATIN9, LATIN10, ISO_8859_5, ISO_8859_6, ISO_8859_7, ISO_8859_8, SQL_ASCII ]
- Valid values for the Collate field: You can execute the
SELECT DISTINCT collname FROM pg_collation;statement to obtain the field value. The default value isC. - Valid values for the Ctype field: You can execute the
SELECT DISTINCT collctype FROM pg_collation;statement to obtain the field value. The default value isen_US.utf8.
- MariaDB: [ utf8, gbk, latin1, utf8mb4 ]
More details refer to API Docs
- MySQL: [ utf8, gbk, latin1, utf8mb4 ] (
- 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.
NOTE: The value of "name" or "character_set" does not support modification.
- instance_
id str - The Id of instance that can run database.
- name str
The name of the database.
NOTE: The name must be 2 to 64 characters in length. The name must start with a lowercase letter and end with a lowercase letter or digit. The name can contain lowercase letters, digits, underscores (_), and hyphens (-). The name must be unique within the instance. For more information about invalid characters, see Forbidden keywords table.
- character
Set String Character set. The value range is limited to the following:
- MySQL: [ utf8, gbk, latin1, utf8mb4 ] (
utf8mb4only supports versions 5.5 and 5.6). - SQLServer: [ Chinese_PRC_CI_AS, Chinese_PRC_CS_AS, SQL_Latin1_General_CP1_CI_AS, SQL_Latin1_General_CP1_CS_AS, Chinese_PRC_BIN ]
- PostgreSQL: Valid values for PostgreSQL databases: a value in the
character set,<Collate>,<Ctype>format. Example:UTF8,C,en_US.utf8.
- Valid values for the character set : [ KOI8U, UTF8, WIN866, WIN874, WIN1250, WIN1251, WIN1252, WIN1253, WIN1254, WIN1255, WIN1256, WIN1257, WIN1258, EUC_CN, EUC_KR, EUC_TW, EUC_JP, EUC_JIS_2004, KOI8R, MULE_INTERNAL, LATIN1, LATIN2, LATIN3, LATIN4, LATIN5, LATIN6, LATIN7, LATIN8, LATIN9, LATIN10, ISO_8859_5, ISO_8859_6, ISO_8859_7, ISO_8859_8, SQL_ASCII ]
- Valid values for the Collate field: You can execute the
SELECT DISTINCT collname FROM pg_collation;statement to obtain the field value. The default value isC. - Valid values for the Ctype field: You can execute the
SELECT DISTINCT collctype FROM pg_collation;statement to obtain the field value. The default value isen_US.utf8.
- MariaDB: [ utf8, gbk, latin1, utf8mb4 ]
More details refer to API Docs
- MySQL: [ utf8, gbk, latin1, utf8mb4 ] (
- description 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.
NOTE: The value of "name" or "character_set" does not support modification.
- instance
Id String - The Id of instance that can run database.
- name String
The name of the database.
NOTE: The name must be 2 to 64 characters in length. The name must start with a lowercase letter and end with a lowercase letter or digit. The name can contain lowercase letters, digits, underscores (_), and hyphens (-). The name must be unique within the instance. For more information about invalid characters, see Forbidden keywords table.
Import
RDS database can be imported using the id, e.g.
$ pulumi import alicloud:rds/database:Database example "rm-12345:tf_database"
To learn more about importing existing cloud resources, see Importing resources.
Package Details
- Repository
- Alibaba Cloud pulumi/pulumi-alicloud
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
alicloudTerraform Provider.