GradientEdge CDK Utils
    Preparing search index...

    Interface ApiToAnyTargetRestApiType

    interface ApiToAnyTargetRestApiType {
        accessLogGroup: LogGroup;
        api: IRestApi;
        authoriser?: IAuthorizer;
        basePathMappings: BasePathMapping[];
        certificate: ICertificate;
        domain: DomainName;
        hostedZone: IHostedZone;
        integration: Integration;
        method: { [httpMethod: string]: Method };
        methodErrorResponse: MethodResponse;
        methodResponse: MethodResponse;
        resource: { [path: string]: Resource };
    }

    Implemented by

    Index

    Properties

    accessLogGroup api authoriser? basePathMappings certificate domain hostedZone integration method methodErrorResponse methodResponse resource

    Properties

    accessLogGroup: LogGroup

    The CloudWatch log group for API Gateway access logs

    api: IRestApi

    The API Gateway REST API

    authoriser?: IAuthorizer

    The optional API Gateway authorizer

    basePathMappings: BasePathMapping[]

    The base path mappings for the API custom domain

    certificate: ICertificate

    The SSL/TLS certificate for the custom domain

    domain: DomainName

    The API Gateway custom domain

    hostedZone: IHostedZone

    The Route53 hosted zone for the API domain

    integration: Integration

    The default API Gateway integration

    method: { [httpMethod: string]: Method }

    Map of HTTP methods to their API Gateway Method resources

    methodErrorResponse: MethodResponse

    The default method error response

    methodResponse: MethodResponse

    The default method success response

    resource: { [path: string]: Resource }

    Map of paths to their API Gateway Resource objects

    Settings

    Member Visibility

    On This Page

    Properties