Pré-requisitos Usar o console Usando o AWS CLI Usando o SDKs Próximas etapas

Começando com o EventBridge Scheduler

Este tópico descreve a criação de uma nova EventBridge agenda do Scheduler. Você usa o console do EventBridge Scheduler, AWS Command Line Interface (AWS CLI), ou AWS SDKs para criar um cronograma com um modelo de destino da AmazonSQS. Em seguida, você configurará o log, configurará novas tentativas e definirá um tempo máximo de retenção para tarefas com falha. Depois de criar o agendamento, você verificará se seu agendamento invoca com sucesso o destino e envia uma mensagem para a fila de destino.

nota

Para seguir este guia, recomendamos que você configure IAM usuários com as permissões mínimas exigidas descritas emUsando políticas baseadas em identidade no Scheduler EventBridge . Depois de criar e configurar um usuário, execute o comando a seguir para definir suas credenciais de acesso. Você precisa de seu ID de chave de acesso da e de uma chave de acesso secreta para configurar a AWS CLI.


$ aws configure
AWS Access Key ID [None]: AKIAIOSFODNN7EXAMPLE
AWS Secret Access Key [None]: wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY
Default region name [None]: us-west-2
Default output format [None]: json

Para obter mais informações sobre as diferentes maneiras de definir suas credenciais, consulte Configurações e precedência no Guia do usuário da versão 2 do AWS Command Line Interface .

Tópicos

Pré-requisitos
Crie uma agenda usando o console do EventBridge Scheduler
Crie um cronograma usando o AWS CLI
Crie uma agenda usando o EventBridge Agendador SDKs
Próximas etapas

Pré-requisitos

Antes de executar as etapas nesta seção, você deverá fazer o seguinte:

Conclua as tarefas descritas em Configurando o Amazon EventBridge Scheduler

Crie uma agenda usando o console do EventBridge Scheduler

Para criar uma nova programação usando o console

Faça login no e escolha o link a seguir para abrir a seção EventBridge Agenda do EventBridge console: https://us-west-2.console.aws.amazon.com/scheduler/home? AWS Management Console region=us-west-2 #home

nota
Você pode mudar o seu Região da AWS usando o seletor AWS Management Console de região.
Na página Programações, clique em Criar programação.
Na página Especificar detalhes da programação, na seção Nome e descrição da programação, faça o seguinte:
1. Em Nome da programação, insira um nome para a programação. Por exemplo, MyTestSchedule
2. Para Descrição - opcional, insira uma descrição para a seu agendamento. Por exemplo, My first schedule.
3. Para Grupo de agendamento, escolha um grupo de agendamento na lista suspensa. Se você ainda não criou nenhum grupo de agendamento, pode escolher o grupo default para sua agenda. Para criar um novo grupo de agendamento, escolha o link criar seu próprio agendamento na descrição do console. Para adicionar tags a grupos de programação, você usa os grupos de programação.
Na seção Schedule details (Detalhes do agendamento), faça o seguinte:
1. Em Ocorrência, selecione uma das opções de padrão a seguir. As opções de configuração mudam dependendo do padrão selecionado.
  - Agendamento único: Um agendamento único invoca um destino somente uma vez na data e hora que você especificar.
    
    Em Data e hora, insira uma data válida no formato YYYY/MM/DD. Em seguida, especifique um carimbo de data e hora no formato hh:mm de 24 horas. Por fim, escolha um fuso horário nas opções suspensas.
  - Agendamento recorrente: Um agendamento recorrente invoca uma meta em uma taxa que você especifica usando uma expressão cron ou expressão rate.
    
    Escolha a agenda baseada em Cron para configurar uma agenda usando uma cron expressão. Para usar uma expressão de taxa, escolha Programação baseada em taxa e insira um número positivo para Valor e, em seguida, escolha uma Unidade nas opções suspensas.
  Para obter mais informações sobre o uso de expressões rate e cron, consulte Tipos de EventBridge agendamento no Scheduler.
