ACS-Mongodb-BulkyModifyBackupPolicy - CloudOps Orchestration Service

Template name

ACS-Mongodb-BulkyModifyBackupPolicy

Execute Now

Template description

Modifies the backup policy of ApsaraDB for MongoDB 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	03:00Z-04: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": [
                "dds:ModifyBackupPolicy"
            ],
            "Resource": "*",
            "Effect": "Allow"
        }
    ]
}

References

ACS-Mongodb-BulkyModifyBackupPolicy

Template content

FormatVersion: OOS-2019-06-01
Description:
  name-en: ACS-Mongodb-BulkyModifyBackupPolicy   
  en: Update mongodb instance backup policy   
Parameters:
  regionId:
    Description:
      en: The ID of region       
    Type: String
    AssociationProperty: RegionId
    Default: '{{ ACS::RegionId }}'
  instanceIds:
    Description:
      en: The Ids of instances       
    Type: List
  preferredBackupTime:
    Description:
      en: Backup Time        
    Type: String
    Default: 03:00Z-04:00Z
  preferredBackupPeriod:
    Description:
      en: Backup Period
    Type: List
    AllowedValues:
      - Monday
      - Tuesday
      - Wednesday
      - Thursday
      - Friday
      - Saturday
      - Sunday
  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 mongodb instance backup policy      
    Properties:
      Service: dds
      API: ModifyBackupPolicy
      Parameters:
        RegionId: '{{ regionId }}'
        DBInstanceId: '{{ ACS::TaskLoopItem }}'
        PreferredBackupTime: '{{ preferredBackupTime }}'
        PreferredBackupPeriod:
          Fn::Join:
            - ','
            - '{{ preferredBackupPeriod }}'
        BackupRetentionPeriod: 30
        EnableBackupLog: 1
        LogBackupRetentionPeriod: 30
        SnapshotBackupType: Standard
        BackupInterval: -1
    Loop:
      RateControl: '{{ rateControl }}'
      Items: '{{  instanceIds}}'
Metadata:
  ALIYUN::OOS::Interface:
    ParameterGroups:
      - Parameters:
          - regionId
          - instanceIds
        Label:
          default:            
            en: Select Instances
      - Parameters:
          - preferredBackupTime
          - preferredBackupPeriod
        Label:
          default:             
            en: Set Backup Policy
      - Parameters:
          - rateControl
          - OOSAssumeRole
        Label:
          default:            
            en: Control Options