Package software.amazon.awsconstructs.services.cloudfrontapigatewaylambda

Interface CloudFrontToApiGatewayToLambdaProps

All Superinterfaces:
software.amazon.jsii.JsiiSerializable
All Known Implementing Classes:
CloudFrontToApiGatewayToLambdaProps.Jsii$Proxy
@Generated(value="jsii-pacmak/1.111.0 (build cc021d6)", date="2025-08-05T21:17:12.611Z") public interface CloudFrontToApiGatewayToLambdaProps extends software.amazon.jsii.JsiiSerializable

  • Method Details

    • getApiGatewayProps

      @NotNull Object getApiGatewayProps()
      User provided props to override the default props for the API Gateway.

      As of release 2.48.0, clients must include this property with defaultMethodOptions: { authorizationType: string } specified. See Issue1043 in the github repo https://github.com/awslabs/aws-solutions-constructs/issues/1043

      Default: - defaultMethodOptions/authorizationType is required, for other, unspecified values the default props are used

    • getCloudFrontDistributionProps

      @Nullable default Object getCloudFrontDistributionProps()
      Optional user provided props to override the default props.

      Default: - Default props are used

    • getCloudFrontLoggingBucketProps

      @Nullable default software.amazon.awscdk.services.s3.BucketProps getCloudFrontLoggingBucketProps()
      Optional user provided props to override the default props for the CloudFront Logging Bucket.

      Default: - Default props are used

    • getCreateUsagePlan

      @Nullable default Boolean getCreateUsagePlan()
      Whether to create a Usage Plan attached to the API.

      Must be true if apiGatewayProps.defaultMethodOptions.apiKeyRequired is true

      Default: - true (to match legacy behavior)

    • getExistingLambdaObj

      @Nullable default software.amazon.awscdk.services.lambda.Function getExistingLambdaObj()
      Existing instance of Lambda Function object, providing both this and lambdaFunctionProps will cause an error.

      Default: - None

    • getInsertHttpSecurityHeaders

      @Nullable default Boolean getInsertHttpSecurityHeaders()
      Optional user provided props to turn on/off the automatic injection of best practice HTTP security headers in all responses from cloudfront.

      Turning this on will inject default headers and is mutually exclusive with passing custom security headers via the responseHeadersPolicyProps parameter.

      Default: - true

    • getLambdaFunctionProps

      @Nullable default software.amazon.awscdk.services.lambda.FunctionProps getLambdaFunctionProps()
      Optional user provided props to override the default props for the Lambda function.

      Default: - Default props are used

    • getLogGroupProps

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

      Default: - Default props are used

    • getResponseHeadersPolicyProps

      @Nullable default software.amazon.awscdk.services.cloudfront.ResponseHeadersPolicyProps getResponseHeadersPolicyProps()
      Optional user provided configuration that cloudfront applies to all http responses.

      Can be used to pass a custom ResponseSecurityHeadersBehavior, ResponseCustomHeadersBehavior or ResponseHeadersCorsBehavior to the cloudfront distribution.

      Passing a custom ResponseSecurityHeadersBehavior is mutually exclusive with turning on the default security headers via insertHttpSecurityHeaders prop. Will throw an error if both insertHttpSecurityHeaders is set to true and ResponseSecurityHeadersBehavior is passed.

      Default: - undefined

    • builder

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