aws-cdk-lib.aws_lambda.CfnUrlProps

interface CfnUrlProps

LanguageType name
.NETAmazon.CDK.AWS.Lambda.CfnUrlProps
Gogithub.com/aws/aws-cdk-go/awscdk/v2/awslambda#CfnUrlProps
Javasoftware.amazon.awscdk.services.lambda.CfnUrlProps
Pythonaws_cdk.aws_lambda.CfnUrlProps
TypeScript aws-cdk-lib » aws_lambda » CfnUrlProps

Properties for defining a CfnUrl.

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

NameTypeDescription
authTypestringThe type of authentication that your function URL uses.
targetFunctionArnstringThe name of the Lambda function.
cors?IResolvable | CorsPropertyThe Cross-Origin Resource Sharing (CORS) settings for your function URL.
invokeMode?stringUse one of the following options:.
qualifier?stringThe alias name.

authType

Type: string

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 .


targetFunctionArn

Type: string

The name of the Lambda function.

Name formats - Function name - my-function .

  • Function ARN - arn:aws:lambda:us-west-2:123456789012:function:my-function .
  • Partial ARN - 123456789012: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.


cors?

Type: IResolvable | CorsProperty (optional)

The Cross-Origin Resource Sharing (CORS) settings for your function URL.


invokeMode?

Type: string (optional)

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 20 MB, however, you can request a quota increase .

qualifier?

Type: string (optional)

The alias name.