ACS-Redis-BulkyModifyBackupPolicy - CloudOps Orchestration Service

Template name

ACS-Redis-BulkyModifyBackupPolicy

Execute Now

Template description

Modifies the automatic backup policy of Tair (Redis OSS-compatible) instances.

Template type

Automated

Owner

Alibaba Cloud

Input parameters

Parameter	Description	Data type	Required	Default value	Limit
instanceIds	The IDs of the instances.	List	Yes
preferredBackupPeriod	The backup cycle.	List	Yes
OOSAssumeRole	The RAM role that is assumed by CloudOps Orchestration Service (OOS).	String	Yes
regionId	The region ID.	String	No	{{ ACS::RegionId }}
preferredBackupTime	The time when a backup is performed. The time must be in UTC. The time range is in the HH:mmZ-HH:mmZ format and its duration must be 1 hour.	String	No	18:00Z-19:00Z
enableBackupLog	Specifies whether to enable the data flashback feature for the instance. Valid values: 1: The data flashback feature is enabled. You must also enable append-only file (AOF) persistence by setting appendonly to yes in the parameter settings of the instance. Then, you can use the data flashback feature. 0: The data flashback feature is disabled. This is the default value.	String	No	1
rateControl	The rate control settings.	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": [
                "kvstore:ModifyBackupPolicy"
            ],
            "Resource": "*",
            "Effect": "Allow"
        }
    ]
}

References

ACS-Redis-BulkyModifyBackupPolicy

Template content

FormatVersion: OOS-2019-06-01
Description:
  en: Modify redis instance's backup policy.   
  name-en: ACS-Redis-BulkyModifyBackupPolicy  
  categories:
    - security
Parameters:
  regionId:
    Label:
      en: RegionId       
    Type: String
    AssociationProperty: RegionId
    Default: '{{ ACS::RegionId }}'
  instanceIds:
    Label:
      en: The Ids of redis instances       
    Type: List
  preferredBackupTime:
    Description:
      en: Backup Time        
    Type: String
    Default: 18:00Z-19:00Z
  preferredBackupPeriod:
    Description:
      en: Backup Period       
    Type: List
    AllowedValues:
      - Monday
      - Tuesday
      - Wednesday
      - Thursday
      - Friday
      - Saturday
      - Sunday
  enableBackupLog:
    Description:
      en: Enable backup log         
    Type: String
    Default: '1'
  rateControl:
    Label:
      en: RateControl       
    Type: Json
    AssociationProperty: RateControl
    Default:
      Mode: Concurrency
      MaxErrors: 0
      Concurrency: 10
  OOSAssumeRole:
    Label:
      en: OOSAssumeRole       
    Type: String
RamRole: '{{ OOSAssumeRole }}'
Tasks:
  - Name: ModifyBackupPolicy
    Action: ACS::ExecuteAPI
    Description:
      en: Modify redis instance's backup policy      
    Properties:
      Service: R-KVSTORE
      API: ModifyBackupPolicy
      Parameters:
        RegionId: '{{ regionId }}'
        InstanceId: '{{ ACS::TaskLoopItem }}'
        PreferredBackupTime: '{{ preferredBackupTime }}'
        PreferredBackupPeriod:
          Fn::Join:
            - ','
            - '{{ preferredBackupPeriod }}'
        EnableBackupLog: '{{ enableBackupLog }}'
    Loop:
      RateControl: '{{ rateControl }}'
      Items: '{{ instanceIds }}'
Metadata:
  ALIYUN::OOS::Interface:
    ParameterGroups:
      - Parameters:
          - regionId
          - instanceIds
        Label:
          default:             
            en: Select Instances
      - Parameters:
          - preferredBackupTime
          - preferredBackupPeriod
          - enableBackupLog
        Label:
          default:            
            en: Set Auto Backup Policy
      - Parameters:
          - rateControl
          - OOSAssumeRole
        Label:
          default:            
            en: Control Options