software.amazon.awscdk.services.lambda

Interface CfnUrlProps

All Known Implementing Classes:

CfnUrlProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)",
           date="2023-03-14T16:25:29.730Z")
public interface CfnUrlProps

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();
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and Description
static CfnUrlProps.Builder	builder()
java.lang.String	getAuthType() The type of authentication that your function URL uses.
default java.lang.Object	getCors() The [Cross-Origin Resource Sharing (CORS)](https://docs.aws.amazon.com/https://developer.mozilla.org/en-US/docs/Web/HTTP/CORS) settings for your function URL.
default java.lang.String	getInvokeMode() `AWS::Lambda::Url.InvokeMode`.
default java.lang.String	getQualifier() The alias name.
java.lang.String	getTargetFunctionArn() The name of the Lambda function.

Method Detail

getAuthType

java.lang.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 .

getTargetFunctionArn

java.lang.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.

getCors

default java.lang.Object getCors()

The [Cross-Origin Resource Sharing (CORS)](https://docs.aws.amazon.com/https://developer.mozilla.org/en-US/docs/Web/HTTP/CORS) settings for your function URL.

getInvokeMode

default java.lang.String getInvokeMode()

`AWS::Lambda::Url.InvokeMode`.

getQualifier

default java.lang.String getQualifier()

The alias name.

builder

static CfnUrlProps.Builder builder()

Returns:

a CfnUrlProps.Builder of CfnUrlProps