Guida introduttiva all'API Cloud Control

Usa questo breve tutorial per iniziare a eseguire operazioni sulle risorse con. AWS Cloud Control API Imparerai le basi dell'utilizzo dell'API Cloud Control per creare, leggere, aggiornare, eliminare ed elencare risorse.

Passaggio 1: crea una risorsa

Per questo tutorial, crea una risorsa di tipoAWS::Logs::LogGroup. Assegna un nome a questo gruppo CloudControlExample di log e imposta la politica di conservazione su di esso su 90 giorni.

1. In AWS Command Line Interface (AWS CLI), esegui il create-resource comando con i seguenti parametri:

   • Specificate l'type-nameasAWS::Logs::LogGroup.

   • desired-stateSpecificalo come stringa contenente JSON che imposta le proprietà desiderate:

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

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

   L'API Cloud Control restituisce un ProgressEvent oggetto che contiene informazioni sullo stato della richiesta di funzionamento delle risorse.

   {
       "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. Per tenere traccia dello stato della tua richiesta di gestione delle risorse, esegui il get-resource-request-status comando con il seguente parametro:

   • Specificate il request-token parametro come valore della RequestToken proprietà restituito nell'ProgressEventoggetto.

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

   L'API Cloud Control restituisce un ProgressEvent oggetto che contiene informazioni sullo stato della richiesta di funzionamento delle risorse. Quando Cloud Control API ha creato correttamente la risorsa, imposta il OperationStatus valore suSUCCESS.

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

Fase 2: Leggere (descrivere) una risorsa

Successivamente, leggi lo stato attuale della risorsa che hai appena creato.

• Nel AWS CLI, esegui il get-resource comando con il seguente parametro:

  • Specificate identifier come valore della identifier proprietà restituito nell'ProgressEventoggetto al momento della creazione della risorsa. In questo casoCloudControlExample, è il nome specificato per il gruppo di log.

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

  L'API Cloud Control restituisce informazioni dettagliate sullo stato attuale della risorsa, incluso un modello delle sue proprietà e impostazioni. In questo caso, include una proprietà generata da Amazon CloudWatch Events al momento della creazione della risorsa. Arn

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

Fase 3: Aggiornare una risorsa

Successivamente, aggiorna il gruppo di log per raddoppiare la politica di conservazione portandola a 180 giorni.

1. Nel AWS CLI, esegui il update-resource comando con il seguente parametro:

   • Specificare l'type-nameasAWS::Logs::LogGroup.

   • Specificate identifier come valore della identifier proprietà restituito nell'ProgressEventoggetto al momento della creazione della risorsa. In questo casoCloudControlExample, è il nome specificato per il gruppo di log.

   • Specificate il patch-document parametro come stringa contenente JSON che rappresenta un'operazione di sostituzione che aggiorna la politica di conservazione a 180 giorni.

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

     Per informazioni dettagliate sulla composizione dei documenti di patch, vedere. Composizione del documento di patch

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

   L'API Cloud Control restituisce un ProgressEvent oggetto che contiene informazioni sullo stato della richiesta di funzionamento delle risorse.

   {
       "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. Per tenere traccia dello stato della tua richiesta di gestione delle risorse, esegui il get-resource-request-status comando con il seguente parametro:

   • Specificate il request-token parametro come valore della RequestToken proprietà restituito nell'ProgressEventoggetto.

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

   L'API Cloud Control restituisce un ProgressEvent oggetto che contiene informazioni sullo stato della richiesta di funzionamento delle risorse. Quando l'API Cloud Control ha aggiornato correttamente la risorsa, imposta il OperationStatus valore suSUCCESS.

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

Passaggio 4: Elenca tutte le risorse di un determinato tipo

Successivamente, utilizza l'API Cloud Control per scoprire le risorse del tuo Account AWS.

• In AWS CLI, esegui il list-resources comando con il seguente parametro:

  • Specificare l'type-nameasAWS::Logs::LogGroup.

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

  L'API Cloud Control restituisce un elenco delle AWS::Logs::LogGroup risorse del tuo account, per identificatore principale. Ciò include CloudControlExample la risorsa che hai creato come parte di questo tutorial, oltre a qualsiasi altro gruppo di log già esistente nel tuo account. Inoltre, per quanto riguarda AWS::Logs::LogGroup le risorse, le informazioni restituite da list-resources includono le proprietà di ciascuna risorsa.

  {
      "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:*"}'
          },
      ]
  }

Fase 5: Eliminare una risorsa

Infine, elimina il gruppo di log da ripulire da questo tutorial.

1. Nel AWS CLI, esegui il delete-resource comando con il seguente parametro:

   • Specificare l'type-nameasAWS::Logs::LogGroup.

   • Specificate identifier come valore della identifier proprietà restituito nell'ProgressEventoggetto al momento della creazione della risorsa. In questo casoCloudControlExample, è il nome specificato per il gruppo di log.

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

   L'API Cloud Control restituisce un ProgressEvent oggetto che contiene informazioni sullo stato della richiesta di funzionamento delle risorse.

   {
       "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. Per tenere traccia dello stato della tua richiesta di gestione delle risorse, esegui il get-resource-request-status comando con il seguente parametro:

   • Specificate il request-token parametro come valore della RequestToken proprietà restituito nell'ProgressEventoggetto.

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

   L'API Cloud Control restituisce un ProgressEvent oggetto che contiene informazioni sullo stato della richiesta di funzionamento delle risorse. Quando l'API Cloud Control ha eliminato con successo la risorsa, imposta il OperationStatus valore suSUCCESS.

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

Passaggi successivi

Per informazioni dettagliate ed esempi sull'utilizzo dell'API Cloud Control con le risorse, consultaOperazioni relative alle API risorse di Cloud Control.