CloudHSM CLI でユーザーをレプリケートする - AWS CloudHSM
ユーザータイプ要件Syntax例引数関連トピック

CloudHSM CLI でユーザーをレプリケートする

CloudHSM CLI の user replicate コマンドを使用して、送信元の AWS CloudHSM クラスターから送信先の AWS CloudHSM クラスターにユーザーをレプリケートします。

ユーザータイプ

このコマンドは、次のタイプのユーザーが実行できます。

  • 管理者 (CO)

要件

  • 送信元クラスターと送信先クラスターはクローンである必要があります。つまり、一方が他方のバックアップから作成されたか、どちらも共通のバックアップから作成されたということです。詳細については「バックアップからクラスターを作成する」を参照してください。

  • このコマンドを実行するには、送信元クラスターと送信先クラスターの両方で、管理者としてログインしている必要があります。

    • 単一コマンドモードでは、コマンドは CLOUDHSM_PIN および CLOUDHSM_ROLE 環境変数を使用してソースクラスターで認証します。詳細については「シングルコマンドモード」を参照してください。送信先クラスターの認証情報を提供するには、DESTINATION_CLOUDHSM_PIN と DESTINATION_CLOUDHSM_ROLE の 2 つの追加の環境変数を設定する必要があります。

      $ export DESTINATION_CLOUDHSM_ROLE=<role>
      $ export DESTINATION_CLOUDHSM_PIN=<username:password>

    • インタラクティブモードでは、ユーザーは送信元クラスターと送信先クラスターの両方に明示的にログインする必要があります。

Syntax

aws-cloudhsm > help user replicate
Replicate a user from a source to a destination cluster

Usage: user replicate --username <USERNAME> --role <ROLE> --source-cluster-id <SOURCE_CLUSTER_ID> --destination-cluster-id <DESTINATION_CLUSTER_ID>

Options:
      --username <USERNAME>
          Username of the user to replicate

      --role <ROLE>
          Role the user has in the cluster

          Possible values:
          - crypto-user: A CryptoUser has the ability to manage and use keys
          - admin:       An Admin has the ability to manage user accounts

      --source-cluster-id <SOURCE_CLUSTER_ID>
          Source cluster ID

      --destination-cluster-id <DESTINATION_CLUSTER_ID>
          Destination cluster ID

  -h, --help
          Print help (see a summary with '-h')

例

例: ユーザーをレプリケートする

このコマンドは、送信元のクラスターから送信先クラスター (クローン) にユーザーをレプリケートします。以下の例は、両方のクラスターに管理者としてログインしたときの出力を示しています。

admin-user@cluster-1234abcdefg > user replicate \
      --username example-admin \
      --role admin \
      --source-cluster-id cluster-1234abcdefg \
      --destination-cluster-id cluster-2345bcdefgh
{
  "error_code": 0,
  "data": {
    "user": {
      "username": "example-admin",
      "role": "admin",
      "locked": "false",
      "mfa": [],
      "quorum": [],
      "cluster-coverage": "full"
    },
    "message": "Successfully replicated user"
  }
}

引数

<USERNAME>

ソースクラスターでレプリケートするユーザーのユーザー名を指定します。

必須: はい

<ROLE>

このユーザーに割り当てられるロールを指定します。このパラメータは必須です。有効な値は admin、crypto-user です。

ユーザーのロールを取得するには、user list コマンドを使用します。HSM のユーザータイプの詳細については、「HSM ユーザーについて」を参照してください。

必須: はい

<SOURCE_CLUSTER_ID>

送信元クラスターの ID。

必須: はい

<DESTINATION_CLUSTER_ID>

送信先クラスターの ID。

必須: はい

関連トピック