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

ScheduleV2

O objeto que descreve um tipo de fonte de ScheduleV2 evento, que define sua função sem servidor como o destino de um evento do Amazon EventBridge Scheduler que é acionado em uma programação. Para obter mais informações, consulte O que é o Amazon EventBridge Scheduler? no Guia do usuário do EventBridge Scheduler.

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

Sintaxe

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

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 Configurando uma fila de mensagens mortas para o EventBridge Scheduler no Guia do usuário do Scheduler. 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::Scheduler::Schedule 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 agenda.

Tipo: string

Obrigatório: não

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

EndDate

A data, em UTC, até a qual a agenda pode invocar seu destino. Dependendo da expressão de recorrência da agenda, as invocações podem ser interrompidas até a EndDate que você especifica.

Tipo: string

Obrigatório: não

Compatibilidade AWS CloudFormation: essa propriedade é passada diretamente para a propriedade EndDate de um recurso AWS::Scheduler::Schedule.

FlexibleTimeWindow

Permite a configuração de uma janela na qual uma agenda pode ser invocada.

Tipo: FlexibleTimeWindow

Obrigatório: não

Compatibilidade AWS CloudFormation: essa propriedade é passada diretamente para a propriedade FlexibleTimeWindow de um recurso AWS::Scheduler::Schedule.

GroupName

O nome do grupo de agendamento a ser associado a esse agendamento. Se não for definido, o grupo padrão será usado.

Tipo: string

Obrigatório: não

Compatibilidade AWS CloudFormation: essa propriedade é passada diretamente para a propriedade GroupName de um recurso AWS::Scheduler::Schedule.

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::Scheduler::Schedule Target.

KmsKeyArn

O ARN de uma chave KMS será usada para criptografar dados do cliente.

Tipo: string

Obrigatório: não

Compatibilidade AWS CloudFormation: essa propriedade é passada diretamente para a propriedade KmsKeyArn de um recurso AWS::Scheduler::Schedule.

Name

O nome da programação. Se você não especificar um nome, o AWS SAM gerará um nome no formato Function-Logical-IDEvent-Source-Name e usará esse ID para o nome da agenda.

Tipo: string

Obrigatório: não

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

OmitName

Por padrão, AWS SAM gera e usa um nome de agendamento no formato < event-source-name ><Function-logical-ID>. Defina essa propriedade true para AWS CloudFormation gerar uma ID física exclusiva e, em vez disso, use-a como nome da programação.

Tipo: booliano

Obrigatório: não

Padrão: false

Compatibilidade AWS CloudFormation: Essa propriedade é exclusiva do AWS SAM e não tem AWS CloudFormation equivalente.

PermissionsBoundary

O ARN da política usada para definir o limite de permissões para a função.

nota

Se PermissionsBoundary estiver definido, o AWS SAM aplicará os mesmos limites ao perfil do IAM de destino da agenda do agendador.

Tipo: string

Obrigatório: não

Compatibilidade AWS CloudFormation: essa propriedade é passada diretamente para a propriedade PermissionsBoundary de um recurso AWS::IAM::Role.

RetryPolicy

Um objeto RetryPolicy que inclui informações sobre as configurações de política de repetição.

Tipo: RetryPolicy

Obrigatório: não

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

RoleArn

O ARN da função do IAM que o EventBridge Scheduler usará para o destino quando o agendamento for invocado.

Tipo: RoleArn

Obrigatório: não

Compatibilidade AWS CloudFormation: essa propriedade é passada diretamente para a propriedade RoleArn do tipo de dados AWS::Scheduler::Schedule Target.

ScheduleExpression

A expressão de programação que determina quando e com que frequência o evento de agendamento do agendador é executado.

Tipo: string

Obrigatório: Sim

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

ScheduleExpressionTimezone

O fuso horário no qual a expressão de agendamento é avaliada.

Tipo: string

Obrigatório: não

Compatibilidade AWS CloudFormation: essa propriedade é passada diretamente para a propriedade ScheduleExpressionTimezone de um recurso AWS::Scheduler::Schedule.

StartDate

A data, em UTC, a partir da qual a agenda pode começar a invocar um destino. Dependendo da expressão de recorrência da agenda, as invocações podem ocorrer a partir da StartDate que você especifica.

Tipo: string

Obrigatório: não

Compatibilidade AWS CloudFormation: essa propriedade é passada diretamente para a propriedade StartDate de um recurso AWS::Scheduler::Schedule.

State

O estado da agenda do programador.

Valores aceitos: DISABLED | ENABLED

Tipo: string

Obrigatório: não

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

Exemplos

Exemplo básico de definição de um recurso ScheduleV2

Resources:
  Function:
    Properties:
      ...
      Events:
        ScheduleEvent:
          Type: ScheduleV2
          Properties:
            ScheduleExpression: "rate(1 minute)"
        ComplexScheduleEvent:
          Type: ScheduleV2
          Properties:
            ScheduleExpression: rate(1 minute)
            FlexibleTimeWindow:
              Mode: FLEXIBLE
              MaximumWindowInMinutes: 5
            StartDate: '2022-12-28T12:00:00.000Z'
            EndDate: '2023-01-28T12:00:00.000Z'
            ScheduleExpressionTimezone: UTC
            RetryPolicy:
              MaximumRetryAttempts: 5
              MaximumEventAgeInSeconds: 300
            DeadLetterConfig:
              Type: SQS