Class CfnUrlProps.Builder
java.lang.Object
software.amazon.awscdk.services.lambda.CfnUrlProps.Builder
- All Implemented Interfaces:
software.amazon.jsii.Builder<CfnUrlProps>
- Enclosing interface:
CfnUrlProps
@Stability(Stable)
public static final class CfnUrlProps.Builder
extends Object
implements software.amazon.jsii.Builder<CfnUrlProps>
A builder for
CfnUrlProps
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionSets the value ofCfnUrlProps.getAuthType()
build()
Builds the configured instance.cors
(IResolvable cors) Sets the value ofCfnUrlProps.getCors()
cors
(CfnUrl.CorsProperty cors) Sets the value ofCfnUrlProps.getCors()
invokeMode
(String invokeMode) Sets the value ofCfnUrlProps.getInvokeMode()
Sets the value ofCfnUrlProps.getQualifier()
targetFunctionArn
(String targetFunctionArn) Sets the value ofCfnUrlProps.getTargetFunctionArn()
-
Constructor Details
-
Builder
public Builder()
-
-
Method Details
-
authType
Sets the value ofCfnUrlProps.getAuthType()
- Parameters:
authType
- The type of authentication that your function URL uses. This parameter is required. Set toAWS_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 .- Returns:
this
-
targetFunctionArn
Sets the value ofCfnUrlProps.getTargetFunctionArn()
- Parameters:
targetFunctionArn
- The name of the Lambda function. This parameter is required. 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.
- Function ARN -
- Returns:
this
-
cors
Sets the value ofCfnUrlProps.getCors()
- Parameters:
cors
- The Cross-Origin Resource Sharing (CORS) settings for your function URL.- Returns:
this
-
cors
Sets the value ofCfnUrlProps.getCors()
- Parameters:
cors
- The Cross-Origin Resource Sharing (CORS) settings for your function URL.- Returns:
this
-
invokeMode
Sets the value ofCfnUrlProps.getInvokeMode()
- Parameters:
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 .
- Returns:
this
-
qualifier
Sets the value ofCfnUrlProps.getQualifier()
- Parameters:
qualifier
- The alias name.- Returns:
this
-
build
Builds the configured instance.- Specified by:
build
in interfacesoftware.amazon.jsii.Builder<CfnUrlProps>
- Returns:
- a new instance of
CfnUrlProps
- Throws:
NullPointerException
- if any required attribute was not provided
-