Up-to-date reference of API arguments for CBR policy you can get at documentation portal

opentelekomcloud_cbr_policy_v3

Manages a V3 CBR policy resource within OpenTelekomCloud.

Example usage

resource "opentelekomcloud_cbr_policy_v3" "policy" {
  name           = "some-policy"
  operation_type = "backup"

  trigger_pattern = [
    "FREQ=WEEKLY;BYDAY=MO,TU,WE,TH,FR,SA,SU;BYHOUR=14;BYMINUTE=00"
  ]
  operation_definition {
    day_backups   = 1
    week_backups  = 2
    year_backups  = 3
    month_backups = 4
    max_backups   = 10
    timezone      = "UTC+03:00"
  }

  enabled = "false"
}

Create a replication policy (periodic backup)

variable "policy_name" {}
variable "destination_region" {}
variable "destination_project_id" {}

resource "opentelekomcloud_cbr_policy_v3" "policy" {
  name                   = var.policy_name
  operation_type         = "replication"
  destination_region     = var.destination_region
  destination_project_id = var.destination_project_id

  trigger_pattern = ["FREQ=WEEKLY;BYDAY=MO,TU,WE,TH,FR,SA,SU;BYHOUR=14;BYMINUTE=00"]

  operation_definition {
    day_backups   = 1
    week_backups  = 2
    year_backups  = 3
    month_backups = 4
    max_backups   = 10
    timezone      = "UTC+03:00"
  }
}

Argument reference

The following arguments are supported:

  • enabled - (Optional, Bool) Whether to enable the policy. Default value is true.

  • name - (Required, String) Specifies the policy name. The value consists of 1 to 64 characters and can contain only letters, digits, underscores (_), and hyphens (-).

  • destination_region - (Optional, String) Specifies the name of the replication destination region, which is mandatory for cross-region replication. Required if operation_type is replication.

  • destination_project_id - (Optional, String) Specifies the ID of the replication destination project, which is mandatory for cross-region replication. Required if operation_type is replication.

  • operation_definition - (Optional, List) Scheduling parameter. See reference below.

  • operation_type - (Required, String) Policy type. Enumeration values: backup, replication.

  • trigger_pattern - (Required, String) Scheduling rule. In the replication policy, you are advised to set one time point for one day. A maximum of 24 rules can be configured. The scheduling rule complies with iCalendar RFC 2445, but it supports only parameters FREQ, BYDAY, BYHOUR, BYMINUTE, and INTERVAL. FREQ can be set only to WEEKLY and DAILY.

The operation_definition block contains:

  • day_backups - (Optional, Int) Specifies the number of retained daily backups. The latest backup of each day is saved in the long term. This parameter can be effective together with the maximum number of retained backups specified by max_backups. The value ranges from 0 to 100. If this parameter is configured, timezone is mandatory.

  • week_backups - (Optional, Int) Specifies the number of retained weekly backups. The latest backup of each week is saved in the long term. This parameter can be effective together with the maximum number of retained backups specified by max_backups. The value ranges from 0 to 100. If this parameter is configured, timezone is mandatory.

  • month_backups - (Optional, Int) Specifies the number of retained monthly backups. The latest backup of each month is saved in the long term. This parameter can be effective together with the maximum number of retained backups specified by max_backups. The value ranges from 0 to 100. If this parameter is configured, timezone is mandatory.

  • year_backups - (Optional, Int) Specifies the number of retained yearly backups. The latest backup of each year is saved in the long term. This parameter can be effective together with the maximum number of retained backups specified by max_backups. The value ranges from 0 to 100. If this parameter is configured, timezone is mandatory.

  • timezone - (Required, String) Time zone where the user is located, for example, UTC+00:00.

  • max_backups - (Optional, Int) Maximum number of retained backups. The value can be -1 or ranges from 0 to 99999. If the value is set to -1, the backups will not be cleared even though the configured retained backup quantity is exceeded. If this parameter and retention_duration_days are both left blank, the backups will be retained permanently.

  • retention_duration_days - (Optional, Int) Duration of retaining a backup, in days. The maximum value is 99999. -1 indicates that the backups will not be cleared based on the retention duration. If this parameter and max_backups are left blank at the same time, the backups will be retained permanently.

Attributes Reference

The following attributes are exported:

  • enabled - See Argument Reference above.

  • name - See Argument Reference above.

  • operation_type - See Argument Reference above.

  • trigger_pattern - See Argument Reference above.

  • region - Specifies the region of the CBRv3 policy.

Import

Volumes can be imported using the id, e.g.

terraform import opentelekomcloud_cbr_policy_v3.policy ea257959-eeb1-4c10-8d33-26f0409a766a
last updated: UTC - commit: