EventBridge Exemplos de tubos usando AWS CLI - AWS Exemplos de código do SDK
Ações

Há mais exemplos de AWS SDK disponíveis no repositório AWS Doc SDK Examples GitHub .

As traduções são geradas por tradução automática. Em caso de conflito entre o conteúdo da tradução e da versão original em inglês, a versão em inglês prevalecerá.

EventBridge Exemplos de tubos usando AWS CLI

Os exemplos de código a seguir mostram como realizar ações e implementar cenários comuns usando o AWS Command Line Interface with EventBridge Pipes.

Ações são trechos de código de programas maiores e devem ser executadas em contexto. Embora as ações mostrem como chamar perfis de serviço individuais, você pode ver as ações no contexto em seus cenários relacionados.

Cada exemplo inclui um link para o código-fonte completo, em que você pode encontrar instruções sobre como configurar e executar o código.

Tópicos

Ações

O código de exemplo a seguir mostra como usar create-pipe.

AWS CLI

Para criar um tubo

O create-pipe exemplo a seguir cria um Pipe nomeado Demo_Pipe com SQS como origem e CloudWatch Log Group como destino para o Pipe.

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

Saída:

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

Para obter mais informações, consulte os conceitos do Amazon EventBridge Pipes no Guia EventBridge do usuário da Amazon.

  • Para obter detalhes da API, consulte CreatePipeem Referência de AWS CLI Comandos.

O código de exemplo a seguir mostra como usar delete-pipe.

AWS CLI

Para excluir uma tubulação existente

O delete-pipe exemplo a seguir exclui um Pipe chamado Demo_Pipe na conta especificada.

aws pipes delete-pipe \
    --name Demo_Pipe

Saída:

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

Para obter mais informações, consulte os conceitos do Amazon EventBridge Pipes no Guia EventBridge do usuário da Amazon.

  • Para obter detalhes da API, consulte DeletePipeem Referência de AWS CLI Comandos.

O código de exemplo a seguir mostra como usar describe-pipe.

AWS CLI

Para recuperar informações sobre um tubo

O describe-pipe exemplo a seguir exibe informações sobre o Pipe Demo_Pipe na conta especificada.

aws pipes describe-pipe \
    --name Demo_Pipe

Saída:

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

Para obter mais informações, consulte os conceitos do Amazon EventBridge Pipes no Guia EventBridge do usuário da Amazon.

  • Para obter detalhes da API, consulte DescribePipeem Referência de AWS CLI Comandos.

O código de exemplo a seguir mostra como usar list-pipes.

AWS CLI

Para recuperar uma lista de tubos

O list-pipes exemplo a seguir mostra todos os canais na conta especificada.

aws pipes list-pipes

Saída:

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

Para obter mais informações, consulte os conceitos do Amazon EventBridge Pipes no Guia EventBridge do usuário da Amazon.

  • Para obter detalhes da API, consulte ListPipesem Referência de AWS CLI Comandos.

O código de exemplo a seguir mostra como usar list-tags-for-resource.

AWS CLI

Para listar as etiquetas associadas a um tubo existente

O list-tags-for-resource exemplo a seguir lista todas as tags associadas a um canal chamado Demo_Pipe na conta especificada.

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

Saída:

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

Para obter mais informações, consulte os conceitos do Amazon EventBridge Pipes no Guia EventBridge do usuário da Amazon.

O código de exemplo a seguir mostra como usar start-pipe.

AWS CLI

Para iniciar uma tubulação existente

O start-pipe exemplo a seguir inicia um Pipe chamado Demo_Pipe na conta especificada.

aws pipes start-pipe \
    --name Demo_Pipe

Saída:

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

Para obter mais informações, consulte Iniciando ou parando uma EventBridge tubulação da Amazon no Guia EventBridge do usuário da Amazon.

  • Para obter detalhes da API, consulte StartPipeem Referência de AWS CLI Comandos.

O código de exemplo a seguir mostra como usar stop-pipe.

AWS CLI

Para parar uma tubulação existente

O stop-pipe exemplo a seguir interrompe um Pipe nomeado Demo_Pipe na conta especificada.

aws pipes stop-pipe \
    --name Demo_Pipe

Saída:

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

Para obter mais informações, consulte Iniciando ou parando uma EventBridge tubulação da Amazon no Guia EventBridge do usuário da Amazon.

  • Para obter detalhes da API, consulte StopPipeem Referência de AWS CLI Comandos.

O código de exemplo a seguir mostra como usar tag-resource.

AWS CLI

Para marcar uma tubulação existente

O tag-resource exemplo a seguir marca um Pipe chamadoDemo_Pipe. Se o comando for bem-sucedido, nenhuma saída será retornada.

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

Para obter mais informações, consulte os conceitos do Amazon EventBridge Pipes no Guia EventBridge do usuário da Amazon.

  • Para obter detalhes da API, consulte TagResourceem Referência de AWS CLI Comandos.

O código de exemplo a seguir mostra como usar untag-resource.

AWS CLI

Para remover uma etiqueta de um tubo existente

O untag-resource exemplo a seguir remove uma tag com a chave stack do Pipe chamadoDemo_Pipe. Se o comando for bem-sucedido, nenhuma saída será retornada.

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

Para obter mais informações, consulte os conceitos do Amazon EventBridge Pipes no Guia EventBridge do usuário da Amazon.

  • Para obter detalhes da API, consulte UntagResourceem Referência de AWS CLI Comandos.

O código de exemplo a seguir mostra como usar update-pipe.

AWS CLI

Para atualizar uma tubulação existente

O update-pipe exemplo a seguir atualiza o Pipe nomeado Demo_Pipe adicionando um parâmetro de configuração CloudWatch Log. Certifique-se de atualizar a função de execução do pipe para que ele tenha as permissões corretas para o destino do Log.

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

Saída:

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

Para obter mais informações, consulte os conceitos do Amazon EventBridge Pipes no Guia EventBridge do usuário da Amazon.

  • Para obter detalhes da API, consulte UpdatePipeem Referência de AWS CLI Comandos.