Beispiele für die Verwendung von AWS CLI mit EventBridge Pipes - AWS Command Line Interface
Aktionen

Beispiele für die Verwendung von AWS CLI mit EventBridge Pipes

Die folgenden Codebeispiele zeigen, wie Sie Aktionen durchführen und gängige Szenarien implementieren, indem Sie die AWS Command Line Interface mit EventBridge Pipes nutzen.

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 create-pipe verwendet wird.

AWS CLI

So erstellen Sie eine Pipe

Im folgenden Beispiel für create-pipe wird eine Pipe mit dem Namen Demo_Pipe mit SQS als Quelle und CloudWatch Log Group als Ziel für die Pipe erstellt.

aws pipes create-pipe \
    --name Demo_Pipe \
    --desired-state RUNNING \
    --role-arn arn:aws:iam::123456789012:role/service-role/Amazon_EventBridge_Pipe_Demo_Pipe_28b3aa4f \
    --source arn:aws:sqs:us-east-1:123456789012:Demo_Queue \
    --target arn:aws:logs:us-east-1:123456789012:log-group:/aws/pipes/Demo_LogGroup

Ausgabe:

{
    "Arn": "arn:aws:pipes:us-east-1:123456789012:pipe/Demo_Pipe",
    "Name": "Demo_Pipe",
    "DesiredState": "RUNNING",
    "CurrentState": "CREATING",
    "CreationTime": "2024-10-08T12:33:59-05:00",
    "LastModifiedTime": "2024-10-08T12:33:59.684839-05:00"
}

Weitere Informationen finden Sie unter Amazon EventBridge Pipes-Konzepte im Benutzerhandbuch zu Amazon EventBridge.

  • API-Details finden Sie unter CreatePipe in der AWS CLI-Befehlsreferenz.

Das folgende Codebeispiel zeigt, wie delete-pipe verwendet wird.

AWS CLI

So löschen Sie eine vorhandene Pipe

Im folgenden Beispiel für delete-pipe wird eine Pipe mit dem Namen Demo_Pipe im angegebenen Konto gelöscht.

aws pipes delete-pipe \
    --name Demo_Pipe

Ausgabe:

{
    "Arn": "arn:aws:pipes:us-east-1:123456789012:pipe/Demo_Pipe",
    "Name": "Demo_Pipe",
    "DesiredState": "STOPPED",
    "CurrentState": "DELETING",
    "CreationTime": "2024-10-08T09:29:10-05:00",
    "LastModifiedTime": "2024-10-08T11:57:22-05:00"
}

Weitere Informationen finden Sie unter Amazon EventBridge Pipes-Konzepte im Benutzerhandbuch zu Amazon EventBridge.

  • API-Details finden Sie unter DeletePipe in der AWS CLI-Befehlsreferenz.

Das folgende Codebeispiel zeigt, wie describe-pipe verwendet wird.

AWS CLI

So rufen Sie Informationen zu einem Auftrag ab

Im folgenden Beispiel für describe-pipe werden Informationen zu der Pipe Demo_Pipe im angegebenen Konto angezeigt.

aws pipes describe-pipe \
    --name Demo_Pipe

Ausgabe:

{
    "Arn": "arn:aws:pipes:us-east-1:123456789012:pipe/Demo_Pipe",
    "Name": "Demo_Pipe",
    "DesiredState": "RUNNING",
    "CurrentState": "RUNNING",
    "StateReason": "User initiated",
    "Source": "arn:aws:sqs:us-east-1:123456789012:Demo_Queue",
    "SourceParameters": {
        "SqsQueueParameters": {
            "BatchSize": 1
        }
    },
    "EnrichmentParameters": {},
    "Target": "arn:aws:logs:us-east-1:123456789012:log-group:/aws/pipes/Demo_LogGroup",
    "TargetParameters": {},
    "RoleArn": "arn:aws:iam::123456789012:role/service-role/Amazon_EventBridge_Pipe_Demo_Pipe_28b3aa4f",
    "Tags": {},
    "CreationTime": "2024-10-08T09:29:10-05:00",
    "LastModifiedTime": "2024-10-08T10:23:47-05:00",
    "LogConfiguration": {
        "CloudwatchLogsLogDestination": {
            "LogGroupArn": "arn:aws:logs:us-east-1:123456789012:log-group:/aws/vendedlogs/pipes/Demo_Pipe"
        },
        "Level": "ERROR"
    }
}

