EventBridge Exemples de tuyaux utilisant AWS CLI

Mode de mise au point

EventBridge Exemples de tuyaux utilisant AWS CLI - AWS Command Line Interface

Les exemples de code suivants vous montrent comment effectuer des actions et implémenter des scénarios courants à l'aide de AWS Command Line Interface with EventBridge Pipes.

Les actions sont des extraits de code de programmes plus larges et doivent être exécutées dans leur contexte. Alors que les actions vous indiquent comment appeler des fonctions de service individuelles, vous pouvez les voir en contexte dans leurs scénarios associés.

Chaque exemple inclut un lien vers le code source complet, où vous trouverez des instructions sur la façon de configurer et d'exécuter le code en contexte.

Rubriques

Actions

Actions

L'exemple de code suivant montre comment utilisercreate-pipe.

AWS CLI

Pour créer un tuyau

L'create-pipeexemple suivant crée un canal nommé Demo_Pipe avec SQS comme source et CloudWatch Log Group comme cible pour le canal.


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

Sortie :


{
    "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"
}

Pour plus d'informations, consultez les concepts d'Amazon EventBridge Pipes dans le guide de EventBridge l'utilisateur Amazon.

Pour plus de détails sur l'API, reportez-vous CreatePipeà la section Référence des AWS CLI commandes.

create-pipe

L'exemple de code suivant montre comment utilisercreate-pipe.

AWS CLI

Pour créer un tuyau

L'create-pipeexemple suivant crée un canal nommé Demo_Pipe avec SQS comme source et CloudWatch Log Group comme cible pour le canal.


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

Sortie :


{
    "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"
}

Pour plus d'informations, consultez les concepts d'Amazon EventBridge Pipes dans le guide de EventBridge l'utilisateur Amazon.

Pour plus de détails sur l'API, reportez-vous CreatePipeà la section Référence des AWS CLI commandes.

L'exemple de code suivant montre comment utiliserdelete-pipe.

AWS CLI

Pour supprimer un canal existant

L'delete-pipeexemple suivant supprime un Pipe nommé Demo_Pipe dans le compte spécifié.


aws pipes delete-pipe \
    --name Demo_Pipe

Sortie :


{
    "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"
}

Pour plus d'informations, consultez les concepts d'Amazon EventBridge Pipes dans le guide de EventBridge l'utilisateur Amazon.

Pour plus de détails sur l'API, reportez-vous DeletePipeà la section Référence des AWS CLI commandes.

delete-pipe

L'exemple de code suivant montre comment utiliserdelete-pipe.

AWS CLI

Pour supprimer un canal existant

L'delete-pipeexemple suivant supprime un Pipe nommé Demo_Pipe dans le compte spécifié.


aws pipes delete-pipe \
    --name Demo_Pipe

Sortie :


{
    "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"
}

Pour plus d'informations, consultez les concepts d'Amazon EventBridge Pipes dans le guide de EventBridge l'utilisateur Amazon.

Pour plus de détails sur l'API, reportez-vous DeletePipeà la section Référence des AWS CLI commandes.

L'exemple de code suivant montre comment utiliserdescribe-pipe.

AWS CLI

Pour récupérer des informations sur un tuyau

L'describe-pipeexemple suivant affiche des informations sur le Pipe Demo_Pipe dans le compte spécifié.


aws pipes describe-pipe \
    --name Demo_Pipe

Sortie :


{
    "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"
    }
}

Pour plus d'informations, consultez les concepts d'Amazon EventBridge Pipes dans le guide de EventBridge l'utilisateur Amazon.

Pour plus de détails sur l'API, reportez-vous DescribePipeà la section Référence des AWS CLI commandes.

describe-pipe

L'exemple de code suivant montre comment utiliserdescribe-pipe.

AWS CLI

Pour récupérer des informations sur un tuyau

L'describe-pipeexemple suivant affiche des informations sur le Pipe Demo_Pipe dans le compte spécifié.


aws pipes describe-pipe \
    --name Demo_Pipe

Sortie :


{
    "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"
    }
}

Pour plus d'informations, consultez les concepts d'Amazon EventBridge Pipes dans le guide de EventBridge l'utilisateur Amazon.

Pour plus de détails sur l'API, reportez-vous DescribePipeà la section Référence des AWS CLI commandes.

L'exemple de code suivant montre comment utiliserlist-pipes.

AWS CLI

Pour récupérer une liste de tuyaux

