software.amazon.awscdk.services.lambda

Class FunctionBase

java.lang.Object

software.constructs.Construct

software.amazon.awscdk.core.Construct

software.amazon.awscdk.core.Resource

software.amazon.awscdk.services.lambda.FunctionBase

All Implemented Interfaces:

IConstruct, IDependable, IResource, IClientVpnConnectionHandler, IConnectable, IGrantable, IFunction

Direct Known Subclasses:

Function, QualifiedFunctionBase, SingletonFunction

@Generated(value="jsii-pacmak/1.63.2 (build a8a8833)",
           date="2022-08-09T19:16:38.881Z")
public abstract class FunctionBase
extends Resource
implements IFunction, IClientVpnConnectionHandler

Nested Class Summary

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

IFunction.Jsii$Default

Nested classes/interfaces inherited from interface software.amazon.awscdk.services.ec2.IClientVpnConnectionHandler

IClientVpnConnectionHandler.Jsii$Default

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
void	addEventSource(IEventSource source) Adds an event source to this function.
EventSourceMapping	addEventSourceMapping(java.lang.String id, EventSourceMappingOptions options) Adds an event source that maps to this AWS Lambda function.
FunctionUrl	addFunctionUrl() Adds a url to this lambda function.
FunctionUrl	addFunctionUrl(FunctionUrlOptions options) Adds a url to this lambda function.
void	addPermission(java.lang.String id, Permission permission) Adds a permission to the Lambda resource policy.
void	addToRolePolicy(PolicyStatement statement) Adds a statement to the IAM role assumed by the instance.
void	configureAsyncInvoke(EventInvokeConfigOptions options) Configures options for asynchronous invocation.
void	considerWarningOnInvokeFunctionPermissions(Construct scope, java.lang.String action) A warning will be added to functions under the following conditions: - permissions that include `lambda:InvokeFunction` are added to the unqualified function.
abstract Architecture	getArchitecture() The architecture of this Lambda Function.
protected abstract java.lang.Boolean	getCanCreatePermissions() Whether the addPermission() call adds any permissions.
Connections	getConnections() Access the Connections object.
abstract java.lang.String	getFunctionArn() The ARN fo the function.
abstract java.lang.String	getFunctionName() The name of the function.
abstract IPrincipal	getGrantPrincipal() The principal this Lambda Function is running as.
java.lang.Boolean	getIsBoundToVpc() Whether or not this Lambda function was bound to a VPC.
IVersion	getLatestVersion() The `$LATEST` version of this function.
abstract ConstructNode	getPermissionsNode() The construct node where permissions are attached.
abstract java.util.List<java.lang.String>	getResourceArnsForGrantInvoke() The ARN(s) to put into the resource field of the generated IAM policy for grantInvoke().
abstract IRole	getRole() The IAM role associated with this function.
Grant	grantInvoke(IGrantable grantee) Grant the given identity permissions to invoke this Lambda.
Grant	grantInvokeUrl(IGrantable grantee) Grant the given identity permissions to invoke this Lambda Function URL.
Metric	metric(java.lang.String metricName) Return the given named metric for this Function.
Metric	metric(java.lang.String metricName, MetricOptions props) Return the given named metric for this Function.
Metric	metricDuration() How long execution of this Lambda takes.
Metric	metricDuration(MetricOptions props) How long execution of this Lambda takes.
Metric	metricErrors() How many invocations of this Lambda fail.
Metric	metricErrors(MetricOptions props) How many invocations of this Lambda fail.
Metric	metricInvocations() How often this Lambda is invoked.
Metric	metricInvocations(MetricOptions props) How often this Lambda is invoked.
Metric	metricThrottles() How often this Lambda is throttled.
Metric	metricThrottles(MetricOptions props) How often this Lambda is throttled.
protected void	warnInvokeFunctionPermissions(Construct scope)

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

FunctionBase

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

FunctionBase

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

FunctionBase

protected FunctionBase(software.constructs.Construct scope,
                       java.lang.String id,
                       ResourceProps props)

Parameters:

scope - This parameter is required.

id - This parameter is required.

props -

FunctionBase

protected FunctionBase(software.constructs.Construct scope,
                       java.lang.String id)

Parameters:

scope - This parameter is required.

id - This parameter is required.

Method Detail

addEventSource

public void addEventSource(IEventSource source)

Adds an event source to this function.

Event sources are implemented in the @aws-cdk/aws-lambda-event-sources module.

The following example adds an SQS Queue as an event source:

 import { SqsEventSource } from '@aws-cdk/aws-lambda-event-sources';
 myFunction.addEventSource(new SqsEventSource(myQueue));
 

Specified by:

addEventSource in interface IFunction

Parameters:

source - This parameter is required.

addEventSourceMapping

public EventSourceMapping addEventSourceMapping(java.lang.String id,
                                                EventSourceMappingOptions options)

Adds an event source that maps to this AWS Lambda function.

Specified by:

addEventSourceMapping in interface IFunction

Parameters:

id - This parameter is required.

options - This parameter is required.

addFunctionUrl

public FunctionUrl addFunctionUrl(FunctionUrlOptions options)

Adds a url to this lambda function.

Specified by:

addFunctionUrl in interface IFunction

Parameters:

options -

addFunctionUrl

public FunctionUrl addFunctionUrl()

Adds a url to this lambda function.

Specified by:

addFunctionUrl in interface IFunction

addPermission

public void addPermission(java.lang.String id,
                          Permission permission)

Adds a permission to the Lambda resource policy.

Specified by:

addPermission in interface IFunction

Parameters:

id - The id for the permission construct. This parameter is required.

permission - The permission to grant to this Lambda function. This parameter is required.

