volcengine.rds_mysql.BackupPolicy
Explore with Pulumi AI
Provides a resource to manage rds mysql backup policy
Example Usage
import * as pulumi from "@pulumi/pulumi";
import * as volcengine from "@volcengine/pulumi";
const foo = new volcengine.rds_mysql.BackupPolicy("foo", {
binlogFileCountsEnable: true,
binlogSpaceLimitEnable: true,
dataFullBackupPeriods: [
"Monday",
"Sunday",
],
instanceId: "mysql-c8c3f45c4b07",
lockDdlTime: 80,
});
import pulumi
import pulumi_volcengine as volcengine
foo = volcengine.rds_mysql.BackupPolicy("foo",
binlog_file_counts_enable=True,
binlog_space_limit_enable=True,
data_full_backup_periods=[
"Monday",
"Sunday",
],
instance_id="mysql-c8c3f45c4b07",
lock_ddl_time=80)
package main
import (
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
"github.com/volcengine/pulumi-volcengine/sdk/go/volcengine/rds_mysql"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := rds_mysql.NewBackupPolicy(ctx, "foo", &rds_mysql.BackupPolicyArgs{
BinlogFileCountsEnable: pulumi.Bool(true),
BinlogSpaceLimitEnable: pulumi.Bool(true),
DataFullBackupPeriods: pulumi.StringArray{
pulumi.String("Monday"),
pulumi.String("Sunday"),
},
InstanceId: pulumi.String("mysql-c8c3f45c4b07"),
LockDdlTime: pulumi.Int(80),
})
if err != nil {
return err
}
return nil
})
}
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Volcengine = Pulumi.Volcengine;
return await Deployment.RunAsync(() =>
{
var foo = new Volcengine.Rds_mysql.BackupPolicy("foo", new()
{
BinlogFileCountsEnable = true,
BinlogSpaceLimitEnable = true,
DataFullBackupPeriods = new[]
{
"Monday",
"Sunday",
},
InstanceId = "mysql-c8c3f45c4b07",
LockDdlTime = 80,
});
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.volcengine.rds_mysql.BackupPolicy;
import com.pulumi.volcengine.rds_mysql.BackupPolicyArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
public static void main(String[] args) {
Pulumi.run(App::stack);
}
public static void stack(Context ctx) {
var foo = new BackupPolicy("foo", BackupPolicyArgs.builder()
.binlogFileCountsEnable(true)
.binlogSpaceLimitEnable(true)
.dataFullBackupPeriods(
"Monday",
"Sunday")
.instanceId("mysql-c8c3f45c4b07")
.lockDdlTime(80)
.build());
}
}
resources:
foo:
type: volcengine:rds_mysql:BackupPolicy
properties:
binlogFileCountsEnable: true
binlogSpaceLimitEnable: true
dataFullBackupPeriods:
- Monday
- Sunday
instanceId: mysql-c8c3f45c4b07
lockDdlTime: 80
Create BackupPolicy Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new BackupPolicy(name: string, args: BackupPolicyArgs, opts?: CustomResourceOptions);
@overload
def BackupPolicy(resource_name: str,
args: BackupPolicyArgs,
opts: Optional[ResourceOptions] = None)
@overload
def BackupPolicy(resource_name: str,
opts: Optional[ResourceOptions] = None,
instance_id: Optional[str] = None,
data_backup_retention_day: Optional[int] = None,
data_full_backup_start_utc_hour: Optional[int] = None,
binlog_file_counts_enable: Optional[bool] = None,
binlog_limit_count: Optional[int] = None,
binlog_local_retention_hour: Optional[int] = None,
binlog_space_limit_enable: Optional[bool] = None,
binlog_storage_percentage: Optional[int] = None,
data_backup_all_retention: Optional[bool] = None,
data_backup_encryption_enabled: Optional[bool] = None,
data_full_backup_time: Optional[str] = None,
binlog_backup_encryption_enabled: Optional[bool] = None,
data_full_backup_periods: Optional[Sequence[str]] = None,
binlog_backup_all_retention: Optional[bool] = None,
data_incr_backup_periods: Optional[Sequence[str]] = None,
data_keep_days_after_released: Optional[int] = None,
data_keep_policy_after_released: Optional[str] = None,
hourly_incr_backup_enable: Optional[bool] = None,
incr_backup_hour_period: Optional[int] = None,
binlog_backup_enabled: Optional[bool] = None,
lock_ddl_time: Optional[int] = None,
log_backup_retention_day: Optional[int] = None,
retention_policy_synced: Optional[bool] = None)
func NewBackupPolicy(ctx *Context, name string, args BackupPolicyArgs, opts ...ResourceOption) (*BackupPolicy, error)
public BackupPolicy(string name, BackupPolicyArgs args, CustomResourceOptions? opts = null)
public BackupPolicy(String name, BackupPolicyArgs args)
public BackupPolicy(String name, BackupPolicyArgs args, CustomResourceOptions options)
type: volcengine:rds_mysql:BackupPolicy
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
Parameters
- name string
- The unique name of the resource.
- args BackupPolicyArgs
- 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 BackupPolicyArgs
- 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 BackupPolicyArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args BackupPolicyArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args BackupPolicyArgs
- 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 backupPolicyResource = new Volcengine.Rds_mysql.BackupPolicy("backupPolicyResource", new()
{
InstanceId = "string",
DataBackupRetentionDay = 0,
DataFullBackupStartUtcHour = 0,
BinlogFileCountsEnable = false,
BinlogLimitCount = 0,
BinlogLocalRetentionHour = 0,
BinlogSpaceLimitEnable = false,
BinlogStoragePercentage = 0,
DataBackupAllRetention = false,
DataBackupEncryptionEnabled = false,
DataFullBackupTime = "string",
BinlogBackupEncryptionEnabled = false,
DataFullBackupPeriods = new[]
{
"string",
},
BinlogBackupAllRetention = false,
DataIncrBackupPeriods = new[]
{
"string",
},
DataKeepDaysAfterReleased = 0,
DataKeepPolicyAfterReleased = "string",
HourlyIncrBackupEnable = false,
IncrBackupHourPeriod = 0,
BinlogBackupEnabled = false,
LockDdlTime = 0,
LogBackupRetentionDay = 0,
RetentionPolicySynced = false,
});
example, err := rds_mysql.NewBackupPolicy(ctx, "backupPolicyResource", &rds_mysql.BackupPolicyArgs{
InstanceId: pulumi.String("string"),
DataBackupRetentionDay: pulumi.Int(0),
DataFullBackupStartUtcHour: pulumi.Int(0),
BinlogFileCountsEnable: pulumi.Bool(false),
BinlogLimitCount: pulumi.Int(0),
BinlogLocalRetentionHour: pulumi.Int(0),
BinlogSpaceLimitEnable: pulumi.Bool(false),
BinlogStoragePercentage: pulumi.Int(0),
DataBackupAllRetention: pulumi.Bool(false),
DataBackupEncryptionEnabled: pulumi.Bool(false),
DataFullBackupTime: pulumi.String("string"),
BinlogBackupEncryptionEnabled: pulumi.Bool(false),
DataFullBackupPeriods: pulumi.StringArray{
pulumi.String("string"),
},
BinlogBackupAllRetention: pulumi.Bool(false),
DataIncrBackupPeriods: pulumi.StringArray{
pulumi.String("string"),
},
DataKeepDaysAfterReleased: pulumi.Int(0),
DataKeepPolicyAfterReleased: pulumi.String("string"),
HourlyIncrBackupEnable: pulumi.Bool(false),
IncrBackupHourPeriod: pulumi.Int(0),
BinlogBackupEnabled: pulumi.Bool(false),
LockDdlTime: pulumi.Int(0),
LogBackupRetentionDay: pulumi.Int(0),
RetentionPolicySynced: pulumi.Bool(false),
})
var backupPolicyResource = new BackupPolicy("backupPolicyResource", BackupPolicyArgs.builder()
.instanceId("string")
.dataBackupRetentionDay(0)
.dataFullBackupStartUtcHour(0)
.binlogFileCountsEnable(false)
.binlogLimitCount(0)
.binlogLocalRetentionHour(0)
.binlogSpaceLimitEnable(false)
.binlogStoragePercentage(0)
.dataBackupAllRetention(false)
.dataBackupEncryptionEnabled(false)
.dataFullBackupTime("string")
.binlogBackupEncryptionEnabled(false)
.dataFullBackupPeriods("string")
.binlogBackupAllRetention(false)
.dataIncrBackupPeriods("string")
.dataKeepDaysAfterReleased(0)
.dataKeepPolicyAfterReleased("string")
.hourlyIncrBackupEnable(false)
.incrBackupHourPeriod(0)
.binlogBackupEnabled(false)
.lockDdlTime(0)
.logBackupRetentionDay(0)
.retentionPolicySynced(false)
.build());
backup_policy_resource = volcengine.rds_mysql.BackupPolicy("backupPolicyResource",
instance_id="string",
data_backup_retention_day=0,
data_full_backup_start_utc_hour=0,
binlog_file_counts_enable=False,
binlog_limit_count=0,
binlog_local_retention_hour=0,
binlog_space_limit_enable=False,
binlog_storage_percentage=0,
data_backup_all_retention=False,
data_backup_encryption_enabled=False,
data_full_backup_time="string",
binlog_backup_encryption_enabled=False,
data_full_backup_periods=["string"],
binlog_backup_all_retention=False,
data_incr_backup_periods=["string"],
data_keep_days_after_released=0,
data_keep_policy_after_released="string",
hourly_incr_backup_enable=False,
incr_backup_hour_period=0,
binlog_backup_enabled=False,
lock_ddl_time=0,
log_backup_retention_day=0,
retention_policy_synced=False)
const backupPolicyResource = new volcengine.rds_mysql.BackupPolicy("backupPolicyResource", {
instanceId: "string",
dataBackupRetentionDay: 0,
dataFullBackupStartUtcHour: 0,
binlogFileCountsEnable: false,
binlogLimitCount: 0,
binlogLocalRetentionHour: 0,
binlogSpaceLimitEnable: false,
binlogStoragePercentage: 0,
dataBackupAllRetention: false,
dataBackupEncryptionEnabled: false,
dataFullBackupTime: "string",
binlogBackupEncryptionEnabled: false,
dataFullBackupPeriods: ["string"],
binlogBackupAllRetention: false,
dataIncrBackupPeriods: ["string"],
dataKeepDaysAfterReleased: 0,
dataKeepPolicyAfterReleased: "string",
hourlyIncrBackupEnable: false,
incrBackupHourPeriod: 0,
binlogBackupEnabled: false,
lockDdlTime: 0,
logBackupRetentionDay: 0,
retentionPolicySynced: false,
});
type: volcengine:rds_mysql:BackupPolicy
properties:
binlogBackupAllRetention: false
binlogBackupEnabled: false
binlogBackupEncryptionEnabled: false
binlogFileCountsEnable: false
binlogLimitCount: 0
binlogLocalRetentionHour: 0
binlogSpaceLimitEnable: false
binlogStoragePercentage: 0
dataBackupAllRetention: false
dataBackupEncryptionEnabled: false
dataBackupRetentionDay: 0
dataFullBackupPeriods:
- string
dataFullBackupStartUtcHour: 0
dataFullBackupTime: string
dataIncrBackupPeriods:
- string
dataKeepDaysAfterReleased: 0
dataKeepPolicyAfterReleased: string
hourlyIncrBackupEnable: false
incrBackupHourPeriod: 0
instanceId: string
lockDdlTime: 0
logBackupRetentionDay: 0
retentionPolicySynced: false
BackupPolicy 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 BackupPolicy resource accepts the following input properties:
- Instance
Id string - The ID of the RDS instance.
- Binlog
Backup boolAll Retention - Whether to retain all log backups before releasing an instance. Values: true: Yes. false: No. Description: BinlogBackupAllRetention is ineffective when the value of RetentionPolicySynced is true.
- Binlog
Backup boolEnabled - Whether to enable log backup function. Values: true: Yes. false: No.
- Binlog
Backup boolEncryption Enabled - Is encryption enabled for log backups? Values: true: Yes. false: No.
- Binlog
File boolCounts Enable - Whether to enable the upper limit of local Binlog retention. Values: true: Enabled. false: Disabled. Description:When modifying the log backup policy, this parameter needs to be passed in.
- Binlog
Limit intCount - Number of local Binlog retained, ranging from 6 to 1000, in units of pieces. Automatically delete local logs that exceed the retained number. Explanation: When modifying the log backup policy, this parameter needs to be passed in.
- Binlog
Local intRetention Hour - Local Binlog retention duration, with a value ranging from 0 to 168, in hours. Local logs exceeding the retention duration will be automatically deleted. When set to 0, local logs will not be automatically deleted. Note: When modifying the log backup policy, this parameter needs to be passed.
- Binlog
Space boolLimit Enable - Whether to enable automatic cleanup of Binlog when space is too large. When the total storage space occupancy rate of the instance exceeds 80% or the remaining space is less than 5GB, the system will automatically start cleaning up the earliest local Binlog until the total space occupancy rate is lower than 80% and the remaining space is greater than 5GB. true: Enabled. false: Disabled. Description: This parameter needs to be passed in when modifying the log backup policy.
- Binlog
Storage intPercentage - Maximum storage space usage rate can be set to 20% - 50%. After exceeding this limit, the earliest Binlog file will be automatically deleted until the space usage rate is lower than this ratio. Local Binlog space usage rate = Local Binlog size / Total available (purchased) instance space size. When modifying the log backup policy, this parameter needs to be passed in. Explanation: When modifying the log backup policy, this parameter needs to be passed in.
- Data
Backup boolAll Retention - Whether to retain all data backups before releasing the instance. Values: true: Yes. false: No.
- Data
Backup boolEncryption Enabled - Whether to enable encryption for data backup. Values: true: Yes. false: No.
- Data
Backup intRetention Day - Data backup retention days, value range: 7 to 365 days. Default retention is 7 days.
- Data
Full List<string>Backup Periods - Full backup period. It is recommended to select at least 2 days for full backup every week. Multiple values are separated by English commas (,). Values: Monday. Tuesday. Wednesday. Thursday. Friday. Saturday. Sunday. When modifying the data backup policy, this parameter needs to be passed in.
- Data
Full intBackup Start Utc Hour - The start point (UTC time) of the time window for starting the full backup task. The time window length is 1 hour. Explanation: Both DataFullBackupStartUTCHour and DataFullBackupTime can be used to indicate the full backup time period of an instance. DataFullBackupStartUTCHour has higher priority. If both fields are returned at the same time, DataFullBackupStartUTCHour shall prevail.
- Data
Full stringBackup Time - Time window for executing backup tasks is one hour. Format: HH:mmZ-HH:mmZ (UTC time). Explanation: This parameter needs to be passed in when modifying the data backup policy.
- Data
Incr List<string>Backup Periods - Incremental backup period. Multiple values are separated by commas (,). Values: Monday. Tuesday. Wednesday. Thursday. Friday. Saturday. Sunday.Description: The incremental backup period cannot conflict with the full backup. When modifying the data backup policy, this parameter needs to be passed in.
- Data
Keep intDays After Released - Backup retention days when an instance is released. Currently, only a value of 7 is supported.
- Data
Keep stringPolicy After Released - Policy for retaining a backup of an instance after it is released. The values are: Last: Keep the last backup. Default value. All: Keep all backups of the instance.
- Hourly
Incr boolBackup Enable - Whether to enable high-frequency backup function. Values: true: Yes. false: No.
- Incr
Backup intHour Period - Frequency of performing high-frequency incremental backups. Values: 2: Perform an incremental backup every 2 hours. 4: Perform an incremental backup every 4 hours. 6: Perform an incremental backup every 6 hours. 12: Perform an incremental backup every 12 hours. Description: This parameter takes effect only when HourlyIncrBackupEnable is set to true.
- Lock
Ddl intTime - Maximum waiting time for DDL. The default value is 30. The minimum value is 10. The maximum value is 1440. The unit is minutes. Description: Only instances of MySQL 8.0 version support this setting.
- Log
Backup intRetention Day - Binlog backup retention period. The value range is 7 to 365, in days. Explanation: When modifying the log backup policy, this parameter needs to be passed in.
- Retention
Policy boolSynced - Is the retention policy for log backups the same as that for data backups? Explanation: When the value is true, LogBackupRetentionDay and BinlogBackupAllRetention are ignored.
- Instance
Id string - The ID of the RDS instance.
- Binlog
Backup boolAll Retention - Whether to retain all log backups before releasing an instance. Values: true: Yes. false: No. Description: BinlogBackupAllRetention is ineffective when the value of RetentionPolicySynced is true.
- Binlog
Backup boolEnabled - Whether to enable log backup function. Values: true: Yes. false: No.
- Binlog
Backup boolEncryption Enabled - Is encryption enabled for log backups? Values: true: Yes. false: No.
- Binlog
File boolCounts Enable - Whether to enable the upper limit of local Binlog retention. Values: true: Enabled. false: Disabled. Description:When modifying the log backup policy, this parameter needs to be passed in.
- Binlog
Limit intCount - Number of local Binlog retained, ranging from 6 to 1000, in units of pieces. Automatically delete local logs that exceed the retained number. Explanation: When modifying the log backup policy, this parameter needs to be passed in.
- Binlog
Local intRetention Hour - Local Binlog retention duration, with a value ranging from 0 to 168, in hours. Local logs exceeding the retention duration will be automatically deleted. When set to 0, local logs will not be automatically deleted. Note: When modifying the log backup policy, this parameter needs to be passed.
- Binlog
Space boolLimit Enable - Whether to enable automatic cleanup of Binlog when space is too large. When the total storage space occupancy rate of the instance exceeds 80% or the remaining space is less than 5GB, the system will automatically start cleaning up the earliest local Binlog until the total space occupancy rate is lower than 80% and the remaining space is greater than 5GB. true: Enabled. false: Disabled. Description: This parameter needs to be passed in when modifying the log backup policy.
- Binlog
Storage intPercentage - Maximum storage space usage rate can be set to 20% - 50%. After exceeding this limit, the earliest Binlog file will be automatically deleted until the space usage rate is lower than this ratio. Local Binlog space usage rate = Local Binlog size / Total available (purchased) instance space size. When modifying the log backup policy, this parameter needs to be passed in. Explanation: When modifying the log backup policy, this parameter needs to be passed in.
- Data
Backup boolAll Retention - Whether to retain all data backups before releasing the instance. Values: true: Yes. false: No.
- Data
Backup boolEncryption Enabled - Whether to enable encryption for data backup. Values: true: Yes. false: No.
- Data
Backup intRetention Day - Data backup retention days, value range: 7 to 365 days. Default retention is 7 days.
- Data
Full []stringBackup Periods - Full backup period. It is recommended to select at least 2 days for full backup every week. Multiple values are separated by English commas (,). Values: Monday. Tuesday. Wednesday. Thursday. Friday. Saturday. Sunday. When modifying the data backup policy, this parameter needs to be passed in.
- Data
Full intBackup Start Utc Hour - The start point (UTC time) of the time window for starting the full backup task. The time window length is 1 hour. Explanation: Both DataFullBackupStartUTCHour and DataFullBackupTime can be used to indicate the full backup time period of an instance. DataFullBackupStartUTCHour has higher priority. If both fields are returned at the same time, DataFullBackupStartUTCHour shall prevail.
- Data
Full stringBackup Time - Time window for executing backup tasks is one hour. Format: HH:mmZ-HH:mmZ (UTC time). Explanation: This parameter needs to be passed in when modifying the data backup policy.
- Data
Incr []stringBackup Periods - Incremental backup period. Multiple values are separated by commas (,). Values: Monday. Tuesday. Wednesday. Thursday. Friday. Saturday. Sunday.Description: The incremental backup period cannot conflict with the full backup. When modifying the data backup policy, this parameter needs to be passed in.
- Data
Keep intDays After Released - Backup retention days when an instance is released. Currently, only a value of 7 is supported.
- Data
Keep stringPolicy After Released - Policy for retaining a backup of an instance after it is released. The values are: Last: Keep the last backup. Default value. All: Keep all backups of the instance.
- Hourly
Incr boolBackup Enable - Whether to enable high-frequency backup function. Values: true: Yes. false: No.
- Incr
Backup intHour Period - Frequency of performing high-frequency incremental backups. Values: 2: Perform an incremental backup every 2 hours. 4: Perform an incremental backup every 4 hours. 6: Perform an incremental backup every 6 hours. 12: Perform an incremental backup every 12 hours. Description: This parameter takes effect only when HourlyIncrBackupEnable is set to true.
- Lock
Ddl intTime - Maximum waiting time for DDL. The default value is 30. The minimum value is 10. The maximum value is 1440. The unit is minutes. Description: Only instances of MySQL 8.0 version support this setting.
- Log
Backup intRetention Day - Binlog backup retention period. The value range is 7 to 365, in days. Explanation: When modifying the log backup policy, this parameter needs to be passed in.
- Retention
Policy boolSynced - Is the retention policy for log backups the same as that for data backups? Explanation: When the value is true, LogBackupRetentionDay and BinlogBackupAllRetention are ignored.
- instance
Id String - The ID of the RDS instance.
- binlog
Backup BooleanAll Retention - Whether to retain all log backups before releasing an instance. Values: true: Yes. false: No. Description: BinlogBackupAllRetention is ineffective when the value of RetentionPolicySynced is true.
- binlog
Backup BooleanEnabled - Whether to enable log backup function. Values: true: Yes. false: No.
- binlog
Backup BooleanEncryption Enabled - Is encryption enabled for log backups? Values: true: Yes. false: No.
- binlog
File BooleanCounts Enable - Whether to enable the upper limit of local Binlog retention. Values: true: Enabled. false: Disabled. Description:When modifying the log backup policy, this parameter needs to be passed in.
- binlog
Limit IntegerCount - Number of local Binlog retained, ranging from 6 to 1000, in units of pieces. Automatically delete local logs that exceed the retained number. Explanation: When modifying the log backup policy, this parameter needs to be passed in.
- binlog
Local IntegerRetention Hour - Local Binlog retention duration, with a value ranging from 0 to 168, in hours. Local logs exceeding the retention duration will be automatically deleted. When set to 0, local logs will not be automatically deleted. Note: When modifying the log backup policy, this parameter needs to be passed.
- binlog
Space BooleanLimit Enable - Whether to enable automatic cleanup of Binlog when space is too large. When the total storage space occupancy rate of the instance exceeds 80% or the remaining space is less than 5GB, the system will automatically start cleaning up the earliest local Binlog until the total space occupancy rate is lower than 80% and the remaining space is greater than 5GB. true: Enabled. false: Disabled. Description: This parameter needs to be passed in when modifying the log backup policy.
- binlog
Storage IntegerPercentage - Maximum storage space usage rate can be set to 20% - 50%. After exceeding this limit, the earliest Binlog file will be automatically deleted until the space usage rate is lower than this ratio. Local Binlog space usage rate = Local Binlog size / Total available (purchased) instance space size. When modifying the log backup policy, this parameter needs to be passed in. Explanation: When modifying the log backup policy, this parameter needs to be passed in.
- data
Backup BooleanAll Retention - Whether to retain all data backups before releasing the instance. Values: true: Yes. false: No.
- data
Backup BooleanEncryption Enabled - Whether to enable encryption for data backup. Values: true: Yes. false: No.
- data
Backup IntegerRetention Day - Data backup retention days, value range: 7 to 365 days. Default retention is 7 days.
- data
Full List<String>Backup Periods - Full backup period. It is recommended to select at least 2 days for full backup every week. Multiple values are separated by English commas (,). Values: Monday. Tuesday. Wednesday. Thursday. Friday. Saturday. Sunday. When modifying the data backup policy, this parameter needs to be passed in.
- data
Full IntegerBackup Start Utc Hour - The start point (UTC time) of the time window for starting the full backup task. The time window length is 1 hour. Explanation: Both DataFullBackupStartUTCHour and DataFullBackupTime can be used to indicate the full backup time period of an instance. DataFullBackupStartUTCHour has higher priority. If both fields are returned at the same time, DataFullBackupStartUTCHour shall prevail.
- data
Full StringBackup Time - Time window for executing backup tasks is one hour. Format: HH:mmZ-HH:mmZ (UTC time). Explanation: This parameter needs to be passed in when modifying the data backup policy.
- data
Incr List<String>Backup Periods - Incremental backup period. Multiple values are separated by commas (,). Values: Monday. Tuesday. Wednesday. Thursday. Friday. Saturday. Sunday.Description: The incremental backup period cannot conflict with the full backup. When modifying the data backup policy, this parameter needs to be passed in.
- data
Keep IntegerDays After Released - Backup retention days when an instance is released. Currently, only a value of 7 is supported.
- data
Keep StringPolicy After Released - Policy for retaining a backup of an instance after it is released. The values are: Last: Keep the last backup. Default value. All: Keep all backups of the instance.
- hourly
Incr BooleanBackup Enable - Whether to enable high-frequency backup function. Values: true: Yes. false: No.
- incr
Backup IntegerHour Period - Frequency of performing high-frequency incremental backups. Values: 2: Perform an incremental backup every 2 hours. 4: Perform an incremental backup every 4 hours. 6: Perform an incremental backup every 6 hours. 12: Perform an incremental backup every 12 hours. Description: This parameter takes effect only when HourlyIncrBackupEnable is set to true.
- lock
Ddl IntegerTime - Maximum waiting time for DDL. The default value is 30. The minimum value is 10. The maximum value is 1440. The unit is minutes. Description: Only instances of MySQL 8.0 version support this setting.
- log
Backup IntegerRetention Day - Binlog backup retention period. The value range is 7 to 365, in days. Explanation: When modifying the log backup policy, this parameter needs to be passed in.
- retention
Policy BooleanSynced - Is the retention policy for log backups the same as that for data backups? Explanation: When the value is true, LogBackupRetentionDay and BinlogBackupAllRetention are ignored.
- instance
Id string - The ID of the RDS instance.
- binlog
Backup booleanAll Retention - Whether to retain all log backups before releasing an instance. Values: true: Yes. false: No. Description: BinlogBackupAllRetention is ineffective when the value of RetentionPolicySynced is true.
- binlog
Backup booleanEnabled - Whether to enable log backup function. Values: true: Yes. false: No.
- binlog
Backup booleanEncryption Enabled - Is encryption enabled for log backups? Values: true: Yes. false: No.
- binlog
File booleanCounts Enable - Whether to enable the upper limit of local Binlog retention. Values: true: Enabled. false: Disabled. Description:When modifying the log backup policy, this parameter needs to be passed in.
- binlog
Limit numberCount - Number of local Binlog retained, ranging from 6 to 1000, in units of pieces. Automatically delete local logs that exceed the retained number. Explanation: When modifying the log backup policy, this parameter needs to be passed in.
- binlog
Local numberRetention Hour - Local Binlog retention duration, with a value ranging from 0 to 168, in hours. Local logs exceeding the retention duration will be automatically deleted. When set to 0, local logs will not be automatically deleted. Note: When modifying the log backup policy, this parameter needs to be passed.
- binlog
Space booleanLimit Enable - Whether to enable automatic cleanup of Binlog when space is too large. When the total storage space occupancy rate of the instance exceeds 80% or the remaining space is less than 5GB, the system will automatically start cleaning up the earliest local Binlog until the total space occupancy rate is lower than 80% and the remaining space is greater than 5GB. true: Enabled. false: Disabled. Description: This parameter needs to be passed in when modifying the log backup policy.
- binlog
Storage numberPercentage - Maximum storage space usage rate can be set to 20% - 50%. After exceeding this limit, the earliest Binlog file will be automatically deleted until the space usage rate is lower than this ratio. Local Binlog space usage rate = Local Binlog size / Total available (purchased) instance space size. When modifying the log backup policy, this parameter needs to be passed in. Explanation: When modifying the log backup policy, this parameter needs to be passed in.
- data
Backup booleanAll Retention - Whether to retain all data backups before releasing the instance. Values: true: Yes. false: No.
- data
Backup booleanEncryption Enabled - Whether to enable encryption for data backup. Values: true: Yes. false: No.
- data
Backup numberRetention Day - Data backup retention days, value range: 7 to 365 days. Default retention is 7 days.
- data
Full string[]Backup Periods - Full backup period. It is recommended to select at least 2 days for full backup every week. Multiple values are separated by English commas (,). Values: Monday. Tuesday. Wednesday. Thursday. Friday. Saturday. Sunday. When modifying the data backup policy, this parameter needs to be passed in.
- data
Full numberBackup Start Utc Hour - The start point (UTC time) of the time window for starting the full backup task. The time window length is 1 hour. Explanation: Both DataFullBackupStartUTCHour and DataFullBackupTime can be used to indicate the full backup time period of an instance. DataFullBackupStartUTCHour has higher priority. If both fields are returned at the same time, DataFullBackupStartUTCHour shall prevail.
- data
Full stringBackup Time - Time window for executing backup tasks is one hour. Format: HH:mmZ-HH:mmZ (UTC time). Explanation: This parameter needs to be passed in when modifying the data backup policy.
- data
Incr string[]Backup Periods - Incremental backup period. Multiple values are separated by commas (,). Values: Monday. Tuesday. Wednesday. Thursday. Friday. Saturday. Sunday.Description: The incremental backup period cannot conflict with the full backup. When modifying the data backup policy, this parameter needs to be passed in.
- data
Keep numberDays After Released - Backup retention days when an instance is released. Currently, only a value of 7 is supported.
- data
Keep stringPolicy After Released - Policy for retaining a backup of an instance after it is released. The values are: Last: Keep the last backup. Default value. All: Keep all backups of the instance.
- hourly
Incr booleanBackup Enable - Whether to enable high-frequency backup function. Values: true: Yes. false: No.
- incr
Backup numberHour Period - Frequency of performing high-frequency incremental backups. Values: 2: Perform an incremental backup every 2 hours. 4: Perform an incremental backup every 4 hours. 6: Perform an incremental backup every 6 hours. 12: Perform an incremental backup every 12 hours. Description: This parameter takes effect only when HourlyIncrBackupEnable is set to true.
- lock
Ddl numberTime - Maximum waiting time for DDL. The default value is 30. The minimum value is 10. The maximum value is 1440. The unit is minutes. Description: Only instances of MySQL 8.0 version support this setting.
- log
Backup numberRetention Day - Binlog backup retention period. The value range is 7 to 365, in days. Explanation: When modifying the log backup policy, this parameter needs to be passed in.
- retention
Policy booleanSynced - Is the retention policy for log backups the same as that for data backups? Explanation: When the value is true, LogBackupRetentionDay and BinlogBackupAllRetention are ignored.
- instance_
id str - The ID of the RDS instance.
- binlog_
backup_ boolall_ retention - Whether to retain all log backups before releasing an instance. Values: true: Yes. false: No. Description: BinlogBackupAllRetention is ineffective when the value of RetentionPolicySynced is true.
- binlog_
backup_ boolenabled - Whether to enable log backup function. Values: true: Yes. false: No.
- binlog_
backup_ boolencryption_ enabled - Is encryption enabled for log backups? Values: true: Yes. false: No.
- binlog_
file_ boolcounts_ enable - Whether to enable the upper limit of local Binlog retention. Values: true: Enabled. false: Disabled. Description:When modifying the log backup policy, this parameter needs to be passed in.
- binlog_
limit_ intcount - Number of local Binlog retained, ranging from 6 to 1000, in units of pieces. Automatically delete local logs that exceed the retained number. Explanation: When modifying the log backup policy, this parameter needs to be passed in.
- binlog_
local_ intretention_ hour - Local Binlog retention duration, with a value ranging from 0 to 168, in hours. Local logs exceeding the retention duration will be automatically deleted. When set to 0, local logs will not be automatically deleted. Note: When modifying the log backup policy, this parameter needs to be passed.
- binlog_
space_ boollimit_ enable - Whether to enable automatic cleanup of Binlog when space is too large. When the total storage space occupancy rate of the instance exceeds 80% or the remaining space is less than 5GB, the system will automatically start cleaning up the earliest local Binlog until the total space occupancy rate is lower than 80% and the remaining space is greater than 5GB. true: Enabled. false: Disabled. Description: This parameter needs to be passed in when modifying the log backup policy.
- binlog_
storage_ intpercentage - Maximum storage space usage rate can be set to 20% - 50%. After exceeding this limit, the earliest Binlog file will be automatically deleted until the space usage rate is lower than this ratio. Local Binlog space usage rate = Local Binlog size / Total available (purchased) instance space size. When modifying the log backup policy, this parameter needs to be passed in. Explanation: When modifying the log backup policy, this parameter needs to be passed in.
- data_
backup_ boolall_ retention - Whether to retain all data backups before releasing the instance. Values: true: Yes. false: No.
- data_
backup_ boolencryption_ enabled - Whether to enable encryption for data backup. Values: true: Yes. false: No.
- data_
backup_ intretention_ day - Data backup retention days, value range: 7 to 365 days. Default retention is 7 days.
- data_
full_ Sequence[str]backup_ periods - Full backup period. It is recommended to select at least 2 days for full backup every week. Multiple values are separated by English commas (,). Values: Monday. Tuesday. Wednesday. Thursday. Friday. Saturday. Sunday. When modifying the data backup policy, this parameter needs to be passed in.
- data_
full_ intbackup_ start_ utc_ hour - The start point (UTC time) of the time window for starting the full backup task. The time window length is 1 hour. Explanation: Both DataFullBackupStartUTCHour and DataFullBackupTime can be used to indicate the full backup time period of an instance. DataFullBackupStartUTCHour has higher priority. If both fields are returned at the same time, DataFullBackupStartUTCHour shall prevail.
- data_
full_ strbackup_ time - Time window for executing backup tasks is one hour. Format: HH:mmZ-HH:mmZ (UTC time). Explanation: This parameter needs to be passed in when modifying the data backup policy.
- data_
incr_ Sequence[str]backup_ periods - Incremental backup period. Multiple values are separated by commas (,). Values: Monday. Tuesday. Wednesday. Thursday. Friday. Saturday. Sunday.Description: The incremental backup period cannot conflict with the full backup. When modifying the data backup policy, this parameter needs to be passed in.
- data_
keep_ intdays_ after_ released - Backup retention days when an instance is released. Currently, only a value of 7 is supported.
- data_
keep_ strpolicy_ after_ released - Policy for retaining a backup of an instance after it is released. The values are: Last: Keep the last backup. Default value. All: Keep all backups of the instance.
- hourly_
incr_ boolbackup_ enable - Whether to enable high-frequency backup function. Values: true: Yes. false: No.
- incr_
backup_ inthour_ period - Frequency of performing high-frequency incremental backups. Values: 2: Perform an incremental backup every 2 hours. 4: Perform an incremental backup every 4 hours. 6: Perform an incremental backup every 6 hours. 12: Perform an incremental backup every 12 hours. Description: This parameter takes effect only when HourlyIncrBackupEnable is set to true.
- lock_
ddl_ inttime - Maximum waiting time for DDL. The default value is 30. The minimum value is 10. The maximum value is 1440. The unit is minutes. Description: Only instances of MySQL 8.0 version support this setting.
- log_
backup_ intretention_ day - Binlog backup retention period. The value range is 7 to 365, in days. Explanation: When modifying the log backup policy, this parameter needs to be passed in.
- retention_
policy_ boolsynced - Is the retention policy for log backups the same as that for data backups? Explanation: When the value is true, LogBackupRetentionDay and BinlogBackupAllRetention are ignored.
- instance
Id String - The ID of the RDS instance.
- binlog
Backup BooleanAll Retention - Whether to retain all log backups before releasing an instance. Values: true: Yes. false: No. Description: BinlogBackupAllRetention is ineffective when the value of RetentionPolicySynced is true.
- binlog
Backup BooleanEnabled - Whether to enable log backup function. Values: true: Yes. false: No.
- binlog
Backup BooleanEncryption Enabled - Is encryption enabled for log backups? Values: true: Yes. false: No.
- binlog
File BooleanCounts Enable - Whether to enable the upper limit of local Binlog retention. Values: true: Enabled. false: Disabled. Description:When modifying the log backup policy, this parameter needs to be passed in.
- binlog
Limit NumberCount - Number of local Binlog retained, ranging from 6 to 1000, in units of pieces. Automatically delete local logs that exceed the retained number. Explanation: When modifying the log backup policy, this parameter needs to be passed in.
- binlog
Local NumberRetention Hour - Local Binlog retention duration, with a value ranging from 0 to 168, in hours. Local logs exceeding the retention duration will be automatically deleted. When set to 0, local logs will not be automatically deleted. Note: When modifying the log backup policy, this parameter needs to be passed.
- binlog
Space BooleanLimit Enable - Whether to enable automatic cleanup of Binlog when space is too large. When the total storage space occupancy rate of the instance exceeds 80% or the remaining space is less than 5GB, the system will automatically start cleaning up the earliest local Binlog until the total space occupancy rate is lower than 80% and the remaining space is greater than 5GB. true: Enabled. false: Disabled. Description: This parameter needs to be passed in when modifying the log backup policy.
- binlog
Storage NumberPercentage - Maximum storage space usage rate can be set to 20% - 50%. After exceeding this limit, the earliest Binlog file will be automatically deleted until the space usage rate is lower than this ratio. Local Binlog space usage rate = Local Binlog size / Total available (purchased) instance space size. When modifying the log backup policy, this parameter needs to be passed in. Explanation: When modifying the log backup policy, this parameter needs to be passed in.
- data
Backup BooleanAll Retention - Whether to retain all data backups before releasing the instance. Values: true: Yes. false: No.
- data
Backup BooleanEncryption Enabled - Whether to enable encryption for data backup. Values: true: Yes. false: No.
- data
Backup NumberRetention Day - Data backup retention days, value range: 7 to 365 days. Default retention is 7 days.
- data
Full List<String>Backup Periods - Full backup period. It is recommended to select at least 2 days for full backup every week. Multiple values are separated by English commas (,). Values: Monday. Tuesday. Wednesday. Thursday. Friday. Saturday. Sunday. When modifying the data backup policy, this parameter needs to be passed in.
- data
Full NumberBackup Start Utc Hour - The start point (UTC time) of the time window for starting the full backup task. The time window length is 1 hour. Explanation: Both DataFullBackupStartUTCHour and DataFullBackupTime can be used to indicate the full backup time period of an instance. DataFullBackupStartUTCHour has higher priority. If both fields are returned at the same time, DataFullBackupStartUTCHour shall prevail.
- data
Full StringBackup Time - Time window for executing backup tasks is one hour. Format: HH:mmZ-HH:mmZ (UTC time). Explanation: This parameter needs to be passed in when modifying the data backup policy.
- data
Incr List<String>Backup Periods - Incremental backup period. Multiple values are separated by commas (,). Values: Monday. Tuesday. Wednesday. Thursday. Friday. Saturday. Sunday.Description: The incremental backup period cannot conflict with the full backup. When modifying the data backup policy, this parameter needs to be passed in.
- data
Keep NumberDays After Released - Backup retention days when an instance is released. Currently, only a value of 7 is supported.
- data
Keep StringPolicy After Released - Policy for retaining a backup of an instance after it is released. The values are: Last: Keep the last backup. Default value. All: Keep all backups of the instance.
- hourly
Incr BooleanBackup Enable - Whether to enable high-frequency backup function. Values: true: Yes. false: No.
- incr
Backup NumberHour Period - Frequency of performing high-frequency incremental backups. Values: 2: Perform an incremental backup every 2 hours. 4: Perform an incremental backup every 4 hours. 6: Perform an incremental backup every 6 hours. 12: Perform an incremental backup every 12 hours. Description: This parameter takes effect only when HourlyIncrBackupEnable is set to true.
- lock
Ddl NumberTime - Maximum waiting time for DDL. The default value is 30. The minimum value is 10. The maximum value is 1440. The unit is minutes. Description: Only instances of MySQL 8.0 version support this setting.
- log
Backup NumberRetention Day - Binlog backup retention period. The value range is 7 to 365, in days. Explanation: When modifying the log backup policy, this parameter needs to be passed in.
- retention
Policy BooleanSynced - Is the retention policy for log backups the same as that for data backups? Explanation: When the value is true, LogBackupRetentionDay and BinlogBackupAllRetention are ignored.
Outputs
All input properties are implicitly available as output properties. Additionally, the BackupPolicy resource produces the following output properties:
- Id string
- The provider-assigned unique ID for this managed resource.
- Id string
- The provider-assigned unique ID for this managed resource.
- id String
- The provider-assigned unique ID for this managed resource.
- id string
- The provider-assigned unique ID for this managed resource.
- id str
- The provider-assigned unique ID for this managed resource.
- id String
- The provider-assigned unique ID for this managed resource.
Look up Existing BackupPolicy Resource
Get an existing BackupPolicy 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?: BackupPolicyState, opts?: CustomResourceOptions): BackupPolicy
@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
binlog_backup_all_retention: Optional[bool] = None,
binlog_backup_enabled: Optional[bool] = None,
binlog_backup_encryption_enabled: Optional[bool] = None,
binlog_file_counts_enable: Optional[bool] = None,
binlog_limit_count: Optional[int] = None,
binlog_local_retention_hour: Optional[int] = None,
binlog_space_limit_enable: Optional[bool] = None,
binlog_storage_percentage: Optional[int] = None,
data_backup_all_retention: Optional[bool] = None,
data_backup_encryption_enabled: Optional[bool] = None,
data_backup_retention_day: Optional[int] = None,
data_full_backup_periods: Optional[Sequence[str]] = None,
data_full_backup_start_utc_hour: Optional[int] = None,
data_full_backup_time: Optional[str] = None,
data_incr_backup_periods: Optional[Sequence[str]] = None,
data_keep_days_after_released: Optional[int] = None,
data_keep_policy_after_released: Optional[str] = None,
hourly_incr_backup_enable: Optional[bool] = None,
incr_backup_hour_period: Optional[int] = None,
instance_id: Optional[str] = None,
lock_ddl_time: Optional[int] = None,
log_backup_retention_day: Optional[int] = None,
retention_policy_synced: Optional[bool] = None) -> BackupPolicy
func GetBackupPolicy(ctx *Context, name string, id IDInput, state *BackupPolicyState, opts ...ResourceOption) (*BackupPolicy, error)
public static BackupPolicy Get(string name, Input<string> id, BackupPolicyState? state, CustomResourceOptions? opts = null)
public static BackupPolicy get(String name, Output<String> id, BackupPolicyState state, CustomResourceOptions options)
resources: _: type: volcengine:rds_mysql:BackupPolicy get: 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.
- Binlog
Backup boolAll Retention - Whether to retain all log backups before releasing an instance. Values: true: Yes. false: No. Description: BinlogBackupAllRetention is ineffective when the value of RetentionPolicySynced is true.
- Binlog
Backup boolEnabled - Whether to enable log backup function. Values: true: Yes. false: No.
- Binlog
Backup boolEncryption Enabled - Is encryption enabled for log backups? Values: true: Yes. false: No.
- Binlog
File boolCounts Enable - Whether to enable the upper limit of local Binlog retention. Values: true: Enabled. false: Disabled. Description:When modifying the log backup policy, this parameter needs to be passed in.
- Binlog
Limit intCount - Number of local Binlog retained, ranging from 6 to 1000, in units of pieces. Automatically delete local logs that exceed the retained number. Explanation: When modifying the log backup policy, this parameter needs to be passed in.
- Binlog
Local intRetention Hour - Local Binlog retention duration, with a value ranging from 0 to 168, in hours. Local logs exceeding the retention duration will be automatically deleted. When set to 0, local logs will not be automatically deleted. Note: When modifying the log backup policy, this parameter needs to be passed.
- Binlog
Space boolLimit Enable - Whether to enable automatic cleanup of Binlog when space is too large. When the total storage space occupancy rate of the instance exceeds 80% or the remaining space is less than 5GB, the system will automatically start cleaning up the earliest local Binlog until the total space occupancy rate is lower than 80% and the remaining space is greater than 5GB. true: Enabled. false: Disabled. Description: This parameter needs to be passed in when modifying the log backup policy.
- Binlog
Storage intPercentage - Maximum storage space usage rate can be set to 20% - 50%. After exceeding this limit, the earliest Binlog file will be automatically deleted until the space usage rate is lower than this ratio. Local Binlog space usage rate = Local Binlog size / Total available (purchased) instance space size. When modifying the log backup policy, this parameter needs to be passed in. Explanation: When modifying the log backup policy, this parameter needs to be passed in.
- Data
Backup boolAll Retention - Whether to retain all data backups before releasing the instance. Values: true: Yes. false: No.
- Data
Backup boolEncryption Enabled - Whether to enable encryption for data backup. Values: true: Yes. false: No.
- Data
Backup intRetention Day - Data backup retention days, value range: 7 to 365 days. Default retention is 7 days.
- Data
Full List<string>Backup Periods - Full backup period. It is recommended to select at least 2 days for full backup every week. Multiple values are separated by English commas (,). Values: Monday. Tuesday. Wednesday. Thursday. Friday. Saturday. Sunday. When modifying the data backup policy, this parameter needs to be passed in.
- Data
Full intBackup Start Utc Hour - The start point (UTC time) of the time window for starting the full backup task. The time window length is 1 hour. Explanation: Both DataFullBackupStartUTCHour and DataFullBackupTime can be used to indicate the full backup time period of an instance. DataFullBackupStartUTCHour has higher priority. If both fields are returned at the same time, DataFullBackupStartUTCHour shall prevail.
- Data
Full stringBackup Time - Time window for executing backup tasks is one hour. Format: HH:mmZ-HH:mmZ (UTC time). Explanation: This parameter needs to be passed in when modifying the data backup policy.
- Data
Incr List<string>Backup Periods - Incremental backup period. Multiple values are separated by commas (,). Values: Monday. Tuesday. Wednesday. Thursday. Friday. Saturday. Sunday.Description: The incremental backup period cannot conflict with the full backup. When modifying the data backup policy, this parameter needs to be passed in.
- Data
Keep intDays After Released - Backup retention days when an instance is released. Currently, only a value of 7 is supported.
- Data
Keep stringPolicy After Released - Policy for retaining a backup of an instance after it is released. The values are: Last: Keep the last backup. Default value. All: Keep all backups of the instance.
- Hourly
Incr boolBackup Enable - Whether to enable high-frequency backup function. Values: true: Yes. false: No.
- Incr
Backup intHour Period - Frequency of performing high-frequency incremental backups. Values: 2: Perform an incremental backup every 2 hours. 4: Perform an incremental backup every 4 hours. 6: Perform an incremental backup every 6 hours. 12: Perform an incremental backup every 12 hours. Description: This parameter takes effect only when HourlyIncrBackupEnable is set to true.
- Instance
Id string - The ID of the RDS instance.
- Lock
Ddl intTime - Maximum waiting time for DDL. The default value is 30. The minimum value is 10. The maximum value is 1440. The unit is minutes. Description: Only instances of MySQL 8.0 version support this setting.
- Log
Backup intRetention Day - Binlog backup retention period. The value range is 7 to 365, in days. Explanation: When modifying the log backup policy, this parameter needs to be passed in.
- Retention
Policy boolSynced - Is the retention policy for log backups the same as that for data backups? Explanation: When the value is true, LogBackupRetentionDay and BinlogBackupAllRetention are ignored.
- Binlog
Backup boolAll Retention - Whether to retain all log backups before releasing an instance. Values: true: Yes. false: No. Description: BinlogBackupAllRetention is ineffective when the value of RetentionPolicySynced is true.
- Binlog
Backup boolEnabled - Whether to enable log backup function. Values: true: Yes. false: No.
- Binlog
Backup boolEncryption Enabled - Is encryption enabled for log backups? Values: true: Yes. false: No.
- Binlog
File boolCounts Enable - Whether to enable the upper limit of local Binlog retention. Values: true: Enabled. false: Disabled. Description:When modifying the log backup policy, this parameter needs to be passed in.
- Binlog
Limit intCount - Number of local Binlog retained, ranging from 6 to 1000, in units of pieces. Automatically delete local logs that exceed the retained number. Explanation: When modifying the log backup policy, this parameter needs to be passed in.
- Binlog
Local intRetention Hour - Local Binlog retention duration, with a value ranging from 0 to 168, in hours. Local logs exceeding the retention duration will be automatically deleted. When set to 0, local logs will not be automatically deleted. Note: When modifying the log backup policy, this parameter needs to be passed.
- Binlog
Space boolLimit Enable - Whether to enable automatic cleanup of Binlog when space is too large. When the total storage space occupancy rate of the instance exceeds 80% or the remaining space is less than 5GB, the system will automatically start cleaning up the earliest local Binlog until the total space occupancy rate is lower than 80% and the remaining space is greater than 5GB. true: Enabled. false: Disabled. Description: This parameter needs to be passed in when modifying the log backup policy.
- Binlog
Storage intPercentage - Maximum storage space usage rate can be set to 20% - 50%. After exceeding this limit, the earliest Binlog file will be automatically deleted until the space usage rate is lower than this ratio. Local Binlog space usage rate = Local Binlog size / Total available (purchased) instance space size. When modifying the log backup policy, this parameter needs to be passed in. Explanation: When modifying the log backup policy, this parameter needs to be passed in.
- Data
Backup boolAll Retention - Whether to retain all data backups before releasing the instance. Values: true: Yes. false: No.
- Data
Backup boolEncryption Enabled - Whether to enable encryption for data backup. Values: true: Yes. false: No.
- Data
Backup intRetention Day - Data backup retention days, value range: 7 to 365 days. Default retention is 7 days.
- Data
Full []stringBackup Periods - Full backup period. It is recommended to select at least 2 days for full backup every week. Multiple values are separated by English commas (,). Values: Monday. Tuesday. Wednesday. Thursday. Friday. Saturday. Sunday. When modifying the data backup policy, this parameter needs to be passed in.
- Data
Full intBackup Start Utc Hour - The start point (UTC time) of the time window for starting the full backup task. The time window length is 1 hour. Explanation: Both DataFullBackupStartUTCHour and DataFullBackupTime can be used to indicate the full backup time period of an instance. DataFullBackupStartUTCHour has higher priority. If both fields are returned at the same time, DataFullBackupStartUTCHour shall prevail.
- Data
Full stringBackup Time - Time window for executing backup tasks is one hour. Format: HH:mmZ-HH:mmZ (UTC time). Explanation: This parameter needs to be passed in when modifying the data backup policy.
- Data
Incr []stringBackup Periods - Incremental backup period. Multiple values are separated by commas (,). Values: Monday. Tuesday. Wednesday. Thursday. Friday. Saturday. Sunday.Description: The incremental backup period cannot conflict with the full backup. When modifying the data backup policy, this parameter needs to be passed in.
- Data
Keep intDays After Released - Backup retention days when an instance is released. Currently, only a value of 7 is supported.
- Data
Keep stringPolicy After Released - Policy for retaining a backup of an instance after it is released. The values are: Last: Keep the last backup. Default value. All: Keep all backups of the instance.
- Hourly
Incr boolBackup Enable - Whether to enable high-frequency backup function. Values: true: Yes. false: No.
- Incr
Backup intHour Period - Frequency of performing high-frequency incremental backups. Values: 2: Perform an incremental backup every 2 hours. 4: Perform an incremental backup every 4 hours. 6: Perform an incremental backup every 6 hours. 12: Perform an incremental backup every 12 hours. Description: This parameter takes effect only when HourlyIncrBackupEnable is set to true.
- Instance
Id string - The ID of the RDS instance.
- Lock
Ddl intTime - Maximum waiting time for DDL. The default value is 30. The minimum value is 10. The maximum value is 1440. The unit is minutes. Description: Only instances of MySQL 8.0 version support this setting.
- Log
Backup intRetention Day - Binlog backup retention period. The value range is 7 to 365, in days. Explanation: When modifying the log backup policy, this parameter needs to be passed in.
- Retention
Policy boolSynced - Is the retention policy for log backups the same as that for data backups? Explanation: When the value is true, LogBackupRetentionDay and BinlogBackupAllRetention are ignored.
- binlog
Backup BooleanAll Retention - Whether to retain all log backups before releasing an instance. Values: true: Yes. false: No. Description: BinlogBackupAllRetention is ineffective when the value of RetentionPolicySynced is true.
- binlog
Backup BooleanEnabled - Whether to enable log backup function. Values: true: Yes. false: No.
- binlog
Backup BooleanEncryption Enabled - Is encryption enabled for log backups? Values: true: Yes. false: No.
- binlog
File BooleanCounts Enable - Whether to enable the upper limit of local Binlog retention. Values: true: Enabled. false: Disabled. Description:When modifying the log backup policy, this parameter needs to be passed in.
- binlog
Limit IntegerCount - Number of local Binlog retained, ranging from 6 to 1000, in units of pieces. Automatically delete local logs that exceed the retained number. Explanation: When modifying the log backup policy, this parameter needs to be passed in.
- binlog
Local IntegerRetention Hour - Local Binlog retention duration, with a value ranging from 0 to 168, in hours. Local logs exceeding the retention duration will be automatically deleted. When set to 0, local logs will not be automatically deleted. Note: When modifying the log backup policy, this parameter needs to be passed.
- binlog
Space BooleanLimit Enable - Whether to enable automatic cleanup of Binlog when space is too large. When the total storage space occupancy rate of the instance exceeds 80% or the remaining space is less than 5GB, the system will automatically start cleaning up the earliest local Binlog until the total space occupancy rate is lower than 80% and the remaining space is greater than 5GB. true: Enabled. false: Disabled. Description: This parameter needs to be passed in when modifying the log backup policy.
- binlog
Storage IntegerPercentage - Maximum storage space usage rate can be set to 20% - 50%. After exceeding this limit, the earliest Binlog file will be automatically deleted until the space usage rate is lower than this ratio. Local Binlog space usage rate = Local Binlog size / Total available (purchased) instance space size. When modifying the log backup policy, this parameter needs to be passed in. Explanation: When modifying the log backup policy, this parameter needs to be passed in.
- data
Backup BooleanAll Retention - Whether to retain all data backups before releasing the instance. Values: true: Yes. false: No.
- data
Backup BooleanEncryption Enabled - Whether to enable encryption for data backup. Values: true: Yes. false: No.
- data
Backup IntegerRetention Day - Data backup retention days, value range: 7 to 365 days. Default retention is 7 days.
- data
Full List<String>Backup Periods - Full backup period. It is recommended to select at least 2 days for full backup every week. Multiple values are separated by English commas (,). Values: Monday. Tuesday. Wednesday. Thursday. Friday. Saturday. Sunday. When modifying the data backup policy, this parameter needs to be passed in.
- data
Full IntegerBackup Start Utc Hour - The start point (UTC time) of the time window for starting the full backup task. The time window length is 1 hour. Explanation: Both DataFullBackupStartUTCHour and DataFullBackupTime can be used to indicate the full backup time period of an instance. DataFullBackupStartUTCHour has higher priority. If both fields are returned at the same time, DataFullBackupStartUTCHour shall prevail.
- data
Full StringBackup Time - Time window for executing backup tasks is one hour. Format: HH:mmZ-HH:mmZ (UTC time). Explanation: This parameter needs to be passed in when modifying the data backup policy.
- data
Incr List<String>Backup Periods - Incremental backup period. Multiple values are separated by commas (,). Values: Monday. Tuesday. Wednesday. Thursday. Friday. Saturday. Sunday.Description: The incremental backup period cannot conflict with the full backup. When modifying the data backup policy, this parameter needs to be passed in.
- data
Keep IntegerDays After Released - Backup retention days when an instance is released. Currently, only a value of 7 is supported.
- data
Keep StringPolicy After Released - Policy for retaining a backup of an instance after it is released. The values are: Last: Keep the last backup. Default value. All: Keep all backups of the instance.
- hourly
Incr BooleanBackup Enable - Whether to enable high-frequency backup function. Values: true: Yes. false: No.
- incr
Backup IntegerHour Period - Frequency of performing high-frequency incremental backups. Values: 2: Perform an incremental backup every 2 hours. 4: Perform an incremental backup every 4 hours. 6: Perform an incremental backup every 6 hours. 12: Perform an incremental backup every 12 hours. Description: This parameter takes effect only when HourlyIncrBackupEnable is set to true.
- instance
Id String - The ID of the RDS instance.
- lock
Ddl IntegerTime - Maximum waiting time for DDL. The default value is 30. The minimum value is 10. The maximum value is 1440. The unit is minutes. Description: Only instances of MySQL 8.0 version support this setting.
- log
Backup IntegerRetention Day - Binlog backup retention period. The value range is 7 to 365, in days. Explanation: When modifying the log backup policy, this parameter needs to be passed in.
- retention
Policy BooleanSynced - Is the retention policy for log backups the same as that for data backups? Explanation: When the value is true, LogBackupRetentionDay and BinlogBackupAllRetention are ignored.
- binlog
Backup booleanAll Retention - Whether to retain all log backups before releasing an instance. Values: true: Yes. false: No. Description: BinlogBackupAllRetention is ineffective when the value of RetentionPolicySynced is true.
- binlog
Backup booleanEnabled - Whether to enable log backup function. Values: true: Yes. false: No.
- binlog
Backup booleanEncryption Enabled - Is encryption enabled for log backups? Values: true: Yes. false: No.
- binlog
File booleanCounts Enable - Whether to enable the upper limit of local Binlog retention. Values: true: Enabled. false: Disabled. Description:When modifying the log backup policy, this parameter needs to be passed in.
- binlog
Limit numberCount - Number of local Binlog retained, ranging from 6 to 1000, in units of pieces. Automatically delete local logs that exceed the retained number. Explanation: When modifying the log backup policy, this parameter needs to be passed in.
- binlog
Local numberRetention Hour - Local Binlog retention duration, with a value ranging from 0 to 168, in hours. Local logs exceeding the retention duration will be automatically deleted. When set to 0, local logs will not be automatically deleted. Note: When modifying the log backup policy, this parameter needs to be passed.
- binlog
Space booleanLimit Enable - Whether to enable automatic cleanup of Binlog when space is too large. When the total storage space occupancy rate of the instance exceeds 80% or the remaining space is less than 5GB, the system will automatically start cleaning up the earliest local Binlog until the total space occupancy rate is lower than 80% and the remaining space is greater than 5GB. true: Enabled. false: Disabled. Description: This parameter needs to be passed in when modifying the log backup policy.
- binlog
Storage numberPercentage - Maximum storage space usage rate can be set to 20% - 50%. After exceeding this limit, the earliest Binlog file will be automatically deleted until the space usage rate is lower than this ratio. Local Binlog space usage rate = Local Binlog size / Total available (purchased) instance space size. When modifying the log backup policy, this parameter needs to be passed in. Explanation: When modifying the log backup policy, this parameter needs to be passed in.
- data
Backup booleanAll Retention - Whether to retain all data backups before releasing the instance. Values: true: Yes. false: No.
- data
Backup booleanEncryption Enabled - Whether to enable encryption for data backup. Values: true: Yes. false: No.
- data
Backup numberRetention Day - Data backup retention days, value range: 7 to 365 days. Default retention is 7 days.
- data
Full string[]Backup Periods - Full backup period. It is recommended to select at least 2 days for full backup every week. Multiple values are separated by English commas (,). Values: Monday. Tuesday. Wednesday. Thursday. Friday. Saturday. Sunday. When modifying the data backup policy, this parameter needs to be passed in.
- data
Full numberBackup Start Utc Hour - The start point (UTC time) of the time window for starting the full backup task. The time window length is 1 hour. Explanation: Both DataFullBackupStartUTCHour and DataFullBackupTime can be used to indicate the full backup time period of an instance. DataFullBackupStartUTCHour has higher priority. If both fields are returned at the same time, DataFullBackupStartUTCHour shall prevail.
- data
Full stringBackup Time - Time window for executing backup tasks is one hour. Format: HH:mmZ-HH:mmZ (UTC time). Explanation: This parameter needs to be passed in when modifying the data backup policy.
- data
Incr string[]Backup Periods - Incremental backup period. Multiple values are separated by commas (,). Values: Monday. Tuesday. Wednesday. Thursday. Friday. Saturday. Sunday.Description: The incremental backup period cannot conflict with the full backup. When modifying the data backup policy, this parameter needs to be passed in.
- data
Keep numberDays After Released - Backup retention days when an instance is released. Currently, only a value of 7 is supported.
- data
Keep stringPolicy After Released - Policy for retaining a backup of an instance after it is released. The values are: Last: Keep the last backup. Default value. All: Keep all backups of the instance.
- hourly
Incr booleanBackup Enable - Whether to enable high-frequency backup function. Values: true: Yes. false: No.
- incr
Backup numberHour Period - Frequency of performing high-frequency incremental backups. Values: 2: Perform an incremental backup every 2 hours. 4: Perform an incremental backup every 4 hours. 6: Perform an incremental backup every 6 hours. 12: Perform an incremental backup every 12 hours. Description: This parameter takes effect only when HourlyIncrBackupEnable is set to true.
- instance
Id string - The ID of the RDS instance.
- lock
Ddl numberTime - Maximum waiting time for DDL. The default value is 30. The minimum value is 10. The maximum value is 1440. The unit is minutes. Description: Only instances of MySQL 8.0 version support this setting.
- log
Backup numberRetention Day - Binlog backup retention period. The value range is 7 to 365, in days. Explanation: When modifying the log backup policy, this parameter needs to be passed in.
- retention
Policy booleanSynced - Is the retention policy for log backups the same as that for data backups? Explanation: When the value is true, LogBackupRetentionDay and BinlogBackupAllRetention are ignored.
- binlog_
backup_ boolall_ retention - Whether to retain all log backups before releasing an instance. Values: true: Yes. false: No. Description: BinlogBackupAllRetention is ineffective when the value of RetentionPolicySynced is true.
- binlog_
backup_ boolenabled - Whether to enable log backup function. Values: true: Yes. false: No.
- binlog_
backup_ boolencryption_ enabled - Is encryption enabled for log backups? Values: true: Yes. false: No.
- binlog_
file_ boolcounts_ enable - Whether to enable the upper limit of local Binlog retention. Values: true: Enabled. false: Disabled. Description:When modifying the log backup policy, this parameter needs to be passed in.
- binlog_
limit_ intcount - Number of local Binlog retained, ranging from 6 to 1000, in units of pieces. Automatically delete local logs that exceed the retained number. Explanation: When modifying the log backup policy, this parameter needs to be passed in.
- binlog_
local_ intretention_ hour - Local Binlog retention duration, with a value ranging from 0 to 168, in hours. Local logs exceeding the retention duration will be automatically deleted. When set to 0, local logs will not be automatically deleted. Note: When modifying the log backup policy, this parameter needs to be passed.
- binlog_
space_ boollimit_ enable - Whether to enable automatic cleanup of Binlog when space is too large. When the total storage space occupancy rate of the instance exceeds 80% or the remaining space is less than 5GB, the system will automatically start cleaning up the earliest local Binlog until the total space occupancy rate is lower than 80% and the remaining space is greater than 5GB. true: Enabled. false: Disabled. Description: This parameter needs to be passed in when modifying the log backup policy.
- binlog_
storage_ intpercentage - Maximum storage space usage rate can be set to 20% - 50%. After exceeding this limit, the earliest Binlog file will be automatically deleted until the space usage rate is lower than this ratio. Local Binlog space usage rate = Local Binlog size / Total available (purchased) instance space size. When modifying the log backup policy, this parameter needs to be passed in. Explanation: When modifying the log backup policy, this parameter needs to be passed in.
- data_
backup_ boolall_ retention - Whether to retain all data backups before releasing the instance. Values: true: Yes. false: No.
- data_
backup_ boolencryption_ enabled - Whether to enable encryption for data backup. Values: true: Yes. false: No.
- data_
backup_ intretention_ day - Data backup retention days, value range: 7 to 365 days. Default retention is 7 days.
- data_
full_ Sequence[str]backup_ periods - Full backup period. It is recommended to select at least 2 days for full backup every week. Multiple values are separated by English commas (,). Values: Monday. Tuesday. Wednesday. Thursday. Friday. Saturday. Sunday. When modifying the data backup policy, this parameter needs to be passed in.
- data_
full_ intbackup_ start_ utc_ hour - The start point (UTC time) of the time window for starting the full backup task. The time window length is 1 hour. Explanation: Both DataFullBackupStartUTCHour and DataFullBackupTime can be used to indicate the full backup time period of an instance. DataFullBackupStartUTCHour has higher priority. If both fields are returned at the same time, DataFullBackupStartUTCHour shall prevail.
- data_
full_ strbackup_ time - Time window for executing backup tasks is one hour. Format: HH:mmZ-HH:mmZ (UTC time). Explanation: This parameter needs to be passed in when modifying the data backup policy.
- data_
incr_ Sequence[str]backup_ periods - Incremental backup period. Multiple values are separated by commas (,). Values: Monday. Tuesday. Wednesday. Thursday. Friday. Saturday. Sunday.Description: The incremental backup period cannot conflict with the full backup. When modifying the data backup policy, this parameter needs to be passed in.
- data_
keep_ intdays_ after_ released - Backup retention days when an instance is released. Currently, only a value of 7 is supported.
- data_
keep_ strpolicy_ after_ released - Policy for retaining a backup of an instance after it is released. The values are: Last: Keep the last backup. Default value. All: Keep all backups of the instance.
- hourly_
incr_ boolbackup_ enable - Whether to enable high-frequency backup function. Values: true: Yes. false: No.
- incr_
backup_ inthour_ period - Frequency of performing high-frequency incremental backups. Values: 2: Perform an incremental backup every 2 hours. 4: Perform an incremental backup every 4 hours. 6: Perform an incremental backup every 6 hours. 12: Perform an incremental backup every 12 hours. Description: This parameter takes effect only when HourlyIncrBackupEnable is set to true.
- instance_
id str - The ID of the RDS instance.
- lock_
ddl_ inttime - Maximum waiting time for DDL. The default value is 30. The minimum value is 10. The maximum value is 1440. The unit is minutes. Description: Only instances of MySQL 8.0 version support this setting.
- log_
backup_ intretention_ day - Binlog backup retention period. The value range is 7 to 365, in days. Explanation: When modifying the log backup policy, this parameter needs to be passed in.
- retention_
policy_ boolsynced - Is the retention policy for log backups the same as that for data backups? Explanation: When the value is true, LogBackupRetentionDay and BinlogBackupAllRetention are ignored.
- binlog
Backup BooleanAll Retention - Whether to retain all log backups before releasing an instance. Values: true: Yes. false: No. Description: BinlogBackupAllRetention is ineffective when the value of RetentionPolicySynced is true.
- binlog
Backup BooleanEnabled - Whether to enable log backup function. Values: true: Yes. false: No.
- binlog
Backup BooleanEncryption Enabled - Is encryption enabled for log backups? Values: true: Yes. false: No.
- binlog
File BooleanCounts Enable - Whether to enable the upper limit of local Binlog retention. Values: true: Enabled. false: Disabled. Description:When modifying the log backup policy, this parameter needs to be passed in.
- binlog
Limit NumberCount - Number of local Binlog retained, ranging from 6 to 1000, in units of pieces. Automatically delete local logs that exceed the retained number. Explanation: When modifying the log backup policy, this parameter needs to be passed in.
- binlog
Local NumberRetention Hour - Local Binlog retention duration, with a value ranging from 0 to 168, in hours. Local logs exceeding the retention duration will be automatically deleted. When set to 0, local logs will not be automatically deleted. Note: When modifying the log backup policy, this parameter needs to be passed.
- binlog
Space BooleanLimit Enable - Whether to enable automatic cleanup of Binlog when space is too large. When the total storage space occupancy rate of the instance exceeds 80% or the remaining space is less than 5GB, the system will automatically start cleaning up the earliest local Binlog until the total space occupancy rate is lower than 80% and the remaining space is greater than 5GB. true: Enabled. false: Disabled. Description: This parameter needs to be passed in when modifying the log backup policy.
- binlog
Storage NumberPercentage - Maximum storage space usage rate can be set to 20% - 50%. After exceeding this limit, the earliest Binlog file will be automatically deleted until the space usage rate is lower than this ratio. Local Binlog space usage rate = Local Binlog size / Total available (purchased) instance space size. When modifying the log backup policy, this parameter needs to be passed in. Explanation: When modifying the log backup policy, this parameter needs to be passed in.
- data
Backup BooleanAll Retention - Whether to retain all data backups before releasing the instance. Values: true: Yes. false: No.
- data
Backup BooleanEncryption Enabled - Whether to enable encryption for data backup. Values: true: Yes. false: No.
- data
Backup NumberRetention Day - Data backup retention days, value range: 7 to 365 days. Default retention is 7 days.
- data
Full List<String>Backup Periods - Full backup period. It is recommended to select at least 2 days for full backup every week. Multiple values are separated by English commas (,). Values: Monday. Tuesday. Wednesday. Thursday. Friday. Saturday. Sunday. When modifying the data backup policy, this parameter needs to be passed in.
- data
Full NumberBackup Start Utc Hour - The start point (UTC time) of the time window for starting the full backup task. The time window length is 1 hour. Explanation: Both DataFullBackupStartUTCHour and DataFullBackupTime can be used to indicate the full backup time period of an instance. DataFullBackupStartUTCHour has higher priority. If both fields are returned at the same time, DataFullBackupStartUTCHour shall prevail.
- data
Full StringBackup Time - Time window for executing backup tasks is one hour. Format: HH:mmZ-HH:mmZ (UTC time). Explanation: This parameter needs to be passed in when modifying the data backup policy.
- data
Incr List<String>Backup Periods - Incremental backup period. Multiple values are separated by commas (,). Values: Monday. Tuesday. Wednesday. Thursday. Friday. Saturday. Sunday.Description: The incremental backup period cannot conflict with the full backup. When modifying the data backup policy, this parameter needs to be passed in.
- data
Keep NumberDays After Released - Backup retention days when an instance is released. Currently, only a value of 7 is supported.
- data
Keep StringPolicy After Released - Policy for retaining a backup of an instance after it is released. The values are: Last: Keep the last backup. Default value. All: Keep all backups of the instance.
- hourly
Incr BooleanBackup Enable - Whether to enable high-frequency backup function. Values: true: Yes. false: No.
- incr
Backup NumberHour Period - Frequency of performing high-frequency incremental backups. Values: 2: Perform an incremental backup every 2 hours. 4: Perform an incremental backup every 4 hours. 6: Perform an incremental backup every 6 hours. 12: Perform an incremental backup every 12 hours. Description: This parameter takes effect only when HourlyIncrBackupEnable is set to true.
- instance
Id String - The ID of the RDS instance.
- lock
Ddl NumberTime - Maximum waiting time for DDL. The default value is 30. The minimum value is 10. The maximum value is 1440. The unit is minutes. Description: Only instances of MySQL 8.0 version support this setting.
- log
Backup NumberRetention Day - Binlog backup retention period. The value range is 7 to 365, in days. Explanation: When modifying the log backup policy, this parameter needs to be passed in.
- retention
Policy BooleanSynced - Is the retention policy for log backups the same as that for data backups? Explanation: When the value is true, LogBackupRetentionDay and BinlogBackupAllRetention are ignored.
Import
RdsMysqlBackupPolicy can be imported using the id, e.g.
$ pulumi import volcengine:rds_mysql/backupPolicy:BackupPolicy default instanceId:backupPolicy
Warning:The resource cannot be deleted, and the destroy operation will not perform any actions.
To learn more about importing existing cloud resources, see Importing resources.
Package Details
- Repository
- volcengine volcengine/pulumi-volcengine
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
volcengine
Terraform Provider.