software.amazon.awscdk.services.lambda

Class FunctionUrl

java.lang.Object

software.constructs.Construct

software.amazon.awscdk.core.Construct

software.amazon.awscdk.core.Resource

software.amazon.awscdk.services.lambda.FunctionUrl

All Implemented Interfaces:

IConstruct, IDependable, IResource, IFunctionUrl

@Generated(value="jsii-pacmak/1.71.0 (build f1f58ae)",
           date="2022-11-18T02:14:10.744Z")
public class FunctionUrl
extends Resource
implements IFunctionUrl

Defines a Lambda function url.

Example:

 // Can be a Function or an Alias
 Function fn;
 Role myRole;
 FunctionUrl fnUrl = fn.addFunctionUrl();
 fnUrl.grantInvokeUrl(myRole);
 CfnOutput.Builder.create(this, "TheUrl")
         // The .url attributes will return the unique Function URL
         .value(fnUrl.getUrl())
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	FunctionUrl.Builder A fluent builder for FunctionUrl.

Nested classes/interfaces inherited from interface software.amazon.awscdk.services.lambda.IFunctionUrl

IFunctionUrl.Jsii$Default, IFunctionUrl.Jsii$Proxy

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	FunctionUrl(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	FunctionUrl(software.amazon.jsii.JsiiObjectRef objRef)
	FunctionUrl(software.constructs.Construct scope, java.lang.String id, FunctionUrlProps props)

Method Summary

Modifier and Type	Method and Description
java.lang.String	getFunctionArn() The ARN of the function this URL refers to.
java.lang.String	getUrl() The url of the Lambda function.
Grant	grantInvokeUrl(IGrantable grantee) Grant the given identity permissions to invoke this Lambda Function URL.

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

applyRemovalPolicy, generatePhysicalName, getEnv, getPhysicalName, getResourceArnAttribute, getResourceNameAttribute, getStack, isResource

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, toString, wait, wait, wait

Methods inherited from interface software.amazon.awscdk.core.IResource

applyRemovalPolicy, getEnv, getStack

Methods inherited from interface software.amazon.awscdk.core.IConstruct

getNode

Constructor Detail

FunctionUrl

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

FunctionUrl

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

FunctionUrl

public FunctionUrl(software.constructs.Construct scope,
                   java.lang.String id,
                   FunctionUrlProps props)

Parameters:

scope - This parameter is required.

id - This parameter is required.

props - This parameter is required.

Method Detail

grantInvokeUrl

public Grant grantInvokeUrl(IGrantable grantee)

Grant the given identity permissions to invoke this Lambda Function URL.

Specified by:

grantInvokeUrl in interface IFunctionUrl

Parameters:

grantee - This parameter is required.

getFunctionArn

public java.lang.String getFunctionArn()

The ARN of the function this URL refers to.

Specified by:

getFunctionArn in interface IFunctionUrl

getUrl

public java.lang.String getUrl()

The url of the Lambda function.

Specified by:

getUrl in interface IFunctionUrl