EdgeFunction

java.lang.Object
- software.constructs.Construct
- - software.amazon.awscdk.core.Construct
  - - software.amazon.awscdk.core.Resource
    - - software.amazon.awscdk.services.cloudfront.experimental.EdgeFunction

All Implemented Interfaces:: IConstruct, IDependable, IResource, IConnectable, IGrantable, IFunction, IVersion

@Generated(value="jsii-pacmak/1.71.0 (build f1f58ae)",
           date="2022-11-18T02:14:13.112Z")
public class EdgeFunction
extends Resource
implements IVersion

A Lambda@Edge function.

Convenience resource for requesting a Lambda function in the 'us-east-1' region for use with Lambda@Edge. Implements several restrictions enforced by Lambda@Edge.

Note that this construct requires that the 'us-east-1' region has been bootstrapped. See https://docs.aws.amazon.com/cdk/latest/guide/bootstrapping.html or 'cdk bootstrap --help' for options.

Example:

 Bucket myBucket;
 // A Lambda@Edge function added to default behavior of a Distribution
 // and triggered on every request
 EdgeFunction myFunc = EdgeFunction.Builder.create(this, "MyFunction")
         .runtime(Runtime.NODEJS_14_X)
         .handler("index.handler")
         .code(Code.fromAsset(join(__dirname, "lambda-handler")))
         .build();
 Distribution.Builder.create(this, "myDist")
         .defaultBehavior(BehaviorOptions.builder()
                 .origin(new S3Origin(myBucket))
                 .edgeLambdas(List.of(EdgeLambda.builder()
                         .functionVersion(myFunc.getCurrentVersion())
                         .eventType(LambdaEdgeEventType.VIEWER_REQUEST)
                         .build()))
                 .build())
         .build();

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class EdgeFunction.Builder
A fluent builder for EdgeFunction.
- Nested classes/interfaces inherited from interface software.amazon.awscdk.services.lambda.IVersion
  IVersion.Jsii$Default, IVersion.Jsii$Proxy

Nested Classes
Modifier and Type	Class and Description
`static class`	`EdgeFunction.Builder` A fluent builder for `EdgeFunction`.

Constructor Summary

Constructors
Modifier	Constructor and Description
`protected`	`EdgeFunction(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)`
`protected`	`EdgeFunction(software.amazon.jsii.JsiiObjectRef objRef)`
	`EdgeFunction(software.constructs.Construct scope, java.lang.String id, EdgeFunctionProps props)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Alias`	`addAlias(java.lang.String aliasName)` Defines an alias for this version.
`Alias`	`addAlias(java.lang.String aliasName, AliasOptions options)` Defines an alias for this version.
`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.
`Connections`	`getConnections()` Not supported.
`IVersion`	`getCurrentVersion()` Convenience method to make `EdgeFunction` conform to the same interface as `Function`.
`java.lang.String`	`getEdgeArn()` The ARN of the version for Lambda@Edge.
`java.lang.String`	`getFunctionArn()` The ARN of the function.
`java.lang.String`	`getFunctionName()` The name of the function.
`IPrincipal`	`getGrantPrincipal()` The principal to grant permissions to.
`java.lang.Boolean`	`getIsBoundToVpc()` Whether or not this Lambda function was bound to a VPC.
`IFunction`	`getLambda()` The underlying AWS Lambda function.
`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().
`IRole`	`getRole()` The IAM role associated with this function.
`java.lang.String`	`getVersion()` The most recently deployed version of 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 class software.amazon.awscdk.core.Resource
applyRemovalPolicy, generatePhysicalName, getEnv, getPhysicalName, getResourceArnAttribute, getResourceNameAttribute, getStack, isResource

Methods inherited from class software.amazon.awscdk.core.Construct
getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface software.amazon.awscdk.core.IResource
applyRemovalPolicy, getEnv, getStack

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

- Constructor Detail
  - EdgeFunction
```
protected EdgeFunction(software.amazon.jsii.JsiiObjectRef objRef)
```
  - EdgeFunction
```
protected EdgeFunction(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
```
  - EdgeFunction
```
public EdgeFunction(software.constructs.Construct scope,
                    java.lang.String id,
                    EdgeFunctionProps props)
```
    Parameters:
    
    scope - This parameter is required.
    
    id - This parameter is required.
    
    props - This parameter is required.
- Method Detail
  - addAlias
```
public Alias addAlias(java.lang.String aliasName,
                      AliasOptions options)
```
    Defines an alias for this version.
    
    Specified by:
    
    addAlias in interface IVersion
    
    Parameters:
    
    aliasName - This parameter is required.
    
    options -
  - addAlias
```
public Alias addAlias(java.lang.String aliasName)
```
    Defines an alias for this version.
    
    Specified by:
    
    addAlias in interface IVersion
    
    Parameters:
    
    aliasName - This parameter is required.
  - addEventSource
```
public void addEventSource(IEventSource source)
```
    Adds an event source to this function.
    
    Specified by:
    
    addEventSource in interface IFunction
    
    Parameters:
    
    source - This parameter is required.
  - addEventSourceMapping
```
public 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 - This parameter is required.
    
    options - This parameter is required.
  - addFunctionUrl
```
public FunctionUrl addFunctionUrl(FunctionUrlOptions options)
```
    Adds a url to this lambda function.
    
    Specified by:
    
    addFunctionUrl in interface IFunction
    
    Parameters:
    
    options -
  - addFunctionUrl
```
public FunctionUrl addFunctionUrl()
```
    Adds a url to this lambda function.
    
    Specified by:
    
    addFunctionUrl in interface IFunction
  - addPermission
```
public void addPermission(java.lang.String id,
                          Permission permission)
```
    Adds a permission to the Lambda resource policy.
    
    Specified by:
    
    addPermission in interface IFunction
    
    Parameters:
    
    id - This parameter is required.
    
    permission - This parameter is required.
    
    See Also:
    
    Permission for details.
  - addToRolePolicy
```
public 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
```
public void configureAsyncInvoke(EventInvokeConfigOptions options)
```
    Configures options for asynchronous invocation.
    
    Specified by:
    
    configureAsyncInvoke in interface IFunction
    
    Parameters:
    
    options - This parameter is required.
  - grantInvoke
```
public 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
```
public 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
```
public 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 -
  - metric
```
public Metric metric(java.lang.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
```
public Metric metricDuration(MetricOptions props)
```
    Metric for the Duration of this Lambda How long execution of this Lambda takes.
    Average over 5 minutes
    
    Specified by:
    
    metricDuration in interface IFunction
    
    Parameters:
    
    props -
  - metricDuration
```
public Metric metricDuration()
```
    Metric for the Duration of this Lambda How long execution of this Lambda takes.
    Average over 5 minutes
    
    Specified by:
    
    metricDuration in interface IFunction
  - metricErrors
```
public Metric metricErrors(MetricOptions props)
```
    How many invocations of this Lambda fail.
    Sum over 5 minutes
    
    Specified by:
    
    metricErrors in interface IFunction
    
    Parameters:
    
    props -
  - metricErrors
```
public Metric metricErrors()
```
    How many invocations of this Lambda fail.
    Sum over 5 minutes
    
    Specified by:
    
    metricErrors in interface IFunction
  - metricInvocations
```
public Metric metricInvocations(MetricOptions props)
```
    Metric for the number of invocations of this Lambda How often this Lambda is invoked.
    Sum over 5 minutes
    
    Specified by:
    
    metricInvocations in interface IFunction
    
    Parameters:
    
    props -
  - metricInvocations
```
public Metric metricInvocations()
```
    Metric for the number of invocations of this Lambda How often this Lambda is invoked.
    Sum over 5 minutes
    
    Specified by:
    
    metricInvocations in interface IFunction
  - metricThrottles
```
public Metric metricThrottles(MetricOptions props)
```
    Metric for the number of throttled invocations of this Lambda How often this Lambda is throttled.
    Sum over 5 minutes
    
    Specified by:
    
    metricThrottles in interface IFunction
    
    Parameters:
    
    props -
  - metricThrottles
```
public Metric metricThrottles()
```
    Metric for the number of throttled invocations of this Lambda How often this Lambda is throttled.
    Sum over 5 minutes
    
    Specified by:
    
    metricThrottles in interface IFunction
  - getArchitecture
```
public Architecture getArchitecture()
```
    The system architectures compatible with this lambda function.
    
    Specified by:
    
    getArchitecture in interface IFunction
  - getConnections
```
public Connections getConnections()
```
    Not supported.
    Connections are only applicable to VPC-enabled functions.
    
    Specified by:
    
    getConnections in interface IConnectable
  - getCurrentVersion
```
public IVersion getCurrentVersion()
```
    Convenience method to make `EdgeFunction` conform to the same interface as `Function`.
  - getEdgeArn
```
public java.lang.String getEdgeArn()
```
    The ARN of the version for Lambda@Edge.
    
    Specified by:
    
    getEdgeArn in interface IVersion
  - getFunctionArn
```
public java.lang.String getFunctionArn()
```
    The ARN of the function.
    
    Specified by:
    
    getFunctionArn in interface IFunction
  - getFunctionName
```
public java.lang.String getFunctionName()
```
    The name of the function.
    
    Specified by:
    
    getFunctionName in interface IFunction
  - getGrantPrincipal
```
public IPrincipal getGrantPrincipal()
```
    The principal to grant permissions to.
    
    Specified by:
    
    getGrantPrincipal in interface IGrantable
  - getIsBoundToVpc
```
public 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
  - getLambda
```
public IFunction getLambda()
```
    The underlying AWS Lambda function.
    
    Specified by:
    
    getLambda in interface IVersion
  - getLatestVersion
```
public 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
```
public ConstructNode getPermissionsNode()
```
    The construct node where permissions are attached.
    
    Specified by:
    
    getPermissionsNode in interface IFunction
  - getResourceArnsForGrantInvoke
```
public 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
  - getVersion
```
public java.lang.String getVersion()
```
    The most recently deployed version of this function.
    
    Specified by:
    
    getVersion in interface IVersion
  - getRole
```
public IRole getRole()
```
    The IAM role associated with this function.
    
    Specified by:
    
    getRole in interface IFunction

Class EdgeFunction

Nested Class Summary

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

Constructor Summary

Method Summary

Methods inherited from class software.amazon.awscdk.core.Resource

Methods inherited from class software.amazon.awscdk.core.Construct

Methods inherited from class java.lang.Object

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

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

Constructor Detail

EdgeFunction

EdgeFunction

EdgeFunction

Method Detail

addAlias

addAlias

addEventSource

addEventSourceMapping

addFunctionUrl

addFunctionUrl

addPermission

addToRolePolicy

configureAsyncInvoke

grantInvoke

grantInvokeUrl

metric

metric

metricDuration

metricDuration

metricErrors

metricErrors

metricInvocations

metricInvocations

metricThrottles

metricThrottles

getArchitecture

getConnections

getCurrentVersion

getEdgeArn

getFunctionArn

getFunctionName

getGrantPrincipal

getIsBoundToVpc

getLambda

getLatestVersion

getPermissionsNode

getResourceArnsForGrantInvoke

getVersion

getRole