IFunction.Jsii$Default

All Superinterfaces:

IConnectable, IConnectable.Jsii$Default, IConstruct, IConstruct.Jsii$Default, IDependable, IDependable.Jsii$Default, IFunction, IGrantable, IGrantable.Jsii$Default, IResource, IResource.Jsii$Default

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
```
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

All Methods Instance Methods Default Methods
Modifier and Type	Method and Description
`default void`	`addEventSource(IEventSource source)` Adds an event source to this function.
`default EventSourceMapping`	`addEventSourceMapping(java.lang.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(java.lang.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 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 java.lang.String`	`getFunctionArn()` The ARN of the function.
`default java.lang.String`	`getFunctionName()` The name of the function.
`default IPrincipal`	`getGrantPrincipal()` The principal to grant permissions to.
`default java.lang.Boolean`	`getIsBoundToVpc()` Whether or not this Lambda function was bound to a VPC.
`default IVersion`	`getLatestVersion()` The `$LATEST` version of this function.
`default ConstructNode`	`getNode()` The construct tree node for this construct.
`default ConstructNode`	`getPermissionsNode()` The construct node where permissions are attached.
`default 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.
`default Stack`	`getStack()` The stack in which this resource is defined.
`default Grant`	`grantInvoke(IGrantable identity)` Grant the given identity permissions to invoke this Lambda.
`default Grant`	`grantInvokeUrl(IGrantable identity)` Grant the given identity permissions to invoke this Lambda Function URL.
`default Metric`	`metric(java.lang.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

- Method Detail
  - getNode
```
default ConstructNode getNode()
```
    The construct tree node for this construct.
    
    Specified by:
    
    getNode in interface IConstruct
    
    Specified by:
    
    getNode in interface IConstruct.Jsii$Default
    
    Specified by:
    
    getNode in interface IResource.Jsii$Default
  - getEnv
```
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 IResource
    
    Specified by:
    
    getEnv in interface IResource.Jsii$Default
  - getStack
```
default Stack getStack()
```
    The stack in which this resource is defined.
    
    Specified by:
    
    getStack in interface IResource
    
    Specified by:
    
    getStack in interface IResource.Jsii$Default
  - getConnections
```
default Connections getConnections()
```
    The network connections associated with this resource.
    
    Specified by:
    
    getConnections in interface IConnectable
    
    Specified by:
    
    getConnections in interface IConnectable.Jsii$Default
  - getGrantPrincipal
```
default IPrincipal getGrantPrincipal()
```
    The principal to grant permissions to.
    
    Specified by:
    
    getGrantPrincipal in interface IGrantable
    
    Specified by:
    
    getGrantPrincipal in interface IGrantable.Jsii$Default
  - getArchitecture
```
default Architecture getArchitecture()
```
    The system architectures compatible with this lambda function.
    
    Specified by:
    
    getArchitecture in interface IFunction
  - getFunctionArn
```
default java.lang.String getFunctionArn()
```
    The ARN of the function.
    
    Specified by:
    
    getFunctionArn in interface IFunction
  - getFunctionName
```
default java.lang.String getFunctionName()
```
    The name of the function.
    
    Specified by:
    
    getFunctionName in interface IFunction
  - getIsBoundToVpc
```
default 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.
    
    Specified by:
    
    getIsBoundToVpc in interface IFunction
  - getLatestVersion
```
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
  - getPermissionsNode
```
default ConstructNode getPermissionsNode()
```
    The construct node where permissions are attached.
    
    Specified by:
    
    getPermissionsNode in interface IFunction
  - getResourceArnsForGrantInvoke
```
default 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.
    
    Specified by:
    
    getResourceArnsForGrantInvoke in interface IFunction
  - getRole
```
default IRole getRole()
```
    The IAM role associated with this function.
    
    Specified by:
    
    getRole in interface IFunction
  - applyRemovalPolicy
```
default void applyRemovalPolicy(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 IResource
    
    Specified by:
    
    applyRemovalPolicy in interface IResource.Jsii$Default
    
    Parameters:
    
    policy - This parameter is required.
  - addEventSource
```
default 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));
    Specified by:
    
    addEventSource in interface IFunction
    
    Parameters:
    
    source - This parameter is required.
  - addEventSourceMapping
```
default EventSourceMapping addEventSourceMapping(java.lang.String id,
                                                 EventSourceMappingOptions options)
```
    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.
  - addFunctionUrl
```
default FunctionUrl addFunctionUrl(FunctionUrlOptions options)
```
    Adds a url to this lambda function.
    
    Specified by:
    
    addFunctionUrl in interface IFunction
    
    Parameters:
    
    options -
  - addPermission
```
default void addPermission(java.lang.String id,
                           Permission permission)
```
    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:
    
    Permission for details.
  - addToRolePolicy
```
default void addToRolePolicy(PolicyStatement statement)
```
    Adds a statement to the IAM role assumed by the instance.
    
    Specified by:
    
    addToRolePolicy in interface IFunction
    
    Parameters:
    
    statement - This parameter is required.
  - configureAsyncInvoke
```
default void configureAsyncInvoke(EventInvokeConfigOptions options)
```
    Configures options for asynchronous invocation.
    
    Specified by:
    
    configureAsyncInvoke in interface IFunction
    
    Parameters:
    
    options - This parameter is required.
  - grantInvoke
```
default Grant grantInvoke(IGrantable identity)
```
    Grant the given identity permissions to invoke this Lambda.
    
    Specified by:
    
    grantInvoke in interface IFunction
    
    Parameters:
    
    identity - This parameter is required.
  - grantInvokeUrl
```
default Grant grantInvokeUrl(IGrantable identity)
```
    Grant the given identity permissions to invoke this Lambda Function URL.
    
    Specified by:
    
    grantInvokeUrl in interface IFunction
    
    Parameters:
    
    identity - This parameter is required.
  - metric
```
default Metric metric(java.lang.String metricName,
                      MetricOptions props)
```
    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
```
default 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
    
    Specified by:
    
    metricDuration in interface IFunction
    
    Parameters:
    
    props -
  - metricErrors
```
default Metric metricErrors(MetricOptions props)
```
    How many invocations of this Lambda fail.
    Sum over 5 minutes
    
    Specified by:
    
    metricErrors in interface IFunction
    
    Parameters:
    
    props -
  - metricInvocations
```
default 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
    
    Specified by:
    
    metricInvocations in interface IFunction
    
    Parameters:
    
    props -
  - metricThrottles
```
default 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
    
    Specified by:
    
    metricThrottles in interface IFunction
    
    Parameters:
    
    props -

Interface IFunction.Jsii$Default

Nested Class Summary

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

Method Summary

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

Method Detail

getNode

getEnv

getStack

getConnections

getGrantPrincipal

getArchitecture

getFunctionArn

getFunctionName

getIsBoundToVpc

getLatestVersion

getPermissionsNode

getResourceArnsForGrantInvoke

getRole

applyRemovalPolicy

addEventSource

addEventSourceMapping

addFunctionUrl

addPermission

addToRolePolicy

configureAsyncInvoke

grantInvoke

grantInvokeUrl

metric

metricDuration

metricErrors

metricInvocations

metricThrottles