翻訳は機械翻訳により提供されています。提供された翻訳内容と英語版の間で齟齬、不一致または矛盾がある場合、英語版が優先します。

# `AWS-EnableDocDbClusterBackupRetentionPeriod`
<a name="aws-enabledocdbclusterbackupretentionperiod"></a>

 **説明** 

 `AWS-EnableDocDbClusterBackupRetentionPeriod` ランブックは、指定した Amazon DocumentDB クラスターのバックアップ保持期間を有効にします。この機能は、自動バックアップが保持される合計日数を設定します。クラスターを変更するには、クラスターが のエンジンタイプで使用可能な状態である必要があります`docdb`。

 [このオートメーションを実行する (コンソール)](https://console.aws.amazon.com/systems-manager/automation/execute/AWS-EnableDocDbClusterBackupRetentionPeriod) 

**ドキュメントタイプ**

Automation

**[所有者]**

Amazon

**[Platforms]** (プラットフォーム)

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) の 1 日あたりの時間範囲。形式は 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 を使用して Amazon DocumentDB クラスター識別子を返します。
+ 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`ステップからの出力。