aws-cdk-lib.aws_lambda.CfnUrlProps

CfnUrlProps Struct

Properties for defining a CfnUrl.

CfnUrlProps

used as props by

• CfnUrl

Source

Generated code

Type last changed

v2.227.0 · 21 Nov 2025

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_lambda as lambda } from 'aws-cdk-lib';
const cfnUrlProps: lambda.CfnUrlProps = {
  authType: 'authType',
  targetFunctionArn: 'targetFunctionArn',

  // the properties below are optional
  cors: {
    allowCredentials: false,
    allowHeaders: ['allowHeaders'],
    allowMethods: ['allowMethods'],
    allowOrigins: ['allowOrigins'],
    exposeHeaders: ['exposeHeaders'],
    maxAge: 123,
  },
  invokeMode: 'invokeMode',
  qualifier: 'qualifier',
};

Properties

authTypestringauth_typestrauthTypeStringAuthTypestringAuthType*stringrequired#

The type of authentication that your function URL uses.

notes

Set to AWS_IAM if you want to restrict access to authenticated users only. Set to NONE if you want to bypass IAM authentication to create a public endpoint. For more information, see Security and auth model for Lambda function URLs .

corsIResolvable | CfnUrl.CorsPropertycorstyping.Union[IResolvable, CorsProperty]corsIResolvableCorsIResolvableCorsinterface{}#

The [Cross-Origin Resource Sharing (CORS)](https://docs.aws.amazon.com/https://developer.mozilla.org/en-US/docs/Web/HTTP/CORS) settings for your function URL.

invokeModestringinvoke_modestrinvokeModeStringInvokeModestringInvokeMode*string#

Use one of the following options:.

notes

• BUFFERED – This is the default option. Lambda invokes your function using the Invoke API operation. Invocation results are available when the payload is complete. The maximum payload size is 6 MB.
• RESPONSE_STREAM – Your function streams payload results as they become available. Lambda invokes your function using the InvokeWithResponseStream API operation. The maximum response payload size is 200 MB.

qualifierstringqualifierstrqualifierStringQualifierstringQualifier*string#

The alias name.

targetFunctionArnstring | IFunctionReftarget_function_arntyping.Union[str, IFunctionRef]targetFunctionArnStringTargetFunctionArnstringTargetFunctionArninterface{}required#

The name of the Lambda function.

notes

Name formats - Function name - my-function .

• Function ARN - lambda: : :function:my-function .
• Partial ARN - :function:my-function .

The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.