@aws-lite/lambda

0.1.5 • Public • Published

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

AddLayerVersionPermission

Canonical AWS API doc

Properties:

  • LayerName (string) [required]
    • Name or ARN of the layer
  • 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
  • VersionNumber (number) [required]
    • The version number of the layer
  • Action (string) [required]
    • The API action that grants access to the layer, for example lambda:GetLayerVersion
  • OrganizationId (string)
    • When Principal is set to *, permission will be granted to all accounts in the specified organization
  • Principal (string)
    • Account ID being granted permissions. Use * along with the OrganizationId to grant permissions to all accounts in the specified organization
  • StatementId (string) [required]
    • ID to distinguish the policy from other policies on the same layer version

AddPermission

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
  • Action (string) [required]
    • Action that the principal can use on the function; for example, lambda:InvokeFunction
  • EventSourceToken (string)
    • A token that Alexa Smart Home requires from the invoker
  • FunctionUrlAuthType (string)
    • The type of authentication that your function URL uses. Set to AWS_IAM if you want to restrict access to authenticated users only. Set to NONE if you want to bypass IAM authentication to create a public endpoint
  • Principal (string) [required]
    • The AWS service or AWS account that invokes the function
  • PrincipalOrgID (string)
    • The identifier for your organization in AWS Organizations
  • 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
  • SourceAccount (string)
    • ID of the AWS account that owns the resource
  • SourceArn (string)
    • ARN of the AWS resource that invokes the function, such as an Amazon S3 bucket
  • StatementId (string) [required]
    • A statement identifier that differentiates the statement from others in the same policy

CreateAlias

Canonical AWS API doc

Properties:

  • FunctionName (string) [required]
    • The name of the Lambda function, version, or alias
  • Description (string)
    • Description of the function
  • FunctionVersion (string) [required]
    • Version of the aliased function
  • Name (string) [required]
    • Name of the alias
  • RoutingConfig (object)

CreateCodeSigningConfig

Canonical AWS API doc

Properties:

  • AllowedPublishers (object) [required]
  • CodeSigningPolicies (object)
  • Description (string)
    • Description of the function

CreateEventSourceMapping

Canonical AWS API doc

Properties:

  • FunctionName (string) [required]
    • The name of the Lambda function, version, or alias
  • AmazonManagedKafkaEventSourceConfig (object)
    • Configuration settings for an Amazon Managed Streaming for Apache Kafka event source
    • More details (AWS)
  • BatchSize (number)
    • Maximum number of records from 1 to 10000 in each batch that Lambda pulls from the stream or queue
    • More details (AWS)
  • BisectBatchOnFunctionError (boolean)
    • If the function returns an error, divide the batch and try again (only for Kinesis and DynamoDB streams)
  • DestinationConfig (object)
  • DocumentDBEventSourceConfig (object)
  • Enabled (boolean)
    • Set to false to disable event source upon creation
  • EventSourceArn (string)
    • ARN of the event source
  • FilterCriteria (object)
  • FunctionResponseTypes (array)
    • A list of at most 1 string defining the current response type enum applied to the event source mapping; For Kinesis, DynamoDB Streams, and Amazon SQS
    • More details (AWS)
  • MaximumBatchingWindowInSeconds (number)
    • Maximum time (in seconds) from 0 to 300 that Lambda may spend gathering records before invoking the function
    • More details (AWS)
  • MaximumRecordAgeInSeconds (number)
    • Maximum age between -1 (infinite, default) to 604,800 of an event before it will be discarded; only for Kinesis and DynamoDB streams
  • MaximumRetryAttempts (number)
    • Maximum number of tries between -1 (infinite, default) to 10,000 before a record is discarded; Kinesis and DynamoDB only
  • ParallelizationFactor (number)
    • Number of batches between 1 to 10 that can be processed from each shard concurrently
  • Queues (array)
    • Array of exactly 1 string specifying the name of the Amazon MQ broker destination queue to consume
  • ScalingConfig (object)
  • SelfManagedEventSource (object)
  • SelfManagedKafkaEventSourceConfig (object)
  • SourceAccessConfigurations (array)
    • Array of at most 22 SourceAccessConfiguration objects to specifying authentication protocols or VPC components required to secure the event source
  • StartingPosition (string)
    • Position in a stream to begin reading, valid entries are TRIM_HORIZON (all available messages), LATEST (from now or after) or AT_TIMESTAMP (specify timestamp)
    • More details (AWS)
  • StartingPositionTimestamp (object)
    • The timestamp in Unix time seconds used when StartingPosition is set to AT_TIMESTAMP; cannot be in the future
  • Topics (array)
    • Array of exactly 1 string specifying the name of the Kafka topic
  • TumblingWindowInSeconds (number)
    • Time (in seconds) from 0 to 900 specifying the duration of a processing window for DynamoDB and Kinesis event stream sources

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)

