ACS-PolarDB-BulkyModifyBackupPolicyForLevel2Backup - CloudOps Orchestration Service

Template name

ACS-PolarDB-BulkyModifyBackupPolicyForLevel2Backup - Modifies the retention period of level-2 backups in the automatic backup policy for a PolarDB cluster

Execute Now

Template description

Modifies the retention period of the level-2 backups for the automatic backup policy of multiple PolarDB clusters.

Template type

Automated

Owner

Alibaba Cloud

Input parameters

Parameter	Description	Data type	Required	Default value	Limit
instanceIds	The IDs of PolarDB clusters.	List	Yes
dataLevel2BackupRetentionPeriod	The retention period of level-2 backups.	String	Yes
dataLevel2BackupPeriod	The backup cycle of level-2 backups.	List	Yes
OOSAssumeRole	The RAM role that is assumed by CloudOps Orchestration Service (OOS).	String	Yes
regionId	The region ID.	String	No	{{ ACS::RegionId }}
rateControl	Task execution concurrency	Json	No	{'Mode': 'Concurrency', 'MaxErrors': 0, 'Concurrency': 10}

Output parameters

N/A.

Permission policy that is required to execute the template

{
    "Version": "1",
    "Statement": [
        {
            "Action": [
                "polardb:ModifyBackupPolicy"
            ],
            "Resource": "*",
            "Effect": "Allow"
        }
    ]
}

Details

ACS-PolarDB-BulkyModifyBackupPolicyForLevel2Backup

Template content

FormatVersion: OOS-2019-06-01
Description:
  en: Modifies the retention period of level-2 backups for the automatic backup policy of PolarDB clusters.
  name-en: ACS-PolarDB-BulkyModifyBackupPolicyForLevel2Backup
  categories:
    - security
    - polardb
Parameters:
  regionId:
    Label:
      en: Region ID
    Type: String
    AssociationProperty: RegionId
    Default: '{{ ACS::RegionId }}'
  instanceIds:
    Label:
      en: PolarDB cluster IDs
    Type: List
  dataLevel2BackupRetentionPeriod:
    Description:
      en: The retention period of level-2 backups. Valid values: 0 (disables the level-2 backup feature), 30 to 7300 (in days), and -1 (permanent retention).
    Label:
      en: Level-2 backup retention period
    Type: String
  dataLevel2BackupPeriod:
    Label:
      en: Level-2 backup cycle
    Type: List
    AllowedValues:
      - Monday
      - Tuesday
      - Wednesday
      - Thursday
      - Friday
      - Saturday
      - Sunday
  rateControl:
    Label:
      en: Concurrency rate
    Type: Json
    AssociationProperty: RateControl
    Default:
      Mode: Concurrency
      MaxErrors: 0
      Concurrency: 10
  OOSAssumeRole:
    Label:
      en: RAM role for OOS
    Type: String
RamRole: '{{ OOSAssumeRole }}'
Tasks:
  - Name: ModifyBackupPolicy
    Action: ACS::ExecuteAPI
    Description:
      en: Modifies the retention period of level-2 backups for the automatic backup policy of a PolarDB cluster.
    Properties:
      Service: POLARDB
      API: ModifyBackupPolicy
      Parameters:
        RegionId: '{{ regionId }}'
        DBClusterId: '{{ ACS::TaskLoopItem }}'
        DataLevel2BackupRetentionPeriod: '{{ dataLevel2BackupRetentionPeriod }}'
        DataLevel2BackupPeriod:
          Fn::Join:
            - ','
            - '{{ dataLevel2BackupPeriod }}'
    Loop:
      RateControl: '{{ rateControl }}'
      Items: '{{ instanceIds }}'
Metadata:
  ALIYUN::OOS::Interface:
    ParameterGroups:
      - Parameters:
          - regionId
          - instanceIds
        Label:
          default:
            en: Select clusters
      - Parameters:
          - dataLevel2BackupRetentionPeriod
        Label:
          default:
            en: Level-2 backup retention period
      - Parameters:
          - dataLevel2BackupPeriod
        Label:
          default:
            en: Level-2 backup cycle
      - Parameters:
          - rateControl
          - OOSAssumeRole
        Label:
          default:
            en: Advanced options