software.amazon.awscdk.services.lambda

Interface IFunction.Jsii$Default

All Superinterfaces:

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

All Known Subinterfaces:

IAlias.Jsii$Default, IVersion.Jsii$Default

All Known Implementing Classes:

IAlias.Jsii$Proxy, IFunction.Jsii$Proxy, IVersion.Jsii$Proxy

Enclosing interface:

IFunction

@Internal
public static interface IFunction.Jsii$Default
extends IFunction, IResource.Jsii$Default, IConnectable.Jsii$Default, IGrantable.Jsii$Default

Internal default implementation for IFunction.

Nested Class Summary

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

IFunction.Jsii$Default, IFunction.Jsii$Proxy

Method Summary

Modifier and Type	Method and Description
default void	addEventSource(IEventSource source) (experimental) Adds an event source to this function.
default EventSourceMapping	addEventSourceMapping(String id, EventSourceMappingOptions options) (experimental) Adds an event source that maps to this AWS Lambda function.
default void	addPermission(String id, Permission permission) (experimental) Adds a permission to the Lambda resource policy.
default void	addToRolePolicy(PolicyStatement statement) (experimental) Adds a statement to the IAM role assumed by the instance.
default void	configureAsyncInvoke(EventInvokeConfigOptions options) (experimental) Configures options for asynchronous invocation.
default Connections	getConnections()
default ResourceEnvironment	getEnv() (experimental) The environment this resource belongs to.
default String	getFunctionArn() (experimental) The ARN fo the function.
default String	getFunctionName() (experimental) The name of the function.
default IPrincipal	getGrantPrincipal() (experimental) The principal to grant permissions to.
default Boolean	getIsBoundToVpc() (experimental) Whether or not this Lambda function was bound to a VPC.
default IVersion	getLatestVersion() (experimental) The `$LATEST` version of this function.
default software.constructs.Node	getNode() The tree node.
default software.constructs.Node	getPermissionsNode() (experimental) The construct node where permissions are attached.
default IRole	getRole() (experimental) The IAM role associated with this function.
default Stack	getStack() (experimental) The stack in which this resource is defined.
default Grant	grantInvoke(IGrantable identity) (experimental) Grant the given identity permissions to invoke this Lambda.
default Metric	metric(String metricName, MetricOptions props) (experimental) Return the given named metric for this Lambda Return the given named metric for this Function.
default Metric	metricDuration(MetricOptions props) (experimental) Metric for the Duration of this Lambda How long execution of this Lambda takes.
default Metric	metricErrors(MetricOptions props) (experimental) How many invocations of this Lambda fail.
default Metric	metricInvocations(MetricOptions props) (experimental) Metric for the number of invocations of this Lambda How often this Lambda is invoked.
default Metric	metricThrottles(MetricOptions props) (experimental) Metric for the number of throttled invocations of this Lambda How often this Lambda is throttled.

Methods inherited from interface software.amazon.awscdk.services.lambda.IFunction

metric, metricDuration, metricErrors, metricInvocations, metricThrottles

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getNode

@Stability(value=Stable)
 @NotNull
default software.constructs.Node getNode()

The tree node.

Specified by:

getNode in interface software.constructs.IConstruct

Specified by:

getNode in interface software.constructs.IConstruct.Jsii$Default

Specified by:

getNode in interface IResource.Jsii$Default

getEnv

@Stability(value=Experimental)
 @NotNull
default ResourceEnvironment getEnv()

(experimental) The environment this resource belongs to.

For resources that are created and managed by the CDK (generally, those created by creating new class instances like Role, Bucket, etc.), this is always the same as the environment of the stack they belong to; however, for imported resources (those obtained from static methods like fromRoleArn, fromBucketName, etc.), that might be different than the stack they were imported into.

Specified by:

getEnv in interface IResource

Specified by:

getEnv in interface IResource.Jsii$Default

getStack

@Stability(value=Experimental)
 @NotNull
default Stack getStack()

(experimental) The stack in which this resource is defined.

Specified by:

getStack in interface IResource

Specified by:

getStack in interface IResource.Jsii$Default

getConnections

@Stability(value=Experimental)
 @NotNull
default Connections getConnections()

Specified by:

getConnections in interface IConnectable

Specified by:

getConnections in interface IConnectable.Jsii$Default

getGrantPrincipal

