ACS-Redis-BulkyModifyInstanceMaintainTime - CloudOps Orchestration Service

Template name

ACS-Redis-BulkyModifyInstanceMaintainTime Modify maintenance windows

Execute Now

Template description

Modifies the maintenance window of instances.

Template type

Automated

Owner

Alibaba Cloud

Input parameters

Parameter	Description	Data type	Required	Default value	Limit
maintainEndTime	The end time of the maintenance window.	String	Yes
OOSAssumeRole	The RAM role that is assumed by Operation Orchestration Service (OOS).	String	Yes
regionId	The ID of the region.	String	No	{{ ACS::RegionId }}
targets	The target instances.	Json	No	{'Type': 'ResourceIds', 'ResourceIds': [], 'RegionId': '{{ regionId }}'}
instanceIds	The list of Redis instance IDs.	List	No	[]
maintainStartTime	The start time of the maintenance window. The time is in the HH:mmZ format and is in UTC.	String	No	16:00Z
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": [
                "kvstore:DescribeInstances",
                "kvstore:ModifyInstanceMaintainTime"
            ],
            "Resource": "*",
            "Effect": "Allow"
        },
        {
            "Action": [
                "oos:GetApplicationGroup"
            ],
            "Resource": "*",
            "Effect": "Allow"
        }
    ]
}

Details

ACS-Redis-BulkyModifyInstanceMaintainTime

Template content

FormatVersion: OOS-2019-06-01
Description:
  en: Modifies the maintenance window for Redis instances.
  name-en: ACS-Redis-BulkyModifyInstanceMaintainTime
  categories:
    - security
    - tair
Parameters:
  regionId:
    Label:
      en: Region ID
    Type: String
    AssociationProperty: RegionId
    Default: '{{ ACS::RegionId }}'
  targets:
    Type: Json
    Label:
      en: Target Instance
    AssociationProperty: Targets
    AssociationPropertyMetadata:
      ResourceType: ALIYUN::Redis::Instance
      RegionId: regionId
    Default:
      Type: ResourceIds
      ResourceIds: []
      RegionId: '{{ regionId }}'
  instanceIds:
    Label:
      en: Redis Instance IDs
    Type: List
    Default: []
    AssociationPropertyMetadata:
      Visible:
        Condition:
          Fn::Equals:
            - ${targets}
            - {}
  maintainStartTime:
    Label:
      en: Start Time
    Type: String
    Default: '16:00Z'
  maintainEndTime:
    Description:
      en: The format is HH:mmZ (UTC), for example, '18:00Z'.
    Label:
      en: End Time
    Type: String
  rateControl:
    Label:
      en: Rate Control
    Type: Json
    AssociationProperty: RateControl
    Default:
      Mode: Concurrency
      MaxErrors: 0
      Concurrency: 10
  OOSAssumeRole:
    Label:
      en: OOS Assume Role
    Type: String
RamRole: '{{ OOSAssumeRole }}'
Conditions:
  instanceId:
    Fn::Equals:
      - '{{ instanceIds }}'
      - []
Tasks:
  - Name: getInstance
    When: instanceId
    Description:
      en: Gets the Redis instances.
    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: Modifies the maintenance window for Redis instances.
    Properties:
      Service: R-KVSTORE
      API: ModifyInstanceMaintainTime
      Parameters:
        RegionId: '{{ regionId }}'
        InstanceId: '{{ ACS::TaskLoopItem }}'
        MaintainStartTime: '{{ maintainStartTime }}'
        MaintainEndTime: '{{ maintainEndTime }}'
    Loop:
      RateControl: '{{ rateControl }}'
      Items:
        Fn::If:
          - Fn::Equals:
              - '{{instanceIds}}'
              - []
          - '{{ getInstance.instanceIds }}'
          - '{{ instanceIds}}'
Metadata:
  ALIYUN::OOS::Interface:
    ParameterGroups:
      - Parameters:
          - maintainStartTime
          - maintainEndTime
        Label:
          default:
            en: Configure Maintenance Window
      - Parameters:
          - regionId
          - instanceIds
          - targets
        Label:
          default:
            en: Select Instances
      - Parameters:
          - rateControl
          - OOSAssumeRole
        Label:
          default:
            en: Advanced Options