Amazon MSK 設定オペレーション

このトピックでは、カスタム MSK 設定を作成する方法と、それらの設定に対してオペレーションを実行する方法について説明します。MSK 設定を使用してクラスターを作成または更新する方法については、「Amazon MSK: 仕組み」を参照してください。

MSK 設定を作成するには

1. 設定する設定プロパティと、それらに割り当てる値を指定するファイルを作成します。次に、設定ファイルの例を示します。

   auto.create.topics.enable = true
   
   log.roll.ms = 604800000

2. AWS CLI 次のコマンドを実行し、config-file-path前のステップで設定を保存したファイルへのパスに置き換えます。

   注記

   設定に選択する名前は、次の正規表現「^[0-9A-Za-z][0-9A-Za-z-]{0,}$」と一致する必要があります。

   aws kafka create-configuration --name "ExampleConfigurationName" --description "Example configuration description." --kafka-versions "1.1.1" --server-properties fileb://config-file-path

   このコマンドを実行した後の正常なレスポンスの例を以下に示します。

   {
       "Arn": "arn:aws:kafka:us-east-1:123456789012:configuration/SomeTest/abcdabcd-1234-abcd-1234-abcd123e8e8e-1",
       "CreationTime": "2019-05-21T19:37:40.626Z",
       "LatestRevision": {
           "CreationTime": "2019-05-21T19:37:40.626Z",
           "Description": "Example configuration description.",
           "Revision": 1
       },
       "Name": "ExampleConfigurationName"
   }

3. 上記のコマンドは、新しい設定の Amazon リソースネーム (ARN) を返します。この ARN は、他のコマンドでこの設定を参照する必要があるため、保存します。設定の ARN を紛失した場合は、アカウント内のすべての設定をリストして、ARN を再確認することができます。

MSK 設定を更新するには

1. 更新する設定プロパティと、それらに割り当てる値を指定するファイルを作成します。次に、設定ファイルの例を示します。

   auto.create.topics.enable = true
   
   min.insync.replicas = 2

2. AWS CLI 次のコマンドを実行し、config-file-path前のステップで設定を保存したファイルへのパスに置き換えます。

   configuration-arn は、設定の作成時に取得した ARN に置き換えてください。設定の作成時に ARN を保存しなかった場合は、list-configurations コマンドを使用して、アカウント内のすべての設定をリストすることができます。目的の設定がレスポンス内のリストに表示されます。設定の ARN もそのリストに表示されます。

   aws kafka update-configuration --arn configuration-arn --description "Example configuration revision description." --server-properties fileb://config-file-path

3. このコマンドを実行した後の正常なレスポンスの例を以下に示します。

   {
       "Arn": "arn:aws:kafka:us-east-1:123456789012:configuration/SomeTest/abcdabcd-1234-abcd-1234-abcd123e8e8e-1",
       "LatestRevision": {
           "CreationTime": "2020-08-27T19:37:40.626Z",
           "Description": "Example configuration revision description.",
           "Revision": 2
       }
   }

MSK 設定を削除するには

次の手順は、クラスターに接続されていない設定を削除する方法を示しています。クラスターに添付されている設定を削除することはできません。

1. この例を実行する際には、configuration-arn を、設定の作成時に取得した ARN に置き換えてください。設定の作成時に ARN を保存しなかった場合は、list-configurations コマンドを使用して、アカウント内のすべての設定をリストすることができます。目的の設定がレスポンス内のリストに表示されます。設定の ARN もそのリストに表示されます。

   aws kafka delete-configuration --arn configuration-arn

2. このコマンドを実行した後の正常なレスポンスの例を以下に示します。

   {
       "arn": " arn:aws:kafka:us-east-1:123456789012:configuration/SomeTest/abcdabcd-1234-abcd-1234-abcd123e8e8e-1",
       "state": "DELETING"
   }

MSK 設定を説明するには

