AWS-EnableDocDbClusterBackupRetentionPeriod - AWS Systems Manager 自动化运行手册参考

本文属于机器翻译版本。若本译文内容与英语原文存在差异，则一律以英文原文为准。

AWS-EnableDocDbClusterBackupRetentionPeriod

描述

AWS-EnableDocDbClusterBackupRetentionPeriod运行手册为您指定的 Amazon DocumentDB 集群启用了备份保留期。此功能可设置保留自动备份的总天数。要修改集群，集群必须处于可用状态，引擎类型为docdb。

运行此自动化（控制台）

文档类型

自动化

所有者

Amazon

平台

Linux，macOS, Windows

参数

  • AutomationAssumeRole

    类型：字符串

    描述：（可选）允许 Systems Manager Automation 代表您执行操作 AWS Identity and Access Management (IAM) 角色的 Amazon 资源名称（ARN）。如果未指定角色，Systems Manager Automation 将使用启动此运行手册的用户的权限。

  • DBClusterResourceId

    类型：字符串

    描述：（必填）您要为其启用备份保留期的 Amazon DocumentDB 集群的资源 ID。

  • BackupRetentionPeriod

    类型：整数

    描述：（必填）保留自动备份的天数。必须是 7-35 天的值。

  • PreferredBackupWindow

    类型：字符串

    描述：（可选）以世界协调时间 (UTC) 为单位的每日时间范围，格式为 hh24: mm-hh24:mm，例如 07:14-07:44。该值必须至少为 30 分钟，并且不能与首选维护时段冲突。

  • ssm:GetAutomationExecution

  • ssm:StartAutomationExecution

  • docdb:DescribeDBClusters

  • docdb:ModifyDBCluster

  • rds:DescribeDBClusters

  • rds:ModifyDBCluster

文档步骤

  • GetDocDbClusterIdentifier (aws:executeAwsApi)-使用提供的资源 ID 返回亚马逊文档数据库集群标识符。

  • 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 -来自 ModifyDBCluster API 操作的响应。

VerifyDocDbBackupsEnabled。 VerifyDbClusterBackupsEnabledResponse -确认成功修改 Amazon DocumentDB 集群的VerifyDocDbBackupsEnabled步骤的输出。