IFunction

All Superinterfaces:

IConnectable, IConstruct, IDependable, IGrantable, IResource

All Known Subinterfaces:

IAlias, IAlias.Jsii$Default, IFunction.Jsii$Default, IVersion, IVersion.Jsii$Default

All Known Implementing Classes:

Alias, DockerImageFunction, EdgeFunction, Function, FunctionBase, GoFunction, IAlias.Jsii$Proxy, IFunction.Jsii$Proxy, IVersion.Jsii$Proxy, NodejsFunction, PythonFunction, QualifiedFunctionBase, SingletonFunction, TriggerFunction, Version
```
@Generated(value="jsii-pacmak/1.73.0 (build 6faeda3)",
           date="2023-01-31T18:36:54.578Z")
public interface IFunction
extends IResource, IConnectable, IGrantable
```

Nested Class Summary

Nested Classes
Modifier and Type	Interface and Description
`static interface`	`IFunction.Jsii$Default` Internal default implementation for `IFunction`.
`static class`	`IFunction.Jsii$Proxy` A proxy class which represents a concrete javascript instance of this type.

Method Summary

All Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method and Description
`void`	`addEventSource(IEventSource source)` Adds an event source to this function.
`EventSourceMapping`	`addEventSourceMapping(java.lang.String id, EventSourceMappingOptions options)` Adds an event source that maps to this AWS Lambda function.
`FunctionUrl`	`addFunctionUrl()` Adds a url to this lambda function.
`FunctionUrl`	`addFunctionUrl(FunctionUrlOptions options)` Adds a url to this lambda function.
`void`	`addPermission(java.lang.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.
`Architecture`	`getArchitecture()` The system architectures compatible with this lambda function.
`java.lang.String`	`getFunctionArn()` The ARN of the function.
`java.lang.String`	`getFunctionName()` The name of the function.
`java.lang.Boolean`	`getIsBoundToVpc()` Whether or not this Lambda function was bound to a VPC.
`IVersion`	`getLatestVersion()` The `$LATEST` version of this function.
`ConstructNode`	`getPermissionsNode()` The construct node where permissions are attached.
`java.util.List<java.lang.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.
`Grant`	`grantInvoke(IGrantable identity)` Grant the given identity permissions to invoke this Lambda.
`Grant`	`grantInvokeUrl(IGrantable identity)` Grant the given identity permissions to invoke this Lambda Function URL.
`Metric`	`metric(java.lang.String metricName)` Return the given named metric for this Lambda Return the given named metric for this Function.
`Metric`	`metric(java.lang.String metricName, MetricOptions props)` Return the given named metric for this Lambda Return the given named metric for this Function.
`Metric`	`metricDuration()` Metric for the Duration of this Lambda How long execution of this Lambda takes.
`Metric`	`metricDuration(MetricOptions props)` Metric for the Duration of this Lambda 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()` Metric for the number of invocations of this Lambda How often this Lambda is invoked.
`Metric`	`metricInvocations(MetricOptions props)` Metric for the number of invocations of this Lambda How often this Lambda is invoked.
`Metric`	`metricThrottles()` Metric for the number of throttled invocations of this Lambda How often this Lambda is throttled.
`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.core.IResource
applyRemovalPolicy, getEnv, getStack

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

Methods inherited from interface software.amazon.awscdk.services.ec2.IConnectable
getConnections

Methods inherited from interface software.amazon.awscdk.services.iam.IGrantable
getGrantPrincipal

- Method Detail
  - getArchitecture
```
Architecture getArchitecture()
```
    The system architectures compatible with this lambda function.
  - getFunctionArn
```
java.lang.String getFunctionArn()
```
    The ARN of the function.
  - getFunctionName
```
java.lang.String getFunctionName()
```
    The name of the function.
  - getIsBoundToVpc
```
java.lang.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.
  - getLatestVersion
```
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.
  - getPermissionsNode
```
ConstructNode getPermissionsNode()
```
    The construct node where permissions are attached.
  - getResourceArnsForGrantInvoke
```
java.util.List<java.lang.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.
  - getRole
```
default IRole getRole()
```
    The IAM role associated with this function.
  - addEventSource
```
void addEventSource(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));
    Parameters:
    
    source - This parameter is required.
  - addEventSourceMapping
```
EventSourceMapping addEventSourceMapping(java.lang.String id,
                                         EventSourceMappingOptions options)
```
    Adds an event source that maps to this AWS Lambda function.
    
    Parameters:
    
    id - construct ID. This parameter is required.
    
    options - mapping options. This parameter is required.
  - addFunctionUrl
```
FunctionUrl addFunctionUrl(FunctionUrlOptions options)
```
    Adds a url to this lambda function.
    
    Parameters:
    
    options -
  - addFunctionUrl
```
FunctionUrl addFunctionUrl()
```
    Adds a url to this lambda function.
  - addPermission
```
void addPermission(java.lang.String id,
                   Permission permission)
```
    Adds a permission to the Lambda resource policy.
    
    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
```
void addToRolePolicy(PolicyStatement statement)
```
    Adds a statement to the IAM role assumed by the instance.
    
    Parameters:
    
    statement - This parameter is required.
  - configureAsyncInvoke
```
void configureAsyncInvoke(EventInvokeConfigOptions options)
```
    Configures options for asynchronous invocation.
    
    Parameters:
    
    options - This parameter is required.
  - grantInvoke
```
Grant grantInvoke(IGrantable identity)
```
    Grant the given identity permissions to invoke this Lambda.
    
    Parameters:
    
    identity - This parameter is required.
  - grantInvokeUrl
```
Grant grantInvokeUrl(IGrantable identity)
```
    Grant the given identity permissions to invoke this Lambda Function URL.
    
    Parameters:
    
    identity - This parameter is required.
  - metric
```
Metric metric(java.lang.String metricName,
              MetricOptions props)
```
    Return the given named metric for this Lambda Return the given named metric for this Function.
    
    Parameters:
    
    metricName - This parameter is required.
    
    props -
  - metric
```
Metric metric(java.lang.String metricName)
```
    Return the given named metric for this Lambda Return the given named metric for this Function.
    
    Parameters:
    
    metricName - This parameter is required.
  - metricDuration
```
Metric metricDuration(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
    
    Parameters:
    
    props -
  - metricDuration
```
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
  - metricErrors
```
Metric metricErrors(MetricOptions props)
```
    How many invocations of this Lambda fail.
    Sum over 5 minutes
    
    Parameters:
    
    props -
  - metricErrors
```
Metric metricErrors()
```
    How many invocations of this Lambda fail.
    Sum over 5 minutes
  - metricInvocations
```
Metric metricInvocations(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
    
    Parameters:
    
    props -
  - metricInvocations
```
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
  - metricThrottles
```
Metric metricThrottles(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
    
    Parameters:
    
    props -
  - metricThrottles
```
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

Interface IFunction

Nested Class Summary

Method Summary

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

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

Methods inherited from interface software.amazon.awscdk.services.ec2.IConnectable

Methods inherited from interface software.amazon.awscdk.services.iam.IGrantable

Method Detail

getArchitecture

getFunctionArn

getFunctionName

getIsBoundToVpc

getLatestVersion

getPermissionsNode

getResourceArnsForGrantInvoke

getRole

addEventSource

addEventSourceMapping

addFunctionUrl

addFunctionUrl

addPermission

addToRolePolicy

configureAsyncInvoke

grantInvoke

grantInvokeUrl

metric

metric

metricDuration

metricDuration

metricErrors

metricErrors

metricInvocations

metricInvocations

metricThrottles

metricThrottles