Package software.amazon.awscdk.services.lambda

Interface IAlias.Jsii$Default

All Superinterfaces:

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

All Known Implementing Classes:

IAlias.Jsii$Proxy

Enclosing interface:

IAlias

@Internal
public static interface IAlias.Jsii$Default
extends IAlias, IAliasRef.Jsii$Default, IFunction.Jsii$Default

Internal default implementation for IAlias.

Nested Class Summary

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

IAlias.Jsii$Default, IAlias.Jsii$Proxy

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

IAliasRef.Jsii$Default, IAliasRef.Jsii$Proxy

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

IConnectable.Jsii$Default, IConnectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default, software.constructs.IConstruct.Jsii$Proxy

Nested classes/interfaces inherited from interface software.constructs.IDependable

software.constructs.IDependable.Jsii$Default, software.constructs.IDependable.Jsii$Proxy

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

IFunction.Jsii$Default, IFunction.Jsii$Proxy

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

IFunctionRef.Jsii$Default, IFunctionRef.Jsii$Proxy

Nested classes/interfaces inherited from interface software.amazon.awscdk.services.iam.IGrantable

IGrantable.Jsii$Default, IGrantable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.amazon.awscdk.IResource

IResource.Jsii$Default, IResource.Jsii$Proxy

Method Summary

Modifier and Type	Method	Description
default void	addEventSource(IEventSource source)	Adds an event source to this function.
default EventSourceMapping	addEventSourceMapping(String id, EventSourceMappingOptions options)	Adds an event source that maps to this AWS Lambda function.
default FunctionUrl	addFunctionUrl(FunctionUrlOptions options)	Adds a url to this lambda function.
default void	addPermission(String id, Permission permission)	Adds a permission to the Lambda resource policy.
default void	addToRolePolicy(PolicyStatement statement)	Adds a statement to the IAM role assumed by the instance.
default void	applyRemovalPolicy(RemovalPolicy policy)	Apply the given removal policy to this resource.
default void	configureAsyncInvoke(EventInvokeConfigOptions options)	Configures options for asynchronous invocation.
default String	getAliasName()	Name of this alias.
default AliasReference	getAliasRef()	(experimental) A reference to a Alias resource.
default Architecture	getArchitecture()	The system architectures compatible with this lambda function.
default Connections	getConnections()	The network connections associated with this resource.
default ResourceEnvironment	getEnv()	The environment this resource belongs to.
default String	getFunctionArn()	The ARN of the function.
default String	getFunctionName()	The name of the function.
default FunctionReference	getFunctionRef()	(experimental) A reference to a Function resource.
default IPrincipal	getGrantPrincipal()	The principal to grant permissions to.
default Boolean	getIsBoundToVpc()	Whether or not this Lambda function was bound to a VPC.
default IVersion	getLatestVersion()	The $LATEST version of this function.
default software.constructs.Node	getNode()	The tree node.
default software.constructs.Node	getPermissionsNode()	The construct node where permissions are attached.
default List<String>	getResourceArnsForGrantInvoke()	The ARN(s) to put into the resource field of the generated IAM policy for grantInvoke().
default IRole	getRole()	The IAM role associated with this function.
default Stack	getStack()	The stack in which this resource is defined.
default IVersion	getVersion()	The underlying Lambda function version.
default Grant	grantInvoke(IGrantable identity)	Grant the given identity permissions to invoke this Lambda.
default List<Grant>	grantInvokeCompositePrincipal(CompositePrincipal compositePrincipal)	Grant multiple principals the ability to invoke this Lambda via CompositePrincipal.
default Grant	grantInvokeLatestVersion(IGrantable identity)	Grant the given identity permissions to invoke the $LATEST version or unqualified version of this Lambda.
default Grant	grantInvokeUrl(IGrantable identity)	Grant the given identity permissions to invoke this Lambda Function URL.
default Grant	grantInvokeVersion(IGrantable identity, IVersion version)	Grant the given identity permissions to invoke the given version of this Lambda.
default Metric	metric(String metricName, MetricOptions props)	Return the given named metric for this Lambda Return the given named metric for this Function.
default Metric	metricDuration(MetricOptions props)	Metric for the Duration of this Lambda How long execution of this Lambda takes.
default Metric	metricErrors(MetricOptions props)	How many invocations of this Lambda fail.
default Metric	metricInvocations(MetricOptions props)	Metric for the number of invocations of this Lambda How often this Lambda is invoked.
default Metric	metricThrottles(MetricOptions props)	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

addFunctionUrl, metric, metricDuration, metricErrors, metricInvocations, metricThrottles

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getNode

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

The tree node.

Specified by:

getNode in interface IAlias

Specified by:

getNode in interface IAliasRef.Jsii$Default

Specified by:

getNode in interface software.constructs.IConstruct

Specified by:

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

Specified by:

getNode in interface IFunction

Specified by:

