Commencer à utiliser l'API Cloud Control

Utilisez ce court didacticiel pour commencer à effectuer des opérations sur les ressources avec AWS Cloud Control API. Vous apprendrez les bases de l'utilisation de l'API Cloud Control pour créer, lire, mettre à jour, supprimer et répertorier des ressources.

Étape 1 : Création d'une ressource

Pour ce didacticiel, créez une ressource de typeAWS::Logs::LogGroup. Nommez ce groupe CloudControlExample de journaux et définissez une politique de conservation de 90 jours pour ce groupe.

1. Dans le AWS Command Line Interface (AWS CLI), exécutez la create-resource commande avec les paramètres suivants :

   • Spécifiez le type-name asAWS::Logs::LogGroup.

   • Spécifiez-le desired-state sous la forme d'une chaîne contenant du JSON qui définit les propriétés souhaitées :

     {"LogGroupName": "CloudControlExample", "RetentionInDays": 90}

   $ aws cloudcontrol create-resource --type-name AWS::Logs::LogGroup \
       --desired-state '{"LogGroupName": "CloudControlExample","RetentionInDays":90}'

   L'API Cloud Control renvoie un ProgressEvent objet contenant des informations sur le statut de votre demande d'opération de ressource.

   {
       "ProgressEvent": {
           "EventTime": "2021-08-26T22:07:23.347Z",
           "TypeName": "AWS::Logs::LogGroup",
           "OperationStatus": "IN_PROGRESS",
           "Operation": "CREATE",
           "Identifier": "CloudControlExample",
           "RequestToken": "758f4a4e-fef4-491a-9b07-00123456789"
       }
   }

2. Pour suivre l'état de votre demande d'opération sur les ressources, exécutez la get-resource-request-status commande avec le paramètre suivant :

   • Spécifiez le request-token paramètre comme valeur de RequestToken propriété renvoyée dans l'ProgressEventobjet.

   $ aws cloudcontrol get-resource-request-status --request-token 758f4a4e-fef4-491a-9b07-00123456789

   L'API Cloud Control renvoie un ProgressEvent objet contenant des informations sur le statut de votre demande d'opération de ressource. Lorsque l'API Cloud Control a créé la ressource avec succès, elle définit la OperationStatus valeur surSUCCESS.

   {
       "ProgressEvent": {
           "EventTime": "2021-08-26T22:29:23.326Z",
           "TypeName": "AWS::Logs::LogGroup",
           "OperationStatus": "SUCCESS",
           "Operation": "CREATE",
           "Identifier": "CloudControlExample",
           "RequestToken": "758f4a4e-fef4-491a-9b07-00123456789"
       }
   }

Étape 2 : lire (décrire) une ressource

Lisez ensuite l'état actuel de la ressource que vous venez de créer.

• Dans le AWS CLI, exécutez la get-resource commande avec le paramètre suivant :

  • Spécifiez identifier comme valeur de identifier propriété renvoyée dans l'ProgressEventobjet lorsque vous avez créé la ressource. Dans ce cas, il s'agit du CloudControlExample nom que vous avez spécifié pour le groupe de journaux.

  $ aws cloudcontrol get-resource --type-name AWS::Logs::LogGroup --identifier CloudControlExample

  L'API Cloud Control renvoie des informations détaillées sur l'état actuel de la ressource, y compris un modèle de ses propriétés et paramètres. Dans ce cas, cela inclut une propriété qui a été générée par Amazon CloudWatch Events lors de la création de la ressource. Arn

  {
      "TypeName": "AWS::Logs::LogGroup", 
      "ResourceDescription": {
          "Identifier": "CloudControlExample", 
          "ResourceModel": '{"RetentionInDays": 90, "LogGroupName": "CloudControlExample", "Arn": "arn:aws:logs:us-west-2:090123456789:log-group:CloudControlExample:*"}'
      }
  }

Étape 3 : Mettre à jour une ressource

Ensuite, mettez à jour votre groupe de journaux pour doubler la politique de rétention à 180 jours.

1. Dans le AWS CLI, exécutez la update-resource commande avec le paramètre suivant :

   • Spécifiez le type-name asAWS::Logs::LogGroup.

   • Spécifiez identifier comme valeur de identifier propriété renvoyée dans l'ProgressEventobjet lorsque vous avez créé la ressource. Dans ce cas, il s'agit du CloudControlExample nom que vous avez spécifié pour le groupe de journaux.

   • Spécifiez le patch-document paramètre sous la forme d'une chaîne contenant du code JSON représentant une opération de remplacement qui met à jour la politique de rétention à 180 jours.

     [{"op": "replace", "path": "RetentionInDays", "value": 180}]

     Pour obtenir des informations détaillées sur la rédaction de documents de correctif, consultezRédaction du document de mise à jour.

   $ aws cloudcontrol update-resource --type-name AWS::Logs::LogGroup \
       --identifier CloudControlExample \
       --patch-document '[{"op": "replace", "path": "RetentionInDays", "value":180}]'

   L'API Cloud Control renvoie un ProgressEvent objet contenant des informations sur le statut de votre demande d'opération de ressource.

   {
       "ProgressEvent": {
           "EventTime": "2021-08-26T22:29:22.547Z", 
           "ResourceModel": '{"RetentionInDays":180,"LogGroupName":"CloudControlExample"}',
           "TypeName": "AWS::Logs::LogGroup",
           "OperationStatus": "IN_PROGRESS",
           "Operation": "UPDATE",
           "Identifier": "CloudControlExample", 
           "RequestToken": "2026055d-f21c-4b50-bd40-111111111111"
       }
   }

