Class CfnUrl.Builder
java.lang.Object
software.amazon.awscdk.services.lambda.CfnUrl.Builder
- All Implemented Interfaces:
software.amazon.jsii.Builder<CfnUrl>
- Enclosing class:
CfnUrl
@Stability(Stable)
public static final class CfnUrl.Builder
extends Object
implements software.amazon.jsii.Builder<CfnUrl>
A fluent builder for
CfnUrl
.-
Method Summary
Modifier and TypeMethodDescriptionThe type of authentication that your function URL uses.build()
cors
(IResolvable cors) The Cross-Origin Resource Sharing (CORS) settings for your function URL.cors
(CfnUrl.CorsProperty cors) The Cross-Origin Resource Sharing (CORS) settings for your function URL.static CfnUrl.Builder
invokeMode
(String invokeMode) Use one of the following options:.The alias name.targetFunctionArn
(String targetFunctionArn) The name of the Lambda function.
-
Method Details
-
create
@Stability(Stable) public static CfnUrl.Builder create(software.constructs.Construct scope, String id) - Parameters:
scope
- Scope in which this resource is defined. This parameter is required.id
- Construct identifier for this resource (unique in its scope). This parameter is required.- Returns:
- a new instance of
CfnUrl.Builder
.
-
authType
The type of authentication that your function URL uses.Set to
AWS_IAM
if you want to restrict access to authenticated users only. Set toNONE
if you want to bypass IAM authentication to create a public endpoint. For more information, see Security and auth model for Lambda function URLs .- Parameters:
authType
- The type of authentication that your function URL uses. This parameter is required.- Returns:
this
- See Also:
-
targetFunctionArn
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.
- Parameters:
targetFunctionArn
- The name of the Lambda function. This parameter is required.- Returns:
this
- See Also:
- Function ARN -
-
cors
The Cross-Origin Resource Sharing (CORS) settings for your function URL.- Parameters:
cors
- The Cross-Origin Resource Sharing (CORS) settings for your function URL. This parameter is required.- Returns:
this
- See Also:
-
cors
The Cross-Origin Resource Sharing (CORS) settings for your function URL.- Parameters:
cors
- The Cross-Origin Resource Sharing (CORS) settings for your function URL. This parameter is required.- Returns:
this
- See Also:
-
invokeMode
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 .
- Parameters:
invokeMode
- Use one of the following options:. This parameter is required.- Returns:
this
- See Also:
-
qualifier
The alias name.- Parameters:
qualifier
- The alias name. This parameter is required.- Returns:
this
- See Also:
-
build
-