Package software.amazon.awscdk.services.lambda

Class FunctionUrl.Builder

java.lang.Object

software.amazon.awscdk.services.lambda.FunctionUrl.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<FunctionUrl>

Enclosing class:

FunctionUrl

@Stability(Stable)
public static final class FunctionUrl.Builder
extends Object
implements software.amazon.jsii.Builder<FunctionUrl>

A fluent builder for FunctionUrl.

Method Summary

Modifier and Type	Method	Description
FunctionUrl.Builder	authType(FunctionUrlAuthType authType)	The type of authentication that your function URL uses.
FunctionUrl	build()
FunctionUrl.Builder	cors(FunctionUrlCorsOptions cors)	The cross-origin resource sharing (CORS) settings for your function URL.
static FunctionUrl.Builder	create(software.constructs.Construct scope, String id)
FunctionUrl.Builder	function(IFunction function)	The function to which this url refers.
FunctionUrl.Builder	invokeMode(InvokeMode invokeMode)	The type of invocation mode that your Lambda function uses.

Methods inherited from class java.lang.Object

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

Method Details

create

@Stability(Stable)
public static FunctionUrl.Builder create(software.constructs.Construct scope,
 String id)

Parameters:

scope - This parameter is required.

id - This parameter is required.

Returns:

a new instance of FunctionUrl.Builder.

authType

@Stability(Stable)
public FunctionUrl.Builder authType(FunctionUrlAuthType authType)

The type of authentication that your function URL uses.

Default: FunctionUrlAuthType.AWS_IAM

Parameters:

authType - The type of authentication that your function URL uses. This parameter is required.

Returns:

this

cors

@Stability(Stable)
public FunctionUrl.Builder cors(FunctionUrlCorsOptions cors)

The cross-origin resource sharing (CORS) settings for your function URL.

Default: - No CORS configuration.

Parameters:

cors - The cross-origin resource sharing (CORS) settings for your function URL. This parameter is required.

Returns:

this

invokeMode

@Stability(Stable)
public FunctionUrl.Builder invokeMode(InvokeMode invokeMode)

The type of invocation mode that your Lambda function uses.

Default: InvokeMode.BUFFERED

Parameters:

invokeMode - The type of invocation mode that your Lambda function uses. This parameter is required.

Returns:

this

function

@Stability(Stable)
public FunctionUrl.Builder function(IFunction function)

The function to which this url refers.

It can also be an Alias but not a Version.

Parameters:

function - The function to which this url refers. This parameter is required.

Returns:

this

build

@Stability(Stable)
public FunctionUrl build()

Specified by:

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

Returns:

a newly built instance of FunctionUrl.