1. Packages
  2. Bytepluscc Provider
  3. API Docs
  4. vedbm
  5. getDatabase
Viewing docs for bytepluscc v0.0.21
published on Thursday, Apr 2, 2026 by Byteplus
bytepluscc logo
Viewing docs for bytepluscc v0.0.21
published on Thursday, Apr 2, 2026 by Byteplus

    Data Source schema for Byteplus::VEDBM::Database

    Using getDatabase

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getDatabase(args: GetDatabaseArgs, opts?: InvokeOptions): Promise<GetDatabaseResult>
    function getDatabaseOutput(args: GetDatabaseOutputArgs, opts?: InvokeOptions): Output<GetDatabaseResult>
    def get_database(id: Optional[str] = None,
                     opts: Optional[InvokeOptions] = None) -> GetDatabaseResult
    def get_database_output(id: Optional[pulumi.Input[str]] = None,
                     opts: Optional[InvokeOptions] = None) -> Output[GetDatabaseResult]
    func LookupDatabase(ctx *Context, args *LookupDatabaseArgs, opts ...InvokeOption) (*LookupDatabaseResult, error)
    func LookupDatabaseOutput(ctx *Context, args *LookupDatabaseOutputArgs, opts ...InvokeOption) LookupDatabaseResultOutput

    > Note: This function is named LookupDatabase in the Go SDK.

    public static class GetDatabase 
    {
        public static Task<GetDatabaseResult> InvokeAsync(GetDatabaseArgs args, InvokeOptions? opts = null)
        public static Output<GetDatabaseResult> Invoke(GetDatabaseInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetDatabaseResult> getDatabase(GetDatabaseArgs args, InvokeOptions options)
    public static Output<GetDatabaseResult> getDatabase(GetDatabaseArgs args, InvokeOptions options)
    
    fn::invoke:
      function: bytepluscc:vedbm/getDatabase:getDatabase
      arguments:
        # arguments dictionary

    The following arguments are supported:

    Id string
    Uniquely identifies the resource.
    Id string
    Uniquely identifies the resource.
    id String
    Uniquely identifies the resource.
    id string
    Uniquely identifies the resource.
    id str
    Uniquely identifies the resource.
    id String
    Uniquely identifies the resource.

    getDatabase Result

    The following output properties are available:

    CharacterSetName string
    Database character set. Options: utf8mb4 (default), utf8, latin1, ascii
    DatabasesPrivileges List<Byteplus.GetDatabaseDatabasesPrivilege>
    Database permission information
    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
    Id string
    Uniquely identifies the resource.
    InstanceId string
    Instance ID
    CharacterSetName string
    Database character set. Options: utf8mb4 (default), utf8, latin1, ascii
    DatabasesPrivileges []GetDatabaseDatabasesPrivilege
    Database permission information
    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
    Id string
    Uniquely identifies the resource.
    InstanceId string
    Instance ID
    characterSetName String
    Database character set. Options: utf8mb4 (default), utf8, latin1, ascii
    databasesPrivileges List<GetDatabaseDatabasesPrivilege>
    Database permission information
    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
    id String
    Uniquely identifies the resource.
    instanceId String
    Instance ID
    characterSetName string
    Database character set. Options: utf8mb4 (default), utf8, latin1, ascii
    databasesPrivileges GetDatabaseDatabasesPrivilege[]
    Database permission information
    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
    id string
    Uniquely identifies the resource.
    instanceId string
    Instance ID
    character_set_name str
    Database character set. Options: utf8mb4 (default), utf8, latin1, ascii
    databases_privileges Sequence[GetDatabaseDatabasesPrivilege]
    Database permission information
    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
    id str
    Uniquely identifies the resource.
    instance_id str
    Instance ID
    characterSetName String
    Database character set. Options: utf8mb4 (default), utf8, latin1, ascii
    databasesPrivileges List<Property Map>
    Database permission information
    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
    id String
    Uniquely identifies the resource.
    instanceId String
    Instance ID

    Supporting Types

    GetDatabaseDatabasesPrivilege

    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

    Package Details

    Repository
    bytepluscc byteplus-sdk/pulumi-bytepluscc
    License
    MPL-2.0
    Notes
    This Pulumi package is based on the bytepluscc Terraform Provider.
    bytepluscc logo
    Viewing docs for bytepluscc v0.0.21
    published on Thursday, Apr 2, 2026 by Byteplus
      Try Pulumi Cloud free. Your team will thank you.