AWS-EnableDocDbClusterBackupRetentionPeriod - AWS Systems Manager 自動化手冊參考

本文為英文版的機器翻譯版本，如內容有任何歧義或不一致之處，概以英文版為準。

AWS-EnableDocDbClusterBackupRetentionPeriod

Description

AWS-EnableDocDbClusterBackupRetentionPeriod執行手冊會為您指定的 Amazon DocumentDB 叢集啟用備份保留期。此功能可設定保留自動備份的總天數。若要修改叢集，叢集必須處於可用狀態且引擎類型為docdb。

運行此自動化（控制台）

文件類型

 自動化

擁有者

Amazon

平台

Linux,macOS, Windows

參數

  • AutomationAssumeRole

    類型：字串

    描述：(選用) 允許 Systems Manager 自動化代表您執行動作的 AWS Identity and Access Management (IAM) 角色的 Amazon 資源名稱 ()。ARN如果未指定角色，Systems Manager 自動化會使用啟動此 runbook 的使用者的權限。

  • DBClusterResourceId

    類型：字串

    說明：(必填) 您要啟用備份保留期之 Amazon DocumentDB 叢集的資源識別碼。

  • BackupRetentionPeriod

    類型：整數

    說明：(必要) 保留自動備份的天數。必須是 7-35 天之間的值。

  • PreferredBackupWindow

    類型：字串

    說明：(選擇性) 以世界協調時間 (UTC) 為單位的每日時間範圍，格式為 hh24：毫米-h24:mm，例如 07:14-07:44。此值必須至少為 30 分鐘，且不能與偏好的維護時段衝突。

  • ssm:GetAutomationExecution

  • ssm:StartAutomationExecution

  • docdb:DescribeDBClusters

  • docdb:ModifyDBCluster

  • rds:DescribeDBClusters

  • rds:ModifyDBCluster

文件步驟

  • GetDocDbClusterIdentifier (aws:executeAwsApi)-使用提供的資源 ID 傳回 Amazon 文件資料庫叢集識別碼。

  • VerifyDocDbEngine (aws:assertAwsResourceProperty)-驗證 Amazon DocumentDB 引擎類型是docdb為了防止意外更改其他 Amazon 引擎類型。RDS

  • VerifyDocDbStatus (aws:waitAwsResourceProperty)-驗證 Amazon DocumentDB 叢集狀態為。available

  • ModifyDocDbRetentionPeriod (aws:executeAwsApi)-使用為指定的 Amazon DocumentDB 叢集提供的值來設定保留期間。

  • VerifyDocDbBackupsEnabled (aws:executeScript)-驗證 Amazon DocumentDB 叢集的保留期間，並且已成功設定偏好的備份時段 (如果指定)。

輸出

ModifyDocDbRetentionPeriod。 ModifyDbClusterResponse -來自ModifyDBClusterAPI操作的響應。

VerifyDocDbBackupsEnabled。 VerifyDbClusterBackupsEnabledResponse -從確認成功修改 Amazon DocumentDB 叢集的VerifyDocDbBackupsEnabled步驟輸出。