getNode in interface IFunction.Jsii$Default

Specified by:

getNode in interface IFunctionRef.Jsii$Default

Specified by:

getNode in interface IResource.Jsii$Default

getEnv

@Stability(Stable)
@NotNull
default ResourceEnvironment getEnv()

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 IFunction.Jsii$Default

Specified by:

getEnv in interface IResource

Specified by:

getEnv in interface IResource.Jsii$Default

getStack

@Stability(Stable)
@NotNull
default Stack getStack()

The stack in which this resource is defined.

Specified by:

getStack in interface IFunction.Jsii$Default

Specified by:

getStack in interface IResource

Specified by:

getStack in interface IResource.Jsii$Default

getConnections

@Stability(Stable)
@NotNull
default Connections getConnections()

The network connections associated with this resource.

Specified by:

getConnections in interface IConnectable

Specified by:

getConnections in interface IConnectable.Jsii$Default

Specified by:

getConnections in interface IFunction.Jsii$Default

getGrantPrincipal

@Stability(Stable)
@NotNull
default IPrincipal getGrantPrincipal()

The principal to grant permissions to.

Specified by:

getGrantPrincipal in interface IFunction.Jsii$Default

Specified by:

getGrantPrincipal in interface IGrantable

Specified by:

getGrantPrincipal in interface IGrantable.Jsii$Default

getFunctionRef

@Stability(Experimental)
@NotNull
default FunctionReference getFunctionRef()

(experimental) A reference to a Function resource.

Specified by:

getFunctionRef in interface IFunction.Jsii$Default

Specified by:

getFunctionRef in interface IFunctionRef

Specified by:

getFunctionRef in interface IFunctionRef.Jsii$Default

getArchitecture

@Stability(Stable)
@NotNull
default Architecture getArchitecture()

The system architectures compatible with this lambda function.

Specified by:

getArchitecture in interface IFunction

Specified by:

getArchitecture in interface IFunction.Jsii$Default

getFunctionArn

@Stability(Stable)
@NotNull
default String getFunctionArn()

The ARN of the function.

Specified by:

getFunctionArn in interface IFunction

Specified by:

getFunctionArn in interface IFunction.Jsii$Default

getFunctionName

@Stability(Stable)
@NotNull
default String getFunctionName()

The name of the function.

Specified by:

getFunctionName in interface IFunction

Specified by:

getFunctionName in interface IFunction.Jsii$Default

getIsBoundToVpc

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

Specified by:

getIsBoundToVpc in interface IFunction.Jsii$Default

getLatestVersion

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

Specified by:

getLatestVersion in interface IFunction.Jsii$Default

getPermissionsNode

@Stability(Stable)
@NotNull
default software.constructs.Node getPermissionsNode()

The construct node where permissions are attached.

Specified by:

getPermissionsNode in interface IFunction

Specified by:

getPermissionsNode in interface IFunction.Jsii$Default

getResourceArnsForGrantInvoke

@Stability(Stable)
@NotNull
default List<String> getResourceArnsForGrantInvoke()

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

This property is for cdk modules to consume only. You should not need to use this property. Instead, use grantInvoke() directly.

Specified by:

getResourceArnsForGrantInvoke in interface IFunction

Specified by:

getResourceArnsForGrantInvoke in interface IFunction.Jsii$Default

getRole

@Stability(Stable)
@Nullable
default IRole getRole()

The IAM role associated with this function.

Specified by:

getRole in interface IFunction

Specified by:

getRole in interface IFunction.Jsii$Default

getAliasRef

@Stability(Experimental)
@NotNull
default AliasReference getAliasRef()

(experimental) A reference to a Alias resource.

Specified by:

getAliasRef in interface IAliasRef

Specified by:

getAliasRef in interface IAliasRef.Jsii$Default

getAliasName

@Stability(Stable)
@NotNull
default String getAliasName()

Name of this alias.

Specified by:

getAliasName in interface IAlias

getVersion

@Stability(Stable)
@NotNull
default IVersion getVersion()

The underlying Lambda function version.

Specified by:

getVersion in interface IAlias

applyRemovalPolicy

@Stability(Stable)
default void applyRemovalPolicy(@NotNull
 RemovalPolicy policy)

Apply the given removal policy to this resource.

The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you've removed it from the CDK application or because you've made a change that requires the resource to be replaced.

The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN).

Specified by:

applyRemovalPolicy in interface IFunction.Jsii$Default

Specified by:

applyRemovalPolicy in interface IResource

Specified by:

applyRemovalPolicy in interface IResource.Jsii$Default

Parameters:

policy - This parameter is required.

addEventSource

@Stability(Stable)
default void addEventSource(@NotNull
 IEventSource source)

Adds an event source to this function.

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

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

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

Specified by:

addEventSource in interface IFunction

Specified by:

addEventSource in interface IFunction.Jsii$Default

Parameters:

