Erste Schritte mit der Cloud Control API

Verwenden Sie dieses kurze Tutorial, um mit der Durchführung von Ressourcenoperationen zu beginnen. AWS Cloud Control API Sie lernen die Grundlagen der Verwendung der Cloud Control API zum Erstellen, Lesen, Aktualisieren, Löschen und Auflisten von Ressourcen kennen.

Schritt 1: Eine Ressource erstellen

Erstellen Sie für dieses Tutorial eine Ressource des TypsAWS::Logs::LogGroup. Geben Sie dieser Protokollgruppe CloudControlExample einen Namen und legen Sie die Aufbewahrungsrichtlinie für sie auf 90 Tage fest.

1. Führen Sie in AWS Command Line Interface (AWS CLI) den create-resource Befehl mit den folgenden Parametern aus:

   • Geben Sie das type-name als anAWS::Logs::LogGroup.

   • Geben Sie die desired-state als Zeichenfolge an, die JSON enthält und die gewünschten Eigenschaften festlegt:

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

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

   Die Cloud Control API gibt ein ProgressEvent Objekt zurück, das Informationen über den Status Ihrer Ressourcenbetriebsanforderung enthält.

   {
       "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. Um den Status Ihrer Ressourcenbetriebsanforderung zu verfolgen, führen Sie den get-resource-request-status Befehl mit dem folgenden Parameter aus:

   • Geben Sie den request-token Parameter als RequestToken Eigenschaftswert an, der im ProgressEvent Objekt zurückgegeben wird.

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

   Die Cloud Control API gibt ein ProgressEvent Objekt zurück, das Informationen über den Status Ihrer Ressourcenbetriebsanforderung enthält. Wenn die Cloud Control API die Ressource erfolgreich erstellt hat, setzt sie den OperationStatus Wert aufSUCCESS.

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

Schritt 2: Eine Ressource lesen (beschreiben)

Lesen Sie als Nächstes den aktuellen Status der Ressource, die Sie gerade erstellt haben.

• Führen Sie im den AWS CLIget-resource Befehl mit dem folgenden Parameter aus:

  • Geben Sie identifier als identifier Eigenschaftswert an, der im ProgressEvent Objekt zurückgegeben wurde, als Sie die Ressource erstellt haben. In diesem Fall ist es der NameCloudControlExample, den Sie für die Protokollgruppe angegeben haben.

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

  Die Cloud Control API gibt detaillierte Informationen zum aktuellen Status der Ressource zurück, einschließlich eines Modells ihrer Eigenschaften und Einstellungen. In diesem Fall beinhaltet dies eine Eigenschaft,Arn, die von Amazon CloudWatch Events generiert wurde, als die Ressource erstellt wurde.

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

Schritt 3: Aktualisieren Sie eine Ressource

Aktualisieren Sie als Nächstes Ihre Protokollgruppe, um die Aufbewahrungsrichtlinie auf 180 Tage zu verdoppeln.

1. Führen Sie im den AWS CLIupdate-resource Befehl mit dem folgenden Parameter aus:

   • Geben Sie das type-name als anAWS::Logs::LogGroup.

   • Geben Sie identifier als identifier Eigenschaftswert an, der im ProgressEvent Objekt zurückgegeben wurde, als Sie die Ressource erstellt haben. In diesem Fall ist es der NameCloudControlExample, den Sie für die Protokollgruppe angegeben haben.

   • Geben Sie den patch-document Parameter als Zeichenfolge an, die JSON enthält und einen Ersatzvorgang darstellt, mit dem die Aufbewahrungsrichtlinie auf 180 Tage aktualisiert wird.

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

     Ausführliche Informationen zum Verfassen von Patch-Dokumenten finden Sie unterDas Patch-Dokument erstellen.

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

   Die Cloud Control API gibt ein ProgressEvent Objekt zurück, das Informationen über den Status Ihrer Ressourcenbetriebsanforderung enthält.

   {
       "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. Um den Status Ihrer Ressourcenbetriebsanforderung zu verfolgen, führen Sie den get-resource-request-status Befehl mit dem folgenden Parameter aus:

   • Geben Sie den request-token Parameter als RequestToken Eigenschaftswert an, der im ProgressEvent Objekt zurückgegeben wird.

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

   Die Cloud Control API gibt ein ProgressEvent Objekt zurück, das Informationen über den Status Ihrer Ressourcenbetriebsanforderung enthält. Wenn die Cloud Control API die Ressource erfolgreich aktualisiert hat, setzt sie den OperationStatus Wert aufSUCCESS.

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

Schritt 4: Alle Ressourcen eines bestimmten Typs auflisten

Verwenden Sie als Nächstes die Cloud Control API, um Ressourcen in Ihrem zu ermitteln AWS-Konto.

• Führen Sie in der AWS CLI den list-resources Befehl mit dem folgenden Parameter aus:

  • Geben Sie das type-name als anAWS::Logs::LogGroup.

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

  Die Cloud Control API gibt eine Liste der AWS::Logs::LogGroup Ressourcen in Ihrem Konto zurück, sortiert nach primärer ID. Dazu gehören die RessourceCloudControlExample, die Sie im Rahmen dieses Tutorials erstellt haben, sowie alle anderen Protokollgruppen, die bereits in Ihrem Konto vorhanden sind. Außerdem list-resources enthalten die von zurückgegebenen Informationen für AWS::Logs::LogGroup Ressourcen die Eigenschaften der einzelnen Ressourcen.

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

Schritt 5: Löschen Sie eine Ressource

Löschen Sie abschließend Ihre Protokollgruppe, um den Inhalt dieses Tutorials zu bereinigen.

1. Führen Sie im den AWS CLIdelete-resource Befehl mit dem folgenden Parameter aus:

   • Geben Sie das type-name als anAWS::Logs::LogGroup.

   • Geben Sie identifier als identifier Eigenschaftswert an, der im ProgressEvent Objekt zurückgegeben wurde, als Sie die Ressource erstellt haben. In diesem Fall ist es der NameCloudControlExample, den Sie für die Protokollgruppe angegeben haben.

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

   Die Cloud Control API gibt ein ProgressEvent Objekt zurück, das Informationen über den Status Ihrer Ressourcenbetriebsanforderung enthält.

   {
       "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. Um den Status Ihrer Ressourcenbetriebsanforderung zu verfolgen, führen Sie den get-resource-request-status Befehl mit dem folgenden Parameter aus:

   • Geben Sie den request-token Parameter als RequestToken Eigenschaftswert an, der im ProgressEvent Objekt zurückgegeben wird.

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

   Die Cloud Control API gibt ein ProgressEvent Objekt zurück, das Informationen über den Status Ihrer Ressourcenbetriebsanforderung enthält. Wenn die Cloud Control API die Ressource erfolgreich gelöscht hat, setzt sie den OperationStatus Wert aufSUCCESS.

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

Nächste Schritte

Ausführliche Informationen und Beispiele zur Verwendung der Cloud Control API mit Ressourcen finden Sie unterDurchführen von Ressourcenoperationen.