Class CfnUrlPropsMixin.Builder
java.lang.Object
software.amazon.awscdk.cfnpropertymixins.services.lambda.CfnUrlPropsMixin.Builder
- All Implemented Interfaces:
software.amazon.jsii.Builder<CfnUrlPropsMixin>
- Enclosing class:
CfnUrlPropsMixin
@Stability(Stable)
public static final class CfnUrlPropsMixin.Builder
extends Object
implements software.amazon.jsii.Builder<CfnUrlPropsMixin>
A fluent builder for
CfnUrlPropsMixin.-
Method Summary
Modifier and TypeMethodDescriptionThe type of authentication that your function URL uses.build()The Cross-Origin Resource Sharing (CORS) settings for your function URL.cors(IResolvable cors) The Cross-Origin Resource Sharing (CORS) settings for your function URL.static CfnUrlPropsMixin.Buildercreate()static CfnUrlPropsMixin.Buildercreate(CfnPropertyMixinOptions options) invokeMode(String invokeMode) Use one of the following options:.The alias name.targetFunctionArn(String targetFunctionArn) The name of the Lambda function.targetFunctionArn(IFunctionRef targetFunctionArn) The name of the Lambda function.
-
Method Details
-
create
- Parameters:
options- Mixin options.- Returns:
- a new instance of
CfnUrlPropsMixin.Builder.
-
create
- Returns:
- a new instance of
CfnUrlPropsMixin.Builder.
-
authType
The type of authentication that your function URL uses.Set to
AWS_IAMif you want to restrict access to authenticated users only. Set toNONEif 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:
-
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 theInvokeAPI 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 theInvokeWithResponseStreamAPI operation. The maximum response payload size is 200 MB.
- 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:
-
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 -
-
targetFunctionArn
@Stability(Stable) public CfnUrlPropsMixin.Builder targetFunctionArn(IFunctionRef 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 -
-
build
- Specified by:
buildin interfacesoftware.amazon.jsii.Builder<CfnUrlPropsMixin>- Returns:
- a newly built instance of
CfnUrlPropsMixin.
-