Schedule - AWS Serverless Application Model
SintaxePropriedadesExemplos

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á.

Schedule

O objeto que descreve um tipo de fonte de Schedule evento, que define sua função sem servidor como o destino de uma regra do Amazon EventBridge que é acionada em um cronograma. Para obter mais informações, consulte O que é o Amazon EventBridge? no Manual do usuário do Amazon EventBridge.

AWS Serverless Application Model (AWS SAM) gera um recurso AWS::Events::Rule quando esse tipo de evento é definido.

nota

O EventBridge agora oferece um novo recurso de agendamento, o Amazon EventBridge Scheduler. O Scheduler do Amazon EventBridge é um agendador sem servidor que permite criar, executar e gerenciar tarefas de um serviço gerenciado central. O EventBridge Scheduler é altamente personalizável e oferece escalabilidade aprimorada em relação às regras programadas do EventBridge, com um conjunto mais amplo de operações de API de destino e Serviços da AWS.

Recomendamos que você use o EventBridge Scheduler para invocar alvos em um cronograma. Para definir esse tipo de fonte de evento em seus modelos AWS SAM, consulte ScheduleV2.

Sintaxe

Para declarar esta entidade no modelo do AWS Serverless Application Model (AWS SAM), use a seguinte sintaxe:

YAML

  DeadLetterConfig: DeadLetterConfig
  Description: String
  Enabled: Boolean
  Input: String
  Name: String
  RetryPolicy: RetryPolicy
  Schedule: String
  State: String

Propriedades

DeadLetterConfig

Configure a fila do Amazon Simple Queue Service (Amazon SQS) para a qual o EventBridge envia eventos após uma falha na invocação de destino. A invocação pode falhar, por exemplo, ao enviar um evento para uma função do Lambda que não existe ou quando o EventBridge não tem permissões suficientes para invocar a função do Lambda. Para obter mais informações, consulte Política de repetição de eventos e uso de filas de mensagens não entregues no Guia do usuário do Amazon EventBridge.

nota

O tipo de recurso AWS::Serverless::Function tem um tipo de dados semelhante, DeadLetterQueue, que lida com falhas que ocorrem após a invocação bem-sucedida da função do Lambda de destino. Exemplos desses tipos de falhas incluem controle de utilização do Lambda ou erros retornados pela função de destino do Lambda. Para obter mais informações sobre a propriedade DeadLetterQueue da função, consulte Filas de mensagens não entregues no Guia do desenvolvedor do AWS Lambda.

Tipo: DeadLetterConfig

Obrigatório: não

Compatibilidade AWS CloudFormation: Essa propriedade é semelhante à propriedade DeadLetterConfig do tipo de dados AWS::Events::Rule Target. A versão AWS SAM dessa propriedade inclui subpropriedades adicionais, caso você queira que o AWS SAM crie a fila de mensagens não entregues para você.

Description

Uma descrição da regra.

Tipo: string

Obrigatório: não

Compatibilidade AWS CloudFormation: essa propriedade é passada diretamente para a propriedade Description de um recurso AWS::Events::Rule.

Enabled

Indica se a regra está habilitada.

Para desativar a regra, defina essa propriedade como false.

nota

Especifique a propriedade Enabled ou State, mas não ambas.

Tipo: booliano

Obrigatório: não

Compatibilidade AWS CloudFormation: essa propriedade é semelhante à propriedade State de um recurso AWS::Events::Rule. Se essa propriedade for definida como true então AWS SAM passa a ENABLED, caso contrário, ela passa a DISABLED.

Input

Texto JSON válido passado para o destino. Se você usar essa propriedade, nada do próprio texto do evento é passado para o destino.

Tipo: string

Obrigatório: não

Compatibilidade AWS CloudFormation: essa propriedade é passada diretamente para a propriedade Input de um recurso AWS::Events::Rule Target.

Name

O nome da regra do . Se você não especificar um nome, o AWS CloudFormation gerará um ID físico exclusivo e usará esse ID no nome da regra.

Tipo: string

Obrigatório: não

Compatibilidade AWS CloudFormation: essa propriedade é passada diretamente para a propriedade Name de um recurso AWS::Events::Rule.

RetryPolicy

Um objeto RetryPolicy que inclui informações sobre as configurações de política de repetição. Para obter mais informações, consulte Política de repetição de eventos e uso de filas de mensagens não entregues no Guia do usuário do Amazon EventBridge.

Type: RetryPolicy

Obrigatório: não

Compatibilidade AWS CloudFormation: essa propriedade é passada diretamente para a propriedade RetryPolicy do tipo de dados AWS::Events::Rule Target.

Schedule

A expressão de programação que determina quando e com que frequência a regra é executada. Para obter mais informações, consulte Programar expressões para regras.

Tipo: string

Obrigatório: Sim

Compatibilidade AWS CloudFormation: essa propriedade é passada diretamente para a propriedade ScheduleExpression de um recurso AWS::Events::Rule.

State

O estado da regra.

Valores aceitos: DISABLED | ENABLED

nota

Especifique a propriedade Enabled ou State, mas não ambas.

Tipo: string

Obrigatório: não

Compatibilidade AWS CloudFormation: essa propriedade é passada diretamente para a propriedade State de um recurso AWS::Events::Rule.

Exemplos

Programar evento do CloudWatch

Exemplo de evento de programação do CloudWatch

YAML

CWSchedule:
  Type: Schedule
  Properties:
    Schedule: 'rate(1 minute)'
    Name: TestSchedule
    Description: test schedule
    Enabled: false