Package software.amazon.awscdk.services.lambda

Interface FunctionUrlOptions

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Subinterfaces:

FunctionUrlProps

All Known Implementing Classes:

FunctionUrlOptions.Jsii$Proxy, FunctionUrlProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.104.0 (build e79254c)",
           date="2024-11-22T02:24:03.928Z")
@Stability(Stable)
public interface FunctionUrlOptions
extends software.amazon.jsii.JsiiSerializable

Options to add a url to a Lambda function.

Example:

 import software.amazon.awscdk.services.lambda.*;
 Function fn;
 FunctionUrl fnUrl = fn.addFunctionUrl(FunctionUrlOptions.builder().authType(FunctionUrlAuthType.NONE).build());
 Distribution.Builder.create(this, "Distribution")
         .defaultBehavior(BehaviorOptions.builder().origin(new FunctionUrlOrigin(fnUrl)).build())
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	FunctionUrlOptions.Builder	A builder for FunctionUrlOptions
static final class	FunctionUrlOptions.Jsii$Proxy	An implementation for FunctionUrlOptions

Method Summary

Modifier and Type	Method	Description
static FunctionUrlOptions.Builder	builder()
default FunctionUrlAuthType	getAuthType()	The type of authentication that your function URL uses.
default FunctionUrlCorsOptions	getCors()	The cross-origin resource sharing (CORS) settings for your function URL.
default InvokeMode	getInvokeMode()	The type of invocation mode that your Lambda function uses.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getAuthType

@Stability(Stable)
@Nullable
default FunctionUrlAuthType getAuthType()

The type of authentication that your function URL uses.

Default: FunctionUrlAuthType.AWS_IAM

getCors

@Stability(Stable)
@Nullable
default FunctionUrlCorsOptions getCors()

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

Default: - No CORS configuration.

getInvokeMode

@Stability(Stable)
@Nullable
default InvokeMode getInvokeMode()

The type of invocation mode that your Lambda function uses.

Default: InvokeMode.BUFFERED

builder

@Stability(Stable)
static FunctionUrlOptions.Builder builder()

Returns:

a FunctionUrlOptions.Builder of FunctionUrlOptions