1. 次のコマンドは、設定に関するメタデータを返します。設定の詳細な説明を取得するには、describe-configuration-revision を実行します。

   この例を実行する際には、configuration-arn を、設定の作成時に取得した ARN に置き換えてください。設定の作成時に ARN を保存しなかった場合は、list-configurations コマンドを使用して、アカウント内のすべての設定をリストすることができます。目的の設定がレスポンス内のリストに表示されます。設定の ARN もそのリストに表示されます。

   aws kafka describe-configuration --arn configuration-arn

2. このコマンドを実行した後の正常なレスポンスの例を以下に示します。

   {
       "Arn": "arn:aws:kafka:us-east-1:123456789012:configuration/SomeTest/abcdabcd-abcd-1234-abcd-abcd123e8e8e-1",
       "CreationTime": "2019-05-21T00:54:23.591Z",
       "Description": "Example configuration description.",
       "KafkaVersions": [
           "1.1.1"
       ],
       "LatestRevision": {
           "CreationTime": "2019-05-21T00:54:23.591Z",
           "Description": "Example configuration description.",
           "Revision": 1
       },
       "Name": "SomeTest"
   }

MSK 設定リビジョンの説明

describe-configuration コマンドを使用して MSK 設定を記述すると、設定のメタデータが表示されます。設定の詳細な記述を取得するには、describe-configuration-revision コマンドを使用します。

• 次のコマンドを実行します。configuration-arn は、設定の作成時に取得した ARN に置き換えてください。設定の作成時に ARN を保存しなかった場合は、list-configurations コマンドを使用して、アカウント内のすべての設定をリストすることができます。目的の設定がレスポンス内のリストに表示されます。設定の ARN もそのリストに表示されます。

  aws kafka describe-configuration-revision --arn configuration-arn --revision 1

  このコマンドを実行した後の正常なレスポンスの例を以下に示します。

  {
      "Arn": "arn:aws:kafka:us-east-1:123456789012:configuration/SomeTest/abcdabcd-abcd-1234-abcd-abcd123e8e8e-1",
      "CreationTime": "2019-05-21T00:54:23.591Z",
      "Description": "Example configuration description.",
      "Revision": 1,
      "ServerProperties": "YXV0by5jcmVhdGUudG9waWNzLmVuYWJsZSA9IHRydWUKCgp6b29rZWVwZXIuY29ubmVjdGlvbi50aW1lb3V0Lm1zID0gMTAwMAoKCmxvZy5yb2xsLm1zID0gNjA0ODAwMDAw"
  }

  ServerProperties の値は base64 でエンコードされます。base64 デコーダー (https://www.base64decode.org/ など) を使用して手動でデコードする場合は、カスタム設定の作成に使用した元の設定ファイルの内容を取得します。この場合、次のようになります。

  auto.create.topics.enable = true
  
  log.roll.ms = 604800000

現在のリージョンのアカウントにあるすべての MSK 設定を一覧表示するには

• 以下のコマンドを実行します。

  aws kafka list-configurations

  このコマンドを実行した後の正常なレスポンスの例を以下に示します。

  {
      "Configurations": [
          {
              "Arn": "arn:aws:kafka:us-east-1:123456789012:configuration/SomeTest/abcdabcd-abcd-1234-abcd-abcd123e8e8e-1",
              "CreationTime": "2019-05-21T00:54:23.591Z",
              "Description": "Example configuration description.",
              "KafkaVersions": [
                  "1.1.1"
              ],
              "LatestRevision": {
                  "CreationTime": "2019-05-21T00:54:23.591Z",
                  "Description": "Example configuration description.",
                  "Revision": 1
              },
              "Name": "SomeTest"
          },
          {
              "Arn": "arn:aws:kafka:us-east-1:123456789012:configuration/SomeTest/abcdabcd-1234-abcd-1234-abcd123e8e8e-1",
              "CreationTime": "2019-05-03T23:08:29.446Z",
              "Description": "Example configuration description.",
              "KafkaVersions": [
                  "1.1.1"
              ],
              "LatestRevision": {
                  "CreationTime": "2019-05-03T23:08:29.446Z",
                  "Description": "Example configuration description.",
                  "Revision": 1
              },
              "Name": "ExampleConfigurationName"
          }
      ]
  }