Docs Packages
  1. Packages
  2. Alibaba Cloud
  3. API Docs
  4. polardb
  5. BackupPolicy
Alibaba Cloud v3.43.1 published on Monday, Sep 11, 2023 by Pulumi
pulumi/pulumi-alicloud

alicloud.polardb.BackupPolicy

Explore with Pulumi AI

alicloud logo
Alibaba Cloud v3.43.1 published on Monday, Sep 11, 2023 by Pulumi
pulumi/pulumi-alicloud

    Import

    PolarDB backup policy can be imported using the id or cluster id, e.g.

     $ pulumi import alicloud:polardb/backupPolicy:BackupPolicy example "rm-12345678"

    Create BackupPolicy Resource

    new BackupPolicy(name: string, args: BackupPolicyArgs, opts?: CustomResourceOptions);
    @overload
def BackupPolicy(resource_name: str,
                 opts: Optional[ResourceOptions] = None,
                 backup_frequency: Optional[str] = None,
                 backup_retention_period: Optional[str] = None,
                 backup_retention_policy_on_cluster_deletion: Optional[str] = None,
                 data_level1_backup_frequency: Optional[str] = None,
                 data_level1_backup_periods: Optional[Sequence[str]] = None,
                 data_level1_backup_retention_period: Optional[int] = None,
                 data_level1_backup_time: Optional[str] = None,
                 data_level2_backup_another_region_region: Optional[str] = None,
                 data_level2_backup_another_region_retention_period: Optional[int] = None,
                 data_level2_backup_periods: Optional[Sequence[str]] = None,
                 data_level2_backup_retention_period: Optional[int] = None,
                 db_cluster_id: Optional[str] = None,
                 enable_backup_log: Optional[int] = None,
                 log_backup_another_region_region: Optional[str] = None,
                 log_backup_another_region_retention_period: Optional[int] = None,
                 log_backup_retention_period: Optional[int] = None,
                 preferred_backup_periods: Optional[Sequence[str]] = None,
                 preferred_backup_time: Optional[str] = None)
