GradientEdge CDK Utils
    Preparing search index...

    Class RestApiLambdaAbstract

    Provides a construct to create and deploy a RestApi as Lambda

    Architecture
    Architecture

    import { RestApiLambda, RestApiLambdaProps } '@gradientedge/cdk-utils'
    import { Construct } from 'constructs'

    class CustomConstruct extends RestApiLambda {
      constructor(parent: Construct, id: string, props: RestApiLambdaProps) {
        super(parent, id, props)
        this.props = props
        this.id = id
        this.initResources()
      }
    }

    Hierarchy (View Summary)

    Index

    Constructors

    constructor

    Properties

    acmManager apiManager appConfigManager applicationSecrets cloudFrontManager cloudTrailManager cloudWatchManager codeBuildManager dynamodbManager ecrManager ecsManager efsManager eksManager elasticacheManager eventManager eventTargetManager evidentlyManager fullyQualifiedDomainName iamManager id kmsManager lambdaManager logManager node props resourceNameFormatter restApi restApiBasePathMappings restApiCertificate restApiDomain restApiHostedZone restApiLambdaEnvironment restApiLambdaFunction restApiLambdaLayers restApiLambdaPolicy restApiLambdaRole route53Manager s3Manager secretsManager sfnManager snsManager sqsManager ssmManager vpcManager wafManager

    Methods

    addCfnOutput createApiBasePathMapping createApiDomain createApiRouteAssets createLambdaEnvironment createLambdaFunction createLambdaLayers createLambdaPolicy createLambdaRole createRestApi createRestApiResources determineFullyQualifiedDomain initResources isDevelopmentStage isProductionStage isTestStage isUatStage resolveCertificate resolveHostedZone resolveSecrets toString with isConstruct

    Constructors

    Properties

    acmManager: AcmManager
    apiManager: ApiManager
    appConfigManager: AppConfigManager
    applicationSecrets: ISecret[]
    cloudFrontManager: CloudFrontManager
    cloudTrailManager: CloudTrailManager
    cloudWatchManager: CloudWatchManager
    codeBuildManager: CodeBuildManager
    dynamodbManager: DynamodbManager
    ecrManager: EcrManager
    ecsManager: EcsManager
    efsManager: EfsManager
    eksManager: EksManager
    elasticacheManager: ElastiCacheManager
    eventManager: EventManager
    eventTargetManager: EventTargetManager
    evidentlyManager: EvidentlyManager
    fullyQualifiedDomainName: string
    iamManager: IamManager
    id: string
    kmsManager: KmsManager
    lambdaManager: LambdaManager
    logManager: LogManager
    node: Node

    The tree node.

    props: RestApiLambdaProps
    resourceNameFormatter: ResourceNameFormatter
    restApi: RestApi
    restApiBasePathMappings: BasePathMapping[] = []
    restApiCertificate: ICertificate
    restApiDomain: DomainName
    restApiHostedZone: IHostedZone
    restApiLambdaEnvironment: RestApiLambdaEnvironment
    restApiLambdaFunction: IFunction
    restApiLambdaLayers: ILayerVersion[] = []
    restApiLambdaPolicy: PolicyDocument
    restApiLambdaRole: Role
    route53Manager: Route53Manager
    s3Manager: S3Manager
    secretsManager: SecretsManager
    sfnManager: SfnManager
    snsManager: SnsManager
    sqsManager: SqsManager
    ssmManager: SsmManager
    vpcManager: VpcManager
    wafManager: WafManager

    Methods

    • Parameters

      • id: string

        scoped id of the resource

      • value: string

        the value of the exported output

      • Optionaldescription: string

        optional description for the output

      • overrideId: boolean = true

        Flag which indicates whether to override the default logical id of the output

      Returns CfnOutput

    • Returns a string representation of this construct.

      Returns string

    • Applies one or more mixins to this construct.

      Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple with() calls if subsequent mixins should apply to added constructs.

      Parameters

      • ...mixins: IMixin[]

        The mixins to apply

      Returns IConstruct

      This construct for chaining

    • Checks if x is a construct.

      Use this method instead of instanceof to properly detect Construct instances, even when the construct library is symlinked.

      Explanation: in JavaScript, multiple copies of the constructs library on disk are seen as independent, completely different libraries. As a consequence, the class Construct in each copy of the constructs library is seen as a different class, and an instance of one class will not test as instanceof the other class. npm install will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the constructs library can be accidentally installed, and instanceof will behave unpredictably. It is safest to avoid using instanceof, and using this type-testing method instead.

      Parameters

      • x: any

        Any object

      Returns x is Construct

      true if x is an object created from a class which extends Construct.

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods