API.md

API Reference

Classes

Name	Description
BaseEdgeConstruct	No description
EdgeFunction	No description
EdgeRole	No description
HttpHeaders	No description
WithConfiguration	No description

Structs

Name	Description
CommonEdgeFunctionProps	No description
Configuration	No description
EdgeFunctionProps	No description
EdgeRoleProps	No description
HttpHeadersProps	No description
WithConfigurationProps	No description

Interfaces

Name	Description
IEdgeLambda	No description
IEdgeRole	No description
ILambdaFunctionAssociation	No description

Enums

Name	Description
LogLevel	No description

class BaseEdgeConstruct

Implements: IConstruct, IConstruct, IConstruct, IDependable Extends: Construct

Initializer

new BaseEdgeConstruct(scope: Construct, id: string)

• scope (Construct) No description
• id (string) No description

Properties

Name	Type	Description
edgeStack	Stack
stack	Stack

class EdgeFunction

Implements: IConstruct, IConstruct, IConstruct, IDependable, ILambdaFunctionAssociation, IEdgeLambda Extends: BaseEdgeConstruct

Initializer

new EdgeFunction(scope: Construct, id: string, props: EdgeFunctionProps)

• scope (Construct) No description
• id (string) No description
• props (EdgeFunctionProps) No description
  • edgeRole (IEdgeRole) No description Optional
  • parameterName (string) The name of the parameter. Optional
  • code (Code) No description
  • configuration (Configuration) No description
  • eventType (LambdaEdgeEventType) No description
  • name (string) No description

Properties

Name	Type	Description
edgeRole	IEdgeRole
eventType	LambdaEdgeEventType
functionVersion	IVersion
lambdaFunction	IVersion

class EdgeRole

Implements: IConstruct, IConstruct, IConstruct, IDependable, IEdgeRole Extends: BaseEdgeConstruct

Initializer

new EdgeRole(scope: Construct, id: string, props?: EdgeRoleProps)

• scope (Construct) No description
• id (string) No description
• props (EdgeRoleProps) No description
  • roleName (string) No description Optional

Properties

Name	Type	Description
role	IRole

Methods

addToEdgeRolePolicy(statement)

addToEdgeRolePolicy(statement: PolicyStatement): void

• statement (PolicyStatement) No description

class HttpHeaders

Implements: IConstruct, IConstruct, IConstruct, IDependable, ILambdaFunctionAssociation, IEdgeLambda Extends: EdgeFunction

Initializer

new HttpHeaders(scope: Construct, id: string, props: HttpHeadersProps)

• scope (Construct) No description
• id (string) No description
• props (HttpHeadersProps) No description
  • edgeRole (IEdgeRole) No description Optional
  • parameterName (string) The name of the parameter. Optional
  • httpHeaders (Map<string, string>) No description
  • logLevel (LogLevel) No description Optional

class WithConfiguration

Implements: IConstruct, IConstruct, IConstruct, IDependable Extends: Construct

Initializer

new WithConfiguration(scope: Construct, id: string, props: WithConfigurationProps)

• scope (Construct) No description
• id (string) No description
• props (WithConfigurationProps) No description
  • configuration (Configuration) No description
  • function (IFunction) No description

Properties

Name	Type	Description
functionVersion	IVersion

struct CommonEdgeFunctionProps

Name	Type	Description
edgeRole?	IEdgeRole	Optional
parameterName?	string	The name of the parameter. Optional

struct Configuration

Name	Type	Description
logLevel	LogLevel

struct EdgeFunctionProps

Name	Type	Description
code	Code
configuration	Configuration
eventType	LambdaEdgeEventType
name	string
edgeRole?	IEdgeRole	Optional
parameterName?	string	The name of the parameter. Optional

struct EdgeRoleProps

Name	Type	Description
roleName?	string	Optional

struct HttpHeadersProps

Name	Type	Description
httpHeaders	Map<string, string>
edgeRole?	IEdgeRole	Optional
logLevel?	LogLevel	Optional
parameterName?	string	The name of the parameter. Optional

interface IEdgeLambda

Implemented by: EdgeFunction, HttpHeaders

Properties

Name	Type	Description
eventType	LambdaEdgeEventType
functionVersion	IVersion

interface IEdgeRole

Implemented by: EdgeRole

Properties

Name	Type	Description
role	IRole

Methods

addToEdgeRolePolicy(statement)

addToEdgeRolePolicy(statement: PolicyStatement): void

• statement (PolicyStatement) No description

interface ILambdaFunctionAssociation

Implemented by: EdgeFunction, HttpHeaders

Properties

Name	Type	Description
eventType	LambdaEdgeEventType
lambdaFunction	IVersion

struct WithConfigurationProps

Name	Type	Description
configuration	Configuration
function	IFunction

enum LogLevel

Name	Description
NONE
INFO
WARN
ERROR
DEBUG