@oystehr/sdk/src/resources/types/ZambdaSchedule.ts

Oystehr SDK

// AUTOGENERATED -- DO NOT EDIT

/**
 * Required when triggerMethod is 'cron', the schedule object defines when the Zambda Function is invoked.
 */
export interface ZambdaSchedule {
  /**
   * A cron expression that determines when the Zambda Function is invoked. The expression must conform to the format here, https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-cron-expressions.html.
   */
  expression: string;
  /**
   * An optional start date and time when the cron expression will go into effect.
   */
  start?: string;
  /**
   * An optional end date and time when the cron expression will no longer be in effect.
   */
  end?: string;
  /**
   * Optional retry policy that defines the behavior of retry attempts and event age.
   */
  retryPolicy?: {
    /**
     * The maximum age of a request that Zambda sends to a function for processing, in seconds.
     */
    maximumEventAge?: number;
    /**
     * The maximum number of times to retry when the function returns an error.
     */
    maximumRetry?: number;
  };
}