このセクションでは、キーリングプラグイン固有のユーザー定義関数 (UDF) ごとに、その目的、呼び出しシーケンス、および戻り値について説明します。 汎用キーリング UDF の詳細は、セクション6.4.4.10「汎用キーリングキー管理関数」 を参照してください。
-
関連付けられたキーリングプラグイン:
keyring_awskeyring_aws_rotate_cmk()は、顧客マスターキー (CMK) をローテーションします。 ローテーションでは、AWS KMS が後続のデータキー暗号化操作に使用するキーのみが変更されます。 AWS KMS は以前の CMK バージョンを保持するため、以前の CMK を使用して生成されたキーはローテーション後も復号化可能なままになります。ローテーションによって AWS KMS 内で使用される CMK 値が変更されますが、参照に使用される ID は変更されないため、
keyring_aws_rotate_cmk()のコール後にkeyring_aws_cmk_idシステム変数を変更する必要はありません。この UDF には
SUPER権限が必要です。引数:
なし
戻り値:
成功した場合は 1、失敗した場合は
NULLおよびエラーを返します。 -
関連付けられたキーリングプラグイン:
keyring_awskeyring_aws_rotate_keys()は、keyring_aws_data_fileシステム変数で指定されたkeyring_awsストレージファイルに格納されているキーをローテーションします。 ローテーションでは、keyring_aws_cmk_idシステム変数の値を CMK 値として使用して、ファイルに格納されている各キーを AWS KMS に再暗号化のために送信し、新しい暗号化キーをファイルに格納します。keyring_aws_rotate_keys()は、次の場合にキーの再暗号化に役立ちます:CMK のローテーション後 (
keyring_aws_rotate_cmk()UDF の起動後)keyring_aws_cmk_idシステム変数を別のキー値に変更した後
この UDF には
SUPER権限が必要です。引数:
なし
戻り値:
成功した場合は 1、失敗した場合は
NULLおよびエラーを返します。 -
keyring_hashicorp_update_config()関連付けられたキーリングプラグイン:
keyring_hashicorpkeyring_hashicorp 構成 で説明されているように、
keyring_hashicorp_update_config()UDF が呼び出されると、keyring_hashicorpはランタイム再構成を実行します。この UDF ではグローバルシステム変数が変更されるため、
SYSTEM_VARIABLES_ADMIN権限が必要です。引数:
なし
戻り値:
成功した場合は文字列
'Configuration update was successful.'、失敗した場合は'Configuration update failed.'を返します。