CreateFunctionUrlConfig

Canonical AWS API doc

Properties:

  • AuthType (string) [required]
    • Type of authentication that the function URL will use, either AWS_IAM or NONE
  • FunctionName (string) [required]
    • The name of the Lambda function, version, or alias
  • Cors (object)
  • InvokeMode (string)
    • Specify how the function will be invoked, either BUFFERED (default, uses the Invoke API operation) or RESPONSE_STREAM (streams results as they become available, uses the InvokeWithResponseStream API operation)
    • More details (AWS)
  • Qualifier (string)
    • Specify a version or alias to invoke a published version of the function

DeleteAlias

Canonical AWS API doc

Properties:

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

DeleteCodeSigningConfig

Canonical AWS API doc

Properties:

  • CodeSigningConfigArn (string) [required]
    • ARN of the code signing configuration

DeleteEventSourceMapping

Canonical AWS API doc

Properties:

  • UUID (string) [required]
    • UUID of the event source mapping

DeleteFunction

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

DeleteFunctionCodeSigningConfig

Canonical AWS API doc

Properties:

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

DeleteFunctionConcurrency

Canonical AWS API doc

Properties:

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

DeleteFunctionEventInvokeConfig

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

DeleteFunctionUrlConfig

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

DeleteLayerVersion

Canonical AWS API doc

Properties:

  • LayerName (string) [required]
    • Name or ARN of the layer
  • VersionNumber (number) [required]
    • The version number of the layer

DeleteProvisionedConcurrencyConfig

Canonical AWS API doc

Properties:

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

GetAccountSettings

Canonical AWS API doc

Properties:

GetAlias

Canonical AWS API doc

Properties:

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

GetCodeSigningConfig

Canonical AWS API doc

Properties:

  • CodeSigningConfigArn (string) [required]
    • ARN of the code signing configuration

GetEventSourceMapping

Canonical AWS API doc

Properties:

  • UUID (string) [required]
    • ARN of the event source mapping

GetFunction

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

GetFunctionCodeSigningConfig

Canonical AWS API doc

Properties:

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

GetFunctionConcurrency

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

GetFunctionEventInvokeConfig

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

GetFunctionUrlConfig

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

GetLayerVersion

Canonical AWS API doc

Properties:

  • LayerName (string) [required]
    • Name or ARN of the layer
  • VersionNumber (number) [required]
    • The version number of the layer

GetLayerVersionByArn

Canonical AWS API doc

Properties:

  • Arn (string) [required]
    • The ARN of the layer version

GetLayerVersionPolicy

Canonical AWS API doc

Properties:

  • LayerName (string) [required]
    • Name or ARN of the layer
  • VersionNumber (number) [required]
    • The version number of the layer

GetPolicy

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

GetProvisionedConcurrencyConfig

Canonical AWS API doc

Properties:

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

GetRuntimeManagementConfig

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

ListAliases

Canonical AWS API doc

Properties:

  • FunctionName (string) [required]
    • The name of the Lambda function, version, or alias
  • FunctionVersion (string)
    • Version of the aliased function
  • Marker (string)
    • Pagination token
  • MaxItems (number)
    • Maximum number of items to be returned; maximum 10,000
  • paginate (boolean, string)
    • Enable automatic result pagination; use this instead of making your own individual pagination requests

