ClusterMasterUserSecret
マスターユーザーパスワードの AWS Secrets Manager で Amazon DocumentDB が管理するシークレットが含まれます。
内容
注記
次のリストで必須のパラメーターを説明します。
- KmsKeyId
-
シークレットの暗号化に使用される AWS KMS キーの識別子。
タイプ: 文字列
必須: いいえ
- SecretArn
-
シークレットの Amazon リソースネーム (ARN)。
タイプ: 文字列
必須: いいえ
- SecretStatus
-
シークレットのステータス。
設定可能なステータス値は以下のとおりです。
-
作成中 – シークレットは作成中です。
-
アクティブ – シークレットは通常の使用とローテーションで利用可能です。
-
ローテーション中 – シークレットはローテーション中です。
-
問題発生中 - シークレットはデータベースの認証情報へのアクセスに使用できますが、ローテーションはできません。例えば、アクセス許可が変更されて Amazon DocumentDB がシークレットやシークレットの KMS キーにアクセスできなくなった場合、いずれかのシークレットがこのステータスになる可能性があります。
シークレットのステータスがこの場合は、ステータスの原因となった状態を修正できます。または、インスタンスを変更してデータベース認証情報の自動管理をオフにしてから、インスタンスを再度変更してデータベース認証情報の自動管理をオンにします。
タイプ: 文字列
必須: いいえ
-
以下の資料も参照してください。
言語固有の AWS SDK のいずれかでこの API を使用する方法の詳細については、以下を参照してください。