Package software.amazon.awsconstructs.services.cloudfrontapigatewaylambda

Class CloudFrontToApiGatewayToLambdaProps.Builder

java.lang.Object

software.amazon.awsconstructs.services.cloudfrontapigatewaylambda.CloudFrontToApiGatewayToLambdaProps.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CloudFrontToApiGatewayToLambdaProps>

Enclosing interface:

CloudFrontToApiGatewayToLambdaProps

public static final class CloudFrontToApiGatewayToLambdaProps.Builder
extends Object
implements software.amazon.jsii.Builder<CloudFrontToApiGatewayToLambdaProps>

A builder for CloudFrontToApiGatewayToLambdaProps

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
CloudFrontToApiGatewayToLambdaProps.Builder	apiGatewayProps(Object apiGatewayProps)	Sets the value of CloudFrontToApiGatewayToLambdaProps.getApiGatewayProps()
CloudFrontToApiGatewayToLambdaProps	build()	Builds the configured instance.
CloudFrontToApiGatewayToLambdaProps.Builder	cloudFrontDistributionProps(Object cloudFrontDistributionProps)	Sets the value of CloudFrontToApiGatewayToLambdaProps.getCloudFrontDistributionProps()
CloudFrontToApiGatewayToLambdaProps.Builder	cloudFrontLoggingBucketProps(software.amazon.awscdk.services.s3.BucketProps cloudFrontLoggingBucketProps)	Sets the value of CloudFrontToApiGatewayToLambdaProps.getCloudFrontLoggingBucketProps()
CloudFrontToApiGatewayToLambdaProps.Builder	createUsagePlan(Boolean createUsagePlan)	Sets the value of CloudFrontToApiGatewayToLambdaProps.getCreateUsagePlan()
CloudFrontToApiGatewayToLambdaProps.Builder	existingLambdaObj(software.amazon.awscdk.services.lambda.Function existingLambdaObj)	Sets the value of CloudFrontToApiGatewayToLambdaProps.getExistingLambdaObj()
CloudFrontToApiGatewayToLambdaProps.Builder	insertHttpSecurityHeaders(Boolean insertHttpSecurityHeaders)	Sets the value of CloudFrontToApiGatewayToLambdaProps.getInsertHttpSecurityHeaders()
CloudFrontToApiGatewayToLambdaProps.Builder	lambdaFunctionProps(software.amazon.awscdk.services.lambda.FunctionProps lambdaFunctionProps)	Sets the value of CloudFrontToApiGatewayToLambdaProps.getLambdaFunctionProps()
CloudFrontToApiGatewayToLambdaProps.Builder	logGroupProps(software.amazon.awscdk.services.logs.LogGroupProps logGroupProps)	Sets the value of CloudFrontToApiGatewayToLambdaProps.getLogGroupProps()
CloudFrontToApiGatewayToLambdaProps.Builder	responseHeadersPolicyProps(software.amazon.awscdk.services.cloudfront.ResponseHeadersPolicyProps responseHeadersPolicyProps)	Sets the value of CloudFrontToApiGatewayToLambdaProps.getResponseHeadersPolicyProps()

Methods inherited from class java.lang.Object

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

Constructor Details

Builder

public Builder()

Method Details

apiGatewayProps

public CloudFrontToApiGatewayToLambdaProps.Builder apiGatewayProps(Object apiGatewayProps)

Sets the value of CloudFrontToApiGatewayToLambdaProps.getApiGatewayProps()

Parameters:

apiGatewayProps - User provided props to override the default props for the API Gateway. This parameter is required. 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

Returns:

this

cloudFrontDistributionProps

public CloudFrontToApiGatewayToLambdaProps.Builder cloudFrontDistributionProps(Object cloudFrontDistributionProps)

Sets the value of CloudFrontToApiGatewayToLambdaProps.getCloudFrontDistributionProps()

Parameters:

cloudFrontDistributionProps - Optional user provided props to override the default props.

Returns:

this

cloudFrontLoggingBucketProps

public CloudFrontToApiGatewayToLambdaProps.Builder cloudFrontLoggingBucketProps(software.amazon.awscdk.services.s3.BucketProps cloudFrontLoggingBucketProps)

Sets the value of CloudFrontToApiGatewayToLambdaProps.getCloudFrontLoggingBucketProps()

Parameters:

cloudFrontLoggingBucketProps - Optional user provided props to override the default props for the CloudFront Logging Bucket.

Returns:

this

createUsagePlan

public CloudFrontToApiGatewayToLambdaProps.Builder createUsagePlan(Boolean createUsagePlan)

Sets the value of CloudFrontToApiGatewayToLambdaProps.getCreateUsagePlan()

Parameters:

createUsagePlan - Whether to create a Usage Plan attached to the API. Must be true if apiGatewayProps.defaultMethodOptions.apiKeyRequired is true

Returns:

this

existingLambdaObj

public CloudFrontToApiGatewayToLambdaProps.Builder existingLambdaObj(software.amazon.awscdk.services.lambda.Function existingLambdaObj)

Sets the value of CloudFrontToApiGatewayToLambdaProps.getExistingLambdaObj()

Parameters:

existingLambdaObj - Existing instance of Lambda Function object, providing both this and lambdaFunctionProps will cause an error.

Returns:

this

insertHttpSecurityHeaders

public CloudFrontToApiGatewayToLambdaProps.Builder insertHttpSecurityHeaders(Boolean insertHttpSecurityHeaders)

Sets the value of CloudFrontToApiGatewayToLambdaProps.getInsertHttpSecurityHeaders()

Parameters:

insertHttpSecurityHeaders - 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.

Returns:

this

lambdaFunctionProps

public CloudFrontToApiGatewayToLambdaProps.Builder lambdaFunctionProps(software.amazon.awscdk.services.lambda.FunctionProps lambdaFunctionProps)

Sets the value of CloudFrontToApiGatewayToLambdaProps.getLambdaFunctionProps()

Parameters:

lambdaFunctionProps - Optional user provided props to override the default props for the Lambda function.

Returns:

this

logGroupProps

public CloudFrontToApiGatewayToLambdaProps.Builder logGroupProps(software.amazon.awscdk.services.logs.LogGroupProps logGroupProps)

Sets the value of CloudFrontToApiGatewayToLambdaProps.getLogGroupProps()

Parameters:

logGroupProps - Optional user provided props to override the default props for the CloudWatchLogs LogGroup.

Returns:

this

responseHeadersPolicyProps

public CloudFrontToApiGatewayToLambdaProps.Builder responseHeadersPolicyProps(software.amazon.awscdk.services.cloudfront.ResponseHeadersPolicyProps responseHeadersPolicyProps)

Sets the value of CloudFrontToApiGatewayToLambdaProps.getResponseHeadersPolicyProps()

Parameters:

responseHeadersPolicyProps - 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.

Returns:

this

build

public CloudFrontToApiGatewayToLambdaProps build()

Builds the configured instance.

Specified by:

build in interface software.amazon.jsii.Builder<CloudFrontToApiGatewayToLambdaProps>

Returns:

a new instance of CloudFrontToApiGatewayToLambdaProps

Throws:

NullPointerException - if any required attribute was not provided