L'list-pipesexemple suivant montre tous les canaux du compte spécifié.


aws pipes list-pipes

Sortie :


{
    "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"
        }
    ]
}

Pour plus d'informations, consultez les concepts d'Amazon EventBridge Pipes dans le guide de EventBridge l'utilisateur Amazon.

Pour plus de détails sur l'API, reportez-vous ListPipesà la section Référence des AWS CLI commandes.

list-pipes

L'exemple de code suivant montre comment utiliserlist-pipes.

AWS CLI

Pour récupérer une liste de tuyaux

L'list-pipesexemple suivant montre tous les canaux du compte spécifié.


aws pipes list-pipes

Sortie :


{
    "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"
        }
    ]
}

Pour plus d'informations, consultez les concepts d'Amazon EventBridge Pipes dans le guide de EventBridge l'utilisateur Amazon.

Pour plus de détails sur l'API, reportez-vous ListPipesà la section Référence des AWS CLI commandes.

L'exemple de code suivant montre comment utiliserlist-tags-for-resource.

AWS CLI

Pour répertorier les balises associées à un canal existant

L'list-tags-for-resourceexemple suivant répertorie toutes les balises associées à un canal nommé Demo_Pipe dans le compte spécifié.


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

Sortie :


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

Pour plus d'informations, consultez les concepts d'Amazon EventBridge Pipes dans le guide de EventBridge l'utilisateur Amazon.

Pour plus de détails sur l'API, reportez-vous ListTagsForResourceà la section Référence des AWS CLI commandes.

list-tags-for-resource

L'exemple de code suivant montre comment utiliserlist-tags-for-resource.

AWS CLI

Pour répertorier les balises associées à un canal existant

L'list-tags-for-resourceexemple suivant répertorie toutes les balises associées à un canal nommé Demo_Pipe dans le compte spécifié.


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

Sortie :


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

Pour plus d'informations, consultez les concepts d'Amazon EventBridge Pipes dans le guide de EventBridge l'utilisateur Amazon.

Pour plus de détails sur l'API, reportez-vous ListTagsForResourceà la section Référence des AWS CLI commandes.

L'exemple de code suivant montre comment utiliserstart-pipe.

AWS CLI

Pour démarrer un tuyau existant

L'start-pipeexemple suivant démarre un Pipe nommé Demo_Pipe dans le compte spécifié.


aws pipes start-pipe \
    --name Demo_Pipe

Sortie :


{
    "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"
}

Pour plus d'informations, consultez la section Démarrage ou arrêt d'un EventBridge canal Amazon dans le guide de EventBridge l'utilisateur Amazon.

Pour plus de détails sur l'API, reportez-vous StartPipeà la section Référence des AWS CLI commandes.

start-pipe

L'exemple de code suivant montre comment utiliserstart-pipe.

AWS CLI

Pour démarrer un tuyau existant

L'start-pipeexemple suivant démarre un Pipe nommé Demo_Pipe dans le compte spécifié.


aws pipes start-pipe \
    --name Demo_Pipe

Sortie :


{
    "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"
}

Pour plus d'informations, consultez la section Démarrage ou arrêt d'un EventBridge canal Amazon dans le guide de EventBridge l'utilisateur Amazon.

Pour plus de détails sur l'API, reportez-vous StartPipeà la section Référence des AWS CLI commandes.

L'exemple de code suivant montre comment utiliserstop-pipe.

AWS CLI

Pour arrêter un tuyau existant

L'stop-pipeexemple suivant arrête un Pipe nommé Demo_Pipe dans le compte spécifié.


aws pipes stop-pipe \
    --name Demo_Pipe

Sortie :


{
    "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"
}

Pour plus d'informations, consultez la section Démarrage ou arrêt d'un EventBridge canal Amazon dans le guide de EventBridge l'utilisateur Amazon.

Pour plus de détails sur l'API, reportez-vous StopPipeà la section Référence des AWS CLI commandes.

stop-pipe

L'exemple de code suivant montre comment utiliserstop-pipe.

AWS CLI

Pour arrêter un tuyau existant

L'stop-pipeexemple suivant arrête un Pipe nommé Demo_Pipe dans le compte spécifié.


aws pipes stop-pipe \
    --name Demo_Pipe

Sortie :


{
    "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"
}

Pour plus d'informations, consultez la section Démarrage ou arrêt d'un EventBridge canal Amazon dans le guide de EventBridge l'utilisateur Amazon.

