GradientEdge CDK Utils
    Preparing search index...

    Interface ApiToAnyTargetRestApiResource

    interface ApiToAnyTargetRestApiResource {
        addProxy: boolean;
        allowedHeaders?: string[];
        allowedMethods?: string[];
        allowedOrigins?: string[];
        authorizer?: IAuthorizer;
        enableDefaultCors?: boolean;
        integration: Integration;
        methodRequestParameters?: { [param: string]: boolean };
        mockIntegration?: MockIntegration;
        mockMethodResponses?: MethodResponse[];
        parent?: IResource;
        path: string;
        proxyIntegration?: Integration;
    }
    Index

    Properties

    addProxy allowedHeaders? allowedMethods? allowedOrigins? authorizer? enableDefaultCors? integration methodRequestParameters? mockIntegration? mockMethodResponses? parent? path proxyIntegration?

    Properties

    addProxy: boolean

    Whether to add a proxy resource ({proxy+}) under this resource

    allowedHeaders?: string[]

    The allowed CORS headers

    allowedMethods?: string[]

    The allowed CORS HTTP methods

    allowedOrigins?: string[]

    The allowed CORS origins

    authorizer?: IAuthorizer

    The optional API Gateway authorizer for this resource

    enableDefaultCors?: boolean

    Whether to enable default CORS preflight configuration

    integration: Integration

    The API Gateway integration for this resource

    methodRequestParameters?: { [param: string]: boolean }

    Required method request parameters

    mockIntegration?: MockIntegration

    The mock integration for testing

    mockMethodResponses?: MethodResponse[]

    The mock method responses

    parent?: IResource

    The parent resource to attach this resource to

    path: string

    The resource path segment

    proxyIntegration?: Integration

    The integration to use for the proxy resource

    Settings

    Member Visibility

    On This Page

    Properties