# CfnUrlProps

Properties for defining a `CfnUrl`.

Extends: CfnUrlProps
Used as props by: CfnUrl

- Source: Generated code
- Type last changed: v2.227.0 · 21 Nov 2025

## Example

```ts
// 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

- `authType`: string (required) — The type of authentication that your function URL uses.

  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](https://docs.aws.amazon.com/lambda/latest/dg/urls-auth.html) .

- `cors`: [IResolvable](/cdk/api/v2/docs/aws-cdk-lib.IResolvable.html) | [CfnUrl.CorsProperty](/cdk/api/v2/docs/aws-cdk-lib.aws_lambda.CfnUrl.CorsProperty.html) — 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.

- `invokeMode`: string — Use one of the following options:.

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

- `qualifier`: string — The alias name.

- `targetFunctionArn`: string | [IFunctionRef](/cdk/api/v2/docs/aws-cdk-lib.interfaces.aws_lambda.IFunctionRef.html) (required) — The name of the Lambda function.

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