ListCodeSigningConfigs

Canonical AWS API doc

Properties:

  • Marker (string)
    • Pagination token
  • MaxItems (number)
    • Maximum number of items to be returned; maximum 10,000
  • paginate (boolean, string)
    • Enable automatic result pagination; use this instead of making your own individual pagination requests

ListEventSourceMappings

Canonical AWS API doc

Properties:

  • EventSourceArn (string)
    • ARN of the event source
  • FunctionName (string)
    • The name of the Lambda function, version, or alias
  • Marker (string)
    • Pagination token
  • MaxItems (number)
    • Maximum number of items to be returned; maximum 10,000
  • paginate (boolean, string)
    • Enable automatic result pagination; use this instead of making your own individual pagination requests

ListFunctionEventInvokeConfigs

Canonical AWS API doc

Properties:

  • FunctionName (string) [required]
    • The name of the Lambda function, version, or alias
  • Marker (string)
    • Pagination token
  • MaxItems (number)
    • Maximum number of items to be returned; maximum 10,000
  • paginate (boolean, string)
    • Enable automatic result pagination; use this instead of making your own individual pagination requests

ListFunctions

Canonical AWS API doc

Properties:

  • FunctionVersion (string)
    • Set to ALL to include entries for all published versions
  • Marker (string)
    • Pagination token
  • MasterRegion (string)
    • Display LambdaEdge functions replicated from a master function in a specified region
    • More details (AWS)
  • MaxItems (number)
    • Maximum number of items to be returned; maximum 10,000
  • paginate (boolean, string)
    • Enable automatic result pagination; use this instead of making your own individual pagination requests

ListFunctionsByCodeSigningConfig

Canonical AWS API doc

Properties:

  • CodeSigningConfigArn (string) [required]
    • ARN of the code signing configuration
  • Marker (string)
    • Pagination token
  • MaxItems (number)
    • Maximum number of items to be returned; maximum 10,000
  • paginate (boolean, string)
    • Enable automatic result pagination; use this instead of making your own individual pagination requests

ListFunctionUrlConfigs

Canonical AWS API doc

Properties:

  • FunctionName (string) [required]
    • The name of the Lambda function, version, or alias
  • Marker (string)
    • Pagination token
  • MaxItems (number)
    • Maximum number of items to be returned; maximum 10,000
  • paginate (boolean, string)
    • Enable automatic result pagination; use this instead of making your own individual pagination requests

ListLayers

Canonical AWS API doc

Properties:

  • CompatibleArchitecture (string)
    • Set instruction set architecture to one of: x86_64, arm64
  • CompatibleRuntime (string)
  • Marker (string)
    • Pagination token
  • MaxItems (number)
    • Maximum number of items to be returned; maximum 10,000
  • paginate (boolean, string)
    • Enable automatic result pagination; use this instead of making your own individual pagination requests

ListLayerVersions

Canonical AWS API doc

Properties:

  • LayerName (string) [required]
    • Name or ARN of the layer
  • CompatibleArchitecture (string)
    • Set instruction set architecture to one of: x86_64, arm64
  • CompatibleRuntime (string)
  • Marker (string)
    • Pagination token
  • MaxItems (number)
    • Maximum number of items to be returned; maximum 10,000
  • paginate (boolean, string)
    • Enable automatic result pagination; use this instead of making your own individual pagination requests

ListProvisionedConcurrencyConfigs

Canonical AWS API doc

Properties:

  • FunctionName (string) [required]
    • The name of the Lambda function, version, or alias
  • Marker (string)
    • Pagination token
  • MaxItems (number)
    • Maximum number of items to be returned; maximum 10,000
  • paginate (boolean, string)
    • Enable automatic result pagination; use this instead of making your own individual pagination requests

ListTags

Canonical AWS API doc

Properties:

  • Resource (string) [required]
    • ARN of the lambda function

ListVersionsByFunction

Canonical AWS API doc

