ACS-Redis-BulkyModifyInstanceBackupTime

模板名称

ACS-Redis-BulkyModifyInstanceBackupTime Redis实例开启增量备份

立即执行

模板描述

None

模板类型

自动化

所有者

Alibaba Cloud

输入参数

参数名称

描述

类型

是否必填

默认值

约束

preferredBackupPeriod

备份周期

List

enableBackupLog

开启或关闭数据闪回功能

String

OOSAssumeRole

OOS扮演的RAM角色

String

regionId

地域ID

String

{{ ACS::RegionId }}

targets

目标实例

Json

{"Type": "ResourceIds", "ResourceIds": [], "RegionId": "{{ regionId }}"}

instanceIds

Redis实例ID列表

List

[]

preferredBackupTime

备份时间

String

07:00Z-08:00Z

rateControl

任务执行的并发比率

Json

{"Mode": "Concurrency", "MaxErrors": 0, "Concurrency": 10}

输出参数

执行此模板需要的权限策略

{
    "Version": "1",
    "Statement": [
        {
            "Action": [
                "kvstore:DescribeInstances",
                "kvstore:ModifyBackupPolicy"
            ],
            "Resource": "*",
            "Effect": "Allow"
        },
        {
            "Action": [
                "oos:GetApplicationGroup"
            ],
            "Resource": "*",
            "Effect": "Allow"
        }
    ]
}

详情

ACS-Redis-BulkyModifyInstanceBackupTime详情

模板内容

FormatVersion: OOS-2019-06-01
Description:
  name-en: ACS-Redis-BulkyModifyInstanceBackupTime
  name-zh-cn: Redis实例开启增量备份
  categories:
    - security
    - tair
Parameters:
  regionId:
    Label:
      en: RegionId
      zh-cn: 地域ID
    Type: String
    AssociationProperty: RegionId
    Default: '{{ ACS::RegionId }}'
  targets:
    Type: Json
    Label:
      en: TargetInstance
      zh-cn: 目标实例
    AssociationProperty: Targets
    AssociationPropertyMetadata:
      ResourceType: ALIYUN::Redis::Instance
      RegionId: regionId
    Default:
      Type: ResourceIds
      ResourceIds: []
      RegionId: '{{ regionId }}'
  instanceIds:
    Type: List
    Label:
      en: RedisInstanceIds
      zh-cn: Redis实例ID列表
    Default: []
    AssociationPropertyMetadata:
      Visible:
        Condition:
          Fn::Equals:
            - ${targets}
            - {}
  preferredBackupTime:
    Label:
      en: backup time
      zh-cn: 备份时间
    Description:
      zh-cn: 必须为整点,且间隔时间为1小时,格式为HH:mmZ-HH:mmZ(UTC时间)
      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
      zh-cn: 备份周期
    Type: List
    AllowedValues:
      - Monday
      - Tuesday
      - Wednesday
      - Thursday
      - Friday
      - Saturday
      - Sunday
  enableBackupLog:
    Label:
      en: enable or disable incremental data backup
      zh-cn: 开启或关闭数据闪回功能
    Description:
      en:  Only Tair (Redis Enterprise Edition) memory type and persistent memory type support this parameter, 1 enable ,0 disable.
      zh-cn: 仅Tair(Redis企业版)内存型和持久内存型支持该参数。1:开启  0:关闭,默认值。
    Type: String
    AllowedValues:
      - 1
      - 0
  rateControl:
    Label:
      en: RateControl
      zh-cn: 任务执行的并发比率
    Type: Json
    AssociationProperty: RateControl
    Default:
      Mode: Concurrency
      MaxErrors: 0
      Concurrency: 10
  OOSAssumeRole:
    Label:
      en: OOSAssumeRole
      zh-cn: OOS扮演的RAM角色
    Type: String
RamRole: '{{ OOSAssumeRole }}'
Conditions:
  instanceId:
    Fn::Equals:
      - '{{ instanceIds }}'
      - []
Tasks:
  - Name: getInstance
    When: instanceId
    Description:
      en: Get the Redis instances
      zh-cn: 获取Redis实例
    Action: ACS::SelectTargets
    Properties:
      ResourceType: ALIYUN::Redis::Instance
      RegionId: '{{regionId}}'
      Filters:
        - '{{ targets }}'
    Outputs:
      instanceIds:
        Type: List
        ValueSelector: Instances.Instance[].InstanceId
  - Name: ModifyInstanceMaintainTime
    Action: ACS::ExecuteAPI
    Description:
      en: Enable backup log
      zh-cn: Redis实例开启增量备份
    Properties:
      Service: R-KVSTORE
      API: ModifyBackupPolicy
      Parameters:
        RegionId: '{{ regionId }}'
        InstanceId: '{{ ACS::TaskLoopItem }}'
        PreferredBackupTime: '{{ preferredBackupTime }}'
        PreferredBackupPeriod:
          'Fn::Join':
            - ','
            - '{{ preferredBackupPeriod }}'
        EnableBackupLog: '{{ enableBackupLog }}'
    Loop:
      RateControl: '{{ rateControl }}'
      Items:
        Fn::If:
          - Fn::Equals:
              - '{{instanceIds}}'
              - []
          - '{{ getInstance.instanceIds }}'
          - '{{ instanceIds}}'
Metadata:
  ALIYUN::OOS::Interface:
    ParameterGroups:
      - Parameters:
          - regionId
          - instanceIds
          - targets
        Label:
          default:
            zh-cn: 选择实例
            en: Select Instances
      - Parameters:
          - preferredBackupTime
          - preferredBackupPeriod
          - enableBackupLog
        Label:
          default:
            zh-cn: 设置备份策略
            en: Set Backup Policy
      - Parameters:
          - rateControl
          - OOSAssumeRole
        Label:
          default:
            zh-cn: 高级选项
            en: Control Options