@Stability(value=Experimental)
 @NotNull
default IPrincipal getGrantPrincipal()

(experimental) The principal to grant permissions to.

Specified by:

getGrantPrincipal in interface IGrantable

Specified by:

getGrantPrincipal in interface IGrantable.Jsii$Default

getFunctionArn

@Stability(value=Experimental)
 @NotNull
default String getFunctionArn()

(experimental) The ARN fo the function.

Specified by:

getFunctionArn in interface IFunction

getFunctionName

@Stability(value=Experimental)
 @NotNull
default String getFunctionName()

(experimental) The name of the function.

Specified by:

getFunctionName in interface IFunction

getIsBoundToVpc

@Stability(value=Experimental)
 @NotNull
default Boolean getIsBoundToVpc()

(experimental) 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=Experimental)
 @NotNull
default IVersion getLatestVersion()

(experimental) 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=Experimental)
 @NotNull
default software.constructs.Node getPermissionsNode()

(experimental) The construct node where permissions are attached.

Specified by:

getPermissionsNode in interface IFunction

getRole

@Stability(value=Experimental)
 @Nullable
default IRole getRole()

(experimental) The IAM role associated with this function.

Specified by:

getRole in interface IFunction

addEventSource

@Stability(value=Experimental)
default void addEventSource(@NotNull
                                                           IEventSource source)

(experimental) 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=Experimental)
 @NotNull
default EventSourceMapping addEventSourceMapping(@NotNull
                                                                                          String id,
                                                                                          @NotNull
                                                                                          EventSourceMappingOptions options)

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

Specified by:

addEventSourceMapping in interface IFunction

Parameters:

id - construct ID. This parameter is required.

options - mapping options. This parameter is required.

addPermission

@Stability(value=Experimental)
default void addPermission(@NotNull
                                                          String id,
                                                          @NotNull
                                                          Permission permission)

(experimental) 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:

for details.

addToRolePolicy

@Stability(value=Experimental)
default void addToRolePolicy(@NotNull
                                                            PolicyStatement statement)

(experimental) 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=Experimental)
default void configureAsyncInvoke(@NotNull
                                                                 EventInvokeConfigOptions options)

(experimental) Configures options for asynchronous invocation.

Specified by:

configureAsyncInvoke in interface IFunction

Parameters:

options - This parameter is required.

grantInvoke

@Stability(value=Experimental)
 @NotNull
default Grant grantInvoke(@NotNull
                                                                   IGrantable identity)

(experimental) Grant the given identity permissions to invoke this Lambda.

Specified by:

grantInvoke in interface IFunction

Parameters:

identity - This parameter is required.

metric

@Stability(value=Experimental)
 @NotNull
default Metric metric(@NotNull
                                                               String metricName,
                                                               @Nullable
                                                               MetricOptions props)

(experimental) Return the given named metric for this Lambda Return the given named metric for this Function.

Specified by:

metric in interface IFunction

Parameters:

metricName - This parameter is required.

props -

metricDuration

@Stability(value=Experimental)
 @NotNull
default Metric metricDuration(@Nullable
                                                                       MetricOptions props)

(experimental) Metric for the Duration of this Lambda How long execution of this Lambda takes.

Average over 5 minutes

Default: average over 5 minutes

Specified by:

metricDuration in interface IFunction

Parameters:

props -

metricErrors

@Stability(value=Experimental)
 @NotNull
default Metric metricErrors(@Nullable
                                                                     MetricOptions props)

(experimental) How many invocations of this Lambda fail.

Sum over 5 minutes

Specified by:

metricErrors in interface IFunction

Parameters:

props -

metricInvocations

@Stability(value=Experimental)
 @NotNull
default Metric metricInvocations(@Nullable
                                                                          MetricOptions props)

(experimental) Metric for the number of invocations of this Lambda How often this Lambda is invoked.

Sum over 5 minutes

Default: sum over 5 minutes

Specified by:

metricInvocations in interface IFunction

Parameters:

props -

metricThrottles

@Stability(value=Experimental)
 @NotNull
default Metric metricThrottles(@Nullable
                                                                        MetricOptions props)

(experimental) Metric for the number of throttled invocations of this Lambda How often this Lambda is throttled.

Sum over 5 minutes

Default: sum over 5 minutes

Specified by:

metricThrottles in interface IFunction

Parameters:

props -