ALIYUN::ClickHouse::EnterpriseDBClusterBackupPolicy - Resource Orchestration Service

Syntax

{
  "Type": "ALIYUN::ClickHouse::EnterpriseDBClusterBackupPolicy",
  "Properties": {
    "BackupRetentionPeriod": Integer,
    "DbInstanceId": String,
    "PreferredBackupPeriod": String,
    "PreferredBackupTime": String
  }
}

Properties

Parameter	Type	Required	Update allowed	Description	Constraints
BackupRetentionPeriod	Integer	Yes	Yes	The backup retention period, in days.	None
DbInstanceId	String	Yes	No	The cluster ID.	None
PreferredBackupPeriod	String	Yes	Yes	The backup schedule.	The days of the week when backups are performed. Use a comma (,) to separate multiple days.
PreferredBackupTime	String	Yes	Yes	The backup time window.	The time must be in UTC and use the `HH:mmZ-HH:mmZ` format. For example, `12:00Z-13:00Z` specifies a backup window from 12:00 UTC to 13:00 UTC.

Return values

Fn::GetAtt

BackupState: The backup state.
PreferredBackupPeriod: The backup schedule.
PreferredBackupTime: The backup time window.
BackupRetentionPeriod: The backup retention period, in days.

Examples

YAML

ROSTemplateFormatVersion: '2015-09-01'
Parameters:
  PreferredBackupPeriod:
    Type: String
    Description:
      en: The days of the week when backups are performed. Use a comma (,) to separate multiple days.
    Required: true
  PreferredBackupTime:
    Type: String
    Description:
      en: The backup time window. The time must be in UTC and use the HH:mmZ-HH:mmZ format. For example, 12:00Z-13:00Z specifies a backup window from 12:00 UTC to 13:00 UTC.
    Required: true
  BackupRetentionPeriod:
    Type: Number
    Description:
      en: The backup retention period, in days.
    Required: true
  DbInstanceId:
    Type: String
    Description:
      en: The cluster ID.
    Required: true
Resources:
  ExtensionResource:
    Type: ALIYUN::ClickHouse::EnterpriseDBClusterBackupPolicy
    Properties:
      PreferredBackupPeriod:
        Ref: PreferredBackupPeriod
      PreferredBackupTime:
        Ref: PreferredBackupTime
      BackupRetentionPeriod:
        Ref: BackupRetentionPeriod
      DbInstanceId:
        Ref: DbInstanceId
Outputs:
  BackupState:
    Description:
      en: The backup state.
    Value:
      Fn::GetAtt:
        - ExtensionResource
        - BackupState
  PreferredBackupPeriod:
    Description:
      en: The backup schedule.
    Value:
      Fn::GetAtt:
        - ExtensionResource
        - PreferredBackupPeriod
  PreferredBackupTime:
    Description:
      en: The backup time window.
    Value:
      Fn::GetAtt:
        - ExtensionResource
        - PreferredBackupTime
  BackupRetentionPeriod:
    Description:
      en: The backup retention period, in days.
    Value:
      Fn::GetAtt:
        - ExtensionResource
        - BackupRetentionPeriod

JSON

{
  "ROSTemplateFormatVersion": "2015-09-01",
  "Parameters": {
    "PreferredBackupPeriod": {
      "Type": "String",
      "Description": {
        "en": "The days of the week when backups are performed. Use a comma (,) to separate multiple days."
      },
      "Required": true
    },
    "PreferredBackupTime": {
      "Type": "String",
      "Description": {
        "en": "The backup time window. The time must be in UTC and use the HH:mmZ-HH:mmZ format. For example, 12:00Z-13:00Z specifies a backup window from 12:00 UTC to 13:00 UTC."
      },
      "Required": true
    },
    "BackupRetentionPeriod": {
      "Type": "Number",
      "Description": {
        "en": "The backup retention period, in days."
      },
      "Required": true
    },
    "DbInstanceId": {
      "Type": "String",
      "Description": {
        "en": "The cluster ID."
      },
      "Required": true
    }
  },
  "Resources": {
    "ExtensionResource": {
      "Type": "ALIYUN::ClickHouse::EnterpriseDBClusterBackupPolicy",
      "Properties": {
        "PreferredBackupPeriod": {
          "Ref": "PreferredBackupPeriod"
        },
        "PreferredBackupTime": {
          "Ref": "PreferredBackupTime"
        },
        "BackupRetentionPeriod": {
          "Ref": "BackupRetentionPeriod"
        },
        "DbInstanceId": {
          "Ref": "DbInstanceId"
        }
      }
    }
  },
  "Outputs": {
    "BackupState": {
      "Description": {
        "en": "The backup state."
      },
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "BackupState"
        ]
      }
    },
    "PreferredBackupPeriod": {
      "Description": {
        "en": "The backup schedule."
      },
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "PreferredBackupPeriod"
        ]
      }
    },
    "PreferredBackupTime": {
      "Description": {
        "en": "The backup time window."
      },
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "PreferredBackupTime"
        ]
      }
    },
    "BackupRetentionPeriod": {
      "Description": {
        "en": "The backup retention period, in days."
      },
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "BackupRetentionPeriod"
        ]
      }
    }
  }
}