This product is not supported for your selected Datadog site. ().

gcp_backupdr_backup_plan

ancestors

Type: UNORDERED_LIST_STRING

backup_rules

Type: UNORDERED_LIST_STRUCT
Provider name: backupRules
Description: Optional. The backup rules for this BackupPlan.

  • backup_retention_days
    Type: INT32
    Provider name: backupRetentionDays
    Description: Required. Configures the duration for which backup data will be kept. It is defined in “days”. The value should be greater than or equal to minimum enforced retention of the backup vault. Minimum value is 1 and maximum value is 36159 for custom retention on-demand backup. Minimum and maximum values are workload specific for all other rules. Note: Longer retention can lead to higher storage costs post introductory trial. We recommend starting with a short duration of 3 days or less.
  • rule_id
    Type: STRING
    Provider name: ruleId
    Description: Required. Immutable. The unique id of this BackupRule. The rule_id is unique per BackupPlan.The rule_id must start with a lowercase letter followed by up to 62 lowercase letters, numbers, or hyphens. Pattern, /a-z{,62}/.
  • standard_schedule
    Type: STRUCT
    Provider name: standardSchedule
    Description: Optional. Defines a schedule that runs within the confines of a defined window of time.
    • backup_window
      Type: STRUCT
      Provider name: backupWindow
      Description: Required. A BackupWindow defines the window of day during which backup jobs will run. Jobs are queued at the beginning of the window and will be marked as NOT_RUN if they do not start by the end of the window. Note: running jobs will not be cancelled at the end of the window.
      • end_hour_of_day
        Type: INT32
        Provider name: endHourOfDay
        Description: Required. The hour of day (1-24) when the window end for e.g. if value of end hour of day is 10 that mean backup window end time is 10:00. End hour of day should be greater than start hour of day. 0 <= start_hour_of_day < end_hour_of_day <= 24 End hour of day is not include in backup window that mean if end_hour_of_day= 10 jobs should start before 10:00.
      • start_hour_of_day
        Type: INT32
        Provider name: startHourOfDay
        Description: Required. The hour of day (0-23) when the window starts for e.g. if value of start hour of day is 6 that mean backup window start at 6:00.
    • days_of_month
      Type: UNORDERED_LIST_INT32
      Provider name: daysOfMonth
      Description: Optional. Specifies days of months like 1, 5, or 14 on which jobs will run. Values for days_of_month are only applicable for recurrence_type, MONTHLY and YEARLY. A validation error will occur if other values are supplied.
    • days_of_week
      Type: UNORDERED_LIST_STRING
      Provider name: daysOfWeek
      Description: Optional. Specifies days of week like, MONDAY or TUESDAY, on which jobs will run. This is required for recurrence_type, WEEKLY and is not applicable otherwise. A validation error will occur if a value is supplied and recurrence_type is not WEEKLY.
    • hourly_frequency
      Type: INT32
      Provider name: hourlyFrequency
      Description: Optional. Specifies frequency for hourly backups. A hourly frequency of 2 means jobs will run every 2 hours from start time till end time defined. This is required for recurrence_type, HOURLY and is not applicable otherwise. A validation error will occur if a value is supplied and recurrence_type is not HOURLY. Value of hourly frequency should be between 4 and 23. Reason for limit : We found that there is bandwidth limitation of 3GB/S for GMI while taking a backup and 5GB/S while doing a restore. Given the amount of parallel backups and restore we are targeting, this will potentially take the backup time to mins and hours (in worst case scenario).
    • months
      Type: UNORDERED_LIST_STRING
      Provider name: months
      Description: Optional. Specifies the months of year, like FEBRUARY and/or MAY, on which jobs will run. This field is only applicable when recurrence_type is YEARLY. A validation error will occur if other values are supplied.
    • recurrence_type
      Type: STRING
      Provider name: recurrenceType
      Description: Required. Specifies the RecurrenceType for the schedule.
      Possible values:
      • RECURRENCE_TYPE_UNSPECIFIED - recurrence type not set
      • HOURLY - The BackupRule is to be applied hourly.
      • DAILY - The BackupRule is to be applied daily.
      • WEEKLY - The BackupRule is to be applied weekly.
      • MONTHLY - The BackupRule is to be applied monthly.
      • YEARLY - The BackupRule is to be applied yearly.
    • time_zone
      Type: STRING
      Provider name: timeZone
      Description: Required. The time zone to be used when interpreting the schedule. The value of this field must be a time zone name from the IANA tz database. See https://en.wikipedia.org/wiki/List_of_tz_database_time_zones for the list of valid timezone names. For e.g., Europe/Paris.
    • week_day_of_month
      Type: STRUCT
      Provider name: weekDayOfMonth
      Description: Optional. Specifies a week day of the month like, FIRST SUNDAY or LAST MONDAY, on which jobs will run. This will be specified by two fields in WeekDayOfMonth, one for the day, e.g. MONDAY, and one for the week, e.g. LAST. This field is only applicable for recurrence_type, MONTHLY and YEARLY. A validation error will occur if other values are supplied.
      • day_of_week
        Type: STRING
        Provider name: dayOfWeek
        Description: Required. Specifies the day of the week.
        Possible values:
        • DAY_OF_WEEK_UNSPECIFIED - The day of the week is unspecified.
        • MONDAY - Monday
        • TUESDAY - Tuesday
        • WEDNESDAY - Wednesday
        • THURSDAY - Thursday
        • FRIDAY - Friday
        • SATURDAY - Saturday
        • SUNDAY - Sunday
      • week_of_month
        Type: STRING
        Provider name: weekOfMonth
        Description: Required. Specifies the week of the month.
        Possible values:
        • WEEK_OF_MONTH_UNSPECIFIED - The zero value. Do not use.
        • FIRST - The first week of the month.
        • SECOND - The second week of the month.
        • THIRD - The third week of the month.
        • FOURTH - The fourth week of the month.
        • LAST - The last week of the month.