@overload
def BackupPolicy(resource_name: str,
                 args: BackupPolicyArgs,
                 opts: Optional[ResourceOptions] = 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: alicloud:polardb:BackupPolicy
properties: # The arguments to resource properties.
options: # 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.
    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.

    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

    The BackupPolicy resource accepts the following input properties:

    DbClusterId string

    The Id of cluster that can run database.

    BackupFrequency string

    The backup frequency. Valid values are Normal, 2/24H, 3/24H, 4/24H.Default to Normal.

    BackupRetentionPeriod string

    Cluster backup retention days, Fixed for 7 days, not modified.

    BackupRetentionPolicyOnClusterDeletion string

    Specifies whether to retain backups when you delete a cluster. Valid values are ALL, LATEST, NONE. Default to NONE. Value options can refer to the latest docs ModifyBackupPolicy

    DataLevel1BackupFrequency string

    The Id of cluster that can run database.The backup frequency. Valid values are Normal, 2/24H, 3/24H, 4/24H.Default to Normal.

    DataLevel1BackupPeriods List<string>

    PolarDB Cluster of level-1 backup period. Valid values: ["Monday", "Tuesday", "Wednesday", "Thursday", "Friday", "Saturday", "Sunday"].

    NOTE: Note Select at least two values. Separate multiple values with commas (,).

    DataLevel1BackupRetentionPeriod int

    The retention period of level-1 backups. Valid values: 3 to 14. Unit: days.

    DataLevel1BackupTime string

    The time period during which automatic backup is performed. The format is HH: MMZ HH: MMZ (UTC time), and the entered value must be an hour apart, such as 14:00z-15:00z.

    DataLevel2BackupAnotherRegionRegion string

    PolarDB Cluster of level-2 backup is a cross regional backup area.

    DataLevel2BackupAnotherRegionRetentionPeriod int

    PolarDB Cluster of level-2 backup cross region backup retention period. Valid values are 0, 30 to 7300, -1. Default to 0.

    DataLevel2BackupPeriods List<string>

    PolarDB Cluster of level-2 backup period. Valid values: ["Monday", "Tuesday", "Wednesday", "Thursday", "Friday", "Saturday", "Sunday"].

    NOTE: Note Select at least two values. Separate multiple values with commas (,).

    DataLevel2BackupRetentionPeriod int

    The retention period of level-2 backups. Valid values are 0, 30 to 7300, -1. Default to 0.

    EnableBackupLog int

    Indicates whether the log backup feature was enabled. Valid values are 0, 1. 1 By default, the log backup feature is enabled and cannot be disabled.

    LogBackupAnotherRegionRegion string

    The region in which you want to store cross-region log backups. For information about regions that support the cross-region backup feature, see Overview.

    LogBackupAnotherRegionRetentionPeriod int

    The retention period of cross-region log backups. Default value: OFF. Valid values are 0, 30 to 7300, -1.

    NOTE: Note When you create a cluster, the default value of this parameter is 0.

    LogBackupRetentionPeriod int

    The retention period of the log backups. Valid values are 3 to 7300, -1.

    PreferredBackupPeriods List<string>

    PolarDB Cluster backup period. Valid values: ["Monday", "Tuesday", "Wednesday", "Thursday", "Friday", "Saturday", "Sunday"]. Default to ["Tuesday", "Thursday", "Saturday"].

    PreferredBackupTime string

    PolarDB Cluster backup time, in the format of HH:mmZ- HH:mmZ. Time setting interval is one hour. Default to "02:00Z-03:00Z". China time is 8 hours behind it.

    DbClusterId string

    The Id of cluster that can run database.

    BackupFrequency string

    The backup frequency. Valid values are Normal, 2/24H, 3/24H, 4/24H.Default to Normal.

    BackupRetentionPeriod string

    Cluster backup retention days, Fixed for 7 days, not modified.

    BackupRetentionPolicyOnClusterDeletion string

    Specifies whether to retain backups when you delete a cluster. Valid values are ALL, LATEST, NONE. Default to NONE. Value options can refer to the latest docs ModifyBackupPolicy

    DataLevel1BackupFrequency string

    The Id of cluster that can run database.The backup frequency. Valid values are Normal, 2/24H, 3/24H, 4/24H.Default to Normal.

    DataLevel1BackupPeriods []string

    PolarDB Cluster of level-1 backup period. Valid values: ["Monday", "Tuesday", "Wednesday", "Thursday", "Friday", "Saturday", "Sunday"].

    NOTE: Note Select at least two values. Separate multiple values with commas (,).

    DataLevel1BackupRetentionPeriod int

    The retention period of level-1 backups. Valid values: 3 to 14. Unit: days.

    DataLevel1BackupTime string

    The time period during which automatic backup is performed. The format is HH: MMZ HH: MMZ (UTC time), and the entered value must be an hour apart, such as 14:00z-15:00z.

    DataLevel2BackupAnotherRegionRegion string

    PolarDB Cluster of level-2 backup is a cross regional backup area.

    DataLevel2BackupAnotherRegionRetentionPeriod int

    PolarDB Cluster of level-2 backup cross region backup retention period. Valid values are 0, 30 to 7300, -1. Default to 0.

    DataLevel2BackupPeriods []string

    PolarDB Cluster of level-2 backup period. Valid values: ["Monday", "Tuesday", "Wednesday", "Thursday", "Friday", "Saturday", "Sunday"].

    NOTE: Note Select at least two values. Separate multiple values with commas (,).

    DataLevel2BackupRetentionPeriod int

    The retention period of level-2 backups. Valid values are 0, 30 to 7300, -1. Default to 0.

    EnableBackupLog int

    Indicates whether the log backup feature was enabled. Valid values are 0, 1. 1 By default, the log backup feature is enabled and cannot be disabled.

    LogBackupAnotherRegionRegion string

    The region in which you want to store cross-region log backups. For information about regions that support the cross-region backup feature, see Overview.

    LogBackupAnotherRegionRetentionPeriod int

    The retention period of cross-region log backups. Default value: OFF. Valid values are 0, 30 to 7300, -1.

    NOTE: Note When you create a cluster, the default value of this parameter is 0.

    LogBackupRetentionPeriod int

    The retention period of the log backups. Valid values are 3 to 7300, -1.

    PreferredBackupPeriods []string

    PolarDB Cluster backup period. Valid values: ["Monday", "Tuesday", "Wednesday", "Thursday", "Friday", "Saturday", "Sunday"]. Default to ["Tuesday", "Thursday", "Saturday"].

    PreferredBackupTime string

    PolarDB Cluster backup time, in the format of HH:mmZ- HH:mmZ. Time setting interval is one hour. Default to "02:00Z-03:00Z". China time is 8 hours behind it.

    dbClusterId String

    The Id of cluster that can run database.

    backupFrequency String

    The backup frequency. Valid values are Normal, 2/24H, 3/24H, 4/24H.Default to Normal.

    backupRetentionPeriod String

    Cluster backup retention days, Fixed for 7 days, not modified.

    backupRetentionPolicyOnClusterDeletion String

    Specifies whether to retain backups when you delete a cluster. Valid values are ALL, LATEST, NONE. Default to NONE. Value options can refer to the latest docs ModifyBackupPolicy

    dataLevel1BackupFrequency String

    The Id of cluster that can run database.The backup frequency. Valid values are Normal, 2/24H, 3/24H, 4/24H.Default to Normal.

    dataLevel1BackupPeriods List<String>

    PolarDB Cluster of level-1 backup period. Valid values: ["Monday", "Tuesday", "Wednesday", "Thursday", "Friday", "Saturday", "Sunday"].

    NOTE: Note Select at least two values. Separate multiple values with commas (,).

    dataLevel1BackupRetentionPeriod Integer

    The retention period of level-1 backups. Valid values: 3 to 14. Unit: days.

    dataLevel1BackupTime String

    The time period during which automatic backup is performed. The format is HH: MMZ HH: MMZ (UTC time), and the entered value must be an hour apart, such as 14:00z-15:00z.

    dataLevel2BackupAnotherRegionRegion String

    PolarDB Cluster of level-2 backup is a cross regional backup area.

    dataLevel2BackupAnotherRegionRetentionPeriod Integer

    PolarDB Cluster of level-2 backup cross region backup retention period. Valid values are 0, 30 to 7300, -1. Default to 0.

    dataLevel2BackupPeriods List<String>

    PolarDB Cluster of level-2 backup period. Valid values: ["Monday", "Tuesday", "Wednesday", "Thursday", "Friday", "Saturday", "Sunday"].

    NOTE: Note Select at least two values. Separate multiple values with commas (,).

    dataLevel2BackupRetentionPeriod Integer

    The retention period of level-2 backups. Valid values are 0, 30 to 7300, -1. Default to 0.

    enableBackupLog Integer

    Indicates whether the log backup feature was enabled. Valid values are 0, 1. 1 By default, the log backup feature is enabled and cannot be disabled.

    logBackupAnotherRegionRegion String

    The region in which you want to store cross-region log backups. For information about regions that support the cross-region backup feature, see Overview.

    logBackupAnotherRegionRetentionPeriod Integer

    The retention period of cross-region log backups. Default value: OFF. Valid values are 0, 30 to 7300, -1.

    NOTE: Note When you create a cluster, the default value of this parameter is 0.

    logBackupRetentionPeriod Integer

    The retention period of the log backups. Valid values are 3 to 7300, -1.

    preferredBackupPeriods List<String>

    PolarDB Cluster backup period. Valid values: ["Monday", "Tuesday", "Wednesday", "Thursday", "Friday", "Saturday", "Sunday"]. Default to ["Tuesday", "Thursday", "Saturday"].

    preferredBackupTime String

    PolarDB Cluster backup time, in the format of HH:mmZ- HH:mmZ. Time setting interval is one hour. Default to "02:00Z-03:00Z". China time is 8 hours behind it.

    dbClusterId string

    The Id of cluster that can run database.

    backupFrequency string

    The backup frequency. Valid values are Normal, 2/24H, 3/24H, 4/24H.Default to Normal.

    backupRetentionPeriod string

    Cluster backup retention days, Fixed for 7 days, not modified.

    backupRetentionPolicyOnClusterDeletion string

    Specifies whether to retain backups when you delete a cluster. Valid values are ALL, LATEST, NONE. Default to NONE. Value options can refer to the latest docs ModifyBackupPolicy

    dataLevel1BackupFrequency string

    The Id of cluster that can run database.The backup frequency. Valid values are Normal, 2/24H, 3/24H, 4/24H.Default to Normal.

    dataLevel1BackupPeriods string[]

    PolarDB Cluster of level-1 backup period. Valid values: ["Monday", "Tuesday", "Wednesday", "Thursday", "Friday", "Saturday", "Sunday"].

    NOTE: Note Select at least two values. Separate multiple values with commas (,).

    dataLevel1BackupRetentionPeriod number

    The retention period of level-1 backups. Valid values: 3 to 14. Unit: days.

    dataLevel1BackupTime string

    The time period during which automatic backup is performed. The format is HH: MMZ HH: MMZ (UTC time), and the entered value must be an hour apart, such as 14:00z-15:00z.

    dataLevel2BackupAnotherRegionRegion string

    PolarDB Cluster of level-2 backup is a cross regional backup area.

    dataLevel2BackupAnotherRegionRetentionPeriod number

    PolarDB Cluster of level-2 backup cross region backup retention period. Valid values are 0, 30 to 7300, -1. Default to 0.

    dataLevel2BackupPeriods string[]

    PolarDB Cluster of level-2 backup period. Valid values: ["Monday", "Tuesday", "Wednesday", "Thursday", "Friday", "Saturday", "Sunday"].

    NOTE: Note Select at least two values. Separate multiple values with commas (,).

    dataLevel2BackupRetentionPeriod number

    The retention period of level-2 backups. Valid values are 0, 30 to 7300, -1. Default to 0.

    enableBackupLog number

    Indicates whether the log backup feature was enabled. Valid values are 0, 1. 1 By default, the log backup feature is enabled and cannot be disabled.

    logBackupAnotherRegionRegion string

    The region in which you want to store cross-region log backups. For information about regions that support the cross-region backup feature, see Overview.

    logBackupAnotherRegionRetentionPeriod number

    The retention period of cross-region log backups. Default value: OFF. Valid values are 0, 30 to 7300, -1.

    NOTE: Note When you create a cluster, the default value of this parameter is 0.

    logBackupRetentionPeriod number

    The retention period of the log backups. Valid values are 3 to 7300, -1.

    preferredBackupPeriods string[]

    PolarDB Cluster backup period. Valid values: ["Monday", "Tuesday", "Wednesday", "Thursday", "Friday", "Saturday", "Sunday"]. Default to ["Tuesday", "Thursday", "Saturday"].

    preferredBackupTime string

    PolarDB Cluster backup time, in the format of HH:mmZ- HH:mmZ. Time setting interval is one hour. Default to "02:00Z-03:00Z". China time is 8 hours behind it.

    db_cluster_id str

    The Id of cluster that can run database.

    backup_frequency str

    The backup frequency. Valid values are Normal, 2/24H, 3/24H, 4/24H.Default to Normal.

    backup_retention_period str

    Cluster backup retention days, Fixed for 7 days, not modified.

    backup_retention_policy_on_cluster_deletion str

    Specifies whether to retain backups when you delete a cluster. Valid values are ALL, LATEST, NONE. Default to NONE. Value options can refer to the latest docs ModifyBackupPolicy

    data_level1_backup_frequency str

    The Id of cluster that can run database.The backup frequency. Valid values are Normal, 2/24H, 3/24H, 4/24H.Default to Normal.

    data_level1_backup_periods Sequence[str]

    PolarDB Cluster of level-1 backup period. Valid values: ["Monday", "Tuesday", "Wednesday", "Thursday", "Friday", "Saturday", "Sunday"].

    NOTE: Note Select at least two values. Separate multiple values with commas (,).

    data_level1_backup_retention_period int

    The retention period of level-1 backups. Valid values: 3 to 14. Unit: days.

    data_level1_backup_time str

    The time period during which automatic backup is performed. The format is HH: MMZ HH: MMZ (UTC time), and the entered value must be an hour apart, such as 14:00z-15:00z.

    data_level2_backup_another_region_region str

    PolarDB Cluster of level-2 backup is a cross regional backup area.

    data_level2_backup_another_region_retention_period int

    PolarDB Cluster of level-2 backup cross region backup retention period. Valid values are 0, 30 to 7300, -1. Default to 0.

    data_level2_backup_periods Sequence[str]

    PolarDB Cluster of level-2 backup period. Valid values: ["Monday", "Tuesday", "Wednesday", "Thursday", "Friday", "Saturday", "Sunday"].

    NOTE: Note Select at least two values. Separate multiple values with commas (,).

    data_level2_backup_retention_period int

    The retention period of level-2 backups. Valid values are 0, 30 to 7300, -1. Default to 0.

    enable_backup_log int

    Indicates whether the log backup feature was enabled. Valid values are 0, 1. 1 By default, the log backup feature is enabled and cannot be disabled.

    log_backup_another_region_region str

    The region in which you want to store cross-region log backups. For information about regions that support the cross-region backup feature, see Overview.

    log_backup_another_region_retention_period int

    The retention period of cross-region log backups. Default value: OFF. Valid values are 0, 30 to 7300, -1.

    NOTE: Note When you create a cluster, the default value of this parameter is 0.

    log_backup_retention_period int

    The retention period of the log backups. Valid values are 3 to 7300, -1.

    preferred_backup_periods Sequence[str]

    PolarDB Cluster backup period. Valid values: ["Monday", "Tuesday", "Wednesday", "Thursday", "Friday", "Saturday", "Sunday"]. Default to ["Tuesday", "Thursday", "Saturday"].

    preferred_backup_time str

    PolarDB Cluster backup time, in the format of HH:mmZ- HH:mmZ. Time setting interval is one hour. Default to "02:00Z-03:00Z". China time is 8 hours behind it.

    dbClusterId String

    The Id of cluster that can run database.

    backupFrequency String

    The backup frequency. Valid values are Normal, 2/24H, 3/24H, 4/24H.Default to Normal.

    backupRetentionPeriod String

    Cluster backup retention days, Fixed for 7 days, not modified.

    backupRetentionPolicyOnClusterDeletion String

    Specifies whether to retain backups when you delete a cluster. Valid values are ALL, LATEST, NONE. Default to NONE. Value options can refer to the latest docs ModifyBackupPolicy

    dataLevel1BackupFrequency String

    The Id of cluster that can run database.The backup frequency. Valid values are Normal, 2/24H, 3/24H, 4/24H.Default to Normal.

    dataLevel1BackupPeriods List<String>

    PolarDB Cluster of level-1 backup period. Valid values: ["Monday", "Tuesday", "Wednesday", "Thursday", "Friday", "Saturday", "Sunday"].

    NOTE: Note Select at least two values. Separate multiple values with commas (,).

    dataLevel1BackupRetentionPeriod Number

    The retention period of level-1 backups. Valid values: 3 to 14. Unit: days.

    dataLevel1BackupTime String

    The time period during which automatic backup is performed. The format is HH: MMZ HH: MMZ (UTC time), and the entered value must be an hour apart, such as 14:00z-15:00z.

    dataLevel2BackupAnotherRegionRegion String

    PolarDB Cluster of level-2 backup is a cross regional backup area.

    dataLevel2BackupAnotherRegionRetentionPeriod Number

    PolarDB Cluster of level-2 backup cross region backup retention period. Valid values are 0, 30 to 7300, -1. Default to 0.

    dataLevel2BackupPeriods List<String>

    PolarDB Cluster of level-2 backup period. Valid values: ["Monday", "Tuesday", "Wednesday", "Thursday", "Friday", "Saturday", "Sunday"].

    NOTE: Note Select at least two values. Separate multiple values with commas (,).

    dataLevel2BackupRetentionPeriod Number

    The retention period of level-2 backups. Valid values are 0, 30 to 7300, -1. Default to 0.

    enableBackupLog Number

    Indicates whether the log backup feature was enabled. Valid values are 0, 1. 1 By default, the log backup feature is enabled and cannot be disabled.

    logBackupAnotherRegionRegion String

    The region in which you want to store cross-region log backups. For information about regions that support the cross-region backup feature, see Overview.

    logBackupAnotherRegionRetentionPeriod Number

    The retention period of cross-region log backups. Default value: OFF. Valid values are 0, 30 to 7300, -1.

    NOTE: Note When you create a cluster, the default value of this parameter is 0.

    logBackupRetentionPeriod Number

    The retention period of the log backups. Valid values are 3 to 7300, -1.

    preferredBackupPeriods List<String>

    PolarDB Cluster backup period. Valid values: ["Monday", "Tuesday", "Wednesday", "Thursday", "Friday", "Saturday", "Sunday"]. Default to ["Tuesday", "Thursday", "Saturday"].

    preferredBackupTime String

    PolarDB Cluster backup time, in the format of HH:mmZ- HH:mmZ. Time setting interval is one hour. Default to "02:00Z-03:00Z". China time is 8 hours behind it.

    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,
        backup_frequency: Optional[str] = None,
        backup_retention_period: Optional[str] = None,
        backup_retention_policy_on_cluster_deletion: Optional[str] = None,
        data_level1_backup_frequency: Optional[str] = None,
        data_level1_backup_periods: Optional[Sequence[str]] = None,
        data_level1_backup_retention_period: Optional[int] = None,
        data_level1_backup_time: Optional[str] = None,
        data_level2_backup_another_region_region: Optional[str] = None,
        data_level2_backup_another_region_retention_period: Optional[int] = None,
        data_level2_backup_periods: Optional[Sequence[str]] = None,
        data_level2_backup_retention_period: Optional[int] = None,
        db_cluster_id: Optional[str] = None,
        enable_backup_log: Optional[int] = None,
        log_backup_another_region_region: Optional[str] = None,
        log_backup_another_region_retention_period: Optional[int] = None,
        log_backup_retention_period: Optional[int] = None,
        preferred_backup_periods: Optional[Sequence[str]] = None,
        preferred_backup_time: Optional[str] = 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)
    Resource lookup is not supported in YAML
    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:
    BackupFrequency string

    The backup frequency. Valid values are Normal, 2/24H, 3/24H, 4/24H.Default to Normal.

    BackupRetentionPeriod string

    Cluster backup retention days, Fixed for 7 days, not modified.

    BackupRetentionPolicyOnClusterDeletion string

    Specifies whether to retain backups when you delete a cluster. Valid values are ALL, LATEST, NONE. Default to NONE. Value options can refer to the latest docs ModifyBackupPolicy

    DataLevel1BackupFrequency string

    The Id of cluster that can run database.The backup frequency. Valid values are Normal, 2/24H, 3/24H, 4/24H.Default to Normal.

    DataLevel1BackupPeriods List<string>

    PolarDB Cluster of level-1 backup period. Valid values: ["Monday", "Tuesday", "Wednesday", "Thursday", "Friday", "Saturday", "Sunday"].

    NOTE: Note Select at least two values. Separate multiple values with commas (,).

    DataLevel1BackupRetentionPeriod int

    The retention period of level-1 backups. Valid values: 3 to 14. Unit: days.

    DataLevel1BackupTime string

    The time period during which automatic backup is performed. The format is HH: MMZ HH: MMZ (UTC time), and the entered value must be an hour apart, such as 14:00z-15:00z.

    DataLevel2BackupAnotherRegionRegion string

    PolarDB Cluster of level-2 backup is a cross regional backup area.

    DataLevel2BackupAnotherRegionRetentionPeriod int

    PolarDB Cluster of level-2 backup cross region backup retention period. Valid values are 0, 30 to 7300, -1. Default to 0.

    DataLevel2BackupPeriods List<string>

    PolarDB Cluster of level-2 backup period. Valid values: ["Monday", "Tuesday", "Wednesday", "Thursday", "Friday", "Saturday", "Sunday"].

    NOTE: Note Select at least two values. Separate multiple values with commas (,).

    DataLevel2BackupRetentionPeriod int

    The retention period of level-2 backups. Valid values are 0, 30 to 7300, -1. Default to 0.

    DbClusterId string

    The Id of cluster that can run database.

    EnableBackupLog int

    Indicates whether the log backup feature was enabled. Valid values are 0, 1. 1 By default, the log backup feature is enabled and cannot be disabled.

    LogBackupAnotherRegionRegion string

    The region in which you want to store cross-region log backups. For information about regions that support the cross-region backup feature, see Overview.

    LogBackupAnotherRegionRetentionPeriod int

    The retention period of cross-region log backups. Default value: OFF. Valid values are 0, 30 to 7300, -1.

    NOTE: Note When you create a cluster, the default value of this parameter is 0.

    LogBackupRetentionPeriod int

    The retention period of the log backups. Valid values are 3 to 7300, -1.

    PreferredBackupPeriods List<string>

    PolarDB Cluster backup period. Valid values: ["Monday", "Tuesday", "Wednesday", "Thursday", "Friday", "Saturday", "Sunday"]. Default to ["Tuesday", "Thursday", "Saturday"].

    PreferredBackupTime string

    PolarDB Cluster backup time, in the format of HH:mmZ- HH:mmZ. Time setting interval is one hour. Default to "02:00Z-03:00Z". China time is 8 hours behind it.

    BackupFrequency string

    The backup frequency. Valid values are Normal, 2/24H, 3/24H, 4/24H.Default to Normal.

    BackupRetentionPeriod string

    Cluster backup retention days, Fixed for 7 days, not modified.

    BackupRetentionPolicyOnClusterDeletion string

    Specifies whether to retain backups when you delete a cluster. Valid values are ALL, LATEST, NONE. Default to NONE. Value options can refer to the latest docs ModifyBackupPolicy

    DataLevel1BackupFrequency string

    The Id of cluster that can run database.The backup frequency. Valid values are Normal, 2/24H, 3/24H, 4/24H.Default to Normal.

    DataLevel1BackupPeriods []string

    PolarDB Cluster of level-1 backup period. Valid values: ["Monday", "Tuesday", "Wednesday", "Thursday", "Friday", "Saturday", "Sunday"].

    NOTE: Note Select at least two values. Separate multiple values with commas (,).

    DataLevel1BackupRetentionPeriod int

    The retention period of level-1 backups. Valid values: 3 to 14. Unit: days.

    DataLevel1BackupTime string

    The time period during which automatic backup is performed. The format is HH: MMZ HH: MMZ (UTC time), and the entered value must be an hour apart, such as 14:00z-15:00z.

    DataLevel2BackupAnotherRegionRegion string

    PolarDB Cluster of level-2 backup is a cross regional backup area.

    DataLevel2BackupAnotherRegionRetentionPeriod int

    PolarDB Cluster of level-2 backup cross region backup retention period. Valid values are 0, 30 to 7300, -1. Default to 0.

    DataLevel2BackupPeriods []string

    PolarDB Cluster of level-2 backup period. Valid values: ["Monday", "Tuesday", "Wednesday", "Thursday", "Friday", "Saturday", "Sunday"].

    NOTE: Note Select at least two values. Separate multiple values with commas (,).

    DataLevel2BackupRetentionPeriod int

    The retention period of level-2 backups. Valid values are 0, 30 to 7300, -1. Default to 0.

    DbClusterId string

    The Id of cluster that can run database.

    EnableBackupLog int

    Indicates whether the log backup feature was enabled. Valid values are 0, 1. 1 By default, the log backup feature is enabled and cannot be disabled.

    LogBackupAnotherRegionRegion string

    The region in which you want to store cross-region log backups. For information about regions that support the cross-region backup feature, see Overview.

    LogBackupAnotherRegionRetentionPeriod int

    The retention period of cross-region log backups. Default value: OFF. Valid values are 0, 30 to 7300, -1.

    NOTE: Note When you create a cluster, the default value of this parameter is 0.

    LogBackupRetentionPeriod int

    The retention period of the log backups. Valid values are 3 to 7300, -1.

    PreferredBackupPeriods []string

    PolarDB Cluster backup period. Valid values: ["Monday", "Tuesday", "Wednesday", "Thursday", "Friday", "Saturday", "Sunday"]. Default to ["Tuesday", "Thursday", "Saturday"].

    PreferredBackupTime string

    PolarDB Cluster backup time, in the format of HH:mmZ- HH:mmZ. Time setting interval is one hour. Default to "02:00Z-03:00Z". China time is 8 hours behind it.

    backupFrequency String

    The backup frequency. Valid values are Normal, 2/24H, 3/24H, 4/24H.Default to Normal.

    backupRetentionPeriod String

    Cluster backup retention days, Fixed for 7 days, not modified.

    backupRetentionPolicyOnClusterDeletion String

    Specifies whether to retain backups when you delete a cluster. Valid values are ALL, LATEST, NONE. Default to NONE. Value options can refer to the latest docs ModifyBackupPolicy

    dataLevel1BackupFrequency String

    The Id of cluster that can run database.The backup frequency. Valid values are Normal, 2/24H, 3/24H, 4/24H.Default to Normal.

    dataLevel1BackupPeriods List<String>

    PolarDB Cluster of level-1 backup period. Valid values: ["Monday", "Tuesday", "Wednesday", "Thursday", "Friday", "Saturday", "Sunday"].

    NOTE: Note Select at least two values. Separate multiple values with commas (,).

    dataLevel1BackupRetentionPeriod Integer

    The retention period of level-1 backups. Valid values: 3 to 14. Unit: days.

    dataLevel1BackupTime String

    The time period during which automatic backup is performed. The format is HH: MMZ HH: MMZ (UTC time), and the entered value must be an hour apart, such as 14:00z-15:00z.

    dataLevel2BackupAnotherRegionRegion String

    PolarDB Cluster of level-2 backup is a cross regional backup area.

    dataLevel2BackupAnotherRegionRetentionPeriod Integer

    PolarDB Cluster of level-2 backup cross region backup retention period. Valid values are 0, 30 to 7300, -1. Default to 0.

    dataLevel2BackupPeriods List<String>

    PolarDB Cluster of level-2 backup period. Valid values: ["Monday", "Tuesday", "Wednesday", "Thursday", "Friday", "Saturday", "Sunday"].

    NOTE: Note Select at least two values. Separate multiple values with commas (,).

    dataLevel2BackupRetentionPeriod Integer

    The retention period of level-2 backups. Valid values are 0, 30 to 7300, -1. Default to 0.

    dbClusterId String

    The Id of cluster that can run database.

    enableBackupLog Integer

    Indicates whether the log backup feature was enabled. Valid values are 0, 1. 1 By default, the log backup feature is enabled and cannot be disabled.

    logBackupAnotherRegionRegion String

    The region in which you want to store cross-region log backups. For information about regions that support the cross-region backup feature, see Overview.

    logBackupAnotherRegionRetentionPeriod Integer

    The retention period of cross-region log backups. Default value: OFF. Valid values are 0, 30 to 7300, -1.

    NOTE: Note When you create a cluster, the default value of this parameter is 0.

    logBackupRetentionPeriod Integer

    The retention period of the log backups. Valid values are 3 to 7300, -1.

    preferredBackupPeriods List<String>

    PolarDB Cluster backup period. Valid values: ["Monday", "Tuesday", "Wednesday", "Thursday", "Friday", "Saturday", "Sunday"]. Default to ["Tuesday", "Thursday", "Saturday"].

    preferredBackupTime String

    PolarDB Cluster backup time, in the format of HH:mmZ- HH:mmZ. Time setting interval is one hour. Default to "02:00Z-03:00Z". China time is 8 hours behind it.

    backupFrequency string

    The backup frequency. Valid values are Normal, 2/24H, 3/24H, 4/24H.Default to Normal.

    backupRetentionPeriod string

    Cluster backup retention days, Fixed for 7 days, not modified.

    backupRetentionPolicyOnClusterDeletion string

    Specifies whether to retain backups when you delete a cluster. Valid values are ALL, LATEST, NONE. Default to NONE. Value options can refer to the latest docs ModifyBackupPolicy

    dataLevel1BackupFrequency string

    The Id of cluster that can run database.The backup frequency. Valid values are Normal, 2/24H, 3/24H, 4/24H.Default to Normal.

    dataLevel1BackupPeriods string[]

    PolarDB Cluster of level-1 backup period. Valid values: ["Monday", "Tuesday", "Wednesday", "Thursday", "Friday", "Saturday", "Sunday"].

    NOTE: Note Select at least two values. Separate multiple values with commas (,).

    dataLevel1BackupRetentionPeriod number

    The retention period of level-1 backups. Valid values: 3 to 14. Unit: days.

    dataLevel1BackupTime string

    The time period during which automatic backup is performed. The format is HH: MMZ HH: MMZ (UTC time), and the entered value must be an hour apart, such as 14:00z-15:00z.

    dataLevel2BackupAnotherRegionRegion string

    PolarDB Cluster of level-2 backup is a cross regional backup area.

    dataLevel2BackupAnotherRegionRetentionPeriod number

    PolarDB Cluster of level-2 backup cross region backup retention period. Valid values are 0, 30 to 7300, -1. Default to 0.

    dataLevel2BackupPeriods string[]

    PolarDB Cluster of level-2 backup period. Valid values: ["Monday", "Tuesday", "Wednesday", "Thursday", "Friday", "Saturday", "Sunday"].

    NOTE: Note Select at least two values. Separate multiple values with commas (,).

    dataLevel2BackupRetentionPeriod number

    The retention period of level-2 backups. Valid values are 0, 30 to 7300, -1. Default to 0.

    dbClusterId string

    The Id of cluster that can run database.

    enableBackupLog number

    Indicates whether the log backup feature was enabled. Valid values are 0, 1. 1 By default, the log backup feature is enabled and cannot be disabled.

    logBackupAnotherRegionRegion string

    The region in which you want to store cross-region log backups. For information about regions that support the cross-region backup feature, see Overview.

    logBackupAnotherRegionRetentionPeriod number

    The retention period of cross-region log backups. Default value: OFF. Valid values are 0, 30 to 7300, -1.

    NOTE: Note When you create a cluster, the default value of this parameter is 0.

    logBackupRetentionPeriod number

    The retention period of the log backups. Valid values are 3 to 7300, -1.

    preferredBackupPeriods string[]

    PolarDB Cluster backup period. Valid values: ["Monday", "Tuesday", "Wednesday", "Thursday", "Friday", "Saturday", "Sunday"]. Default to ["Tuesday", "Thursday", "Saturday"].

    preferredBackupTime string

    PolarDB Cluster backup time, in the format of HH:mmZ- HH:mmZ. Time setting interval is one hour. Default to "02:00Z-03:00Z". China time is 8 hours behind it.

    backup_frequency str

    The backup frequency. Valid values are Normal, 2/24H, 3/24H, 4/24H.Default to Normal.

    backup_retention_period str

    Cluster backup retention days, Fixed for 7 days, not modified.

    backup_retention_policy_on_cluster_deletion str

    Specifies whether to retain backups when you delete a cluster. Valid values are ALL, LATEST, NONE. Default to NONE. Value options can refer to the latest docs ModifyBackupPolicy

    data_level1_backup_frequency str

    The Id of cluster that can run database.The backup frequency. Valid values are Normal, 2/24H, 3/24H, 4/24H.Default to Normal.

    data_level1_backup_periods Sequence[str]

    PolarDB Cluster of level-1 backup period. Valid values: ["Monday", "Tuesday", "Wednesday", "Thursday", "Friday", "Saturday", "Sunday"].

    NOTE: Note Select at least two values. Separate multiple values with commas (,).

    data_level1_backup_retention_period int

    The retention period of level-1 backups. Valid values: 3 to 14. Unit: days.

    data_level1_backup_time str

    The time period during which automatic backup is performed. The format is HH: MMZ HH: MMZ (UTC time), and the entered value must be an hour apart, such as 14:00z-15:00z.

    data_level2_backup_another_region_region str

    PolarDB Cluster of level-2 backup is a cross regional backup area.

    data_level2_backup_another_region_retention_period int

    PolarDB Cluster of level-2 backup cross region backup retention period. Valid values are 0, 30 to 7300, -1. Default to 0.

    data_level2_backup_periods Sequence[str]

    PolarDB Cluster of level-2 backup period. Valid values: ["Monday", "Tuesday", "Wednesday", "Thursday", "Friday", "Saturday", "Sunday"].

    NOTE: Note Select at least two values. Separate multiple values with commas (,).

    data_level2_backup_retention_period int

    The retention period of level-2 backups. Valid values are 0, 30 to 7300, -1. Default to 0.

    db_cluster_id str

    The Id of cluster that can run database.

    enable_backup_log int

    Indicates whether the log backup feature was enabled. Valid values are 0, 1. 1 By default, the log backup feature is enabled and cannot be disabled.

    log_backup_another_region_region str

    The region in which you want to store cross-region log backups. For information about regions that support the cross-region backup feature, see Overview.

    log_backup_another_region_retention_period int

    The retention period of cross-region log backups. Default value: OFF. Valid values are 0, 30 to 7300, -1.

    NOTE: Note When you create a cluster, the default value of this parameter is 0.

    log_backup_retention_period int

    The retention period of the log backups. Valid values are 3 to 7300, -1.

    preferred_backup_periods Sequence[str]

    PolarDB Cluster backup period. Valid values: ["Monday", "Tuesday", "Wednesday", "Thursday", "Friday", "Saturday", "Sunday"]. Default to ["Tuesday", "Thursday", "Saturday"].

    preferred_backup_time str

    PolarDB Cluster backup time, in the format of HH:mmZ- HH:mmZ. Time setting interval is one hour. Default to "02:00Z-03:00Z". China time is 8 hours behind it.

    backupFrequency String

    The backup frequency. Valid values are Normal, 2/24H, 3/24H, 4/24H.Default to Normal.

    backupRetentionPeriod String

    Cluster backup retention days, Fixed for 7 days, not modified.

    backupRetentionPolicyOnClusterDeletion String

    Specifies whether to retain backups when you delete a cluster. Valid values are ALL, LATEST, NONE. Default to NONE. Value options can refer to the latest docs ModifyBackupPolicy

    dataLevel1BackupFrequency String

    The Id of cluster that can run database.The backup frequency. Valid values are Normal, 2/24H, 3/24H, 4/24H.Default to Normal.

    dataLevel1BackupPeriods List<String>

    PolarDB Cluster of level-1 backup period. Valid values: ["Monday", "Tuesday", "Wednesday", "Thursday", "Friday", "Saturday", "Sunday"].

    NOTE: Note Select at least two values. Separate multiple values with commas (,).

    dataLevel1BackupRetentionPeriod Number

    The retention period of level-1 backups. Valid values: 3 to 14. Unit: days.

    dataLevel1BackupTime String

    The time period during which automatic backup is performed. The format is HH: MMZ HH: MMZ (UTC time), and the entered value must be an hour apart, such as 14:00z-15:00z.

    dataLevel2BackupAnotherRegionRegion String

    PolarDB Cluster of level-2 backup is a cross regional backup area.

    dataLevel2BackupAnotherRegionRetentionPeriod Number

    PolarDB Cluster of level-2 backup cross region backup retention period. Valid values are 0, 30 to 7300, -1. Default to 0.

    dataLevel2BackupPeriods List<String>

    PolarDB Cluster of level-2 backup period. Valid values: ["Monday", "Tuesday", "Wednesday", "Thursday", "Friday", "Saturday", "Sunday"].

    NOTE: Note Select at least two values. Separate multiple values with commas (,).

    dataLevel2BackupRetentionPeriod Number

    The retention period of level-2 backups. Valid values are 0, 30 to 7300, -1. Default to 0.

    dbClusterId String

    The Id of cluster that can run database.

    enableBackupLog Number

    Indicates whether the log backup feature was enabled. Valid values are 0, 1. 1 By default, the log backup feature is enabled and cannot be disabled.

    logBackupAnotherRegionRegion String

    The region in which you want to store cross-region log backups. For information about regions that support the cross-region backup feature, see Overview.

    logBackupAnotherRegionRetentionPeriod Number

    The retention period of cross-region log backups. Default value: OFF. Valid values are 0, 30 to 7300, -1.

    NOTE: Note When you create a cluster, the default value of this parameter is 0.

    logBackupRetentionPeriod Number

    The retention period of the log backups. Valid values are 3 to 7300, -1.

    preferredBackupPeriods List<String>

    PolarDB Cluster backup period. Valid values: ["Monday", "Tuesday", "Wednesday", "Thursday", "Friday", "Saturday", "Sunday"]. Default to ["Tuesday", "Thursday", "Saturday"].

    preferredBackupTime String

    PolarDB Cluster backup time, in the format of HH:mmZ- HH:mmZ. Time setting interval is one hour. Default to "02:00Z-03:00Z". China time is 8 hours behind it.

    Package Details

    Repository
    Alibaba Cloud pulumi/pulumi-alicloud
    License
    Apache-2.0
    Notes

    This Pulumi package is based on the alicloud Terraform Provider.

    alicloud logo
    Alibaba Cloud v3.43.1 published on Monday, Sep 11, 2023 by Pulumi
    pulumi/pulumi-alicloud