Sign in Dashboard Get started
  1. Packages
  2. Packages
  3. Bytepluscc Provider
  4. API Docs
  5. rdspostgresql
  6. Backup
Viewing docs for bytepluscc v0.0.28
published on Thursday, May 21, 2026 by Byteplus
Schema (JSON)
byteplus-sdk/pulumi-bytepluscc

bytepluscc.rdspostgresql.Backup

bytepluscc logo
Viewing docs for bytepluscc v0.0.28
published on Thursday, May 21, 2026 by Byteplus
Schema (JSON)
byteplus-sdk/pulumi-bytepluscc

    RDS PostgreSQL backup resources support both physical and logical backups. Physical backups can be created and queried; logical backups can be created, deleted, downloaded, and queried.

    Example Usage

    Example coming soon!

    Example coming soon!

    Example coming soon!

    Example coming soon!

    Example coming soon!

    resources:
  rDSPostgreSQLBackupDemo:
    type: bytepluscc:rdspostgresql:Backup
    name: RDSPostgreSQLBackupDemo
    properties:
      backupMethod: Logical
      backupScope: Database
      instanceId: postgres-09xxxxxxxxx
      backupMetas:
        - db_name: test_db
      backupDescription: 逻辑增量库级备份并下载测试
      backupPolicy:
        data_incr_backup_periods: Wednesday
        full_backup_period: Tuesday,Thursday,Saturday
        hourly_incr_backup_enable: true
        full_backup_time: 01:00Z-02:00Z
        increment_backup_frequency: 2
        backup_retention_period: 14
        wal_log_space_limit_enable: true

    Example coming soon!

    Create Backup Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new Backup(name: string, args: BackupArgs, opts?: CustomResourceOptions);
    @overload
def Backup(resource_name: str,
           args: BackupArgs,
           opts: Optional[ResourceOptions] = None)

@overload
def Backup(resource_name: str,
           opts: Optional[ResourceOptions] = None,
           instance_id: Optional[str] = None,
           backup_description: Optional[str] = None,
           backup_metas: Optional[Sequence[BackupBackupMetaArgs]] = None,
           backup_method: Optional[str] = None,
           backup_policy: Optional[BackupBackupPolicyArgs] = None,
           backup_scope: Optional[str] = None,
           backup_type: Optional[str] = None,
           download_backup: Optional[bool] = None)
    func NewBackup(ctx *Context, name string, args BackupArgs, opts ...ResourceOption) (*Backup, error)
    public Backup(string name, BackupArgs args, CustomResourceOptions? opts = null)
    public Backup(String name, BackupArgs args)
public Backup(String name, BackupArgs args, CustomResourceOptions options)

    type: bytepluscc:rdspostgresql:Backup
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.


    resource "bytepluscc_rdspostgresql_backup" "name" {
    # resource properties
}

    Parameters

    name string
    The unique name of the resource.
    args BackupArgs
    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 BackupArgs
    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 BackupArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args BackupArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args BackupArgs
    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 byteplusccBackupResource = new Bytepluscc.Rdspostgresql.Backup("byteplusccBackupResource", new()
{
    InstanceId = "string",
    BackupDescription = "string",
    BackupMetas = new[]
    {
        new Bytepluscc.Rdspostgresql.Inputs.BackupBackupMetaArgs
        {
            DbName = "string",
        },
    },
    BackupMethod = "string",
    BackupPolicy = new Bytepluscc.Rdspostgresql.Inputs.BackupBackupPolicyArgs
    {
        BackupRetentionPeriod = 0,
        DataIncrBackupPeriods = "string",
        FullBackupPeriod = "string",
        FullBackupTime = "string",
        HourlyIncrBackupEnable = false,
        IncrementBackupFrequency = 0,
        WalLogSpaceLimitEnable = false,
    },
    BackupScope = "string",
    BackupType = "string",
    DownloadBackup = false,
});

    example, err := rdspostgresql.NewBackup(ctx, "byteplusccBackupResource", &rdspostgresql.BackupArgs{
	InstanceId:        pulumi.String("string"),
	BackupDescription: pulumi.String("string"),
	BackupMetas: rdspostgresql.BackupBackupMetaArray{
		&rdspostgresql.BackupBackupMetaArgs{
			DbName: pulumi.String("string"),
		},
	},
	BackupMethod: pulumi.String("string"),
	BackupPolicy: &rdspostgresql.BackupBackupPolicyArgs{
		BackupRetentionPeriod:    pulumi.Int(0),
		DataIncrBackupPeriods:    pulumi.String("string"),
		FullBackupPeriod:         pulumi.String("string"),
		FullBackupTime:           pulumi.String("string"),
		HourlyIncrBackupEnable:   pulumi.Bool(false),
		IncrementBackupFrequency: pulumi.Int(0),
		WalLogSpaceLimitEnable:   pulumi.Bool(false),
	},
	BackupScope:    pulumi.String("string"),
	BackupType:     pulumi.String("string"),
	DownloadBackup: pulumi.Bool(false),
})

    resource "bytepluscc_rdspostgresql_backup" "byteplusccBackupResource" {
  instance_id        = "string"
  backup_description = "string"
  backup_metas {
    db_name = "string"
  }
  backup_method = "string"
  backup_policy = {
    backup_retention_period    = 0
    data_incr_backup_periods   = "string"
    full_backup_period         = "string"
    full_backup_time           = "string"
    hourly_incr_backup_enable  = false
    increment_backup_frequency = 0
    wal_log_space_limit_enable = false
  }
  backup_scope    = "string"
  backup_type     = "string"
  download_backup = false
}

    var byteplusccBackupResource = new com.byteplus.bytepluscc.rdspostgresql.Backup("byteplusccBackupResource", com.byteplus.bytepluscc.rdspostgresql.BackupArgs.builder()
    .instanceId("string")
    .backupDescription("string")
    .backupMetas(BackupBackupMetaArgs.builder()
        .dbName("string")
        .build())
    .backupMethod("string")
    .backupPolicy(BackupBackupPolicyArgs.builder()
        .backupRetentionPeriod(0)
        .dataIncrBackupPeriods("string")
        .fullBackupPeriod("string")
        .fullBackupTime("string")
        .hourlyIncrBackupEnable(false)
        .incrementBackupFrequency(0)
        .walLogSpaceLimitEnable(false)
        .build())
    .backupScope("string")
    .backupType("string")
    .downloadBackup(false)
    .build());

    bytepluscc_backup_resource = bytepluscc.rdspostgresql.Backup("byteplusccBackupResource",
    instance_id="string",
    backup_description="string",
    backup_metas=[{
        "db_name": "string",
    }],
    backup_method="string",
    backup_policy={
        "backup_retention_period": 0,
        "data_incr_backup_periods": "string",
        "full_backup_period": "string",
        "full_backup_time": "string",
        "hourly_incr_backup_enable": False,
        "increment_backup_frequency": 0,
        "wal_log_space_limit_enable": False,
    },
    backup_scope="string",
    backup_type="string",
    download_backup=False)

    const byteplusccBackupResource = new bytepluscc.rdspostgresql.Backup("byteplusccBackupResource", {
    instanceId: "string",
    backupDescription: "string",
    backupMetas: [{
        dbName: "string",
    }],
    backupMethod: "string",
    backupPolicy: {
        backupRetentionPeriod: 0,
        dataIncrBackupPeriods: "string",
        fullBackupPeriod: "string",
        fullBackupTime: "string",
        hourlyIncrBackupEnable: false,
        incrementBackupFrequency: 0,
        walLogSpaceLimitEnable: false,
    },
    backupScope: "string",
    backupType: "string",
    downloadBackup: false,
});

    type: bytepluscc:rdspostgresql:Backup
