@softchef/cdk-iot-device-management/lib/job-api.d.ts

IoT device management is composed of things, thing types, thing groups, jobs, files API services. The constructs can be used independently, that are based on full-managed service to create an API Gateway & Lambda function.

import { ScheduleFunction } from '@softchef/cdk-schedule-function';
import { AuthorizationType, IAuthorizer } from 'aws-cdk-lib/aws-apigateway';
import { Construct } from 'constructs';
/**
 * Job API props.
 *
 * @stability stable
 */
export interface JobApiProps {
    /**
     * Specify API Gateway all resources's authorization type, COGNTIO/IAM/CUSTOM/NONE.
     *
     * @default AuthorizationType.NONE
     * @stability stable
     */
    readonly authorizationType?: AuthorizationType;
    /**
     * Specify API Gateway's authorizer, CognitoUserPool/Lambda.
     *
     * @default undefined
     * @stability stable
     */
    readonly authorizer?: IAuthorizer | undefined;
    /**
     * Specify Schedule Function to enable create schedule job function.
     *
     * @default undefined
     * @stability stable
     */
    readonly scheduleFunction?: ScheduleFunction;
}
/**
 * Job API construct.
 *
 * @stability stable
 */
export declare class JobApi extends Construct {
    /**
     * The Job API Gateway
     */
    private readonly _restApi;
    /**
     * @stability stable
     */
    constructor(scope: Construct, id: string, props?: JobApiProps);
    /**
     * Job API API ID.
     *
     * @stability stable
     */
    get restApiId(): string;
    private createCreateScheduleJobFunction;
    private createAssociateTargetsWithJobFunction;
    private createCreateJobFunction;
    private createListJobsFunction;
    private createGetJobFunction;
    private createUpdateJobFunction;
    private createDeleteJobFunction;
    private createCancelJobFunction;
    private createGetJobExecutionFunction;
    private createListJobExecutionsForJobFunction;
    private createListJobExecutionsForThingFunction;
    private createDeleteJobExecutionFunction;
    private createCancelJobExecutionFunction;
    private createGetJobDocumentFunction;
    private createCreateJobTemplateFunction;
    private createListJobTemplatesFunction;
    private createGetJobTemplateFunction;
    private createDeleteJobTemplateFunction;
}