software.amazon.awscdk.services.lambda

Class CfnUrl

java.lang.Object

software.constructs.Construct

software.amazon.awscdk.core.Construct

software.amazon.awscdk.core.CfnElement

software.amazon.awscdk.core.CfnRefElement

software.amazon.awscdk.core.CfnResource

software.amazon.awscdk.services.lambda.CfnUrl

All Implemented Interfaces:

IConstruct, IDependable, IInspectable

@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)",
           date="2023-03-14T16:25:29.727Z")
public class CfnUrl
extends CfnResource
implements IInspectable

A CloudFormation `AWS::Lambda::Url`.

The AWS::Lambda::Url resource creates a function URL with the specified configuration parameters. A function URL is a dedicated HTTP(S) endpoint that you can use to invoke your function.

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.*;
 CfnUrl cfnUrl = CfnUrl.Builder.create(this, "MyCfnUrl")
         .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	Class and Description
static class	CfnUrl.Builder A fluent builder for CfnUrl.
static interface	CfnUrl.CorsProperty 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.

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IConstruct

IConstruct.Jsii$Default

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CFN_RESOURCE_TYPE_NAME The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors

Modifier	Constructor and Description
	CfnUrl(Construct scope, java.lang.String id, CfnUrlProps props) Create a new `AWS::Lambda::Url`.
protected	CfnUrl(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnUrl(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
java.lang.String	getAttrFunctionArn() The Amazon Resource Name (ARN) of the function.
java.lang.String	getAttrFunctionUrl() The HTTP URL endpoint for your function.
java.lang.String	getAuthType() The type of authentication that your function URL uses.
protected java.util.Map<java.lang.String,java.lang.Object>	getCfnProperties()
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.
java.lang.String	getInvokeMode() `AWS::Lambda::Url.InvokeMode`.
java.lang.String	getQualifier() The alias name.
java.lang.String	getTargetFunctionArn() The name of the Lambda function.
void	inspect(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.
protected java.util.Map<java.lang.String,java.lang.Object>	renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)
void	setAuthType(java.lang.String value) The type of authentication that your function URL uses.
void	setCors(CfnUrl.CorsProperty value) 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.
void	setCors(IResolvable value) 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.
void	setInvokeMode(java.lang.String value) `AWS::Lambda::Url.InvokeMode`.
void	setQualifier(java.lang.String value) The alias name.
void	setTargetFunctionArn(java.lang.String value) The name of the Lambda function.

Methods inherited from class software.amazon.awscdk.core.CfnResource

addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, isCfnResource, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.core.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.core.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.amazon.awscdk.core.Construct

getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

CFN_RESOURCE_TYPE_NAME

public static final java.lang.String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Detail

CfnUrl

protected CfnUrl(software.amazon.jsii.JsiiObjectRef objRef)

CfnUrl

protected CfnUrl(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

CfnUrl

public CfnUrl(Construct scope,
              java.lang.String id,
              CfnUrlProps props)

Create a new `AWS::Lambda::Url`.

Parameters:

scope - - scope in which this resource is defined. This parameter is required.

id - - scoped id of the resource. This parameter is required.

props - - resource properties. This parameter is required.

Method Detail

inspect

public void inspect(TreeInspector inspector)

Examines the CloudFormation resource and discloses attributes.

Specified by:

inspect in interface IInspectable

Parameters:

inspector - - tree inspector to collect and process attributes. This parameter is required.

renderProperties

protected java.util.Map<java.lang.String,java.lang.Object> renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getAttrFunctionArn

public java.lang.String getAttrFunctionArn()

The Amazon Resource Name (ARN) of the function.

getAttrFunctionUrl

public java.lang.String getAttrFunctionUrl()

The HTTP URL endpoint for your function.

getCfnProperties

protected java.util.Map<java.lang.String,java.lang.Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getAuthType

public 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 .

setAuthType

public void setAuthType(java.lang.String value)

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

public 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.

setTargetFunctionArn

public void setTargetFunctionArn(java.lang.String value)

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

public 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.

setCors

public void setCors(IResolvable value)

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.

setCors

public void setCors(CfnUrl.CorsProperty value)

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

public java.lang.String getInvokeMode()

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

setInvokeMode

public void setInvokeMode(java.lang.String value)

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

getQualifier

public java.lang.String getQualifier()

The alias name.

setQualifier

public void setQualifier(java.lang.String value)

The alias name.