JSPM

  • ESM via JSPM
  • ES Module Entrypoint
  • Export Map
  • Keywords
  • License
  • Repository URL
  • TypeScript Types
  • README
  • Created
  • Published
  • Downloads 1061
  • Score
    100M100P100Q108745F
  • License Apache-2.0

Official `aws-lite` plugin for Lambda

Package Exports

  • @aws-lite/lambda
  • @aws-lite/lambda/src/index.mjs

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (@aws-lite/lambda) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

@aws-lite/lambda

Official aws-lite plugin for Lambda

Maintained by: @architect

Install

npm i @aws-lite/lambda

Optionally install types:

npm i -D @aws-lite/lambda-types

Reference

Reference documentation with examples at aws-lite.org

Methods

CreateFunction

Canonical AWS API doc

Properties:

  • Code (object) [required]
    • Code payload to be run in Lambda; object can contain: ImageUri (ECR image), S3Bucket + S3Key + S3ObjectVersion (S3 bucket in the same region, key, and optional version), or ZipFile (base64-encoded zip)
    • More details (AWS)
  • FunctionName (string) [required]
    • The name of the Lambda function, version, or alias
  • Role (string) [required]
    • ARN of the function's execution role
  • Architectures (array)
    • System architecture, array can contain either x86_64 (default) or arm64
  • CodeSigningConfigArn (string)
    • ARN of a code-signing configuration used to enable code signing for this function
  • DeadLetterConfig (object)
  • Description (string)
    • Description of the function
  • Environment (object)
  • EphemeralStorage (object)
    • Size of the function /tmp directory (in MB), from 512 (default) to 10240
    • More details (AWS)
  • FileSystemConfigs (array)
  • Handler (string)
    • The name of the handler file and method method within your code that Lambda calls to run your function (e.g. index.handler)
    • More details (AWS)
  • ImageConfig (object)
  • KMSKeyArn (string)
    • ARN of the Key Management Service (KMS) customer managed key used to encrypt your function environment variables
  • Layers (array)
    • List of function layer ARNs (including version) to add to the function execution environment
  • MemorySize (number)
    • Amount of memory available (in MB) at runtime from 128 to 10240; increasing memory also increases CPU allocation
  • PackageType (string)
    • Deployment package type, either Image (container image) or Zip (zip archive)
  • Publish (boolean)
    • Set to true to publish the first version of the function during creation
  • Runtime (string)
  • SnapStart (object)
  • Tags (array)
    • List of tags to apply to the function
  • Timeout (number)
    • Time (in seconds) a function is allowed to run before being stopped, from 3 (default) to 900
  • TracingConfig (object)
  • VpcConfig (object)

DeleteFunctionConcurrency

Canonical AWS API doc

Properties:

  • FunctionName (string) [required]
    • The name of the Lambda function, version, or alias

GetFunctionConfiguration

Canonical AWS API doc

Properties:

  • FunctionName (string) [required]
    • The name of the Lambda function, version, or alias
  • Qualifier (string)
    • Specify a version or alias to invoke a published version of the function

Invoke

Canonical AWS API doc

Properties:

  • FunctionName (string) [required]
    • The name of the Lambda function, version, or alias
  • InvocationType (string)
    • Set invocation type to one of: RequestResponse (default, synchronous), Event (asynchronous), DryRun (validate invoke request only)
  • Payload (array, object) [required]
    • Event payload to invoke function with
  • LogType (string)
    • Set to Tail to include the execution log in the X-Amz-Log-Result response header of synchronously invoked functions
  • ClientContext (string)
    • Up to 3,583 bytes of base64-encoded data to pass to the function in the context object
  • Qualifier (string)
    • Specify a version or alias to invoke a published version of the function

PutFunctionConcurrency

Canonical AWS API doc

Properties:

  • FunctionName (string) [required]
    • The name of the Lambda function, version, or alias
  • ReservedConcurrentExecutions (number) [required]
    • number of simultaneous executions to reserve

UpdateFunctionCode

Canonical AWS API doc

Properties:

  • FunctionName (string) [required]
    • The name of the Lambda function, version, or alias
  • Architectures (array)
    • System architecture, array can contain either x86_64 (default) or arm64
  • DryRun (string)
    • Validate the request parameters and access permissions without modifying the function code (true)
  • ImageUri (string)
    • URI of a container image in the Amazon ECR registry (if not using a .zip file)
  • Publish (boolean)
    • Publish a new version after after updating the code (true); effectively the same as calling PublishVersion
  • RevisionId (string)
    • Update the function config only if the current revision ID matches the specified RevisionId; used to avoid modifying a function that has changed since you last read it
  • S3Bucket (string)
    • S3 bucket containing the key of the deployment package; must be in the same region
  • S3Key (string)
    • S3 key of the deployment package (must be a .zip file)
  • S3ObjectVersion (string)
    • S3 object version to use, if applicable
  • ZipFile (string, buffer)
    • File path or raw buffer of the .zip deployment package

UpdateFunctionConfiguration

Canonical AWS API doc

Properties:

  • FunctionName (string) [required]
    • The name of the Lambda function, version, or alias
  • DeadLetterConfig (object)
  • Description (string)
    • Description of the function
  • Environment (object)
  • EphemeralStorage (object)
    • Size of the function /tmp directory (in MB), from 512 (default) to 10240
    • More details (AWS)
  • FileSystemConfigs (array)
  • Handler (string)
    • The name of the handler file and method method within your code that Lambda calls to run your function (e.g. index.handler)
    • More details (AWS)
  • ImageConfig (object)
  • KMSKeyArn (string)
    • ARN of the Key Management Service (KMS) customer managed key used to encrypt your function environment variables
  • Layers (array)
    • List of function layer ARNs (including version) to add to the function execution environment
  • MemorySize (number)
    • Amount of memory available (in MB) at runtime from 128 to 10240; increasing memory also increases CPU allocation
  • RevisionId (string)
    • Update the function config only if the current revision ID matches the specified RevisionId; used to avoid modifying a function that has changed since you last read it
  • Role (string)
    • ARN of the function's execution role
  • Runtime (string)
  • SnapStart (object)
  • Timeout (number)
    • Time (in seconds) a function is allowed to run before being stopped, from 3 (default) to 900
  • TracingConfig (object)
  • VpcConfig (object)

Methods yet to be implemented

Please help out by opening a PR!

Learn more