キーローテーションポリシーを更新します。
操作説明
自動キーローテーションを有効にすると、Key Management Service (KMS) は、事前に設定されたローテーション期間が経過した後に、自動的にキーバージョンを作成します。さらに、KMS は新しいキーバージョンをプライマリキーバージョンとして設定します。
以下のキーには、自動キーローテーションポリシーを設定できません。
非対称キー
サービスマネージドキー
KMS にインポートされた BYOK (Bring Your Own Key)
有効 状態ではないキー
この例では、ID が 1234abcd-12ab-34cd-56ef-12345678**** のカスタマーマスターキー (CMK) に対して自動キーローテーションが有効化されます。自動ローテーション期間は 30 日です。
今すぐお試しください
テスト
RAM 認証
リクエストパラメーター
|
パラメーター |
型 |
必須 / 任意 |
説明 |
例 |
| KeyId |
string |
必須 |
カスタマーマスターキー (CMK) の ID。この ID はグローバルに一意である必要があります。 |
1234abcd-12ab-34cd-56ef-12345678**** |
| EnableAutomaticRotation |
boolean |
必須 |
自動キーローテーションを有効にするかどうかを指定します。有効な値：
|
true |
| RotationInterval |
string |
任意 |
自動キーローテーションの期間。値は integer[unit] 形式で指定します。サポートされている単位は、d (日)、h (時間)、m (分)、s (秒) です。たとえば、7 日間の期間を指定するには、7d または 604800s のいずれかを使用できます。期間は 7 日から 730 日の範囲で指定できます。 説明
EnableAutomaticRotation パラメーターを true に設定した場合は、このパラメーターも指定する必要があります。EnableAutomaticRotation パラメーターを false に設定した場合は、このパラメーターを未指定のままにすることができます。 |
30d |
レスポンスフィールド
|
フィールド |
型 |
説明 |
例 |
|
object |
|||
| RequestId |
string |
リクエスト ID。問題の特定やトラブルシューティングに使用されます。 |
efb1cbbd-a093-4278-bc03-639dd4fcc207 |
例
成功レスポンス
JSONJSON
{
"RequestId": "efb1cbbd-a093-4278-bc03-639dd4fcc207"
}エラーコード
|
HTTP ステータスコード |
エラーコード |
エラーメッセージ |
説明 |
|---|---|---|---|
| 400 | Rejected.UnsupportedOperation | Unsupported operation. | |
| 400 | InvalidParameter | The specified parameter RotationInterval is not valid. | |
| 404 | Forbidden.KeyNotFound | The specified Key is not found. | アクセスキーが有効になっていません。 |
完全なリストについては、「エラーコード」をご参照ください。
変更履歴
完全なリストについては、「変更履歴」をご参照ください。