2. Para Janela de tempo flexível, escolha Desativado para desativar a opção ou escolher uma das janelas de tempo predefinidas da lista em cascata. Por exemplo, se você escolher 15 minutos e definir uma programação recorrente para invocar o destino uma vez a cada hora, a programação será executada em até 15 minutos após o início de cada hora.
Se você escolheu agendamento recorrente na etapa anterior, na seção Prazo, especifique um fuso horário e, opcionalmente, defina uma data e hora de início e uma data e hora de término para o agendamento. Um agendamento recorrente sem data de início começará assim que for criada e disponibilizada. Um agendamento recorrente sem data de término continuará a invocar sua meta indefinidamente.
Escolha Próximo.
Na página Selecionar destino, faça o seguinte:
1. Selecione alvos modelados e escolha um alvo. API Neste exemplo, escolheremos o alvo SQS SendMessage modelado da Amazon.
2. Na SendMessageseção, para SQSfila, escolha uma SQS fila existente da Amazon, ARN como na arn:aws:sqs:us-west-2:123456789012:TestQueue lista suspensa. Para criar uma nova fila, escolha Criar nova SQS fila para navegar até o console da AmazonSQS. Depois de terminar de criar uma fila, retorne ao console do EventBridge Scheduler e atualize o menu suspenso. Sua nova fila ARN aparece e pode ser selecionada.
3. Em Target, insira a carga que você deseja que o EventBridge Scheduler entregue ao alvo. Neste exemplo, enviaremos a seguinte mensagem para a fila de destino: Hello, it's EventBridge Scheduler.
Escolha Avançar e, na página Configurações - opcional, faça o seguinte:
1. Na seção Estado do agendamento, em Ativar agendamento, ative ou desative o atributo usando o botão. Por padrão, o EventBridge Agendador ativa sua agenda.
2. Na seção Ação após a conclusão do cronograma, configure a ação que o EventBridge Agendador executa após a conclusão do cronograma:
  - Escolha DELETEse você deseja que a agenda seja excluída automaticamente. Para agendamentos únicos, isso ocorre depois que o agendamento invocar o destino uma vez. Para agendamentos recorrentes, isso ocorre após a última invocação planejada do agendamento. Para obter mais informações sobre a exclusão automática, consulte Exclusão após a conclusão do agendamento.
  - Escolha NONEou não escolha um valor se você não quiser que o EventBridge Agendador execute nenhuma ação após a conclusão do cronograma.
3. Na seção Política de repetição e fila de mensagens mortas (DLQ), em Política de repetição, ative Tentar novamente para configurar uma política de repetição para sua agenda. Com políticas de repetição, se um agendamento falhar em invocar seu destino, o EventBridge Scheduler executará novamente o agendamento. Se configurado, você deve definir o tempo máximo de retenção e as novas tentativas da programação.
4. Em Idade máxima do evento - opcional, insira o (s) máximo (s) de hora (s) e minuto (s) em que o EventBridge Agendador deve manter um evento não processado.
  
  nota
  O valor máximo é 24 horas.
5. Em Máximo de tentativas, insira o número máximo de vezes que o EventBridge Scheduler repete o agendamento se o alvo retornar um erro.
  
  nota
  O valor máximo é 185 tentativas.
6. Para Dead-letter queue (DLQ), escolha entre as seguintes opções:
  - Nenhum — Escolha essa opção se você não quiser configurar umDLQ.
  - Selecione uma SQS fila da Amazon em minha AWS conta como DLQ — Escolha essa opção, selecione uma fila ARN na lista suspensa e configure DLQ a Conta da AWS mesma em que você está criando a programação.
  - Especifique uma SQS fila da Amazon em outra AWS conta como DLQ — Escolha essa opção e, em seguida, insira a ARN fila configurada como aDLQ, se a fila estiver em outra. Conta da AWS Você deve inserir o exato ARN da fila para usar essa opção.
7. Na seção Criptografia, escolha Personalizar configurações de criptografia (avançadas) para usar uma KMS chave gerenciada pelo cliente para criptografar sua entrada de destino. Se você escolher essa opção, insira uma KMS chave existente ARN ou escolha Criar uma AWS KMS chave para navegar até o AWS KMS console. Para obter mais informações sobre como o EventBridge Scheduler criptografa seus dados em repouso, consulte. Criptografia em repouso no EventBridge Scheduler
8. Em Permissões, escolha Usar função existente e selecione a função que você criou durante o procedimento de configuração na lista suspensa. Você também pode escolher Ir para o IAM console para criar uma nova função.
  
  Se você quiser que o EventBridge Scheduler crie uma nova função de execução para você, escolha Criar nova função para esta agenda. Depois, insira um nome em Nome do perfil. Se você escolher essa opção, o EventBridge Scheduler adicionará à função as permissões necessárias para seu alvo modelado.
