software.amazon.awscdk.services.lambda

Class FunctionBase

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.core.Construct

software.amazon.awscdk.core.Resource

software.amazon.awscdk.services.lambda.FunctionBase

All Implemented Interfaces:

IDependable, IResource, IConnectable, IGrantable, IFunction, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct

Direct Known Subclasses:

Function, QualifiedFunctionBase, SingletonFunction

@Generated(value="jsii-pacmak/1.24.0 (build b722f66)",
           date="2021-03-11T13:46:44.564Z")
 @Stability(value=Stable)
public abstract class FunctionBase
extends Resource
implements IFunction

Nested Class Summary

Nested classes/interfaces inherited from class software.constructs.Construct

software.constructs.Construct.Builder

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

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

IFunction.Jsii$Default

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
void	addEventSource(IEventSource source) Adds an event source to this function.
EventSourceMapping	addEventSourceMapping(String id, EventSourceMappingOptions options) Adds an event source that maps to this AWS Lambda function.
void	addPermission(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.
protected abstract Boolean	getCanCreatePermissions() Whether the addPermission() call adds any permissions.
Connections	getConnections() Access the Connections object.
abstract String	getFunctionArn() The ARN fo the function.
abstract String	getFunctionName() The name of the function.
abstract IPrincipal	getGrantPrincipal() The principal this Lambda Function is running as.
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 IRole	getRole() The IAM role associated with this function.
Grant	grantInvoke(IGrantable grantee) Grant the given identity permissions to invoke this Lambda.
Metric	metric(String metricName) Return the given named metric for this Function.
Metric	metric(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.

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 software.constructs.Construct

toString

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

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

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

getEnv, getStack

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

getNode

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Constructor Detail

FunctionBase

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

FunctionBase

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

FunctionBase

@Stability(value=Stable)
protected FunctionBase(@NotNull
                                                software.constructs.Construct scope,
                                                @NotNull
                                                String id,
                                                @Nullable
                                                ResourceProps props)

Parameters:

scope - This parameter is required.

id - This parameter is required.

props -

FunctionBase

@Stability(value=Stable)
protected FunctionBase(@NotNull
                                                software.constructs.Construct scope,
                                                @NotNull
                                                String id)

Parameters:

scope - This parameter is required.

id - This parameter is required.

Method Detail

addEventSource

@Stability(value=Stable)
public void addEventSource(@NotNull
                                                    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

@Stability(value=Stable)
 @NotNull
public EventSourceMapping addEventSourceMapping(@NotNull
                                                                                   String id,
                                                                                   @NotNull
                                                                                   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.

addPermission

@Stability(value=Stable)
public void addPermission(@NotNull
                                                   String id,
                                                   @NotNull
                                                   Permission permission)

Adds a permission to the Lambda resource policy.

Specified by:

addPermission in interface IFunction

Parameters:

id - The id ƒor the permission construct. This parameter is required.

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

See Also:

for details.

addToRolePolicy

@Stability(value=Stable)
public void addToRolePolicy(@NotNull
                                                     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

@Stability(value=Stable)
public void configureAsyncInvoke(@NotNull
                                                          EventInvokeConfigOptions options)

Configures options for asynchronous invocation.

Specified by:

configureAsyncInvoke in interface IFunction

Parameters:

options - This parameter is required.

grantInvoke

@Stability(value=Stable)
 @NotNull
public Grant grantInvoke(@NotNull
                                                            IGrantable grantee)

Grant the given identity permissions to invoke this Lambda.

Specified by:

grantInvoke in interface IFunction

Parameters:

grantee - This parameter is required.

metric

@Stability(value=Stable)
 @NotNull
public Metric metric(@NotNull
                                                        String metricName,
                                                        @Nullable
                                                        MetricOptions props)

Return the given named metric for this Function.

Specified by:

metric in interface IFunction

Parameters:

metricName - This parameter is required.

props -

metric

@Stability(value=Stable)
 @NotNull
public Metric metric(@NotNull
                                                        String metricName)

Return the given named metric for this Function.

Specified by:

metric in interface IFunction

Parameters:

metricName - This parameter is required.

metricDuration

@Stability(value=Stable)
 @NotNull
public Metric metricDuration(@Nullable
                                                                MetricOptions props)

How long execution of this Lambda takes.

Average over 5 minutes

Specified by:

metricDuration in interface IFunction

Parameters:

props -

metricDuration

@Stability(value=Stable)
 @NotNull
public Metric metricDuration()

How long execution of this Lambda takes.

Average over 5 minutes

Specified by:

metricDuration in interface IFunction

metricErrors

@Stability(value=Stable)
 @NotNull
public Metric metricErrors(@Nullable
                                                              MetricOptions props)

How many invocations of this Lambda fail.

Sum over 5 minutes

Specified by:

metricErrors in interface IFunction

Parameters:

props -

metricErrors

@Stability(value=Stable)
 @NotNull
public Metric metricErrors()

How many invocations of this Lambda fail.

Sum over 5 minutes

Specified by:

metricErrors in interface IFunction

metricInvocations

@Stability(value=Stable)
 @NotNull
public Metric metricInvocations(@Nullable
                                                                   MetricOptions props)

How often this Lambda is invoked.

Sum over 5 minutes

Specified by:

metricInvocations in interface IFunction

Parameters:

props -

metricInvocations

@Stability(value=Stable)
 @NotNull
public Metric metricInvocations()

How often this Lambda is invoked.

Sum over 5 minutes

Specified by:

metricInvocations in interface IFunction

metricThrottles

@Stability(value=Stable)
 @NotNull
public Metric metricThrottles(@Nullable
                                                                 MetricOptions props)

How often this Lambda is throttled.

Sum over 5 minutes

Specified by:

metricThrottles in interface IFunction

Parameters:

props -

metricThrottles

@Stability(value=Stable)
 @NotNull
public Metric metricThrottles()

How often this Lambda is throttled.

Sum over 5 minutes

Specified by:

metricThrottles in interface IFunction

getCanCreatePermissions

@Stability(value=Stable)
 @NotNull
protected abstract Boolean getCanCreatePermissions()

Whether the addPermission() call adds any permissions.

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

getConnections

@Stability(value=Stable)
 @NotNull
public Connections getConnections()

Access the Connections object.

Will fail if not a VPC-enabled Lambda Function

Specified by:

getConnections in interface IConnectable

getFunctionArn

@Stability(value=Stable)
 @NotNull
public abstract String getFunctionArn()

The ARN fo the function.

Specified by:

getFunctionArn in interface IFunction

getFunctionName

@Stability(value=Stable)
 @NotNull
public abstract String getFunctionName()

The name of the function.

Specified by:

getFunctionName in interface IFunction

getGrantPrincipal

@Stability(value=Stable)
 @NotNull
public abstract IPrincipal getGrantPrincipal()

The principal this Lambda Function is running as.

Specified by:

getGrantPrincipal in interface IGrantable

getIsBoundToVpc

@Stability(value=Stable)
 @NotNull
public 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

@Stability(value=Stable)
 @NotNull
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

@Stability(value=Stable)
 @NotNull
public abstract ConstructNode getPermissionsNode()

The construct node where permissions are attached.

Specified by:

getPermissionsNode in interface IFunction

getRole

@Stability(value=Stable)
 @Nullable
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