source - This parameter is required.

addEventSourceMapping

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

Specified by:

addEventSourceMapping in interface IFunction.Jsii$Default

Parameters:

id - construct ID. This parameter is required.

options - mapping options. This parameter is required.

addFunctionUrl

@Stability(Stable)
@NotNull
default FunctionUrl addFunctionUrl(@Nullable
 FunctionUrlOptions options)

Adds a url to this lambda function.

Specified by:

addFunctionUrl in interface IFunction

Specified by:

addFunctionUrl in interface IFunction.Jsii$Default

Parameters:

options -

addPermission

@Stability(Stable)
default void addPermission(@NotNull
 String id,
 @NotNull
 Permission permission)

Adds a permission to the Lambda resource policy.

Specified by:

addPermission in interface IFunction

Specified by:

addPermission in interface IFunction.Jsii$Default

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

@Stability(Stable)
default void addToRolePolicy(@NotNull
 PolicyStatement statement)

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

Specified by:

addToRolePolicy in interface IFunction

Specified by:

addToRolePolicy in interface IFunction.Jsii$Default

Parameters:

statement - This parameter is required.

configureAsyncInvoke

@Stability(Stable)
default void configureAsyncInvoke(@NotNull
 EventInvokeConfigOptions options)

Configures options for asynchronous invocation.

Specified by:

configureAsyncInvoke in interface IFunction

Specified by:

configureAsyncInvoke in interface IFunction.Jsii$Default

Parameters:

options - This parameter is required.

grantInvoke

@Stability(Stable)
@NotNull
default Grant grantInvoke(@NotNull
 IGrantable identity)

Grant the given identity permissions to invoke this Lambda.

Specified by:

grantInvoke in interface IFunction

Specified by:

grantInvoke in interface IFunction.Jsii$Default

Parameters:

identity - This parameter is required.

grantInvokeCompositePrincipal

@Stability(Stable)
@NotNull
default List<Grant> grantInvokeCompositePrincipal(@NotNull
 CompositePrincipal compositePrincipal)

Grant multiple principals the ability to invoke this Lambda via CompositePrincipal.

Specified by:

grantInvokeCompositePrincipal in interface IFunction

Specified by:

grantInvokeCompositePrincipal in interface IFunction.Jsii$Default

Parameters:

compositePrincipal - This parameter is required.

grantInvokeLatestVersion

@Stability(Stable)
@NotNull
default Grant grantInvokeLatestVersion(@NotNull
 IGrantable identity)

Grant the given identity permissions to invoke the $LATEST version or unqualified version of this Lambda.

Specified by:

grantInvokeLatestVersion in interface IFunction

Specified by:

grantInvokeLatestVersion in interface IFunction.Jsii$Default

Parameters:

identity - This parameter is required.

grantInvokeUrl

@Stability(Stable)
@NotNull
default Grant grantInvokeUrl(@NotNull
 IGrantable identity)

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

Specified by:

grantInvokeUrl in interface IFunction

Specified by:

grantInvokeUrl in interface IFunction.Jsii$Default

Parameters:

identity - This parameter is required.

grantInvokeVersion

@Stability(Stable)
@NotNull
default Grant grantInvokeVersion(@NotNull
 IGrantable identity,
 @NotNull
 IVersion version)

Grant the given identity permissions to invoke the given version of this Lambda.

Specified by:

grantInvokeVersion in interface IFunction

Specified by:

grantInvokeVersion in interface IFunction.Jsii$Default

Parameters:

identity - This parameter is required.

version - This parameter is required.

metric

@Stability(Stable)
@NotNull
default Metric metric(@NotNull
 String metricName,
 @Nullable
 MetricOptions props)

Return the given named metric for this Lambda Return the given named metric for this Function.

Specified by:

metric in interface IFunction

Specified by:

metric in interface IFunction.Jsii$Default

Parameters:

metricName - This parameter is required.

props -

metricDuration

@Stability(Stable)
@NotNull
default Metric metricDuration(@Nullable
 MetricOptions props)

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

Specified by:

metricDuration in interface IFunction.Jsii$Default

Parameters:

props -

metricErrors

@Stability(Stable)
@NotNull
default Metric metricErrors(@Nullable
 MetricOptions props)

How many invocations of this Lambda fail.

Sum over 5 minutes

Specified by:

metricErrors in interface IFunction

Specified by:

metricErrors in interface IFunction.Jsii$Default

Parameters:

props -

metricInvocations

@Stability(Stable)
@NotNull
default Metric metricInvocations(@Nullable
 MetricOptions props)

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

Specified by:

metricInvocations in interface IFunction.Jsii$Default

Parameters:

props -

metricThrottles

@Stability(Stable)
@NotNull
default Metric metricThrottles(@Nullable
 MetricOptions props)

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

Specified by:

metricThrottles in interface IFunction.Jsii$Default

Parameters:

props -