Package software.amazon.awsconstructs.services.openapigatewaylambda

Interface OpenApiGatewayToLambdaProps

All Superinterfaces:
software.amazon.jsii.JsiiSerializable
All Known Implementing Classes:
OpenApiGatewayToLambdaProps.Jsii$Proxy
@Generated(value="jsii-pacmak/1.102.0 (build e354887)", date="2024-08-27T01:33:38.819Z") public interface OpenApiGatewayToLambdaProps extends software.amazon.jsii.JsiiSerializable

  • Method Details

    • getApiIntegrations

      @NotNull List<ApiIntegration> getApiIntegrations()
      One or more key-value pairs that contain an id for the api integration and either an existing lambda function or an instance of the LambdaProps.

      Example: const apiIntegrations: ApiIntegration[] = [ { id: 'MessagesHandler', lambdaFunctionProps: { runtime: defaults.COMMERCIAL_REGION_LAMBDA_NODE_RUNTIME, handler: 'index.handler', code: lambda.Code.fromAsset(${__dirname}/messages-lambda), } }, { id: 'PhotosHandler', existingLambdaObj: new lambda.Function(this, 'PhotosLambda', { runtime: defaults.COMMERCIAL_REGION_LAMBDA_NODE_RUNTIME, handler: 'index.handler', code: lambda.Code.fromAsset(${__dirname}/photos-lambda), }) } ]

    • getApiDefinitionAsset

      @Nullable default software.amazon.awscdk.services.s3.assets.Asset getApiDefinitionAsset()
      Local file asset of the OpenAPI spec file.

    • getApiDefinitionBucket

      @Nullable default software.amazon.awscdk.services.s3.IBucket getApiDefinitionBucket()
      S3 Bucket where the OpenAPI spec file is located.

      When specifying this property, apiDefinitionKey must also be specified.

    • getApiDefinitionKey

      @Nullable default String getApiDefinitionKey()
      S3 Object name of the OpenAPI spec file.

      When specifying this property, apiDefinitionBucket must also be specified.

    • getApiGatewayProps

      @Nullable default software.amazon.awscdk.services.apigateway.RestApiBaseProps getApiGatewayProps()
      Optional user-provided props to override the default props for the API.

      Default: - Default props are used.

    • getInternalTransformMemorySize

      @Nullable default Number getInternalTransformMemorySize()
      Optional user-defined memory size for the Lambda function custom resource installed to do the OpenAPI definition transformation.

      This setting does not affect the deployed architecture - only the ability for the Construct to complete its work.

      Defaults to 1024 MiB, but for larger files (hundreds of megabytes or gigabytes in size) this value may need to be increased.

      Default: 1024

    • getInternalTransformTimeout

      @Nullable default software.amazon.awscdk.Duration getInternalTransformTimeout()
      Optional user-defined timeout for the Lambda function custom resource installed to do the OpenAPI definition transformation.

      This setting does not affect the deployed architecture - only the ability for the Construct to complete its work.

      Defaults to 1 minute, but for larger files (hundreds of megabytes or gigabytes in size) this value may need to be increased.

      Default: Duration.minutes(1)

    • getLogGroupProps

      @Nullable default software.amazon.awscdk.services.logs.LogGroupProps getLogGroupProps()
      User provided props to override the default props for the CloudWatchLogs LogGroup.

      Default: - Default props are used

    • builder

      static OpenApiGatewayToLambdaProps.Builder builder()
      Returns:
      a OpenApiGatewayToLambdaProps.Builder of OpenApiGatewayToLambdaProps