Escolha Próximo.
Na página Revisar e criar programação, revise os detalhes da programação. Em cada seção, escolha Editar para voltar a essa etapa e editar seus detalhes.
Escolha Criar agendamento para concluir a criação da nova agenda. Você pode ver a lista com as programações novas e existentes na página Programações. Na coluna Status, verifique se a nova programação está Ativada.
Para verificar se sua agenda invoca o SQS alvo da Amazon, abra o SQS console da Amazon e faça o seguinte:
1. Escolha a fila de destino na lista Filas.
2. Escolha Send and receive messages (Enviar e receber mensagens).
3. Na página Enviar e receber mensagens, em Receber mensagens, escolha Sondar mensagens para recuperar as mensagens de teste que seu agendamento enviou para a fila de destino.

Crie um cronograma usando o AWS CLI

O exemplo a seguir mostra como usar o AWS CLI comando create-schedulepara criar um cronograma do EventBridge Scheduler com um modelo de destino da AmazonSQS. Substitua os valores do espaço reservado para os seguintes parâmetros por suas informações:

--name: Insira um nome para o agendamento.
RoleArn— Insira a função ARN de execução que você deseja associar ao cronograma.
Arn — Insira o ARN para o alvo. Nesse caso, o destino é uma SQS fila da Amazon.
Entrada — Insira uma mensagem que o EventBridge Scheduler entrega à fila de destino.


$ aws scheduler create-schedule --name sqs-templated-schedule --schedule-expression 'rate(5 minutes)' \
--target '{"RoleArn": "ROLE_ARN", "Arn": "QUEUE_ARN", "Input": "TEST_PAYLOAD" }' \
--flexible-time-window '{ "Mode": "OFF"}'

Crie uma agenda usando o EventBridge Agendador SDKs

No exemplo a seguir, você usa o EventBridge Scheduler SDKs para criar um cronograma do EventBridge Scheduler com um modelo de destino da AmazonSQS.

exemplo Python SDK


import boto3
scheduler = boto3.client('scheduler')

flex_window = { "Mode": "OFF" }

sqs_templated = {
    "RoleArn": "<ROLE_ARN>",
    "Arn": "<QUEUE_ARN>",
    "Input": "Message for scheduleArn: '<aws.scheduler.schedule-arn>', scheduledTime: '<aws.scheduler.scheduled-time>'"
}

scheduler.create_schedule(
    Name="sqs-python-templated",
    ScheduleExpression="rate(5 minutes)",
    Target=sqs_templated,
    FlexibleTimeWindow=flex_window)

exemplo Java SDK


package com.example;

import software.amazon.awssdk.regions.Region;
import software.amazon.awssdk.services.scheduler.SchedulerClient;
import software.amazon.awssdk.services.scheduler.model.*;


public class MySchedulerApp {

    public static void main(String[] args) {
        
        final SchedulerClient client = SchedulerClient.builder()
                .region(Region.US_WEST_2)
                .build();
        
        Target sqsTarget = Target.builder()
                .roleArn("<ROLE_ARN>")
                .arn("<QUEUE_ARN>")
                .input("Message for scheduleArn: '<aws.scheduler.schedule-arn>', scheduledTime: '<aws.scheduler.scheduled-time>'")
                .build();
        
        CreateScheduleRequest createScheduleRequest = CreateScheduleRequest.builder()
                .name("<SCHEDULE NAME>")
                .scheduleExpression("rate(10 minutes)")
                .target(sqsTarget)
                .flexibleTimeWindow(FlexibleTimeWindow.builder()
                        .mode(FlexibleTimeWindowMode.OFF)
                        .build())
                .build();
                
        client.createSchedule(createScheduleRequest);
        System.out.println("Created schedule with rate expression and an Amazon SQS templated target");
    }
}

Próximas etapas

Para obter mais informações sobre como gerenciar sua agenda usando o console ou o EventBridge AgendadorSDK, consulteGerenciando uma agenda no EventBridge Scheduler. AWS CLI
Para obter mais informações sobre como configurar destinos modelados e aprender a usar o parâmetro de destino universal, consulte Gerenciando alvos no EventBridge Scheduler.
Para obter mais informações sobre os tipos de dados e API operações do EventBridge Scheduler, consulte a Referência do EventBridge Scheduler. API

Atenção O Javascript está desativado ou não está disponível no seu navegador.

Para usar a documentação da AWS, o Javascript deve estar ativado. Consulte as páginas de Ajuda do navegador para obter instruções.

Convenções do documento

Configuração

Tipos de agendamento