Weitere Informationen finden Sie unter Amazon EventBridge Pipes-Konzepte im Benutzerhandbuch zu Amazon EventBridge.

  • API-Details finden Sie unter DescribePipe in der AWS CLI-Befehlsreferenz.

Das folgende Codebeispiel zeigt, wie list-pipes verwendet wird.

AWS CLI

So rufen Sie eine Liste von Pipes ab

Das folgende Beispiel für list-pipes listet alle Pipes im angegebenen Konto auf.

aws pipes list-pipes

Ausgabe:

{
    "Pipes": [
        {
            "Name": "Demo_Pipe",
            "Arn": "arn:aws:pipes:us-east-1:123456789012:pipe/Demo_Pipe",
            "DesiredState": "RUNNING",
            "CurrentState": "RUNNING",
            "StateReason": "User initiated",
            "CreationTime": "2024-10-08T09:29:10-05:00",
            "LastModifiedTime": "2024-10-08T10:23:47-05:00",
            "Source": "arn:aws:sqs:us-east-1:123456789012:Demo_Queue",
            "Target": "arn:aws:logs:us-east-1:123456789012:log-group:/aws/pipes/Demo_LogGroup"
        }
    ]
}

Weitere Informationen finden Sie unter Amazon EventBridge Pipes-Konzepte im Benutzerhandbuch zu Amazon EventBridge.

  • API-Details finden Sie unter ListPipes in der AWS CLI-Befehlsreferenz.

Das folgende Codebeispiel zeigt, wie list-tags-for-resource verwendet wird.

AWS CLI

So listen Sie die Tags auf, die einer vorhandenen Pipe zugeordnet sind

Im folgenden Beispiel für list-tags-for-resource werden alle Tags aufgelistet, die einer Pipe mit dem Namen Demo_Pipe im angegebenen Konto zugeordnet sind.

aws pipes list-tags-for-resource \
    --resource-arn arn:aws:pipes:us-east-1:123456789012:pipe/Demo_Pipe

Ausgabe:

{
    "tags": {
        "stack": "Production",
        "team": "DevOps"
    }
}

Weitere Informationen finden Sie unter Amazon EventBridge Pipes-Konzepte im Benutzerhandbuch zu Amazon EventBridge.

Das folgende Codebeispiel zeigt, wie start-pipe verwendet wird.

AWS CLI

So starten Sie eine vorhandene Pipe

Im folgenden Beispiel für start-pipe wird eine Pipe mit dem Namen Demo_Pipe im angegebenen Konto gestartet.

aws pipes start-pipe \
    --name Demo_Pipe

Ausgabe:

{
    "Arn": "arn:aws:pipes:us-east-1:123456789012:pipe/Demo_Pipe",
    "Name": "Demo_Pipe",
    "DesiredState": "RUNNING",
    "CurrentState": "STARTING",
    "CreationTime": "2024-10-08T09:29:10-05:00",
    "LastModifiedTime": "2024-10-08T10:17:24-05:00"
}

Weitere Informationen finden Sie unter So starten oder stoppen Sie eine Amazon-EventBridge-Pipe im Benutzerhandbuch zu Amazon EventBridge.

  • API-Details finden Sie unter StartPipe in der AWS CLI-Befehlsreferenz.

Das folgende Codebeispiel zeigt, wie stop-pipe verwendet wird.

AWS CLI

So stoppen Sie eine vorhandene Pipe

Im folgenden Beispiel für stop-pipe wird eine Pipe mit dem Namen Demo_Pipe im angegebenen Konto gestoppt.

