GradientEdge CDK Utils
    Preparing search index...

    Class ApiManager

    Provides operations on AWS API Gateway.

    • A new instance of this class is injected into CommonConstruct constructor.
    • If a custom construct extends CommonConstruct, an instance is available within the context.
    import { CommonConstruct } from '@gradientedge/cdk-utils'

    class CustomConstruct extends CommonConstruct {
      constructor(parent: Construct, id: string, props: common.CommonStackProps) {
        super(parent, id, props)
        this.props = props
        const lambdaFunction = this.lambdaManager.createLambdaFunction('MyFunction', this, role, layers, code)
        this.apiManager.createLambdaRestApi('MyCertificate', this, props, lambdaFunction)
      }
    }

    [CDK API Gateway Module]https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_apigateway-readme.html

    Index

    Constructors

    constructor

    Methods

    createApiDeployment createApiDomain createApiResource createLambdaRestApi

    Constructors

    Methods

    • Parameters

      • id: string

        scoped id of the resource

      • scope: CommonConstruct

        scope in which this resource is defined

      • domainName: string

        the domain name to use

      • certificate: ICertificate

        the certificate used for custom restApi domain

      Returns DomainName

    • Parameters

      • id: string
      • scope: CommonConstruct
      • parent: IResource
      • path: string
      • integration: Integration
      • addProxy: boolean
      • Optionalauthorizer: IAuthorizer
      • OptionalallowedOrigins: string[]
      • OptionalallowedMethods: string[]
      • OptionalallowedHeaders: string[]
      • OptionalmethodRequestParameters: { [param: string]: boolean }
      • OptionalproxyIntegration: Integration
      • OptionalenableDefaultCors: boolean
      • OptionalmockIntegration: Integration
      • OptionalmockMethodResponses: MethodResponse[]

      Returns Resource

    Settings

    Member Visibility

    On This Page

    Constructors
    Methods