Type Alias APIEnvironmentScheduledFunction

APIEnvironmentScheduledFunction: APIDeploymentPayloadScheduledFunction & {
    aws: {
        eventBridge: {
            name: string;
        };
        lambda: {
            functionArn: string;
        };
    };
    schedule?: APIEnvironmentSchedule;
}

Type declaration

  • aws: {
        eventBridge: {
            name: string;
        };
        lambda: {
            functionArn: string;
        };
    }

    AWS configuration

    • eventBridge: {
          name: string;
      }

      AWS EventBridge configuration

      • name: string

        The name identifier for the AWS EventBridge rule

    • lambda: {
          functionArn: string;
      }

      AWS Lambda configuration

      • functionArn: string

        The Lambda function ARN to allow linking between EventBridge and Lambda

  • Optionalschedule?: APIEnvironmentSchedule

    The schedule configuration in a structure format parsed from a cron expression