Cloud Control API-Beispiele mit AWS CLI - AWS Command Line Interface

Diese Dokumentation bezieht sich AWS CLI nur auf Version 1 von. Dokumentation zu Version 2 von finden Sie im Benutzerhandbuch für Version 2. AWS CLI

Die vorliegende Übersetzung wurde maschinell erstellt. Im Falle eines Konflikts oder eines Widerspruchs zwischen dieser übersetzten Fassung und der englischen Fassung (einschließlich infolge von Verzögerungen bei der Übersetzung) ist die englische Fassung maßgeblich.

Cloud Control API-Beispiele mit AWS CLI

Die folgenden Codebeispiele zeigen Ihnen, wie Sie mithilfe der AWS Command Line Interface with Cloud Control API Aktionen ausführen und allgemeine Szenarien implementieren.

Aktionen sind Codeauszüge aus größeren Programmen und müssen im Kontext ausgeführt werden. Während Aktionen Ihnen zeigen, wie Sie einzelne Service-Funktionen aufrufen, können Sie Aktionen im Kontext der zugehörigen Szenarien anzeigen.

Jedes Beispiel enthält einen Link zum vollständigen Quellcode, wo Sie Anleitungen zum Einrichten und Ausführen des Codes im Kontext finden.

Themen

Aktionen

Das folgende Codebeispiel zeigt, wie Siecreate-resource.

AWS CLI

So erstellen Sie eine Ressource

Im folgenden create-resource Beispiel wird eine benannte AWS ResourceExample: :Kinesis: :Stream-Ressource mit einer Aufbewahrungsdauer von 168 Stunden und einer Shard-Anzahl von drei erstellt.

aws cloudcontrol create-resource \ --type-name AWS::Kinesis::Stream \ --desired-state "{\"Name\": \"ResourceExample\",\"RetentionPeriodHours\":168, \"ShardCount\":3}"

Ausgabe:

{ "ProgressEvent": { "EventTime": 1632506656.706, "TypeName": "AWS::Kinesis::Stream", "OperationStatus": "IN_PROGRESS", "Operation": "CREATE", "Identifier": "ResourceExample", "RequestToken": "20999d87-e304-4725-ad84-832dcbfd7fc5" } }

Weitere Informationen finden Sie unter Erstellen einer Ressource im Benutzerhandbuch zu Cloud Control API.

  • Einzelheiten zur API finden Sie in der Befehlsreferenz CreateResource.AWS CLI

Das folgende Codebeispiel zeigt die Verwendungdelete-resource.

AWS CLI

So löschen Sie eine Ressource

Im folgenden delete-resource Beispiel wird eine AWS: :Kinesis: :Stream-Ressource mit der ID ResourceExample aus Ihrem Konto gelöscht. AWS

aws cloudcontrol delete-resource \ --type-name AWS::Kinesis::Stream \ --identifier ResourceExample

Ausgabe:

{ "ProgressEvent": { "TypeName": "AWS::Kinesis::Stream", "Identifier": "ResourceExample", "RequestToken": "e48f26ff-d0f9-4ab8-a878-120db1edf111", "Operation": "DELETE", "OperationStatus": "IN_PROGRESS", "EventTime": 1632950300.14 } }

Weitere Informationen finden Sie unter Löschen einer Ressource im Benutzerhandbuch zu Cloud Control API.

  • Einzelheiten zur API finden Sie in der Befehlsreferenz DeleteResource.AWS CLI

Das folgende Codebeispiel zeigt die Verwendungget-resource-request-status.

AWS CLI

So rufen Sie die Statusinformationen einer Ressourcenanforderung ab

Im folgenden Beispiel für get-resource-request-status werden Statusinformationen zur angegebenen Ressourcenanforderung abgerufen.

aws cloudcontrol get-resource-request-status \ --request-token "e1a6b86e-46bd-41ac-bfba-001234567890"

Ausgabe:

{ "ProgressEvent": { "TypeName": "AWS::Kinesis::Stream", "Identifier": "Demo", "RequestToken": "e1a6b86e-46bd-41ac-bfba-001234567890", "Operation": "CREATE", "OperationStatus": "FAILED", "EventTime": 1632950268.481, "StatusMessage": "Resource of type 'AWS::Kinesis::Stream' with identifier 'Demo' already exists.", "ErrorCode": "AlreadyExists" } }

Weitere Informationen finden Sie unter Verwalten von Ressourcenoperationsanforderungen im Benutzerhandbuch zu Cloud Control API.