properties:
    backupDescription: string
    backupMetas:
        - dbName: string
    backupMethod: string
    backupPolicy:
        backupRetentionPeriod: 0
        dataIncrBackupPeriods: string
        fullBackupPeriod: string
        fullBackupTime: string
        hourlyIncrBackupEnable: false
        incrementBackupFrequency: 0
        walLogSpaceLimitEnable: false
    backupScope: string
    backupType: string
    downloadBackup: false
    instanceId: string

    Backup 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 Backup resource accepts the following input properties:

    InstanceId string
    RDS PostgreSQL instance ID.
    BackupDescription string
    Backup description.
    BackupMetas List<Byteplus.BackupBackupMeta>
    BackupMethod string
    Backup method: Physical for physical backup, Logical for logical backup.
    BackupPolicy Byteplus.BackupBackupPolicy
    Backup policy configuration information.
    BackupScope string
    Backup scope: Instance for instance-level backup, Database for database-level backup.
    BackupType string
    Backup type: Full for full backup, Increment for incremental backup.
    DownloadBackup bool
    Download logical backup file after creation. Only valid for logical backups.
    InstanceId string
    RDS PostgreSQL instance ID.
    BackupDescription string
    Backup description.
    BackupMetas []BackupBackupMetaArgs
    BackupMethod string
    Backup method: Physical for physical backup, Logical for logical backup.
    BackupPolicy BackupBackupPolicyArgs
    Backup policy configuration information.
    BackupScope string
    Backup scope: Instance for instance-level backup, Database for database-level backup.
    BackupType string
    Backup type: Full for full backup, Increment for incremental backup.
    DownloadBackup bool
    Download logical backup file after creation. Only valid for logical backups.
    instance_id string
    RDS PostgreSQL instance ID.
    backup_description string
    Backup description.
    backup_metas list(object)
    backup_method string
    Backup method: Physical for physical backup, Logical for logical backup.
    backup_policy object
    Backup policy configuration information.
    backup_scope string
    Backup scope: Instance for instance-level backup, Database for database-level backup.
    backup_type string
    Backup type: Full for full backup, Increment for incremental backup.
    download_backup bool
    Download logical backup file after creation. Only valid for logical backups.
    instanceId String
    RDS PostgreSQL instance ID.
    backupDescription String
    Backup description.
    backupMetas List<BackupBackupMeta>
    backupMethod String
    Backup method: Physical for physical backup, Logical for logical backup.
    backupPolicy BackupBackupPolicy
    Backup policy configuration information.
    backupScope String
    Backup scope: Instance for instance-level backup, Database for database-level backup.
    backupType String
    Backup type: Full for full backup, Increment for incremental backup.
    downloadBackup Boolean
    Download logical backup file after creation. Only valid for logical backups.
    instanceId string
    RDS PostgreSQL instance ID.
    backupDescription string
    Backup description.
    backupMetas BackupBackupMeta[]
    backupMethod string
    Backup method: Physical for physical backup, Logical for logical backup.
    backupPolicy BackupBackupPolicy
    Backup policy configuration information.
    backupScope string
    Backup scope: Instance for instance-level backup, Database for database-level backup.
    backupType string
    Backup type: Full for full backup, Increment for incremental backup.
    downloadBackup boolean
    Download logical backup file after creation. Only valid for logical backups.
    instance_id str
    RDS PostgreSQL instance ID.
    backup_description str
    Backup description.
    backup_metas Sequence[BackupBackupMetaArgs]
    backup_method str
    Backup method: Physical for physical backup, Logical for logical backup.
    backup_policy BackupBackupPolicyArgs
    Backup policy configuration information.
    backup_scope str
    Backup scope: Instance for instance-level backup, Database for database-level backup.
    backup_type str
    Backup type: Full for full backup, Increment for incremental backup.
    download_backup bool
    Download logical backup file after creation. Only valid for logical backups.
    instanceId String
    RDS PostgreSQL instance ID.
    backupDescription String
    Backup description.
    backupMetas List<Property Map>
    backupMethod String
    Backup method: Physical for physical backup, Logical for logical backup.
    backupPolicy Property Map
    Backup policy configuration information.
    backupScope String
    Backup scope: Instance for instance-level backup, Database for database-level backup.
    backupType String
    Backup type: Full for full backup, Increment for incremental backup.
    downloadBackup Boolean
    Download logical backup file after creation. Only valid for logical backups.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the Backup resource produces the following output properties:

    BackupDataSize int
    Backup data size (bytes).
    BackupEndTime string
    Backup end time.
    BackupFileName string
    Backup file name.
    BackupFileSize int
    Backup file size (bytes).
    BackupId string
    Backup ID.
    BackupProgress int
    Backup progress percentage.
    BackupStartTime string
    Backup start time.
    BackupStatus string
    Backup status, such as Success, Running, Failed.
    CreateType string
    Creation method: Manual for manual creation, Automated for automatic creation.
    DownloadProgress int
    Download preparation progress percentage.
    DownloadStatus string
    Download status.
    Id string
    The provider-assigned unique ID for this managed resource.
    BackupDataSize int
    Backup data size (bytes).
    BackupEndTime string
    Backup end time.
    BackupFileName string
    Backup file name.
    BackupFileSize int
    Backup file size (bytes).
    BackupId string
    Backup ID.
    BackupProgress int
    Backup progress percentage.
    BackupStartTime string
    Backup start time.
    BackupStatus string
    Backup status, such as Success, Running, Failed.
    CreateType string
    Creation method: Manual for manual creation, Automated for automatic creation.
    DownloadProgress int
    Download preparation progress percentage.
    DownloadStatus string
    Download status.
    Id string
    The provider-assigned unique ID for this managed resource.
    backup_data_size number
    Backup data size (bytes).
    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_progress number
    Backup progress percentage.
    backup_start_time string
    Backup start time.
    backup_status string
    Backup status, such as Success, Running, Failed.
    create_type string
    Creation method: Manual for manual creation, Automated for automatic creation.
    download_progress number
    Download preparation progress percentage.
    download_status string
    Download status.
    id string
    The provider-assigned unique ID for this managed resource.
    backupDataSize Integer
    Backup data size (bytes).
    backupEndTime String
    Backup end time.
    backupFileName String
    Backup file name.
    backupFileSize Integer
    Backup file size (bytes).
    backupId String
    Backup ID.
    backupProgress Integer
    Backup progress percentage.
    backupStartTime String
    Backup start time.
    backupStatus String
    Backup status, such as Success, Running, Failed.
    createType String
    Creation method: Manual for manual creation, Automated for automatic creation.
    downloadProgress Integer
    Download preparation progress percentage.
    downloadStatus String
    Download status.
    id String
    The provider-assigned unique ID for this managed resource.
    backupDataSize number
    Backup data size (bytes).
    backupEndTime string
    Backup end time.
    backupFileName string
    Backup file name.
    backupFileSize number
    Backup file size (bytes).
    backupId string
    Backup ID.
    backupProgress number
    Backup progress percentage.
    backupStartTime string
    Backup start time.
    backupStatus string
    Backup status, such as Success, Running, Failed.
    createType string
    Creation method: Manual for manual creation, Automated for automatic creation.
    downloadProgress number
    Download preparation progress percentage.
    downloadStatus string
    Download status.
    id string
    The provider-assigned unique ID for this managed resource.
    backup_data_size int
    Backup data size (bytes).
    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_progress int
    Backup progress percentage.
    backup_start_time str
    Backup start time.
    backup_status str
    Backup status, such as Success, Running, Failed.
    create_type str
    Creation method: Manual for manual creation, Automated for automatic creation.
    download_progress int
    Download preparation progress percentage.
    download_status str
    Download status.
    id str
    The provider-assigned unique ID for this managed resource.
    backupDataSize Number
    Backup data size (bytes).
    backupEndTime String
    Backup end time.
    backupFileName String
    Backup file name.
    backupFileSize Number
    Backup file size (bytes).
    backupId String
    Backup ID.
    backupProgress Number
    Backup progress percentage.
    backupStartTime String
    Backup start time.
    backupStatus String
    Backup status, such as Success, Running, Failed.
    createType String
    Creation method: Manual for manual creation, Automated for automatic creation.
    downloadProgress Number
    Download preparation progress percentage.
    downloadStatus String
    Download status.
    id String
    The provider-assigned unique ID for this managed resource.

    Look up Existing Backup Resource

    Get an existing Backup 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?: BackupState, opts?: CustomResourceOptions): Backup
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        backup_data_size: Optional[int] = None,
        backup_description: Optional[str] = None,
        backup_end_time: Optional[str] = None,
        backup_file_name: Optional[str] = None,
        backup_file_size: Optional[int] = None,
        backup_id: Optional[str] = None,
        backup_metas: Optional[Sequence[BackupBackupMetaArgs]] = None,
        backup_method: Optional[str] = None,
        backup_policy: Optional[BackupBackupPolicyArgs] = None,
        backup_progress: Optional[int] = None,
        backup_scope: Optional[str] = None,
        backup_start_time: Optional[str] = None,
        backup_status: Optional[str] = None,
        backup_type: Optional[str] = None,
        create_type: Optional[str] = None,
        download_backup: Optional[bool] = None,
        download_progress: Optional[int] = None,
        download_status: Optional[str] = None,
        instance_id: Optional[str] = None) -> Backup
    func GetBackup(ctx *Context, name string, id IDInput, state *BackupState, opts ...ResourceOption) (*Backup, error)
    public static Backup Get(string name, Input<string> id, BackupState? state, CustomResourceOptions? opts = null)
    public static Backup get(String name, Output<String> id, BackupState state, CustomResourceOptions options)
    resources:  _:    type: bytepluscc:rdspostgresql:Backup    get:      id: ${id}
    import {
  to = bytepluscc_rdspostgresql_backup.example
  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:
    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<Byteplus.BackupBackupMeta>
    BackupMethod string
    Backup method: Physical for physical backup, Logical for logical backup.
    BackupPolicy Byteplus.BackupBackupPolicy
    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.
    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 []BackupBackupMetaArgs
    BackupMethod string
    Backup method: Physical for physical backup, Logical for logical backup.
    BackupPolicy BackupBackupPolicyArgs
    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.
    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_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.
    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<BackupBackupMeta>
    backupMethod String
    Backup method: Physical for physical backup, Logical for logical backup.
    backupPolicy BackupBackupPolicy
    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.
    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 BackupBackupMeta[]
    backupMethod string
    Backup method: Physical for physical backup, Logical for logical backup.
    backupPolicy BackupBackupPolicy
    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.
    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[BackupBackupMetaArgs]
    backup_method str
    Backup method: Physical for physical backup, Logical for logical backup.
    backup_policy BackupBackupPolicyArgs
    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.
    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>
    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.
    instanceId String
    RDS PostgreSQL instance ID.

    Supporting Types

    BackupBackupMeta, BackupBackupMetaArgs

    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.

    BackupBackupPolicy, BackupBackupPolicyArgs

    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.

    Import

    $ pulumi import bytepluscc:rdspostgresql/backup:Backup example "backup_id|instance_id"

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

    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.28
    published on Thursday, May 21, 2026 by Byteplus
    Schema (JSON)
    byteplus-sdk/pulumi-bytepluscc

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial