1. Packages
  2. Volcenginecc Provider
  3. API Docs
  4. vedbm
  5. Database
Viewing docs for volcenginecc v0.0.29
published on Thursday, Apr 2, 2026 by Volcengine
Schema (JSON)
volcengine/pulumi-volcenginecc

volcenginecc.vedbm.Database

volcenginecc logo
Viewing docs for volcenginecc v0.0.29
published on Thursday, Apr 2, 2026 by Volcengine
Schema (JSON)
volcengine/pulumi-volcenginecc

    Cloud Database Management

    Example Usage

    Example coming soon!

    Example coming soon!

    Example coming soon!

    Example coming soon!

    Example coming soon!

    resources:
  vEDBMDatabaseDemo:
    type: volcenginecc:vedbm:Database
    name: VEDBMDatabaseDemo
    properties:
      dbName: testdb-tf
      instanceId: vedbm-ls2ehotj2***
      characterSetName: utf8mb4
      dbDesc: desctest
      databasesPrivileges:
        - account_name: test
          account_privilege: Custom
          account_privilege_detail:
            - SELECT
            - UPDATE
            - INSERT

    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_name: Optional[str] = None,
             databases_privileges: Optional[Sequence[DatabaseDatabasesPrivilegeArgs]] = None,
             db_desc: Optional[str] = None,
             db_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: volcenginecc:vedbm: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 exampledatabaseResourceResourceFromVedbmdatabase = new Volcenginecc.Vedbm.Database("exampledatabaseResourceResourceFromVedbmdatabase", new()
{
    InstanceId = "string",
    CharacterSetName = "string",
    DatabasesPrivileges = new[]
    {
        new Volcenginecc.Vedbm.Inputs.DatabaseDatabasesPrivilegeArgs
        {
            AccountName = "string",
            AccountPrivilege = "string",
            AccountPrivilegeDetails = new[]
            {
                "string",
            },
        },
    },
    DbDesc = "string",
    DbName = "string",
});

    example, err := vedbm.NewDatabase(ctx, "exampledatabaseResourceResourceFromVedbmdatabase", &vedbm.DatabaseArgs{
	InstanceId:       pulumi.String("string"),
	CharacterSetName: pulumi.String("string"),
	DatabasesPrivileges: vedbm.DatabaseDatabasesPrivilegeArray{
		&vedbm.DatabaseDatabasesPrivilegeArgs{
			AccountName:      pulumi.String("string"),
			AccountPrivilege: pulumi.String("string"),
			AccountPrivilegeDetails: pulumi.StringArray{
				pulumi.String("string"),
			},
		},
	},
	DbDesc: pulumi.String("string"),
	DbName: pulumi.String("string"),
})

    var exampledatabaseResourceResourceFromVedbmdatabase = new com.volcengine.volcenginecc.vedbm.Database("exampledatabaseResourceResourceFromVedbmdatabase", com.volcengine.volcenginecc.vedbm.DatabaseArgs.builder()
    .instanceId("string")
    .characterSetName("string")
    .databasesPrivileges(DatabaseDatabasesPrivilegeArgs.builder()
        .accountName("string")
        .accountPrivilege("string")
        .accountPrivilegeDetails("string")
        .build())
    .dbDesc("string")
    .dbName("string")
    .build());

    exampledatabase_resource_resource_from_vedbmdatabase = volcenginecc.vedbm.Database("exampledatabaseResourceResourceFromVedbmdatabase",
    instance_id="string",
    character_set_name="string",
    databases_privileges=[{
        "account_name": "string",
        "account_privilege": "string",
        "account_privilege_details": ["string"],
    }],
    db_desc="string",
    db_name="string")

    const exampledatabaseResourceResourceFromVedbmdatabase = new volcenginecc.vedbm.Database("exampledatabaseResourceResourceFromVedbmdatabase", {
    instanceId: "string",
    characterSetName: "string",
    databasesPrivileges: [{
        accountName: "string",
        accountPrivilege: "string",
        accountPrivilegeDetails: ["string"],
    }],
    dbDesc: "string",
    dbName: "string",
});

    type: volcenginecc:vedbm:Database
properties:
    characterSetName: string
    databasesPrivileges:
        - accountName: string
          accountPrivilege: string
          accountPrivilegeDetails:
            - string
    dbDesc: string
    dbName: string
    instanceId: 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:

    InstanceId string
    Instance ID
    CharacterSetName string
    Database character set. Options: utf8mb4 (default), utf8, latin1, ascii
    DatabasesPrivileges List<Volcengine.DatabaseDatabasesPrivilege>
    DbDesc string
    Database description, length 0–256 characters; can include numbers, Chinese and English characters, underscores (_), and hyphens (-)
    DbName string
    Database name. Naming rules: Must be unique within the current instance; length 2–64 characters; starts with a letter, ends with a letter or number; can contain letters, numbers, underscores (_), and hyphens (-); reserved words are not allowed
    InstanceId string
    Instance ID
    CharacterSetName string
    Database character set. Options: utf8mb4 (default), utf8, latin1, ascii
    DatabasesPrivileges []DatabaseDatabasesPrivilegeArgs
    DbDesc string
    Database description, length 0–256 characters; can include numbers, Chinese and English characters, underscores (_), and hyphens (-)
    DbName string
    Database name. Naming rules: Must be unique within the current instance; length 2–64 characters; starts with a letter, ends with a letter or number; can contain letters, numbers, underscores (_), and hyphens (-); reserved words are not allowed
    instanceId String
    Instance ID
    characterSetName String
    Database character set. Options: utf8mb4 (default), utf8, latin1, ascii
    databasesPrivileges List<DatabaseDatabasesPrivilege>
    dbDesc String
    Database description, length 0–256 characters; can include numbers, Chinese and English characters, underscores (_), and hyphens (-)
    dbName String
    Database name. Naming rules: Must be unique within the current instance; length 2–64 characters; starts with a letter, ends with a letter or number; can contain letters, numbers, underscores (_), and hyphens (-); reserved words are not allowed
    instanceId string
    Instance ID
    characterSetName string
    Database character set. Options: utf8mb4 (default), utf8, latin1, ascii
    databasesPrivileges DatabaseDatabasesPrivilege[]
    dbDesc string
    Database description, length 0–256 characters; can include numbers, Chinese and English characters, underscores (_), and hyphens (-)
    dbName string
    Database name. Naming rules: Must be unique within the current instance; length 2–64 characters; starts with a letter, ends with a letter or number; can contain letters, numbers, underscores (_), and hyphens (-); reserved words are not allowed
    instance_id str
    Instance ID
    character_set_name str
    Database character set. Options: utf8mb4 (default), utf8, latin1, ascii
    databases_privileges Sequence[DatabaseDatabasesPrivilegeArgs]
    db_desc str
    Database description, length 0–256 characters; can include numbers, Chinese and English characters, underscores (_), and hyphens (-)
    db_name str
    Database name. Naming rules: Must be unique within the current instance; length 2–64 characters; starts with a letter, ends with a letter or number; can contain letters, numbers, underscores (_), and hyphens (-); reserved words are not allowed
    instanceId String
    Instance ID
    characterSetName String
    Database character set. Options: utf8mb4 (default), utf8, latin1, ascii
    databasesPrivileges List<Property Map>
    dbDesc String
    Database description, length 0–256 characters; can include numbers, Chinese and English characters, underscores (_), and hyphens (-)
    dbName String
    Database name. Naming rules: Must be unique within the current instance; length 2–64 characters; starts with a letter, ends with a letter or number; can contain letters, numbers, underscores (_), and hyphens (-); reserved words are not allowed

    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_name: Optional[str] = None,
        databases_privileges: Optional[Sequence[DatabaseDatabasesPrivilegeArgs]] = None,
        db_desc: Optional[str] = None,
        db_name: Optional[str] = None,
        instance_id: 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)
    public static Database get(String name, Output<String> id, DatabaseState state, CustomResourceOptions options)
    resources:  _:    type: volcenginecc:vedbm:Database    get:      id: ${id}
    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:
    CharacterSetName string
    Database character set. Options: utf8mb4 (default), utf8, latin1, ascii
    DatabasesPrivileges List<Volcengine.DatabaseDatabasesPrivilege>
    DbDesc string
    Database description, length 0–256 characters; can include numbers, Chinese and English characters, underscores (_), and hyphens (-)
    DbName string
    Database name. Naming rules: Must be unique within the current instance; length 2–64 characters; starts with a letter, ends with a letter or number; can contain letters, numbers, underscores (_), and hyphens (-); reserved words are not allowed
    InstanceId string
    Instance ID
    CharacterSetName string
    Database character set. Options: utf8mb4 (default), utf8, latin1, ascii
    DatabasesPrivileges []DatabaseDatabasesPrivilegeArgs
    DbDesc string
    Database description, length 0–256 characters; can include numbers, Chinese and English characters, underscores (_), and hyphens (-)
    DbName string
    Database name. Naming rules: Must be unique within the current instance; length 2–64 characters; starts with a letter, ends with a letter or number; can contain letters, numbers, underscores (_), and hyphens (-); reserved words are not allowed
    InstanceId string
    Instance ID
    characterSetName String
    Database character set. Options: utf8mb4 (default), utf8, latin1, ascii
    databasesPrivileges List<DatabaseDatabasesPrivilege>
    dbDesc String
    Database description, length 0–256 characters; can include numbers, Chinese and English characters, underscores (_), and hyphens (-)
    dbName String
    Database name. Naming rules: Must be unique within the current instance; length 2–64 characters; starts with a letter, ends with a letter or number; can contain letters, numbers, underscores (_), and hyphens (-); reserved words are not allowed
    instanceId String
    Instance ID
    characterSetName string
    Database character set. Options: utf8mb4 (default), utf8, latin1, ascii
    databasesPrivileges DatabaseDatabasesPrivilege[]
    dbDesc string
    Database description, length 0–256 characters; can include numbers, Chinese and English characters, underscores (_), and hyphens (-)
    dbName string
    Database name. Naming rules: Must be unique within the current instance; length 2–64 characters; starts with a letter, ends with a letter or number; can contain letters, numbers, underscores (_), and hyphens (-); reserved words are not allowed
    instanceId string
    Instance ID
    character_set_name str
    Database character set. Options: utf8mb4 (default), utf8, latin1, ascii
    databases_privileges Sequence[DatabaseDatabasesPrivilegeArgs]
    db_desc str
    Database description, length 0–256 characters; can include numbers, Chinese and English characters, underscores (_), and hyphens (-)
    db_name str
    Database name. Naming rules: Must be unique within the current instance; length 2–64 characters; starts with a letter, ends with a letter or number; can contain letters, numbers, underscores (_), and hyphens (-); reserved words are not allowed
    instance_id str
    Instance ID
    characterSetName String
    Database character set. Options: utf8mb4 (default), utf8, latin1, ascii
    databasesPrivileges List<Property Map>
    dbDesc String
    Database description, length 0–256 characters; can include numbers, Chinese and English characters, underscores (_), and hyphens (-)
    dbName String
    Database name. Naming rules: Must be unique within the current instance; length 2–64 characters; starts with a letter, ends with a letter or number; can contain letters, numbers, underscores (_), and hyphens (-); reserved words are not allowed
    instanceId String
    Instance ID

    Supporting Types

    DatabaseDatabasesPrivilege, DatabaseDatabasesPrivilegeArgs

    AccountName string
    Account name to be authorized
    AccountPrivilege string
    Database permission type: ReadWrite/ReadOnly/DDLOnly/DMLOnly/Custom
    AccountPrivilegeDetails List<string>
    Specific SQL operation permissions, separated by English commas; required for Custom type
    AccountName string
    Account name to be authorized
    AccountPrivilege string
    Database permission type: ReadWrite/ReadOnly/DDLOnly/DMLOnly/Custom
    AccountPrivilegeDetails []string
    Specific SQL operation permissions, separated by English commas; required for Custom type
    accountName String
    Account name to be authorized
    accountPrivilege String
    Database permission type: ReadWrite/ReadOnly/DDLOnly/DMLOnly/Custom
    accountPrivilegeDetails List<String>
    Specific SQL operation permissions, separated by English commas; required for Custom type
    accountName string
    Account name to be authorized
    accountPrivilege string
    Database permission type: ReadWrite/ReadOnly/DDLOnly/DMLOnly/Custom
    accountPrivilegeDetails string[]
    Specific SQL operation permissions, separated by English commas; required for Custom type
    account_name str
    Account name to be authorized
    account_privilege str
    Database permission type: ReadWrite/ReadOnly/DDLOnly/DMLOnly/Custom
    account_privilege_details Sequence[str]
    Specific SQL operation permissions, separated by English commas; required for Custom type
    accountName String
    Account name to be authorized
    accountPrivilege String
    Database permission type: ReadWrite/ReadOnly/DDLOnly/DMLOnly/Custom
    accountPrivilegeDetails List<String>
    Specific SQL operation permissions, separated by English commas; required for Custom type

    Import

    $ pulumi import volcenginecc:vedbm/database:Database example "instance_id|db_name"

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    volcenginecc volcengine/pulumi-volcenginecc
    License
    MPL-2.0
    Notes
    This Pulumi package is based on the volcenginecc Terraform Provider.
    volcenginecc logo
    Viewing docs for volcenginecc v0.0.29
    published on Thursday, Apr 2, 2026 by Volcengine
    Schema (JSON)
    volcengine/pulumi-volcenginecc
      Try Pulumi Cloud free. Your team will thank you.