:CreateKey

キーの説明。
説明は 0 ～ 8,192 文字です。

キーの用途。有効な値：

• ENCRYPT/DECRYPT: データを暗号化および復号化します。

• SIGN/VERIFY: デジタル署名を生成および検証します。

デフォルト値: キーが署名検証をサポートしている場合、デフォルト値は SIGN/VERIFY です。 それ以外の場合は、デフォルト値は ENCRYPT/DECRYPT です。

キーマテリアルのソース。有効な値：

• Aliyun_KMS (デフォルト): キーマテリアルは Alibaba Cloud KMS によって生成されます。

• EXTERNAL: キーマテリアルはインポートされます。

• このパラメーターを EXTERNAL に設定した場合は、キーマテリアルをインポートします。 詳細については、「対称キーのキーマテリアルをインポートする」または「非対称キーのキーマテリアルをインポートする」をご参照ください。

このパラメーターを指定する必要はありません。 KMS は、キーに適切な保護レベルを自動的に設定します。

キーの保護レベル。有効な値：

• SOFTWARE

• HSM

• DKMSInstanceId を指定しない場合は、このパラメーターを空のままにします。 KMS は保護レベルを設定します。 マネージド HSM がリージョンで使用可能な場合、KMS はこのパラメーターを HSM に設定します。 それ以外の場合は、KMS はこのパラメーターを SOFTWARE に設定します。 詳細については、「マネージド HSM の概要」をご参照ください。

キーの自動ローテーションを有効にするかどうかを指定します。有効な値：

• true: キーの自動ローテーションを有効にします。

• false (デフォルト): キーの自動ローテーションを無効にします。

このパラメーターは、キーのキー管理タイプが自動ローテーションをサポートしている場合にのみ有効です。 詳細については、「キーローテーション」をご参照ください。

自動ローテーション期間。 フォーマットは `integer[unit]` です。 `integer` は期間の長さを示します。 `unit` は時間の単位を示します。 有効な単位: d (日)、h (時間)、m (分)、s (秒)。 たとえば、7d と 604800s はどちらも 7 日間の期間を表します。

• キーがデフォルトキーの場合、値は 365d です。

• キーがソフトウェアで保護されたキーの場合、値は 7d ～ 365d です。

• キーがハードウェアで保護されたキーの場合、自動ローテーションはサポートされていません。

キーの仕様。 有効な値は、キー管理タイプによって異なります。 キー仕様、サポートされている標準、およびアルゴリズムの詳細については、「キー管理タイプとキー仕様」をご参照ください。

KMS インスタンスの ID。

キーにバインドするタグ。 各タグは、タグキーとタグ値を含むキーと値のペア (Key:Value) で構成されます。

最大 20 個のタグを指定します。 複数のタグを指定するには、次のフォーマットを使用します: [{"TagKey":"key1","TagValue":"value1"},{"TagKey":"key2","TagValue":"value2"},...]。

各タグキーとタグ値は最大 128 文字で、大文字、小文字、数字、スラッシュ (/)、バックスラッシュ (\)、アンダースコア (_)、ハイフン (-)、ピリオド (.)、プラス記号 (+)、等号 (=)、コロン (:)、アットマーク (@) を含めることができます。

キーポリシーの内容。 値は JSON 形式です。 ポリシーは最大 32,768 バイトです。 キーポリシーの詳細については、「キーポリシーの概要」をご参照ください。 このパラメーターを指定しない場合、デフォルトの認証情報ポリシーが使用されます。

キーポリシーには次の内容が含まれています。

• Version: キーポリシーのバージョン。 バージョン 1 のみがサポートされています。

• Statement: キーポリシーのステートメント。 各キーポリシーには 1 つ以上のステートメントが含まれています。

キーポリシーのフォーマットは次のとおりです。

{
  "Version": "1",
  "Statement": [
    {
      "Sid": "Enable RAM User Permissions", // RAM ユーザー権限の有効化
      "Effect": "Allow",  // 許可
      "Principal": {
        "RAM": ["acs:ram::112890462****:root"]
      },
      "Action": [
        "kms:*"
      ],
      "Resource": [
        "*"
      ],
      "Condition": {
        "condition operator": { // 条件演算子
          "condition key": "condition value" // 条件キー：条件値
        }
      }
    }
  ]
}

ステートメントの詳細：

• Sid: (オプション) カスタムステートメント ID。 ID は最大 128 文字で、大文字 (A ～ Z)、小文字 (a ～ z)、数字 (0 ～ 9)、および特殊文字 (アンダースコア (_)、スラッシュ (/)、プラス記号 (+)、等号 (=)、ピリオド (.)、アットマーク (@)、ハイフン (-) など) を含めることができます。

• Effect: (必須) ポリシーステートメントの効果。有効な値: Allow および Deny。

• Principal: (必須) 権限が付与されるプリンシパル。 このパラメーターを現在の Alibaba Cloud アカウント (キーが属する Alibaba Cloud アカウント)、現在の Alibaba Cloud アカウントの RAM ユーザーまたは RAM ロール、または別の Alibaba Cloud アカウントの RAM ユーザーまたは RAM ロールに設定します。

• Action: (必須) 許可または拒否される API 操作。 値は "kms:" で始まる必要があります。 サポートされている操作のリストについては、「キーポリシーの概要」をご参照ください。 リストにない操作を指定した場合、設定は有効になりません。

• Resource: (必須) 値は * のみ可能です。これは現在の KMS キーを示します。

• Condition: (オプション) 権限付与が有効になる条件。 条件を使用して API リクエストのコンテキストを評価し、ポリシーステートメントを適用するかどうかを決定します。 フォーマットは "Condition": {"condition operator": {"condition key": "condition value"}} です。 詳細については、「キーポリシーの概要」をご参照ください。

キーの保管場所。 このパラメーターは、ハードウェアキー管理インスタンスに DKMSInstanceId が指定されている場合にのみ有効です。有効な値：

• HsmInternal (デフォルト): キーは HSM に保存され、ローテーションはサポートされていません。

• HsmEncryptedDatabase: キーはデータベースに保存されます。

  • 対称キー: ローテーションがサポートされています。

  • 非対称キー: ローテーションはサポートされていません。