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 máquina de estado como o destino de um evento do Amazon EventBridge Scheduler que é acionado em um agendamento. 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 AWS::Scheduler::Schedulerecurso quando esse tipo de evento é definido.

Sintaxe

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

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

Digite: DeadLetterConfig

Obrigatório: não

CloudFormation compatibilidade: essa propriedade é semelhante à DeadLetterConfig propriedade do tipo de AWS::Scheduler::Schedule 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 agenda.

Tipo: string

Obrigatório: não

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

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

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

FlexibleTimeWindow

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

Digite: FlexibleTimeWindow

Obrigatório: não

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

GroupName

O nome do grupo de agendas para associar a essa agenda. Se não for definido, o grupo padrão será usado.

Tipo: string

Obrigatório: não

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

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

KmsKeyArn

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

Tipo: string

Obrigatório: não

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

Name

O nome da programação. Se você não especificar um nome, AWS SAM gera um nome no formato StateMachine-Logical-IDEvent-Source-Name e usa essa ID para o nome da agenda.

Tipo: string

Obrigatório: não

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

OmitName

Por padrão, AWS SAM gera e usa um nome de agendamento no formato de<State-machine-logical-ID><event-source-name>. Defina essa propriedade true para 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

CloudFormation compatibilidade: essa propriedade é exclusiva AWS SAM e não tem 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, AWS SAM aplicará os mesmos limites à função IAM de destino da agenda do agendador.

Tipo: string

Obrigatório: não

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

RetryPolicy

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

Digite: RetryPolicy

Obrigatório: não

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

RoleArn

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

Digite: RoleArn

Obrigatório: não

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

ScheduleExpression

A expressão de agendamento que determina quando e com que frequência o agendamento é executado.

Tipo: string

Obrigatório: Sim

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

ScheduleExpressionTimezone

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

Tipo: string

Obrigatório: não

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

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

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

State

O estado da programação.

Valores aceitos: DISABLED | ENABLED

Tipo: string

Obrigatório: não

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

Exemplos

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

StateMachine:
  Type: AWS::Serverless::StateMachine
  Properties:
    Name: MyStateMachine
    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
    DefinitionUri:
      Bucket: sam-sam-s3-demo-bucket
      Key: my-state-machine.asl.json
      Version: 3
    Policies:
      - LambdaInvokePolicy:
          FunctionName: !Ref MyFunction