Pour plus de détails sur l'API, reportez-vous StopPipeà la section Référence des AWS CLI commandes.

L'exemple de code suivant montre comment utilisertag-resource.

AWS CLI

Pour étiqueter un canal existant

L'tag-resourceexemple suivant balise un tuyau nomméDemo_Pipe. Si la commande réussit, aucune sortie n’est renvoyée.


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

Pour plus d'informations, consultez les concepts d'Amazon EventBridge Pipes dans le guide de EventBridge l'utilisateur Amazon.

Pour plus de détails sur l'API, reportez-vous TagResourceà la section Référence des AWS CLI commandes.

tag-resource

L'exemple de code suivant montre comment utilisertag-resource.

AWS CLI

Pour étiqueter un canal existant

L'tag-resourceexemple suivant balise un tuyau nomméDemo_Pipe. Si la commande réussit, aucune sortie n’est renvoyée.


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

Pour plus d'informations, consultez les concepts d'Amazon EventBridge Pipes dans le guide de EventBridge l'utilisateur Amazon.

Pour plus de détails sur l'API, reportez-vous TagResourceà la section Référence des AWS CLI commandes.

L'exemple de code suivant montre comment utiliseruntag-resource.

AWS CLI

Pour supprimer un tag d'un canal existant

L'untag-resourceexemple suivant supprime une balise avec la clé stack du tuyau nomméDemo_Pipe. Si la commande réussit, aucune sortie n’est renvoyée.


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

Pour plus d'informations, consultez les concepts d'Amazon EventBridge Pipes dans le guide de EventBridge l'utilisateur Amazon.

Pour plus de détails sur l'API, reportez-vous UntagResourceà la section Référence des AWS CLI commandes.

untag-resource

L'exemple de code suivant montre comment utiliseruntag-resource.

AWS CLI

Pour supprimer un tag d'un canal existant

L'untag-resourceexemple suivant supprime une balise avec la clé stack du tuyau nomméDemo_Pipe. Si la commande réussit, aucune sortie n’est renvoyée.


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

Pour plus d'informations, consultez les concepts d'Amazon EventBridge Pipes dans le guide de EventBridge l'utilisateur Amazon.

Pour plus de détails sur l'API, reportez-vous UntagResourceà la section Référence des AWS CLI commandes.

L'exemple de code suivant montre comment utiliserupdate-pipe.

AWS CLI

Pour mettre à jour un canal existant

L'update-pipeexemple suivant met à jour le canal nommé Demo_Pipe en ajoutant un paramètre de configuration CloudWatch Log. Assurez-vous de mettre à jour le rôle d'exécution du canal afin qu'il dispose des autorisations appropriées pour la destination du journal.


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

Sortie :


{
    "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"
}

Pour plus d'informations, consultez les concepts d'Amazon EventBridge Pipes dans le guide de EventBridge l'utilisateur Amazon.

Pour plus de détails sur l'API, reportez-vous UpdatePipeà la section Référence des AWS CLI commandes.

update-pipe

L'exemple de code suivant montre comment utiliserupdate-pipe.

AWS CLI

Pour mettre à jour un canal existant


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

Sortie :


{
    "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"
}

Pour plus d'informations, consultez les concepts d'Amazon EventBridge Pipes dans le guide de EventBridge l'utilisateur Amazon.

Pour plus de détails sur l'API, reportez-vous UpdatePipeà la section Référence des AWS CLI commandes.

Avertissement JavaScript est désactivé ou n'est pas disponible dans votre navigateur.

Pour que vous puissiez utiliser la documentation AWS, Javascript doit être activé. Vous trouverez des instructions sur les pages d'aide de votre navigateur.

Conventions de rédaction

EventBridge

Firewall Manager

Sur cette page

Sélectionner vos préférences de cookies

Personnaliser les préférences de cookies

Essentiels

Performances

Fonctionnels

Publicitaires

Impossible d'enregistrer les préférences concernant les cookies

EventBridge Exemples de tuyaux utilisant AWS CLI

Rubriques

Actions

create-pipe

delete-pipe

describe-pipe

list-pipes

list-tags-for-resource

start-pipe

stop-pipe

tag-resource

untag-resource

update-pipe

Sur cette page

Cette page vous a-t-elle été utile ?

Rubrique suivante :

Rubrique précédente :

Avez-vous besoin d’aide ?