Das folgende Codebeispiel zeigt die Verwendungget-resource.

AWS CLI

So rufen Sie den aktuellen Status einer Ressource ab

Das folgende get-resource Beispiel gibt den aktuellen Status der benannten AWS: :Kinesis: :Stream-Ressource zurück. ResourceExample

aws cloudcontrol get-resource \ --type-name AWS::Kinesis::Stream \ --identifier ResourceExample

Ausgabe:

{ "TypeName": "AWS::Kinesis::Stream", "ResourceDescription": { "Identifier": "ResourceExample", "Properties": "{\"Arn\":\"arn:aws:kinesis:us-west-2:099908667365:stream/ResourceExample\",\"RetentionPeriodHours\":168,\"Name\":\"ResourceExample\",\"ShardCount\":3}" } }

Weitere Informationen finden Sie unter Lesen des aktuellen Status einer Ressource im Benutzerhandbuch zu Cloud Control API.

  • Einzelheiten zur API finden Sie unter Befehlsreferenz GetResource.AWS CLI

Das folgende Codebeispiel zeigt die Verwendunglist-resource-requests.

AWS CLI

So listen Sie die aktiven Ressourcenoperationsanforderungen auf

Das folgende list-resource-requests Beispiel listet die Ressourcenanforderungen für CREATE- und UPDATE-Operationen auf, die in Ihrem AWS Konto fehlgeschlagen sind.

aws cloudcontrol list-resource-requests \ --resource-request-status-filter Operations=CREATE,OperationStatuses=FAILED

Ausgabe:

{ "ResourceRequestStatusSummaries": [ { "TypeName": "AWS::Kinesis::Stream", "Identifier": "Demo", "RequestToken": "e1a6b86e-46bd-41ac-bfba-633abcdfdbd7", "Operation": "CREATE", "OperationStatus": "FAILED", "EventTime": 1632950268.481, "StatusMessage": "Resource of type 'AWS::Kinesis::Stream' with identifier 'Demo' already exists.", "ErrorCode": "AlreadyExists" } ] }

Weitere Informationen finden Sie unter Verwalten von Ressourcenoperationsanforderungen im Benutzerhandbuch zu Cloud Control API.

Das folgende Codebeispiel zeigt die Verwendunglist-resources.

AWS CLI

So listen Sie die Ressourcen eines bestimmten Typs auf

Das folgende list-resources Beispiel listet die AWS: :Kinesis: :Stream-Ressourcen auf, die in Ihrem Konto bereitgestellt werden. AWS

aws cloudcontrol list-resources \ --type-name AWS::Kinesis::Stream

Ausgabe:

{ "TypeName": "AWS::Kinesis::Stream", "ResourceDescriptions": [ { "Identifier": "MyKinesisStream", "Properties": "{\"Name\":\"MyKinesisStream\"}" }, { "Identifier": "AnotherStream", "Properties": "{\"Name\":\"AnotherStream\"}" } ] }

Weitere Informationen finden Sie unter Ermitteln von Ressourcen im Benutzerhandbuch zu Cloud Control API.

  • Einzelheiten zur API finden Sie in der Befehlsreferenz ListResources.AWS CLI

Das folgende Codebeispiel zeigt die Verwendungupdate-resource.

AWS CLI

So aktualisieren Sie die Eigenschaften einer vorhandenen Ressource

Im folgenden update-resource Beispiel wird die Aufbewahrungsrichtlinie einer AWS: :Logs:: LogGroup -Ressource mit dem Namen ExampleLogGroup auf 90 Tage aktualisiert.

aws cloudcontrol update-resource \ --type-name AWS::Logs::LogGroup \ --identifier ExampleLogGroup \ --patch-document "[{\"op\":\"replace\",\"path\":\"/RetentionInDays\",\"value\":90}]"

Ausgabe:

{ "ProgressEvent": { "EventTime": "2021-08-09T18:17:15.219Z", "TypeName": "AWS::Logs::LogGroup", "OperationStatus": "IN_PROGRESS", "Operation": "UPDATE", "Identifier": "ExampleLogGroup", "RequestToken": "5f40c577-3534-4b20-9599-0b0123456789" } }

Weitere Informationen finden Sie unter Aktualisieren einer Ressource im Benutzerhandbuch zu Cloud Control API.

  • Einzelheiten zur API finden Sie UpdateResourcein der AWS CLI Befehlsreferenz.