Package software.amazon.awscdk.services.lambda

Class IFunction.Jsii$Proxy

java.lang.Object

software.amazon.jsii.JsiiObject

software.amazon.awscdk.services.lambda.IFunction.Jsii$Proxy

All Implemented Interfaces:

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

Enclosing interface:

IFunction

@Internal
public static final class IFunction.Jsii$Proxy
extends software.amazon.jsii.JsiiObject
implements IFunction.Jsii$Default

A proxy class which represents a concrete javascript instance of this type.

Nested Class Summary

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.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.iam.IGrantable

IGrantable.Jsii$Default, IGrantable.Jsii$Proxy

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

IResource.Jsii$Default, IResource.Jsii$Proxy

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

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

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

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Constructor Details

Jsii$Proxy

protected Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef)

Method Details

getNode

@Stability(Stable)
@NotNull
public final 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 IFunction.Jsii$Default

Specified by:

getNode in interface IResource.Jsii$Default

getEnv

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

getArchitecture

@Stability(Stable)
@NotNull
public final 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
public final 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
public final 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
public final 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
public final 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
public final 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
public final 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
public final IRole getRole()

The IAM role associated with this function.

Specified by:

getRole in interface IFunction

Specified by:

getRole in interface IFunction.Jsii$Default

applyRemovalPolicy

@Stability(Stable)
public final 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)
public final 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
public final 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
public final 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 -

addFunctionUrl

@Stability(Stable)
@NotNull
public final FunctionUrl addFunctionUrl()

Adds a url to this lambda function.

Specified by:

addFunctionUrl in interface IFunction

addPermission

@Stability(Stable)
public final 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)
public final 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)
public final 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
public final 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
public final 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
public final 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
public final 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
public final 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
public final 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 -

metric

@Stability(Stable)
@NotNull
public final Metric metric(@NotNull
 String metricName)

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.

metricDuration

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

metricDuration

@Stability(Stable)
@NotNull
public final Metric metricDuration()

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

metricErrors

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

metricErrors

@Stability(Stable)
@NotNull
public final Metric metricErrors()

How many invocations of this Lambda fail.

Sum over 5 minutes

Specified by:

metricErrors in interface IFunction

metricInvocations

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

metricInvocations

@Stability(Stable)
@NotNull
public final Metric metricInvocations()

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

metricThrottles

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

metricThrottles

@Stability(Stable)
@NotNull
public final Metric metricThrottles()

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