Properties:

  • FunctionName (string) [required]
    • The name of the Lambda function, version, or alias
  • Marker (string)
    • Pagination token
  • MaxItems (number)
    • Maximum number of items to be returned; maximum 10,000
  • paginate (boolean, string)
    • Enable automatic result pagination; use this instead of making your own individual pagination requests

PublishLayerVersion

Canonical AWS API doc

Properties:

  • Content (object) [required]
    • Contents of the layer; object can contain: S3Bucket, S3Key, S3ObjectVersion, or ZipFile (base64-encoded zip)
    • More details (AWS)
  • CompatibleArchitectures (array)
    • Array with a maximum of 2 strings specifying instruction set architecture; array can contain: x86_64, arm64
    • More details (AWS)
  • CompatibleRuntimes (array)
    • Array with a maximum of 15 strings specifying compatible runtime environments
    • More details (AWS)
  • Description (string)
    • Description of the function
  • LiscenceInfo (string)

PublishVersion

Canonical AWS API doc

Properties:

  • FunctionName (string) [required]
    • The name of the Lambda function, version, or alias
  • CodeSha256 (string)
  • Description (string)
    • Description of the function
  • 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

PutFunctionCodeSigningConfig

Canonical AWS API doc

Properties:

  • FunctionName (string) [required]
    • The name of the Lambda function, version, or alias
  • CodeSigningConfigArn (string) [required]
    • ARN of the code signing configuration

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

PutFunctionEventInvokeConfig

Canonical AWS API doc

Properties:

  • FunctionName (string) [required]
    • The name of the Lambda function, version, or alias
  • DestinationConfig (object)
  • MaximumEventAgeInSeconds (number)
    • Set a maximum age in whole seconds between 60 and 21,600 (inclusive) for events to be processed
  • MaximumRetryAttempts (number)
    • Set a maximum number of retries between 0 and 2 (inclusive) when the function returns an error
  • Qualifier (string)
    • Specify a version or alias to invoke a published version of the function

PutProvisionedConcurrencyConfig

Canonical AWS API doc

Properties:

  • FunctionName (string) [required]
    • The name of the Lambda function, version, or alias
  • ProvisionedConcurrentExecutions (number) [required]
    • Amount of provisioned concurrency of at least 1, to allocate for the version or alias
  • Qualifier (string) [required]
    • Specify a version or alias to invoke a published version of the function

PutRuntimeManagementConfig

Canonical AWS API doc

Properties:

  • FunctionName (string) [required]
    • The name of the Lambda function, version, or alias
  • UpdateRuntimeOn (string) [required]
    • Specify the runtime update mode; can be one of: Auto (default), FunctionUpdate, Manual
    • More details (AWS)
  • Qualifier (string)
  • RuntimeVersionArn (string)
    • ARN of the runtime version the function will use

RemoveLayerVersionPermission

Canonical AWS API doc

Properties:

  • LayerName (string) [required]
    • Name or ARN of the layer
  • StatementId (string) [required]
    • Identifier specified when the statement was added
  • VersionNumber (number) [required]
    • The version number of the layer
  • 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

RemovePermission

Canonical AWS API doc

Properties:

  • FunctionName (string) [required]
    • The name of the Lambda function, version, or alias
  • StatementId (string) [required]
    • Statement ID of the permission to remove
  • 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
  • Qualifier (string)
    • Specify a version or alias to invoke a published version of the function

TagResource

Canonical AWS API doc

Properties:

  • Resource (string) [required]
    • ARN of the lambda function
  • Tags (object) [required]

UntagResource

Canonical AWS API doc

Properties:

  • Resource (string) [required]
    • ARN of the lambda function
  • TagKeys (array) [required]
    • Array of tag keys (strings) to removed from the function

UpdateAlias

Canonical AWS API doc

Properties:

  • FunctionName (string) [required]
    • The name of the Lambda function, version, or alias
  • Name (string) [required]
    • Name of the alias
  • Description (string)
    • Description of the function
  • FunctionVersion (string)
    • Version of the aliased function
  • 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
  • RoutingConfig (object)

