Package software.amazon.awscdk.services.lambda

Interface CfnUrlProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnUrlProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.102.0 (build e354887)",
           date="2024-08-23T05:56:18.896Z")
@Stability(Stable)
public interface CfnUrlProps
extends software.amazon.jsii.JsiiSerializable

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 software.amazon.awscdk.services.lambda.*;
 CfnUrlProps cfnUrlProps = CfnUrlProps.builder()
         .authType("authType")
         .targetFunctionArn("targetFunctionArn")
         // the properties below are optional
         .cors(CorsProperty.builder()
                 .allowCredentials(false)
                 .allowHeaders(List.of("allowHeaders"))
                 .allowMethods(List.of("allowMethods"))
                 .allowOrigins(List.of("allowOrigins"))
                 .exposeHeaders(List.of("exposeHeaders"))
                 .maxAge(123)
                 .build())
         .invokeMode("invokeMode")
         .qualifier("qualifier")
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-url.html

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnUrlProps.Builder	A builder for CfnUrlProps
static final class	CfnUrlProps.Jsii$Proxy	An implementation for CfnUrlProps

Method Summary

Modifier and Type	Method	Description
static CfnUrlProps.Builder	builder()
String	getAuthType()	The type of authentication that your function URL uses.
default Object	getCors()	The Cross-Origin Resource Sharing (CORS) settings for your function URL.
default String	getInvokeMode()	Use one of the following options:.
default String	getQualifier()	The alias name.
String	getTargetFunctionArn()	The name of the Lambda function.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getAuthType

@Stability(Stable)
@NotNull
String getAuthType()

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 .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-url.html#cfn-lambda-url-authtype

getTargetFunctionArn

@Stability(Stable)
@NotNull
String getTargetFunctionArn()

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.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-url.html#cfn-lambda-url-targetfunctionarn

getCors

@Stability(Stable)
@Nullable
default Object getCors()

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-url.html#cfn-lambda-url-cors

getInvokeMode

@Stability(Stable)
@Nullable
default String getInvokeMode()

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 .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-url.html#cfn-lambda-url-invokemode

getQualifier

@Stability(Stable)
@Nullable
default String getQualifier()

The alias name.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-url.html#cfn-lambda-url-qualifier

builder

@Stability(Stable)
static CfnUrlProps.Builder builder()

Returns:

a CfnUrlProps.Builder of CfnUrlProps