# CfnUrlProps

Properties for defining a `CfnUrl`.

Used as props by: [CfnUrl](/cdk/api/v2/docs/aws-cdk-lib.aws_lambda.CfnUrl.html)

- Source: Generated at build time
- Type last changed: v2.227.0 · 21 Nov 2025

## Example

TypeScript:

```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',
};
```

Python:

```python
# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_lambda as lambda_

cfn_url_props = lambda.CfnUrlProps(
    auth_type="authType",
    target_function_arn="targetFunctionArn",

    # the properties below are optional
    cors=lambda.CfnUrl.CorsProperty(
        allow_credentials=False,
        allow_headers=["allowHeaders"],
        allow_methods=["allowMethods"],
        allow_origins=["allowOrigins"],
        expose_headers=["exposeHeaders"],
        max_age=123
    ),
    invoke_mode="invokeMode",
    qualifier="qualifier"
)
```

Java:

```java
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import software.amazon.awscdk.services.lambda.*;

CfnUrlProps cfnUrlProps = CfnUrlProps.builder()
        .authType("authType")
        .targetFunctionArn("targetFunctionArn")

        // the properties below are optional
        .cors(CorsProperty.builder()
                .allowCredentials(false)
                .allowHeaders(List.of("allowHeaders"))
                .allowMethods(List.of("allowMethods"))
                .allowOrigins(List.of("allowOrigins"))
                .exposeHeaders(List.of("exposeHeaders"))
                .maxAge(123)
                .build())
        .invokeMode("invokeMode")
        .qualifier("qualifier")
        .build();
```

C# / .NET:

```csharp
// Install: dotnet add package Amazon.CDK.Lib
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.Lambda;

var cfnUrlProps = new CfnUrlProps {
    AuthType = "authType",
    TargetFunctionArn = "targetFunctionArn",

    // the properties below are optional
    Cors = new CorsProperty {
        AllowCredentials = false,
        AllowHeaders = new [] { "allowHeaders" },
        AllowMethods = new [] { "allowMethods" },
        AllowOrigins = new [] { "allowOrigins" },
        ExposeHeaders = new [] { "exposeHeaders" },
        MaxAge = 123
    },
    InvokeMode = "invokeMode",
    Qualifier = "qualifier"
};
```

Golang:

```go
// Install: go get github.com/aws/aws-cdk-go/awscdk/v2
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"

cfnUrlProps := &CfnUrlProps{
	AuthType: jsii.String("authType"),
	TargetFunctionArn: jsii.String("targetFunctionArn"),

	// the properties below are optional
	Cors: &CorsProperty{
		AllowCredentials: jsii.Boolean(false),
		AllowHeaders: []*string{
			jsii.String("allowHeaders"),
		},
		AllowMethods: []*string{
			jsii.String("allowMethods"),
		},
		AllowOrigins: []*string{
			jsii.String("allowOrigins"),
		},
		ExposeHeaders: []*string{
			jsii.String("exposeHeaders"),
		},
		MaxAge: jsii.Number(123),
	},
	InvokeMode: jsii.String("invokeMode"),
	Qualifier: jsii.String("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.
