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 EventBridge regra da Amazon que é acionada em um cronograma. Para obter mais informações, consulte O que é a Amazon EventBridge? no Guia do EventBridge usuário da Amazon.

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

nota

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

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

Sintaxe

Para declarar essa entidade em seu modelo AWS Serverless Application Model (AWS SAM), use a sintaxe a seguir.

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 EventBridge qual 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 Lambda que não existe ou quando não há permissões suficientes para invocar EventBridge a função Lambda. Para obter mais informações, consulte Política de repetição de eventos e uso de filas de mensagens sem saída no Guia do usuário da 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 .

Digite: DeadLetterConfig

Obrigatório: não

CloudFormation compatibilidade: essa propriedade é semelhante à DeadLetterConfig propriedade do tipo de AWS::Events::Rule Target dados. A AWS SAM versão dessa propriedade inclui subpropriedades adicionais, caso você queira criar AWS SAM a fila de mensagens mortas para você.

Description

Uma descrição da regra.

Tipo: string

Obrigatório: não

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

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

CloudFormation compatibilidade: essa propriedade é semelhante à State propriedade de um AWS::Events::Rule recurso. Se essa propriedade for definida como, true então AWS SAM passaENABLED, caso contrário, ela passaDISABLED.

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

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

Name

O nome da regra. Se você não especificar um nome, CloudFormation gera uma ID física exclusiva e usa essa ID para o nome da regra.

Type: string

Obrigatório: não

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

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 sem saída no Guia do usuário da Amazon. EventBridge

Digite: RetryPolicy

Obrigatório: não

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

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

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

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

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

Exemplos

CloudWatch Agende um evento

CloudWatch Exemplo de agendamento de evento

YAML

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