UpdateCodeSigningConfig

Canonical AWS API doc

Properties:

  • CodeSigningConfigArn (string) [required]
    • ARN of the code signing configuration
  • AllowedPublishers (object)
  • CodeSigningPolicies (object)
  • Description (string)
    • Description of the function

UpdateEventSourceMapping

Canonical AWS API doc

Properties:

  • UUID (string) [required]
    • UUID of the event source mapping
  • AmazonManagedKafkaEventSourceConfig (object)
    • Configuration settings for an Amazon Managed Streaming for Apache Kafka event source
    • More details (AWS)
  • BatchSize (number)
    • Maximum number of records from 1 to 10000 in each batch that Lambda pulls from the stream or queue
    • More details (AWS)
  • BisectBatchOnFunctionError (boolean)
    • If the function returns an error, divide the batch and try again (only for Kinesis and DynamoDB streams)
  • DestinationConfig (object)
  • DocumentDBEventSourceConfig (object)
  • Enabled (boolean)
    • Set to false to disable event source upon creation
  • FilterCriteria (object)
  • FunctionName (string)
    • The name of the Lambda function, version, or alias
  • FunctionResponseTypes (array)
    • A list of at most 1 string defining the current response type enum applied to the event source mapping; For Kinesis, DynamoDB Streams, and Amazon SQS
    • More details (AWS)
  • MaximumBatchingWindowInSeconds (number)
    • Maximum time (in seconds) from 0 to 300 that Lambda may spend gathering records before invoking the function
    • More details (AWS)
  • MaximumRecordAgeInSeconds (number)
    • Maximum age between -1 (infinite, default) to 604,800 of an event before it will be discarded; only for Kinesis and DynamoDB streams
  • MaximumRetryAttempts (number)
    • Maximum number of tries between -1 (infinite, default) to 10,000 before a record is discarded; Kinesis and DynamoDB only
  • ParallelizationFactor (number)
    • Number of batches between 1 to 10 that can be processed from each shard concurrently
  • Queues (array)
    • Array of exactly 1 string specifying the name of the Amazon MQ broker destination queue to consume
  • ScalingConfig (object)
  • SourceAccessConfigurations (array)
    • Array of at most 22 SourceAccessConfiguration objects to specifying authentication protocols or VPC components required to secure the event source
  • TumblingWindowInSeconds (number)
    • Time (in seconds) from 0 to 900 specifying the duration of a processing window for DynamoDB and Kinesis event stream sources

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)

UpdateFunctionEventInvokeConfig

Canonical AWS API doc

Properties:

  • FunctionName (string) [required]
    • The name of the Lambda function, version, or alias
  • DestinationConfig (object)
  • MaximumEventAgeInSeconds (number)
    • Set a maximum age in whole seconds between 60 and 21,600 (inclusive) for events to be processed
  • MaximumRetryAttempts (number)
    • Maximum number of tries between -1 (infinite, default) to 10,000 before a record is discarded; Kinesis and DynamoDB only

UpdateFunctionUrlConfig

Canonical AWS API doc

Properties:

  • FunctionName (string) [required]
    • The name of the Lambda function, version, or alias
  • AuthType (string)
    • Type of authentication that the function URL will use, either AWS_IAM or NONE
  • Cors (object)
  • InvokeMode (string)
    • Specify how the function will be invoked, either BUFFERED (default, uses the Invoke API operation) or RESPONSE_STREAM (streams results as they become available, uses the InvokeWithResponseStream API operation)
    • More details (AWS)
  • Qualifier (string)
    • Specify a version or alias to invoke a published version of the function

Deprecated methods

Methods yet to be implemented

Please help out by opening a PR!

Learn more

Dependents (2)

Package Sidebar

Install

npm i @aws-lite/lambda

Weekly Downloads

1,513

Version

0.1.5

License

Apache-2.0

Unpacked Size

100 kB

Total Files

4

Last publish

Collaborators

  • brianleroux
  • architectci
  • ryanblock