aws pipes stop-pipe \
    --name Demo_Pipe

Ausgabe:

{
    "Arn": "arn:aws:pipes:us-east-1:123456789012:pipe/Demo_Pipe",
    "Name": "Demo_Pipe",
    "DesiredState": "STOPPED",
    "CurrentState": "STOPPING",
    "CreationTime": "2024-10-08T09:29:10-05:00",
    "LastModifiedTime": "2024-10-08T09:29:49-05:00"
}

Weitere Informationen finden Sie unter So starten oder stoppen Sie eine Amazon-EventBridge-Pipe im Benutzerhandbuch zu Amazon EventBridge.

  • API-Details finden Sie unter StopPipe in der AWS CLI-Befehlsreferenz.

Das folgende Codebeispiel zeigt, wie tag-resource verwendet wird.

AWS CLI

So fügen Sie einer vorhandenen Pipe einen Tag hinzu

Im folgenden Beispiel für tag-resource wird einer Pipe mit dem Namen Demo_Pipe ein Tag hinzugefügt. Wird der Befehl erfolgreich ausgeführt, wird keine Ausgabe zurückgegeben.

aws pipes tag-resource \
    --resource-arn arn:aws:pipes:us-east-1:123456789012:pipe/Demo_Pipe \
    --tags stack=Production

Weitere Informationen finden Sie unter Amazon EventBridge Pipes-Konzepte im Benutzerhandbuch zu Amazon EventBridge.

  • API-Details finden Sie unter TagResource in der AWS CLI-Befehlsreferenz.

Das folgende Codebeispiel zeigt, wie untag-resource verwendet wird.

AWS CLI

So entfernen Sie ein Tag von einer vorhandenen Pipe

Im folgenden Beispiel für untag-resource wird das Tag mit dem Schlüssel stack von der Pipe mit dem Namen Demo_Pipe entfernt. Wird der Befehl erfolgreich ausgeführt, wird keine Ausgabe zurückgegeben.

aws pipes untag-resource \
    --resource-arn arn:aws:pipes:us-east-1:123456789012:pipe/Demo_Pipe \
    --tags stack

Weitere Informationen finden Sie unter Amazon EventBridge Pipes-Konzepte im Benutzerhandbuch zu Amazon EventBridge.

  • API-Details finden Sie unter UntagResource in der AWS CLI-Befehlsreferenz.

Das folgende Codebeispiel zeigt, wie update-pipe verwendet wird.

AWS CLI

So aktualisieren Sie eine vorhandene Pipe

Im folgenden Beispiel für update-pipe wird die Pipe mit dem Namen Demo_Pipe aktualisiert, indem ein CloudWatch Log-Konfigurationsparameter hinzugefügt wird. Achten Sie darauf, dass die Ausführungsrolle der Pipe aktualisiert wird, sodass sie die richtigen Berechtigungen für das Protokollziel hat.

aws pipes update-pipe \
    --name Demo_Pipe \
    --desired-state RUNNING \
    --log-configuration CloudwatchLogsLogDestination={LogGroupArn=arn:aws:logs:us-east-1:123456789012:log-group:/aws/vendedlogs/pipes/Demo_Pipe},Level=TRACE \
    --role-arn arn:aws:iam::123456789012:role/service-role/Amazon_EventBridge_Pipe_Demo_Pipe_28b3aa4f

Ausgabe:

{
    "Arn": "arn:aws:pipes:us-east-1:123456789012:pipe/Demo_Pipe",
    "Name": "Demo_Pipe",
    "DesiredState": "RUNNING",
    "CurrentState": "UPDATING",
    "CreationTime": "2024-10-08T09:29:10-05:00",
    "LastModifiedTime": "2024-10-08T11:35:48-05:00"
}

Weitere Informationen finden Sie unter Amazon EventBridge Pipes-Konzepte im Benutzerhandbuch zu Amazon EventBridge.

  • API-Details finden Sie unter UpdatePipe in der AWS CLI-Befehlsreferenz.