1. Packages
  2. Packages
  3. Volcenginecc Provider
  4. API Docs
  5. rdsmysql
  6. getBackup
Viewing docs for volcenginecc v0.0.33
published on Thursday, May 7, 2026 by Volcengine
Schema (JSON)
volcengine/pulumi-volcenginecc

volcenginecc.rdsmysql.getBackup

volcenginecc logo
Viewing docs for volcenginecc v0.0.33
published on Thursday, May 7, 2026 by Volcengine
Schema (JSON)
volcengine/pulumi-volcenginecc

    Data Source schema for Volcengine::RDSMySQL::Backup

    Using getBackup

    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 getBackup(args: GetBackupArgs, opts?: InvokeOptions): Promise<GetBackupResult>
function getBackupOutput(args: GetBackupOutputArgs, opts?: InvokeOptions): Output<GetBackupResult>
    def get_backup(id: Optional[str] = None,
               opts: Optional[InvokeOptions] = None) -> GetBackupResult
def get_backup_output(id: pulumi.Input[Optional[str]] = None,
               opts: Optional[InvokeOptions] = None) -> Output[GetBackupResult]
    func LookupBackup(ctx *Context, args *LookupBackupArgs, opts ...InvokeOption) (*LookupBackupResult, error)
func LookupBackupOutput(ctx *Context, args *LookupBackupOutputArgs, opts ...InvokeOption) LookupBackupResultOutput

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

    public static class GetBackup 
{
    public static Task<GetBackupResult> InvokeAsync(GetBackupArgs args, InvokeOptions? opts = null)
    public static Output<GetBackupResult> Invoke(GetBackupInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetBackupResult> getBackup(GetBackupArgs args, InvokeOptions options)
public static Output<GetBackupResult> getBackup(GetBackupArgs args, InvokeOptions options)

    fn::invoke:
  function: volcenginecc:rdsmysql/getBackup:getBackup
  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.

    getBackup Result

    The following output properties are available:

    BackupEndTime string
    Backup creation end time (UTC)
    BackupFileName string
    Backup file name
    BackupFileSize int
    Backup file size (bytes)
    BackupId string
    Backup ID
    BackupMetas List<Volcengine.GetBackupBackupMeta>
    When creating a logical backup of database tables, this is used to specify the database and table information to be backed up
    BackupMethod string
    Backup type. Values: Physical (physical backup), Logical (logical backup), Snapshot (snapshot backup)
    BackupName string
    Backup name
    BackupRegion string
    Backup region
    BackupStartTime string
    Backup creation start time (UTC)
    BackupStatus string
    Backup status. Values: Success, Failed, Running
    BackupType string
    Backup method. Values: Full (full/database table backup), Increment (incremental backup), DumpAll (full database backup)
    ConsistentTime string
    Consistency time point
    CreateType string
    Backup creator. Values: System (system), User (user)
    DbEngineVersion string
    Compatible version. Values: MySQL57: MySQL 5.7 version; MySQL80: MySQL 8.0 version
    DbTableInfos List<Volcengine.GetBackupDbTableInfo>
    Database and table information list
    DownloadStatus string
    Download status
    EngineType string
    Database engine type. Values: InnoDB: InnoDB engine; RocksDB: RocksDB engine
    ErrorMessage string
    Error message for backup failure
    ExpiredTime string
    Backup expiration time (UTC)
    Id string
    Uniquely identifies the resource.
    InstanceId string
    Instance ID
    IsEncrypted bool
    Whether encrypted
    IsExpired bool
    Whether expired
    BackupEndTime string
    Backup creation end time (UTC)
    BackupFileName string
    Backup file name
    BackupFileSize int
    Backup file size (bytes)
    BackupId string
    Backup ID
    BackupMetas []GetBackupBackupMeta
    When creating a logical backup of database tables, this is used to specify the database and table information to be backed up
    BackupMethod string
    Backup type. Values: Physical (physical backup), Logical (logical backup), Snapshot (snapshot backup)
    BackupName string
    Backup name
    BackupRegion string
    Backup region
    BackupStartTime string
    Backup creation start time (UTC)
    BackupStatus string
    Backup status. Values: Success, Failed, Running
    BackupType string
    Backup method. Values: Full (full/database table backup), Increment (incremental backup), DumpAll (full database backup)
    ConsistentTime string
    Consistency time point
    CreateType string
    Backup creator. Values: System (system), User (user)
    DbEngineVersion string
    Compatible version. Values: MySQL57: MySQL 5.7 version; MySQL80: MySQL 8.0 version
    DbTableInfos []GetBackupDbTableInfo
    Database and table information list
    DownloadStatus string
    Download status
    EngineType string
    Database engine type. Values: InnoDB: InnoDB engine; RocksDB: RocksDB engine
    ErrorMessage string
    Error message for backup failure
    ExpiredTime string
    Backup expiration time (UTC)
    Id string
    Uniquely identifies the resource.
    InstanceId string
    Instance ID
    IsEncrypted bool
    Whether encrypted
    IsExpired bool
    Whether expired
    backupEndTime String
    Backup creation end time (UTC)
    backupFileName String
    Backup file name
    backupFileSize Integer
    Backup file size (bytes)
    backupId String
    Backup ID
    backupMetas List<GetBackupBackupMeta>
    When creating a logical backup of database tables, this is used to specify the database and table information to be backed up
    backupMethod String
    Backup type. Values: Physical (physical backup), Logical (logical backup), Snapshot (snapshot backup)
    backupName String
    Backup name
    backupRegion String
    Backup region
    backupStartTime String
    Backup creation start time (UTC)
    backupStatus String
    Backup status. Values: Success, Failed, Running
    backupType String
    Backup method. Values: Full (full/database table backup), Increment (incremental backup), DumpAll (full database backup)
    consistentTime String
    Consistency time point
    createType String
    Backup creator. Values: System (system), User (user)
    dbEngineVersion String
    Compatible version. Values: MySQL57: MySQL 5.7 version; MySQL80: MySQL 8.0 version
    dbTableInfos List<GetBackupDbTableInfo>
    Database and table information list
    downloadStatus String
    Download status
    engineType String
    Database engine type. Values: InnoDB: InnoDB engine; RocksDB: RocksDB engine
    errorMessage String
    Error message for backup failure
    expiredTime String
    Backup expiration time (UTC)
    id String
    Uniquely identifies the resource.
    instanceId String
    Instance ID
    isEncrypted Boolean
    Whether encrypted
    isExpired Boolean
    Whether expired
    backupEndTime string
    Backup creation end time (UTC)
    backupFileName string
    Backup file name
    backupFileSize number
    Backup file size (bytes)
    backupId string
    Backup ID
    backupMetas GetBackupBackupMeta[]
    When creating a logical backup of database tables, this is used to specify the database and table information to be backed up
    backupMethod string
    Backup type. Values: Physical (physical backup), Logical (logical backup), Snapshot (snapshot backup)
    backupName string
    Backup name
    backupRegion string
    Backup region
    backupStartTime string
    Backup creation start time (UTC)
    backupStatus string
    Backup status. Values: Success, Failed, Running
    backupType string
    Backup method. Values: Full (full/database table backup), Increment (incremental backup), DumpAll (full database backup)
    consistentTime string
    Consistency time point
    createType string
    Backup creator. Values: System (system), User (user)
    dbEngineVersion string
    Compatible version. Values: MySQL57: MySQL 5.7 version; MySQL80: MySQL 8.0 version
    dbTableInfos GetBackupDbTableInfo[]
    Database and table information list
    downloadStatus string
    Download status
    engineType string
    Database engine type. Values: InnoDB: InnoDB engine; RocksDB: RocksDB engine
    errorMessage string
    Error message for backup failure
    expiredTime string
    Backup expiration time (UTC)
    id string
    Uniquely identifies the resource.
    instanceId string
    Instance ID
    isEncrypted boolean
    Whether encrypted
    isExpired boolean
    Whether expired
    backup_end_time str
    Backup creation end time (UTC)
    backup_file_name str
    Backup file name
    backup_file_size int
    Backup file size (bytes)
    backup_id str
    Backup ID
    backup_metas Sequence[GetBackupBackupMeta]
    When creating a logical backup of database tables, this is used to specify the database and table information to be backed up
    backup_method str
    Backup type. Values: Physical (physical backup), Logical (logical backup), Snapshot (snapshot backup)
    backup_name str
    Backup name
    backup_region str
    Backup region
    backup_start_time str
    Backup creation start time (UTC)
    backup_status str
    Backup status. Values: Success, Failed, Running
    backup_type str
    Backup method. Values: Full (full/database table backup), Increment (incremental backup), DumpAll (full database backup)
    consistent_time str
    Consistency time point
    create_type str
    Backup creator. Values: System (system), User (user)
    db_engine_version str
    Compatible version. Values: MySQL57: MySQL 5.7 version; MySQL80: MySQL 8.0 version
    db_table_infos Sequence[GetBackupDbTableInfo]
    Database and table information list
    download_status str
    Download status
    engine_type str
    Database engine type. Values: InnoDB: InnoDB engine; RocksDB: RocksDB engine
    error_message str
    Error message for backup failure
    expired_time str
    Backup expiration time (UTC)
    id str
    Uniquely identifies the resource.
    instance_id str
    Instance ID
    is_encrypted bool
    Whether encrypted
    is_expired bool
    Whether expired
    backupEndTime String
    Backup creation end time (UTC)
    backupFileName String
    Backup file name
    backupFileSize Number
    Backup file size (bytes)
    backupId String
    Backup ID
    backupMetas List<Property Map>
    When creating a logical backup of database tables, this is used to specify the database and table information to be backed up
    backupMethod String
    Backup type. Values: Physical (physical backup), Logical (logical backup), Snapshot (snapshot backup)
    backupName String
    Backup name
    backupRegion String
    Backup region
    backupStartTime String
    Backup creation start time (UTC)
    backupStatus String
    Backup status. Values: Success, Failed, Running
    backupType String
    Backup method. Values: Full (full/database table backup), Increment (incremental backup), DumpAll (full database backup)
    consistentTime String
    Consistency time point
    createType String
    Backup creator. Values: System (system), User (user)
    dbEngineVersion String
    Compatible version. Values: MySQL57: MySQL 5.7 version; MySQL80: MySQL 8.0 version
    dbTableInfos List<Property Map>
    Database and table information list
    downloadStatus String
    Download status
    engineType String
    Database engine type. Values: InnoDB: InnoDB engine; RocksDB: RocksDB engine
    errorMessage String
    Error message for backup failure
    expiredTime String
    Backup expiration time (UTC)
    id String
    Uniquely identifies the resource.
    instanceId String
    Instance ID
    isEncrypted Boolean
    Whether encrypted
    isExpired Boolean
    Whether expired

    Supporting Types

    GetBackupBackupMeta

    Database string
    Database name
    Tables List<string>
    Table name list
    Database string
    Database name
    Tables []string
    Table name list
    database String
    Database name
    tables List<String>
    Table name list
    database string
    Database name
    tables string[]
    Table name list
    database str
    Database name
    tables Sequence[str]
    Table name list
    database String
    Database name
    tables List<String>
    Table name list

    GetBackupDbTableInfo

    Database string
    Database name
    Tables List<string>
    Table name list
    Database string
    Database name
    Tables []string
    Table name list
    database String
    Database name
    tables List<String>
    Table name list
    database string
    Database name
    tables string[]
    Table name list
    database str
    Database name
    tables Sequence[str]
    Table name list
    database String
    Database name
    tables List<String>
    Table name list

    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.33
    published on Thursday, May 7, 2026 by Volcengine
    Schema (JSON)
    volcengine/pulumi-volcenginecc
      Try Pulumi Cloud free. Your team will thank you.