ACS-Redis-BulkyModifyInstanceBackupTime - CloudOps Orchestration Service

Template name

ACS-Redis-BulkyModifyInstanceBackupTime

Execute Now

Template description

Enables incremental backup for Tair (Redis OSS-compatible) instances.

Template type

Automated

Owner

Alibaba Cloud

Input parameters

Parameter	Description	Data type	Required	Default value	Limit
preferredBackupPeriod	The backup cycle.	List	Yes
enableBackupLog	Specifies whether to enable the data flashback feature for the instances.	String	Yes
instanceIds	The IDs of the Tair (Redis OSS-compatible) instances.	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 backup time.	String	No	07:00Z-08:00Z
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-BulkyModifyInstanceBackupTime

Template content

FormatVersion: OOS-2019-06-01
Description:
  name-en: ACS-Redis-BulkyModifyInstanceBackupTime  
  categories:
    - security
Parameters:
  regionId:
    Label:
      en: RegionId       
    Type: String
    AssociationProperty: RegionId
    Default: '{{ ACS::RegionId }}'
  preferredBackupTime:
    Label:
      en: backup time       
    Description:       
      en: TThe beginning and end of the time range must be on the hour. The duration must be an hour. Specify the time in the ISO 8601 standard in the HH:mmZ-HH:mmZ format. The time must be in UTC.
    Type: String
    Default: '07:00Z-08:00Z'
  preferredBackupPeriod:
    Label:
      en: backup period       
    Type: List
    AllowedValues:
      - Monday
      - Tuesday
      - Wednesday
      - Thursday
      - Friday
      - Saturday
      - Sunday
  enableBackupLog:
    Label:
      en: enable or disable incremental data backup      
    Description:
      en:  Only Tair (Redis Enterprise Edition) memory type and persistent memory type support this parameter, 1 enable ,0 disable.       
    Type: String
    AllowedValues:
      - 1
      - 0
  instanceIds:
    Label:
      en: The Ids of redis instances
    Type: List
  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: ModifyInstanceMaintainTime
    Action: ACS::ExecuteAPI
    Description:
      en: Enable backup log   
    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 Backup Policy
      - Parameters:
          - rateControl
          - OOSAssumeRole
        Label:
          default:            
            en: Control Options