Package software.amazon.awsconstructs.services.openapigatewaylambda

Class OpenApiGatewayToLambdaProps.Jsii$Proxy

java.lang.Object
software.amazon.jsii.JsiiObject
software.amazon.awsconstructs.services.openapigatewaylambda.OpenApiGatewayToLambdaProps.Jsii$Proxy
All Implemented Interfaces:
OpenApiGatewayToLambdaProps, software.amazon.jsii.JsiiSerializable
Enclosing interface:
OpenApiGatewayToLambdaProps
@Internal public static final class OpenApiGatewayToLambdaProps.Jsii$Proxy extends software.amazon.jsii.JsiiObject implements OpenApiGatewayToLambdaProps
An implementation for OpenApiGatewayToLambdaProps

  • Nested Class Summary

    Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

    software.amazon.jsii.JsiiObject.InitializationMode

    Nested classes/interfaces inherited from interface software.amazon.awsconstructs.services.openapigatewaylambda.OpenApiGatewayToLambdaProps

    OpenApiGatewayToLambdaProps.Builder, OpenApiGatewayToLambdaProps.Jsii$Proxy

  • Constructor Summary

    Constructors
    Modifier
    Constructor
    Description
    protected
    Jsii$Proxy(OpenApiGatewayToLambdaProps.Builder builder)
    Constructor that initializes the object based on literal property values passed by the OpenApiGatewayToLambdaProps.Builder.
    protected
    Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef)
    Constructor that initializes the object based on values retrieved from the JsiiObject.

  • Method Summary

    Modifier and Type
    Method
    Description
    com.fasterxml.jackson.databind.JsonNode
    $jsii$toJson()
     
    final boolean
    equals(Object o)
     
    final software.amazon.awscdk.services.s3.assets.Asset
    getApiDefinitionAsset()
    Local file asset of the OpenAPI spec file.
    final software.amazon.awscdk.services.s3.IBucket
    getApiDefinitionBucket()
    S3 Bucket where the OpenAPI spec file is located.
    final Object
    getApiDefinitionJson()
    OpenAPI specification represented in a JSON object to be embedded in the CloudFormation template.
    final String
    getApiDefinitionKey()
    S3 Object name of the OpenAPI spec file.
    final software.amazon.awscdk.services.apigateway.RestApiBaseProps
    getApiGatewayProps()
    Optional user-provided props to override the default props for the API.
    final 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.
    final Number
    getInternalTransformMemorySize()
    Optional user-defined memory size for the Lambda function custom resource installed to do the OpenAPI definition transformation.
    final software.amazon.awscdk.Duration
    getInternalTransformTimeout()
    Optional user-defined timeout for the Lambda function custom resource installed to do the OpenAPI definition transformation.
    final software.amazon.awscdk.services.logs.LogGroupProps
    getLogGroupProps()
    User provided props to override the default props for the CloudWatchLogs LogGroup.
    final int
    hashCode()
     

    Methods inherited from class software.amazon.jsii.JsiiObject

    jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

    Methods inherited from class java.lang.Object

    clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

  • Constructor Details

    • Jsii$Proxy

      protected Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef)
      Constructor that initializes the object based on values retrieved from the JsiiObject.
      Parameters:
      objRef - Reference to the JSII managed object.

    • Jsii$Proxy

      protected Jsii$Proxy(OpenApiGatewayToLambdaProps.Builder builder)
      Constructor that initializes the object based on literal property values passed by the OpenApiGatewayToLambdaProps.Builder.

  • Method Details

    • getApiIntegrations

      public final List<ApiIntegration> getApiIntegrations()
      Description copied from interface: OpenApiGatewayToLambdaProps
      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), }) } ]

      Specified by:
      getApiIntegrations in interface OpenApiGatewayToLambdaProps

    • getApiDefinitionAsset

      public final software.amazon.awscdk.services.s3.assets.Asset getApiDefinitionAsset()
      Description copied from interface: OpenApiGatewayToLambdaProps
      Local file asset of the OpenAPI spec file.
      Specified by:
      getApiDefinitionAsset in interface OpenApiGatewayToLambdaProps

    • getApiDefinitionBucket

      public final software.amazon.awscdk.services.s3.IBucket getApiDefinitionBucket()
      Description copied from interface: OpenApiGatewayToLambdaProps
      S3 Bucket where the OpenAPI spec file is located.

      When specifying this property, apiDefinitionKey must also be specified.

      Specified by:
      getApiDefinitionBucket in interface OpenApiGatewayToLambdaProps

    • getApiDefinitionJson

      public final Object getApiDefinitionJson()
      Description copied from interface: OpenApiGatewayToLambdaProps
      OpenAPI specification represented in a JSON object to be embedded in the CloudFormation template.

      IMPORTANT - Including the spec in the template introduces a risk of the template growing too big, but there are some use cases that require an embedded spec. Unless your use case explicitly requires an embedded spec you should pass your spec as an S3 asset.

      Specified by:
      getApiDefinitionJson in interface OpenApiGatewayToLambdaProps

    • getApiDefinitionKey

      public final String getApiDefinitionKey()
      Description copied from interface: OpenApiGatewayToLambdaProps
      S3 Object name of the OpenAPI spec file.

      When specifying this property, apiDefinitionBucket must also be specified.

      Specified by:
      getApiDefinitionKey in interface OpenApiGatewayToLambdaProps

    • getApiGatewayProps

      public final software.amazon.awscdk.services.apigateway.RestApiBaseProps getApiGatewayProps()
      Description copied from interface: OpenApiGatewayToLambdaProps
      Optional user-provided props to override the default props for the API.

      Default: - Default props are used.

      Specified by:
      getApiGatewayProps in interface OpenApiGatewayToLambdaProps

    • getInternalTransformMemorySize

      public final Number getInternalTransformMemorySize()
      Description copied from interface: OpenApiGatewayToLambdaProps
      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

      Specified by:
      getInternalTransformMemorySize in interface OpenApiGatewayToLambdaProps

    • getInternalTransformTimeout

      public final software.amazon.awscdk.Duration getInternalTransformTimeout()
      Description copied from interface: OpenApiGatewayToLambdaProps
      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)

      Specified by:
      getInternalTransformTimeout in interface OpenApiGatewayToLambdaProps

    • getLogGroupProps

      public final software.amazon.awscdk.services.logs.LogGroupProps getLogGroupProps()
      Description copied from interface: OpenApiGatewayToLambdaProps
      User provided props to override the default props for the CloudWatchLogs LogGroup.

      Default: - Default props are used

      Specified by:
      getLogGroupProps in interface OpenApiGatewayToLambdaProps

    • $jsii$toJson

      @Internal public com.fasterxml.jackson.databind.JsonNode $jsii$toJson()
      Specified by:
      $jsii$toJson in interface software.amazon.jsii.JsiiSerializable

    • equals

      public final boolean equals(Object o)
      Overrides:
      equals in class Object

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class Object