See Also:

Permission for details.

addToRolePolicy

public void addToRolePolicy(PolicyStatement statement)

Adds a statement to the IAM role assumed by the instance.

Specified by:

addToRolePolicy in interface IFunction

Parameters:

statement - This parameter is required.

configureAsyncInvoke

public void configureAsyncInvoke(EventInvokeConfigOptions options)

Configures options for asynchronous invocation.

Specified by:

configureAsyncInvoke in interface IFunction

Parameters:

options - This parameter is required.

considerWarningOnInvokeFunctionPermissions

public void considerWarningOnInvokeFunctionPermissions(Construct scope,
                                                       java.lang.String action)

A warning will be added to functions under the following conditions: - permissions that include `lambda:InvokeFunction` are added to the unqualified function.

• function.currentVersion is invoked before or after the permission is created.

This applies only to permissions on Lambda functions, not versions or aliases. This function is overridden as a noOp for QualifiedFunctionBase.

Parameters:

scope - This parameter is required.

action - This parameter is required.

grantInvoke

public Grant grantInvoke(IGrantable grantee)

Grant the given identity permissions to invoke this Lambda.

Specified by:

grantInvoke in interface IFunction

Parameters:

grantee - This parameter is required.

grantInvokeUrl

public Grant grantInvokeUrl(IGrantable grantee)

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

Specified by:

grantInvokeUrl in interface IFunction

Parameters:

grantee - This parameter is required.

metric

public Metric metric(java.lang.String metricName,
                     MetricOptions props)

Return the given named metric for this Function.

Specified by:

metric in interface IFunction

Parameters:

metricName - This parameter is required.

props -

metric

public Metric metric(java.lang.String metricName)

Return the given named metric for this Function.

Specified by:

metric in interface IFunction

Parameters:

metricName - This parameter is required.

metricDuration

public Metric metricDuration(MetricOptions props)

How long execution of this Lambda takes.

Average over 5 minutes

Specified by:

metricDuration in interface IFunction

Parameters:

props -

metricDuration

public Metric metricDuration()

How long execution of this Lambda takes.

Average over 5 minutes

Specified by:

metricDuration in interface IFunction

metricErrors

public Metric metricErrors(MetricOptions props)

How many invocations of this Lambda fail.

Sum over 5 minutes

Specified by:

metricErrors in interface IFunction

Parameters:

props -

metricErrors

public Metric metricErrors()

How many invocations of this Lambda fail.

Sum over 5 minutes

Specified by:

metricErrors in interface IFunction

metricInvocations

public Metric metricInvocations(MetricOptions props)

How often this Lambda is invoked.

Sum over 5 minutes

Specified by:

metricInvocations in interface IFunction

Parameters:

props -

metricInvocations

public Metric metricInvocations()

How often this Lambda is invoked.

Sum over 5 minutes

Specified by:

metricInvocations in interface IFunction

metricThrottles

public Metric metricThrottles(MetricOptions props)

How often this Lambda is throttled.

Sum over 5 minutes

Specified by:

metricThrottles in interface IFunction

Parameters:

props -

metricThrottles

public Metric metricThrottles()

How often this Lambda is throttled.

Sum over 5 minutes

Specified by:

metricThrottles in interface IFunction

warnInvokeFunctionPermissions

protected void warnInvokeFunctionPermissions(Construct scope)

Parameters:

scope - This parameter is required.

getArchitecture

public abstract Architecture getArchitecture()

The architecture of this Lambda Function.

Specified by:

getArchitecture in interface IFunction

getCanCreatePermissions

protected abstract java.lang.Boolean getCanCreatePermissions()

Whether the addPermission() call adds any permissions.

True for new Lambdas, false for version $LATEST and imported Lambdas from different accounts.

getConnections

public Connections getConnections()

Access the Connections object.

Will fail if not a VPC-enabled Lambda Function

Specified by:

getConnections in interface IConnectable

getFunctionArn

public abstract java.lang.String getFunctionArn()

The ARN fo the function.

Specified by:

getFunctionArn in interface IClientVpnConnectionHandler

Specified by:

getFunctionArn in interface IFunction

getFunctionName

public abstract java.lang.String getFunctionName()

The name of the function.

Specified by:

getFunctionName in interface IClientVpnConnectionHandler

Specified by:

getFunctionName in interface IFunction

getGrantPrincipal

public abstract IPrincipal getGrantPrincipal()

The principal this Lambda Function is running as.

Specified by:

getGrantPrincipal in interface IGrantable

getIsBoundToVpc

public java.lang.Boolean getIsBoundToVpc()

Whether or not this Lambda function was bound to a VPC.

If this is is false, trying to access the connections object will fail.

Specified by:

getIsBoundToVpc in interface IFunction

getLatestVersion

public IVersion getLatestVersion()

The `$LATEST` version of this function.

Note that this is reference to a non-specific AWS Lambda version, which means the function this version refers to can return different results in different invocations.

To obtain a reference to an explicit version which references the current function configuration, use lambdaFunction.currentVersion instead.

Specified by:

getLatestVersion in interface IFunction

getPermissionsNode

public abstract ConstructNode getPermissionsNode()

The construct node where permissions are attached.

Specified by:

getPermissionsNode in interface IFunction

getResourceArnsForGrantInvoke

public abstract java.util.List<java.lang.String> getResourceArnsForGrantInvoke()

The ARN(s) to put into the resource field of the generated IAM policy for grantInvoke().

Specified by:

getResourceArnsForGrantInvoke in interface IFunction

getRole

public abstract IRole getRole()

The IAM role associated with this function.

Undefined if the function was imported without a role.

Specified by:

getRole in interface IFunction