2. Pour suivre l'état de votre demande d'opération sur les ressources, exécutez la get-resource-request-status commande avec le paramètre suivant :

   • Spécifiez le request-token paramètre comme valeur de RequestToken propriété renvoyée dans l'ProgressEventobjet.

   $ aws cloudcontrol get-resource-request-status --request-token 2026055d-f21c-4b50-bd40-123456789012

   L'API Cloud Control renvoie un ProgressEvent objet contenant des informations sur le statut de votre demande d'opération de ressource. Lorsque l'API Cloud Control a correctement mis à jour la ressource, elle définit la OperationStatus valeur surSUCCESS.

   {
       "ProgressEvent": {
           "EventTime": "2021-08-26T22:29:23.326Z",
           "TypeName": "AWS::Logs::LogGroup",
           "OperationStatus": "SUCCESS",
           "Operation": "UPDATE",
           "Identifier": "CloudControlExample",
           "RequestToken": "2026055d-f21c-4b50-bd40-123456789012"
       }
   }

Étape 4 : Répertorier toutes les ressources d'un certain type

Ensuite, utilisez l'API Cloud Control pour découvrir les ressources de votre Compte AWS.

• Dans le AWS CLI, exécutez la list-resources commande avec le paramètre suivant :

  • Spécifiez le type-name asAWS::Logs::LogGroup.

  $ aws cloudcontrol list-resources --type-name AWS::Logs::LogGroup

  L'API Cloud Control renvoie une liste des AWS::Logs::LogGroup ressources de votre compte, par identifiant principal. Cela inclut CloudControlExample la ressource que vous avez créée dans le cadre de ce didacticiel, en plus de tous les autres groupes de journaux qui existent déjà dans votre compte. En outre, pour les AWS::Logs::LogGroup ressources, les informations renvoyées par list-resources incluent les propriétés de chaque ressource.

  {
      "TypeName": "AWS::Logs::LogGroup",
      "ResourceDescriptions": [
          {
              "Identifier": "CloudControlExample",
              "Properties": '{"RetentionInDays":180, "LogGroupName": "CloudControlExample", "Arn":"arn:aws:logs:us-west-2:090123456789:log-group:CloudControlExample:*"}'
          },
          {
              "Identifier": "AnotherLogGroupResourceExample",
              "Properties": '{"RetentionInDays": 90, "LogGroupName": "AnotherLogGroupResourceExample", "Arn": "arn:aws:logs:us-west-2:011111111111:log-group:AnotherLogGroupResourceExample:*"}'
          },
      ]
  }

Étape 5 : Supprimer une ressource

Enfin, supprimez votre groupe de journaux pour le nettoyer à partir de ce didacticiel.

1. Dans le AWS CLI, exécutez la delete-resource commande avec le paramètre suivant :

   • Spécifiez le type-name asAWS::Logs::LogGroup.

   • Spécifiez identifier comme valeur de identifier propriété renvoyée dans l'ProgressEventobjet lorsque vous avez créé la ressource. Dans ce cas, il s'agit du CloudControlExample nom que vous avez spécifié pour le groupe de journaux.

   $ aws cloudcontrol delete-resource --type-name AWS::Logs::LogGroup --identifier CloudControlExample

   L'API Cloud Control renvoie un ProgressEvent objet contenant des informations sur le statut de votre demande d'opération de ressource.

   {
       "ProgressEvent": {
           "EventTime": "2021-08-26T22:50:20.037Z",
           "TypeName": "AWS::Logs::LogGroup",
           "OperationStatus": "IN_PROGRESS",
           "Operation": "DELETE",
           "Identifier": "CloudControlExample",
           "RequestToken": "bb0ed9cd-84f9-44c2-b638-000000000000"
       }
   }

2. Pour suivre l'état de votre demande d'opération sur les ressources, exécutez la get-resource-request-status commande avec le paramètre suivant :

   • Spécifiez le request-token paramètre comme valeur de RequestToken propriété renvoyée dans l'ProgressEventobjet.

   $ aws cloudcontrol get-resource-request-status --request-token 2026055d-f21c-4b50-bd40-111111111111

   L'API Cloud Control renvoie un ProgressEvent objet contenant des informations sur le statut de votre demande d'opération de ressource. Lorsque l'API Cloud Control a correctement supprimé la ressource, elle définit la OperationStatus valeur surSUCCESS.

   {
       "ProgressEvent": {
           "EventTime": "2021-08-26T22:50:20.831Z",
           "TypeName": "AWS::Logs::LogGroup",
           "OperationStatus": "SUCCESS",
           "Operation": "DELETE",
           "Identifier": "CloudControlExample",
           "RequestToken": "bb0ed9cd-84f9-44c2-b638-000000000000"
       }
   }

Étapes suivantes

Pour obtenir des informations détaillées et des exemples sur l'utilisation de l'API Cloud Control avec des ressources, consultezOpérations relatives aux API ressources Cloud Control.