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.lambda.IFunction

IFunction.Jsii$Default, IFunction.Jsii$Proxy

Constructor Summary

Constructors

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

Method Summary

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

Jsii$Proxy

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

Method Detail

getNode

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

The tree node.

Specified by:

getNode in interface IResource.Jsii$Default

Specified by:

getNode in interface IFunction.Jsii$Default

Specified by:

getNode in interface software.constructs.IConstruct

Specified by:

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

getEnv

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

Specified by:

getEnv in interface IFunction.Jsii$Default

getStack

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

Specified by:

getStack in interface IFunction.Jsii$Default

getConnections

@Stability(value=Experimental)
 @NotNull
public final Connections getConnections()

Specified by:

getConnections in interface IConnectable

Specified by:

getConnections in interface IConnectable.Jsii$Default

Specified by:

getConnections in interface IFunction.Jsii$Default

getGrantPrincipal

@Stability(value=Experimental)
 @NotNull
public final IPrincipal getGrantPrincipal()

(experimental) The principal to grant permissions to.

Specified by:

getGrantPrincipal in interface IGrantable

Specified by:

getGrantPrincipal in interface IGrantable.Jsii$Default

Specified by:

getGrantPrincipal in interface IFunction.Jsii$Default

getFunctionArn

@Stability(value=Experimental)
 @NotNull
public final String getFunctionArn()

(experimental) The ARN fo the function.

Specified by:

getFunctionArn in interface IFunction

Specified by:

getFunctionArn in interface IFunction.Jsii$Default

getFunctionName

@Stability(value=Experimental)
 @NotNull
public final String getFunctionName()

(experimental) The name of the function.

Specified by:

getFunctionName in interface IFunction

Specified by:

getFunctionName in interface IFunction.Jsii$Default

getIsBoundToVpc

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

Specified by:

getIsBoundToVpc in interface IFunction.Jsii$Default

getLatestVersion

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

Specified by:

getLatestVersion in interface IFunction.Jsii$Default

getPermissionsNode

@Stability(value=Experimental)
 @NotNull
public final software.constructs.Node getPermissionsNode()

(experimental) The construct node where permissions are attached.

Specified by:

getPermissionsNode in interface IFunction

Specified by:

getPermissionsNode in interface IFunction.Jsii$Default

getRole

@Stability(value=Experimental)
 @Nullable
public final IRole getRole()

(experimental) The IAM role associated with this function.

Specified by:

getRole in interface IFunction

Specified by:

getRole in interface IFunction.Jsii$Default

addEventSource

@Stability(value=Experimental)
public final 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

Specified by:

addEventSource in interface IFunction.Jsii$Default

Parameters:

source - This parameter is required.

addEventSourceMapping

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

Specified by:

addEventSourceMapping in interface IFunction.Jsii$Default

Parameters:

id - construct ID. This parameter is required.

options - mapping options. This parameter is required.

addPermission

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

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

for details.

addToRolePolicy

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

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

(experimental) 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(value=Experimental)
 @NotNull
public final Grant grantInvoke(@NotNull
                                                                        IGrantable identity)

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

metric

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

Specified by:

metric in interface IFunction.Jsii$Default

Parameters:

metricName - This parameter is required.

props -

metric

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

(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.

metricDuration

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

Specified by:

metricDuration in interface IFunction.Jsii$Default

Parameters:

props -

metricDuration

@Stability(value=Experimental)
 @NotNull
public final Metric metricDuration()

(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

metricErrors

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

(experimental) 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(value=Experimental)
 @NotNull
public final Metric metricErrors()

(experimental) How many invocations of this Lambda fail.

Sum over 5 minutes

Specified by:

metricErrors in interface IFunction

metricInvocations

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

Specified by:

metricInvocations in interface IFunction.Jsii$Default

Parameters:

props -

metricInvocations

@Stability(value=Experimental)
 @NotNull
public final Metric metricInvocations()

(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

metricThrottles

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

Specified by:

metricThrottles in interface IFunction.Jsii$Default

Parameters:

props -

metricThrottles

@Stability(value=Experimental)
 @NotNull
public final Metric metricThrottles()

(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