interface CfnUrlProps
Language | Type name |
---|---|
![]() | Amazon.CDK.AWS.Lambda.CfnUrlProps |
![]() | github.com/aws/aws-cdk-go/awscdk/v2/awslambda#CfnUrlProps |
![]() | software.amazon.awscdk.services.lambda.CfnUrlProps |
![]() | aws_cdk.aws_lambda.CfnUrlProps |
![]() | aws-cdk-lib » aws_lambda » CfnUrlProps |
Properties for defining a CfnUrl
.
See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-url.html
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
Name | Type | Description |
---|---|---|
auth | string | The type of authentication that your function URL uses. |
target | string | The name of the Lambda function. |
cors? | IResolvable | Cors | The Cross-Origin Resource Sharing (CORS) settings for your function URL. |
invoke | string | Use one of the following options:. |
qualifier? | string | The 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 -
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.
cors?
Type:
IResolvable
|
Cors
(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 theInvoke
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 theInvokeWithResponseStream
API operation. The maximum response payload size is 20 MB, however, you can request a quota increase .
qualifier?
Type:
string
(optional)
The alias name.