Opérations MSK de configuration Amazon

Cette rubrique explique comment créer des MSK configurations personnalisées et comment effectuer des opérations sur celles-ci. Pour plus d'informations sur l'utilisation des MSK configurations pour créer ou mettre à jour des clusters, consultezAmazon MSK : comment ça marche.

Pour créer une MSK configuration

1. Créez un fichier dans lequel vous spécifiez les propriétés de configuration à définir et les valeurs que vous souhaitez leur attribuer. Voici le contenu d'un exemple de fichier de configuration.

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

2. Exécutez la AWS CLI commande suivante et remplacez config-file-path avec le chemin du fichier dans lequel vous avez enregistré votre configuration à l'étape précédente.

   Note

   Le nom que vous choisissez pour votre configuration doit correspondre à la regex suivante : « ^[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

   Voici un exemple de réponse réussie après l'exécution de cette commande.

   {
       "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. La commande précédente renvoie un Amazon Resource Name (ARN) pour votre nouvelle configuration. Enregistrez-le ARN car vous en avez besoin pour faire référence à cette configuration dans d'autres commandes. Si vous perdez votre configurationARN, vous pouvez répertorier toutes les configurations de votre compte pour la retrouver.

Pour mettre à jour une MSK configuration

1. Créez un fichier dans lequel vous spécifiez les propriétés de configuration que vous souhaitez mettre à jour et les valeurs que vous souhaitez leur attribuer. Voici le contenu d'un exemple de fichier de configuration.

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

2. Exécutez la AWS CLI commande suivante et remplacez config-file-path avec le chemin du fichier dans lequel vous avez enregistré votre configuration à l'étape précédente.

   Remplacez configuration-arn avec celui ARN que vous avez obtenu lors de la création de la configuration. Si vous n'avez pas enregistré le ARN lors de la création de la configuration, vous pouvez utiliser la list-configurations commande pour répertorier toutes les configurations de votre compte. La configuration que vous souhaitez voir figurer dans la liste apparaît dans la réponse. La ARN configuration apparaît également dans cette liste.

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

3. Voici un exemple de réponse réussie après l'exécution de cette commande.

   {
       "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
       }
   }

Pour supprimer une MSK configuration

La procédure suivante explique comment supprimer une configuration qui n'est pas attachée à un cluster. Vous ne pouvez pas supprimer une configuration attachée à un cluster.

1. Pour exécuter cet exemple, remplacez configuration-arn avec celui ARN que vous avez obtenu lors de la création de la configuration. Si vous n'avez pas enregistré le ARN lors de la création de la configuration, vous pouvez utiliser la list-configurations commande pour répertorier toutes les configurations de votre compte. La configuration que vous souhaitez voir figurer dans la liste apparaît dans la réponse. La ARN configuration apparaît également dans cette liste.

   aws kafka delete-configuration --arn configuration-arn

2. Voici un exemple de réponse réussie après l'exécution de cette commande.

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

Pour décrire une MSK configuration

1. La commande suivante renvoie les métadonnées relatives à la configuration. Pour obtenir une description détaillée de la configuration, exécutez le describe-configuration-revision.

   Pour exécuter cet exemple, remplacez configuration-arn avec celui ARN que vous avez obtenu lors de la création de la configuration. Si vous n'avez pas enregistré le ARN lors de la création de la configuration, vous pouvez utiliser la list-configurations commande pour répertorier toutes les configurations de votre compte. La configuration que vous souhaitez voir figurer dans la liste apparaît dans la réponse. La ARN configuration apparaît également dans cette liste.

   aws kafka describe-configuration --arn configuration-arn

2. Voici un exemple de réponse réussie après l'exécution de cette commande.

   {
       "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"
   }

Pour décrire une révision MSK de configuration

Si vous utilisez la describe-configuration commande pour décrire une MSK configuration, les métadonnées de la configuration s'affichent. Pour obtenir une description de la configuration, utilisez la commande describe-configuration-revision.

• Exécutez la commande suivante et remplacez configuration-arn avec celui ARN que vous avez obtenu lors de la création de la configuration. Si vous n'avez pas enregistré le ARN lors de la création de la configuration, vous pouvez utiliser la list-configurations commande pour répertorier toutes les configurations de votre compte. La configuration que vous souhaitez voir figurer dans la liste apparaît dans la réponse. La ARN configuration apparaît également dans cette liste.

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

  Voici un exemple de réponse réussie après l'exécution de cette commande.

  {
      "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"
  }

  La valeur de ServerProperties est codée à l'aide de base64. Si vous utilisez un décodeur base64 (par exemple, https://www.base64decode.org/) pour le décoder manuellement, vous obtenez le contenu du fichier de configuration d'origine utilisé pour créer la configuration personnalisée. Dans ce cas, vous obtenez ce qui suit :

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

Pour répertorier toutes les MSK configurations de votre compte pour la région actuelle

• Exécutez la commande suivante.

  aws kafka list-configurations

  Voici un exemple de réponse réussie après l'exécution de cette commande.

  {
      "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"
          }
      ]
  }