ACS-RDS-BulkyModifyDBInstanceMaintainTime - CloudOps Orchestration Service

Template name

ACS-RDS-BulkyModifyDBInstanceMaintainTime - Modifies maintenance windows in bulk

Execute Now

Template description

Modifies the maintenance window of an instance.

Template type

Automated

Owner

Alibaba Cloud

Input parameters

Parameter	Description	Type	Required	Default value	Limit
maintainTime	The maintenance window of the instance.	String	Yes
OOSAssumeRole	The RAM role that Operation Orchestration Service (OOS) assumes.	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 instance IDs.	List	No	[]
rateControl	The concurrency rate for task execution.	Json	No	{'Mode': 'Concurrency', 'MaxErrors': 0, 'Concurrency': 10}

Output parameters

None

Permission policy that is required to execute the template

{
    "Version": "1",
    "Statement": [
        {
            "Action": [
                "rds:DescribeDBInstances",
                "rds:ModifyDBInstanceMaintainTime"
            ],
            "Resource": "*",
            "Effect": "Allow"
        },
        {
            "Action": [
                "oos:GetApplicationGroup"
            ],
            "Resource": "*",
            "Effect": "Allow"
        }
    ]
}

Details

Details for ACS-RDS-BulkyModifyDBInstanceMaintainTime

Template content

FormatVersion: OOS-2019-06-01
Description:
  en: Modifies the maintenance window of an RDS instance.
  name-en: 'ACS-RDS-BulkyModifyDBInstanceMaintainTime: Modify Maintenance Window'
  categories:
    - security
    - rds
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::RDS::Instance
      RegionId: regionId
    Default:
      Type: ResourceIds
      ResourceIds: []
      RegionId: '{{ regionId }}'
  instanceIds:
    Label:
      en: Instance IDs
    Type: List
    Default: []
    AssociationPropertyMetadata:
      Visible:
        Condition:
          Fn::Equals:
            - ${targets}
            - {}
  maintainTime:
    Description:
      en: "Specify the time in the ISO 8601 standard in the HH:mmZ-HH:mmZ format. The time must be in UTC. Example: 04:00Z-05:00Z."
    Label:
      en: Maintenance Window
    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 RDS instances.
    Action: ACS::SelectTargets
    Properties:
      ResourceType: ALIYUN::RDS::Instance
      RegionId: '{{regionId}}'
      Filters:
        - '{{ targets }}'
    Outputs:
      instanceIds:
        Type: List
        ValueSelector: Instances.Instance[].InstanceId
  - Name: ModifyDBInstanceMaintainTime
    Action: ACS::ExecuteAPI
    Description:
      en: Modifies the maintenance window of the RDS instances.
    Properties:
      Service: RDS
      API: ModifyDBInstanceMaintainTime
      Parameters:
        RegionId: '{{ regionId }}'
        DBInstanceId: '{{ ACS::TaskLoopItem }}'
        MaintainTime: '{{ maintainTime }}'
    Loop:
      RateControl: '{{ rateControl }}'
      Items:
        Fn::If:
          - Fn::Equals:
              - '{{instanceIds}}'
              - []
          - '{{ getInstance.instanceIds }}'
          - '{{ instanceIds}}'
Metadata:
  ALIYUN::OOS::Interface:
    ParameterGroups:
      - Parameters:
          - maintainTime
        Label:
          default:
            en: Set Maintenance Window
      - Parameters:
          - regionId
          - instanceIds
          - targets
        Label:
          default:
            en: Select Instances
      - Parameters:
          - rateControl
          - OOSAssumeRole
        Label:
          default:
            en: Advanced Options