1. Packages
  2. Volcenginecc Provider
  3. API Docs
  4. rdspostgresql
  5. getDatabase
Viewing docs for volcenginecc v0.0.29
published on Thursday, Apr 2, 2026 by Volcengine
volcenginecc logo
Viewing docs for volcenginecc v0.0.29
published on Thursday, Apr 2, 2026 by Volcengine

    Data Source schema for Volcengine::RDSPostgreSQL::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: volcenginecc:rdspostgresql/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:

    CType string
    Character classification. Supported values: C (default), C.UTF-8, enUS.utf8, zhCN.utf8, and POSIX
    CharacterSetName string
    Database character set. Supported character sets: utf8 (default), latin1, ascii
    Collate string
    Collation. Supported values: C (default), C.UTF-8, enUS.utf8, zhCN.utf8, and POSIX
    DbName string
    Database name. Naming rules: Length must be 2–63 characters. Can contain letters, numbers, underscores, or hyphens. Must start with a letter and end with a letter or number. Reserved keywords are not allowed. For a list of all disabled keywords, see Disabled Keywords.
    DbStatus string
    Database status: Unavailable: Not available. Available: Available.
    Id string
    Uniquely identifies the resource.
    InstanceId string
    Instance ID
    Owner string
    Database owner. Note: Read-only instance accounts, high-privilege accounts with DDL permissions disabled, or regular accounts with DDL permissions disabled cannot be set as the database owner. If no value is provided or the value is empty, this field defaults to rds superuser
    CType string
    Character classification. Supported values: C (default), C.UTF-8, enUS.utf8, zhCN.utf8, and POSIX
    CharacterSetName string
    Database character set. Supported character sets: utf8 (default), latin1, ascii
    Collate string
    Collation. Supported values: C (default), C.UTF-8, enUS.utf8, zhCN.utf8, and POSIX
    DbName string
    Database name. Naming rules: Length must be 2–63 characters. Can contain letters, numbers, underscores, or hyphens. Must start with a letter and end with a letter or number. Reserved keywords are not allowed. For a list of all disabled keywords, see Disabled Keywords.
    DbStatus string
    Database status: Unavailable: Not available. Available: Available.
    Id string
    Uniquely identifies the resource.
    InstanceId string
    Instance ID
    Owner string
    Database owner. Note: Read-only instance accounts, high-privilege accounts with DDL permissions disabled, or regular accounts with DDL permissions disabled cannot be set as the database owner. If no value is provided or the value is empty, this field defaults to rds superuser
    cType String
    Character classification. Supported values: C (default), C.UTF-8, enUS.utf8, zhCN.utf8, and POSIX
    characterSetName String
    Database character set. Supported character sets: utf8 (default), latin1, ascii
    collate String
    Collation. Supported values: C (default), C.UTF-8, enUS.utf8, zhCN.utf8, and POSIX
    dbName String
    Database name. Naming rules: Length must be 2–63 characters. Can contain letters, numbers, underscores, or hyphens. Must start with a letter and end with a letter or number. Reserved keywords are not allowed. For a list of all disabled keywords, see Disabled Keywords.
    dbStatus String
    Database status: Unavailable: Not available. Available: Available.
    id String
    Uniquely identifies the resource.
    instanceId String
    Instance ID
    owner String
    Database owner. Note: Read-only instance accounts, high-privilege accounts with DDL permissions disabled, or regular accounts with DDL permissions disabled cannot be set as the database owner. If no value is provided or the value is empty, this field defaults to rds superuser
    cType string
    Character classification. Supported values: C (default), C.UTF-8, enUS.utf8, zhCN.utf8, and POSIX
    characterSetName string
    Database character set. Supported character sets: utf8 (default), latin1, ascii
    collate string
    Collation. Supported values: C (default), C.UTF-8, enUS.utf8, zhCN.utf8, and POSIX
    dbName string
    Database name. Naming rules: Length must be 2–63 characters. Can contain letters, numbers, underscores, or hyphens. Must start with a letter and end with a letter or number. Reserved keywords are not allowed. For a list of all disabled keywords, see Disabled Keywords.
    dbStatus string
    Database status: Unavailable: Not available. Available: Available.
    id string
    Uniquely identifies the resource.
    instanceId string
    Instance ID
    owner string
    Database owner. Note: Read-only instance accounts, high-privilege accounts with DDL permissions disabled, or regular accounts with DDL permissions disabled cannot be set as the database owner. If no value is provided or the value is empty, this field defaults to rds superuser
    c_type str
    Character classification. Supported values: C (default), C.UTF-8, enUS.utf8, zhCN.utf8, and POSIX
    character_set_name str
    Database character set. Supported character sets: utf8 (default), latin1, ascii
    collate str
    Collation. Supported values: C (default), C.UTF-8, enUS.utf8, zhCN.utf8, and POSIX
    db_name str
    Database name. Naming rules: Length must be 2–63 characters. Can contain letters, numbers, underscores, or hyphens. Must start with a letter and end with a letter or number. Reserved keywords are not allowed. For a list of all disabled keywords, see Disabled Keywords.
    db_status str
    Database status: Unavailable: Not available. Available: Available.
    id str
    Uniquely identifies the resource.
    instance_id str
    Instance ID
    owner str
    Database owner. Note: Read-only instance accounts, high-privilege accounts with DDL permissions disabled, or regular accounts with DDL permissions disabled cannot be set as the database owner. If no value is provided or the value is empty, this field defaults to rds superuser
    cType String
    Character classification. Supported values: C (default), C.UTF-8, enUS.utf8, zhCN.utf8, and POSIX
    characterSetName String
    Database character set. Supported character sets: utf8 (default), latin1, ascii
    collate String
    Collation. Supported values: C (default), C.UTF-8, enUS.utf8, zhCN.utf8, and POSIX
    dbName String
    Database name. Naming rules: Length must be 2–63 characters. Can contain letters, numbers, underscores, or hyphens. Must start with a letter and end with a letter or number. Reserved keywords are not allowed. For a list of all disabled keywords, see Disabled Keywords.
    dbStatus String
    Database status: Unavailable: Not available. Available: Available.
    id String
    Uniquely identifies the resource.
    instanceId String
    Instance ID
    owner String
    Database owner. Note: Read-only instance accounts, high-privilege accounts with DDL permissions disabled, or regular accounts with DDL permissions disabled cannot be set as the database owner. If no value is provided or the value is empty, this field defaults to rds superuser

    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
      Try Pulumi Cloud free. Your team will thank you.