backup_vault

Type: STRING
Provider name: backupVault
Description: Required. Resource name of backup vault which will be used as storage location for backups. Format: projects/{project}/locations/{location}/backupVaults/{backupvault}

backup_vault_service_account

Type: STRING
Provider name: backupVaultServiceAccount
Description: Output only. The Google Cloud Platform Service Account to be used by the BackupVault for taking backups. Specify the email address of the Backup Vault Service Account.

create_time

Type: TIMESTAMP
Provider name: createTime
Description: Output only. When the BackupPlan was created.

description

Type: STRING
Provider name: description
Description: Optional. The description of the BackupPlan resource. The description allows for additional details about BackupPlan and its use cases to be provided. An example description is the following: “This is a backup plan that performs a daily backup at 6pm and retains data for 3 months”. The description must be at most 2048 characters.

etag

Type: STRING
Provider name: etag
Description: Optional. etag is returned from the service in the response. As a user of the service, you may provide an etag value in this field to prevent stale resources.

labels

Type: UNORDERED_LIST_STRING

log_retention_days

Type: INT64
Provider name: logRetentionDays
Description: Optional. Applicable only for CloudSQL resource_type. Configures how long logs will be stored. It is defined in “days”. This value should be greater than or equal to minimum enforced log retention duration of the backup vault.

name

Type: STRING
Provider name: name
Description: Output only. Identifier. The resource name of the BackupPlan. Format: projects/{project}/locations/{location}/backupPlans/{backup_plan}

organization_id

Type: STRING

parent

Type: STRING

project_id

Type: STRING

project_number

Type: STRING

resource_name

Type: STRING

resource_type

Type: STRING
Provider name: resourceType
Description: Required. The resource type to which the BackupPlan will be applied. Examples include, “compute.googleapis.com/Instance”, “sqladmin.googleapis.com/Instance”, “alloydb.googleapis.com/Cluster”, “compute.googleapis.com/Disk”.

revision_id

Type: STRING
Provider name: revisionId
Description: Output only. The user friendly revision ID of the BackupPlanRevision. Example: v0, v1, v2, etc.

revision_name

Type: STRING
Provider name: revisionName
Description: Output only. The resource id of the BackupPlanRevision. Format: projects/{project}/locations/{location}/backupPlans/{backup_plan}/revisions/{revision_id}

state

Type: STRING
Provider name: state
Description: Output only. The State for the BackupPlan.
Possible values:

  • STATE_UNSPECIFIED - State not set.
  • CREATING - The resource is being created.
  • ACTIVE - The resource has been created and is fully usable.
  • DELETING - The resource is being deleted.
  • INACTIVE - The resource has been created but is not usable.
  • UPDATING - The resource is being updated.

supported_resource_types

Type: UNORDERED_LIST_STRING
Provider name: supportedResourceTypes
Description: Output only. All resource types to which backupPlan can be applied.

tags

Type: UNORDERED_LIST_STRING

update_time

Type: TIMESTAMP
Provider name: updateTime
Description: Output only. When the BackupPlan was last updated.