Sign in Dashboard Get started
  1. Packages
  2. Packages
  3. Volcenginecc Provider
  4. API Docs
  5. rdspostgresql
  6. getBackup
Viewing docs for volcenginecc v0.0.37
published on Friday, May 22, 2026 by Volcengine
Schema (JSON)
volcengine/pulumi-volcenginecc

volcenginecc.rdspostgresql.getBackup

volcenginecc logo
Viewing docs for volcenginecc v0.0.37
published on Friday, May 22, 2026 by Volcengine
Schema (JSON)
volcengine/pulumi-volcenginecc

    Data Source schema for Volcengine::RDSPostgreSQL::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:rdspostgresql/getBackup:getBackup
  arguments:
    # arguments dictionary
    data "volcenginecc_rdspostgresql_getbackup" "name" {
    # arguments
}

    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 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:

    BackupDataSize int
    Backup data size (bytes).
    BackupDescription string
    Backup description.
    BackupEndTime string
    Backup end time.
    BackupFileName string
    Backup file name.
    BackupFileSize int
    Backup file size (bytes).
    BackupId string
    Backup ID.
    BackupMetas List<Volcengine.GetBackupBackupMeta>
    Backup metadata, used to specify the database list for logical backups.
    BackupMethod string
    Backup method: Physical for physical backup, Logical for logical backup.
    BackupPolicy Volcengine.GetBackupBackupPolicy
    Backup policy configuration information.
    BackupProgress int
    Backup progress percentage.
    BackupScope string
    Backup scope: Instance for instance-level backup, Database for database-level backup.
    BackupStartTime string
    Backup start time.
    BackupStatus string
    Backup status, such as Success, Running, Failed.
    BackupType string
    Backup type: Full for full backup, Increment for incremental backup.
    CreateType string
    Creation method: Manual for manual creation, Automated for automatic creation.
    DownloadBackup bool
    Download logical backup file after creation. Only valid for logical backups.
    DownloadProgress int
    Download preparation progress percentage.
    DownloadStatus string
    Download status.
    Id string
    Uniquely identifies the resource.
    InstanceId string
    RDS PostgreSQL instance ID.
    BackupDataSize int
    Backup data size (bytes).
    BackupDescription string
    Backup description.
    BackupEndTime string
    Backup end time.
    BackupFileName string
    Backup file name.
    BackupFileSize int
    Backup file size (bytes).
    BackupId string
    Backup ID.
    BackupMetas []GetBackupBackupMeta
    Backup metadata, used to specify the database list for logical backups.
    BackupMethod string
    Backup method: Physical for physical backup, Logical for logical backup.
    BackupPolicy GetBackupBackupPolicy
    Backup policy configuration information.
    BackupProgress int
    Backup progress percentage.
    BackupScope string
    Backup scope: Instance for instance-level backup, Database for database-level backup.
    BackupStartTime string
    Backup start time.
    BackupStatus string
    Backup status, such as Success, Running, Failed.
    BackupType string
    Backup type: Full for full backup, Increment for incremental backup.
    CreateType string
    Creation method: Manual for manual creation, Automated for automatic creation.
    DownloadBackup bool
    Download logical backup file after creation. Only valid for logical backups.
    DownloadProgress int
    Download preparation progress percentage.
    DownloadStatus string
    Download status.
    Id string
    Uniquely identifies the resource.
    InstanceId string
    RDS PostgreSQL instance ID.
    backup_data_size number
    Backup data size (bytes).
    backup_description string
    Backup description.
    backup_end_time string
    Backup end time.
    backup_file_name string
    Backup file name.
    backup_file_size number
    Backup file size (bytes).
    backup_id string
    Backup ID.
    backup_metas list(object)
    Backup metadata, used to specify the database list for logical backups.
    backup_method string
    Backup method: Physical for physical backup, Logical for logical backup.
    backup_policy object
    Backup policy configuration information.
    backup_progress number
    Backup progress percentage.
    backup_scope string
    Backup scope: Instance for instance-level backup, Database for database-level backup.
    backup_start_time string
    Backup start time.
    backup_status string
    Backup status, such as Success, Running, Failed.
    backup_type string
    Backup type: Full for full backup, Increment for incremental backup.
    create_type string
    Creation method: Manual for manual creation, Automated for automatic creation.
    download_backup bool
    Download logical backup file after creation. Only valid for logical backups.
    download_progress number
    Download preparation progress percentage.
    download_status string
    Download status.
    id string
    Uniquely identifies the resource.
    instance_id string
    RDS PostgreSQL instance ID.
    backupDataSize Integer
    Backup data size (bytes).
    backupDescription String
    Backup description.
    backupEndTime String
    Backup end time.
    backupFileName String
    Backup file name.
    backupFileSize Integer
    Backup file size (bytes).
    backupId String
    Backup ID.
    backupMetas List<GetBackupBackupMeta>
    Backup metadata, used to specify the database list for logical backups.
    backupMethod String
    Backup method: Physical for physical backup, Logical for logical backup.
    backupPolicy GetBackupBackupPolicy
    Backup policy configuration information.
    backupProgress Integer
    Backup progress percentage.
    backupScope String
    Backup scope: Instance for instance-level backup, Database for database-level backup.
    backupStartTime String
    Backup start time.
    backupStatus String
    Backup status, such as Success, Running, Failed.
    backupType String
    Backup type: Full for full backup, Increment for incremental backup.
    createType String
    Creation method: Manual for manual creation, Automated for automatic creation.
    downloadBackup Boolean
    Download logical backup file after creation. Only valid for logical backups.
    downloadProgress Integer
    Download preparation progress percentage.
    downloadStatus String
    Download status.
    id String
    Uniquely identifies the resource.
    instanceId String
    RDS PostgreSQL instance ID.
    backupDataSize number
    Backup data size (bytes).
    backupDescription string
    Backup description.
    backupEndTime string
    Backup end time.
    backupFileName string
    Backup file name.
    backupFileSize number
    Backup file size (bytes).
    backupId string
    Backup ID.
    backupMetas GetBackupBackupMeta[]
    Backup metadata, used to specify the database list for logical backups.
    backupMethod string
    Backup method: Physical for physical backup, Logical for logical backup.
    backupPolicy GetBackupBackupPolicy
    Backup policy configuration information.
    backupProgress number
    Backup progress percentage.
    backupScope string
    Backup scope: Instance for instance-level backup, Database for database-level backup.
    backupStartTime string
    Backup start time.
    backupStatus string
    Backup status, such as Success, Running, Failed.
    backupType string
    Backup type: Full for full backup, Increment for incremental backup.
    createType string
    Creation method: Manual for manual creation, Automated for automatic creation.
    downloadBackup boolean
    Download logical backup file after creation. Only valid for logical backups.
    downloadProgress number
    Download preparation progress percentage.
    downloadStatus string
    Download status.
    id string
    Uniquely identifies the resource.
    instanceId string
    RDS PostgreSQL instance ID.
    backup_data_size int
    Backup data size (bytes).
    backup_description str
    Backup description.
    backup_end_time str
    Backup end time.
    backup_file_name str
    Backup file name.
    backup_file_size int
    Backup file size (bytes).
    backup_id str
    Backup ID.
    backup_metas Sequence[GetBackupBackupMeta]
    Backup metadata, used to specify the database list for logical backups.
    backup_method str
    Backup method: Physical for physical backup, Logical for logical backup.
    backup_policy GetBackupBackupPolicy
    Backup policy configuration information.
    backup_progress int
    Backup progress percentage.
    backup_scope str
    Backup scope: Instance for instance-level backup, Database for database-level backup.
    backup_start_time str
    Backup start time.
    backup_status str
    Backup status, such as Success, Running, Failed.
    backup_type str
    Backup type: Full for full backup, Increment for incremental backup.
    create_type str
    Creation method: Manual for manual creation, Automated for automatic creation.
    download_backup bool
    Download logical backup file after creation. Only valid for logical backups.
    download_progress int
    Download preparation progress percentage.
    download_status str
    Download status.
    id str
    Uniquely identifies the resource.
    instance_id str
    RDS PostgreSQL instance ID.
    backupDataSize Number
    Backup data size (bytes).
    backupDescription String
    Backup description.
    backupEndTime String
    Backup end time.
    backupFileName String
    Backup file name.
    backupFileSize Number
    Backup file size (bytes).
    backupId String
    Backup ID.
    backupMetas List<Property Map>
    Backup metadata, used to specify the database list for logical backups.
    backupMethod String
    Backup method: Physical for physical backup, Logical for logical backup.
    backupPolicy Property Map
    Backup policy configuration information.
    backupProgress Number
    Backup progress percentage.
    backupScope String
    Backup scope: Instance for instance-level backup, Database for database-level backup.
    backupStartTime String
    Backup start time.
    backupStatus String
    Backup status, such as Success, Running, Failed.
    backupType String
    Backup type: Full for full backup, Increment for incremental backup.
    createType String
    Creation method: Manual for manual creation, Automated for automatic creation.
    downloadBackup Boolean
    Download logical backup file after creation. Only valid for logical backups.
    downloadProgress Number
    Download preparation progress percentage.
    downloadStatus String
    Download status.
    id String
    Uniquely identifies the resource.
    instanceId String
    RDS PostgreSQL instance ID.

    Supporting Types

    GetBackupBackupMeta

    DbName string
    Database name.
    DbName string
    Database name.
    db_name string
    Database name.
    dbName String
    Database name.
    dbName string
    Database name.
    db_name str
    Database name.
    dbName String
    Database name.

    GetBackupBackupPolicy

    BackupRetentionPeriod int
    Backup retention days.
    DataIncrBackupPeriods string
    Data incremental backup schedule.
    FullBackupPeriod string
    Full backup schedule, such as Monday,Tuesday.
    FullBackupTime string
    Full backup time window, such as 00:00Z-01:00Z.
    HourlyIncrBackupEnable bool
    Enable hourly incremental backup.
    IncrementBackupFrequency int
    Incremental backup frequency (hours).
    WalLogSpaceLimitEnable bool
    Enable WAL log space limit.
    BackupRetentionPeriod int
    Backup retention days.
    DataIncrBackupPeriods string
    Data incremental backup schedule.
    FullBackupPeriod string
    Full backup schedule, such as Monday,Tuesday.
    FullBackupTime string
    Full backup time window, such as 00:00Z-01:00Z.
    HourlyIncrBackupEnable bool
    Enable hourly incremental backup.
    IncrementBackupFrequency int
    Incremental backup frequency (hours).
    WalLogSpaceLimitEnable bool
    Enable WAL log space limit.
    backup_retention_period number
    Backup retention days.
    data_incr_backup_periods string
    Data incremental backup schedule.
    full_backup_period string
    Full backup schedule, such as Monday,Tuesday.
    full_backup_time string
    Full backup time window, such as 00:00Z-01:00Z.
    hourly_incr_backup_enable bool
    Enable hourly incremental backup.
    increment_backup_frequency number
    Incremental backup frequency (hours).
    wal_log_space_limit_enable bool
    Enable WAL log space limit.
    backupRetentionPeriod Integer
    Backup retention days.
    dataIncrBackupPeriods String
    Data incremental backup schedule.
    fullBackupPeriod String
    Full backup schedule, such as Monday,Tuesday.
    fullBackupTime String
    Full backup time window, such as 00:00Z-01:00Z.
    hourlyIncrBackupEnable Boolean
    Enable hourly incremental backup.
    incrementBackupFrequency Integer
    Incremental backup frequency (hours).
    walLogSpaceLimitEnable Boolean
    Enable WAL log space limit.
    backupRetentionPeriod number
    Backup retention days.
    dataIncrBackupPeriods string
    Data incremental backup schedule.
    fullBackupPeriod string
    Full backup schedule, such as Monday,Tuesday.
    fullBackupTime string
    Full backup time window, such as 00:00Z-01:00Z.
    hourlyIncrBackupEnable boolean
    Enable hourly incremental backup.
    incrementBackupFrequency number
    Incremental backup frequency (hours).
    walLogSpaceLimitEnable boolean
    Enable WAL log space limit.
    backup_retention_period int
    Backup retention days.
    data_incr_backup_periods str
    Data incremental backup schedule.
    full_backup_period str
    Full backup schedule, such as Monday,Tuesday.
    full_backup_time str
    Full backup time window, such as 00:00Z-01:00Z.
    hourly_incr_backup_enable bool
    Enable hourly incremental backup.
    increment_backup_frequency int
    Incremental backup frequency (hours).
    wal_log_space_limit_enable bool
    Enable WAL log space limit.
    backupRetentionPeriod Number
    Backup retention days.
    dataIncrBackupPeriods String
    Data incremental backup schedule.
    fullBackupPeriod String
    Full backup schedule, such as Monday,Tuesday.
    fullBackupTime String
    Full backup time window, such as 00:00Z-01:00Z.
    hourlyIncrBackupEnable Boolean
    Enable hourly incremental backup.
    incrementBackupFrequency Number
    Incremental backup frequency (hours).
    walLogSpaceLimitEnable Boolean
    Enable WAL log space limit.

    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.37
    published on Friday, May 22, 2026 by Volcengine
    Schema (JSON)
    volcengine/pulumi-volcenginecc

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial