ACS-ADB-EnableBackupPolicy

Template name

ACS-ADB-EnableBackupPolicy - Enables the automatic backup policy for an ADB instance.

Execute Now

Template description

Enables the automatic backup policy for an AnalyticDB for MySQL cluster.

Template type

Automated

Owner

Alibaba Cloud

Input parameters

Parameter	Description	Type	Required	Default value	Limit
instanceId	The ID of the AnalyticDB for MySQL cluster.	String	Yes
OOSAssumeRole	The RAM role assumed by CloudOps Orchestration Service (OOS).	String	Yes
regionId	The region ID.	String	No	{{ ACS::RegionId }}
rateControl	The task execution concurrency settings.	Json	No	{'Mode': 'Concurrency', 'MaxErrors': 0, 'Concurrency': 10}

Output parameters

None

Permission policy that is required to execute the template

{
    "Version": "1",
    "Statement": [
        {
            "Action": [
                "adb:DescribeBackupPolicy",
                "adb:ModifyBackupPolicy"
            ],
            "Resource": "*",
            "Effect": "Allow"
        }
    ]
}

Details

For more information, see ACS-ADB-EnableBackupPolicy.yml at GitHub.

Template content

FormatVersion: OOS-2019-06-01
Description:
  en: Enables the automatic backup policy for an ADB instance.
  name-en: ACS-ADB-EnableBackupPolicy
  categories:
    - security
    - analyticdb
Parameters:
  regionId:
    Label:
      en: Region ID
    Type: String
    AssociationProperty: RegionId
    Default: '{{ ACS::RegionId }}'
  instanceId:
    Label:
      en: Instance ID
    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 }}'
Tasks:
  - Name: describeBackupPolicy
    Action: ACS::ExecuteAPI
    Description:
      en: Describes the backup policy of the ADB instance.
    Properties:
      Service: ADB
      API: DescribeBackupPolicy
      Parameters:
        RegionId: '{{ regionId }}'
        DBClusterId: '{{ instanceId }}'
    Outputs:
      PreferredBackupTime:
        Type: String
        ValueSelector: .PreferredBackupTime
      PreferredBackupPeriod:
        Type: String
        ValueSelector: .PreferredBackupPeriod
      BackupRetentionPeriod:
        Type: String
        ValueSelector: .BackupRetentionPeriod
      LogBackupRetentionPeriod:
        Type: String
        ValueSelector: .LogBackupRetentionPeriod
  - Name: modifyBackupPolicy
    Action: ACS::ExecuteAPI
    Description:
      en: Enables the backup policy for the AnalyticDB for MySQL instance.
    Properties:
      Service: ADB
      API: ModifyBackupPolicy
      Parameters:
        RegionId: '{{ regionId }}'
        DBClusterId: '{{ instanceId }}'
        PreferredBackupTime: '{{ describeBackupPolicy.PreferredBackupTime }}'
        PreferredBackupPeriod: '{{ describeBackupPolicy.PreferredBackupPeriod }}'
        BackupRetentionPeriod: '{{ describeBackupPolicy.BackupRetentionPeriod }}'
        LogBackupRetentionPeriod: '{{ describeBackupPolicy.LogBackupRetentionPeriod }}'
        EnableBackupLog: Enable
Metadata:
  ALIYUN::OOS::Interface:
    ParameterGroups:
      - Parameters:
          - regionId
          - instanceId
        Label:
          default:
            en: Select Instance
      - Parameters:
          - rateControl
          - OOSAssumeRole
        Label:
          default:
            en: Advanced Options