Official
aws-lite
plugin for Lambda
Maintained by: @architect
npm i @aws-lite/lambda
Optionally install types:
npm i -D @aws-lite/lambda-types
Reference documentation with examples at aws-lite.org
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
- Update the function config only if the current revision ID matches the specified
-
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
- The API action that grants access to the layer, for example
-
OrganizationId
(string)- When
Principal
is set to*
, permission will be granted to all accounts in the specified organization
- When
-
Principal
(string)- Account ID being granted permissions. Use
*
along with theOrganizationId
to grant permissions to all accounts in the specified organization
- Account ID being granted permissions. Use
-
StatementId
(string) [required]- ID to distinguish the policy from other policies on the same layer version
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
- Action that the principal can use on the function; for example,
-
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
- Update the function config only if the current revision ID matches the specified
-
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
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)- Configure function version weights
- More details (AWS)
Properties:
-
AllowedPublishers
(object) [required]- Signing profiles for this code signing configuration
- More details (AWS)
-
CodeSigningPolicies
(object)- Define actions to take if validation checks fail
- More details (AWS)
-
Description
(string)- Description of the function
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)- Specify the destination of an event after being processed by Lambda
- More details (AWS)
-
DocumentDBEventSourceConfig
(object)- Configuration for a
DocumentDB
event source - More details (AWS)
- Configuration for a
-
Enabled
(boolean)- Set to
false
to disable event source upon creation
- Set to
-
EventSourceArn
(string)- ARN of the event source
-
FilterCriteria
(object)- Define how incoming events will be filtered
- More details (AWS)
-
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
andDynamoDB
streams
- Maximum age between -1 (infinite, default) to 604,800 of an event before it will be discarded; only for
-
MaximumRetryAttempts
(number)- Maximum number of tries between -1 (infinite, default) to 10,000 before a record is discarded;
Kinesis
andDynamoDB
only
- Maximum number of tries between -1 (infinite, default) to 10,000 before a record is discarded;
-
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
- Array of exactly 1 string specifying the name of the
-
ScalingConfig
(object)- Configure scaling for the event source; Amazon SQS only
- More details (AWS)
-
SelfManagedEventSource
(object)- A self managed
Apache Kafka
cluster to receive records from - More details (AWS)
- A self managed
-
SelfManagedKafkaEventSourceConfig
(object)- Configure a self managed
Apache Kafka
event source - More details (AWS)
- Configure a self managed
-
SourceAccessConfigurations
(array)- Array of at most 22
SourceAccessConfiguration
objects to specifying authentication protocols or VPC components required to secure the event source
- Array of at most 22
-
StartingPosition
(string)- Position in a stream to begin reading, valid entries are
TRIM_HORIZON
(all available messages),LATEST
(from now or after) orAT_TIMESTAMP
(specify timestamp) - More details (AWS)
- Position in a stream to begin reading, valid entries are
-
StartingPositionTimestamp
(object)- The
timestamp
inUnix time seconds
used whenStartingPosition
is set toAT_TIMESTAMP
; cannot be in the future
- The
-
Topics
(array)- Array of exactly 1 string specifying the name of the
Kafka
topic
- Array of exactly 1 string specifying the name of the
-
TumblingWindowInSeconds
(number)- Time (in seconds) from 0 to 900 specifying the duration of a processing window for
DynamoDB
andKinesis
event stream sources
- Time (in seconds) from 0 to 900 specifying the duration of a processing window for
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), orZipFile
(base64-encoded zip) - More details (AWS)
- Code payload to be run in Lambda; object can contain:
-
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) orarm64
- System architecture, array can contain either
-
CodeSigningConfigArn
(string)- ARN of a code-signing configuration used to enable code signing for this function
-
DeadLetterConfig
(object)- Dead-letter queue configuration
- More details (AWS)
-
Description
(string)- Description of the function
-
Environment
(object)- Environment variable configuration
- More details (AWS)
-
EphemeralStorage
(object)- Size of the function
/tmp
directory (in MB), from 512 (default) to 10240 - More details (AWS)
- Size of the function
-
FileSystemConfigs
(array)- EFS file system connection settings
- More details (AWS)
-
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)
- The name of the handler file and method method within your code that Lambda calls to run your function (e.g.
-
ImageConfig
(object)- Container image configuration (overrides Docker file)
- More details (AWS)
-
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) orZip
(zip archive)
- Deployment package type, either
-
Publish
(boolean)- Set to
true
to publish the first version of the function during creation
- Set to
-
Runtime
(string)- Runtime identifier
- More details (AWS)
-
SnapStart
(object)- SnapStart settings
- More details (AWS)
-
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)- Sample and trace a subset of incoming requests with X-Ray
- More details (AWS)
-
VpcConfig
(object)- VPC networking configuration
- More details (AWS)
Properties:
-
AuthType
(string) [required]- Type of authentication that the function URL will use, either
AWS_IAM
orNONE
- Type of authentication that the function URL will use, either
-
FunctionName
(string) [required]- The name of the Lambda function, version, or alias
-
Cors
(object)- Cross-origin resource sharing settings
- More details (AWS)
-
InvokeMode
(string)- Specify how the function will be invoked, either
BUFFERED
(default, uses theInvoke
API operation) orRESPONSE_STREAM
(streams results as they become available, uses theInvokeWithResponseStream
API operation) - More details (AWS)
- Specify how the function will be invoked, either
-
Qualifier
(string)- Specify a version or alias to invoke a published version of the function
Properties:
-
FunctionName
(string) [required]- The name of the Lambda function, version, or alias
-
Name
(string) [required]- Name of the alias
Properties:
-
CodeSigningConfigArn
(string) [required]- ARN of the code signing configuration
Properties:
-
UUID
(string) [required]- UUID of the event source mapping
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
Properties:
-
FunctionName
(string) [required]- The name of the Lambda function, version, or alias
Properties:
-
FunctionName
(string) [required]- The name of the Lambda function, version, or alias
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
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
Properties:
-
LayerName
(string) [required]- Name or ARN of the layer
-
VersionNumber
(number) [required]- The version number of the layer
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
Properties:
Properties:
-
FunctionName
(string) [required]- The name of the Lambda function, version, or alias
-
Name
(string) [required]- Name of the function alias
Properties:
-
CodeSigningConfigArn
(string) [required]- ARN of the code signing configuration
Properties:
-
UUID
(string) [required]- ARN of the event source mapping
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
Properties:
-
FunctionName
(string) [required]- The name of the Lambda function, version, or alias
Properties:
-
FunctionName
(string) [required]- The name of the Lambda function, version, or alias
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
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
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
Properties:
-
LayerName
(string) [required]- Name or ARN of the layer
-
VersionNumber
(number) [required]- The version number of the layer
Properties:
-
Arn
(string) [required]- The ARN of the layer version
Properties:
-
LayerName
(string) [required]- Name or ARN of the layer
-
VersionNumber
(number) [required]- The version number of the layer
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
Properties:
-
FunctionName
(string) [required]- The name of the Lambda function, version, or alias
-
Qualifier
(string) [required]- The version number or alias name
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
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)
- Set invocation type to one of:
-
Payload
(array, object) [required]- Event payload to invoke function with
-
LogType
(string)- Set to
Tail
to include the execution log in theX-Amz-Log-Result
response header of synchronously invoked functions
- Set to
-
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
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
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
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
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
Properties:
-
FunctionVersion
(string)- Set to
ALL
to include entries for all published versions
- Set to
-
Marker
(string)- Pagination token
-
MasterRegion
(string)- Display
LambdaEdge
functions replicated from a master function in a specified region - More details (AWS)
- Display
-
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
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
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
Properties:
-
CompatibleArchitecture
(string)- Set instruction set architecture to one of:
x86_64
,arm64
- Set instruction set architecture to one of:
-
CompatibleRuntime
(string)- Set the runtime identifier
- More details (AWS)
-
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
Properties:
-
LayerName
(string) [required]- Name or ARN of the layer
-
CompatibleArchitecture
(string)- Set instruction set architecture to one of:
x86_64
,arm64
- Set instruction set architecture to one of:
-
CompatibleRuntime
(string)- Set the runtime identifier
- More details (AWS)
-
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
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
Properties:
-
Resource
(string) [required]- ARN of the lambda function
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
Properties:
-
Content
(object) [required]- Contents of the layer; object can contain:
S3Bucket
,S3Key
,S3ObjectVersion
, orZipFile
(base64-encoded zip) - More details (AWS)
- Contents of the layer; object can contain:
-
CompatibleArchitectures
(array)- Array with a maximum of 2 strings specifying instruction set architecture; array can contain:
x86_64
,arm64
- More details (AWS)
- Array with a maximum of 2 strings specifying instruction set architecture; array can contain:
-
CompatibleRuntimes
(array)- Array with a maximum of 15 strings specifying compatible runtime environments
- More details (AWS)
-
Description
(string)- Description of the function
-
LiscenceInfo
(string)- The layer's software license
- More details (AWS)
Properties:
-
FunctionName
(string) [required]- The name of the Lambda function, version, or alias
-
CodeSha256
(string)- Checksum to confirm the function has not changed since being updated
- More details (AWS)
-
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
- Update the function config only if the current revision ID matches the specified
Properties:
-
FunctionName
(string) [required]- The name of the Lambda function, version, or alias
-
CodeSigningConfigArn
(string) [required]- ARN of the code signing configuration
Properties:
-
FunctionName
(string) [required]- The name of the Lambda function, version, or alias
-
ReservedConcurrentExecutions
(number) [required]- number of simultaneous executions to reserve
Properties:
-
FunctionName
(string) [required]- The name of the Lambda function, version, or alias
-
DestinationConfig
(object)- Specify the destination of an event after being processed by Lambda
- More details (AWS)
-
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
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
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)
- Specify the runtime update mode; can be one of:
-
Qualifier
(string)- Specify a version of the function
- More details (AWS)
-
RuntimeVersionArn
(string)- ARN of the runtime version the function will use
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
- Update the function config only if the current revision ID matches the specified
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
- Update the function config only if the current revision ID matches the specified
-
Qualifier
(string)- Specify a version or alias to invoke a published version of the function
Properties:
-
Resource
(string) [required]- ARN of the lambda function
-
Tags
(object) [required]- Record of tags to be applied to the function
- More details (AWS)
Properties:
-
Resource
(string) [required]- ARN of the lambda function
-
TagKeys
(array) [required]- Array of tag keys (strings) to removed from the function
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
- Update the function config only if the current revision ID matches the specified
-
RoutingConfig
(object)- Configure function version weights
- More details (AWS)
Properties:
-
CodeSigningConfigArn
(string) [required]- ARN of the code signing configuration
-
AllowedPublishers
(object)- Signing profiles for this code signing configuration
- More details (AWS)
-
CodeSigningPolicies
(object)- Define actions to take if validation checks fail
- More details (AWS)
-
Description
(string)- Description of the function
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)- Specify the destination of an event after being processed by Lambda
- More details (AWS)
-
DocumentDBEventSourceConfig
(object)- Configuration for a
DocumentDB
event source - More details (AWS)
- Configuration for a
-
Enabled
(boolean)- Set to
false
to disable event source upon creation
- Set to
-
FilterCriteria
(object)- Define how incoming events will be filtered
- More details (AWS)
-
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
andDynamoDB
streams
- Maximum age between -1 (infinite, default) to 604,800 of an event before it will be discarded; only for
-
MaximumRetryAttempts
(number)- Maximum number of tries between -1 (infinite, default) to 10,000 before a record is discarded;
Kinesis
andDynamoDB
only
- Maximum number of tries between -1 (infinite, default) to 10,000 before a record is discarded;
-
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
- Array of exactly 1 string specifying the name of the
-
ScalingConfig
(object)- Configure scaling for the event source; Amazon SQS only
- More details (AWS)
-
SourceAccessConfigurations
(array)- Array of at most 22
SourceAccessConfiguration
objects to specifying authentication protocols or VPC components required to secure the event source
- Array of at most 22
-
TumblingWindowInSeconds
(number)- Time (in seconds) from 0 to 900 specifying the duration of a processing window for
DynamoDB
andKinesis
event stream sources
- Time (in seconds) from 0 to 900 specifying the duration of a processing window for
Properties:
-
FunctionName
(string) [required]- The name of the Lambda function, version, or alias
-
Architectures
(array)- System architecture, array can contain either
x86_64
(default) orarm64
- System architecture, array can contain either
-
DryRun
(string)- Validate the request parameters and access permissions without modifying the function code (
true
)
- Validate the request parameters and access permissions without modifying the function code (
-
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 callingPublishVersion
- Publish a new version after after updating the code (
-
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
- Update the function config only if the current revision ID matches the specified
-
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
Properties:
-
FunctionName
(string) [required]- The name of the Lambda function, version, or alias
-
DeadLetterConfig
(object)- Dead-letter queue configuration
- More details (AWS)
-
Description
(string)- Description of the function
-
Environment
(object)- Environment variable configuration
- More details (AWS)
-
EphemeralStorage
(object)- Size of the function
/tmp
directory (in MB), from 512 (default) to 10240 - More details (AWS)
- Size of the function
-
FileSystemConfigs
(array)- EFS file system connection settings
- More details (AWS)
-
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)
- The name of the handler file and method method within your code that Lambda calls to run your function (e.g.
-
ImageConfig
(object)- Container image configuration (overrides Docker file)
- More details (AWS)
-
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
- Update the function config only if the current revision ID matches the specified
-
Role
(string)- ARN of the function's execution role
-
Runtime
(string)- Runtime identifier
- More details (AWS)
-
SnapStart
(object)- SnapStart settings
- More details (AWS)
-
Timeout
(number)- Time (in seconds) a function is allowed to run before being stopped, from 3 (default) to 900
-
TracingConfig
(object)- Sample and trace a subset of incoming requests with X-Ray
- More details (AWS)
-
VpcConfig
(object)- VPC networking configuration
- More details (AWS)
Properties:
-
FunctionName
(string) [required]- The name of the Lambda function, version, or alias
-
DestinationConfig
(object)- Specify the destination of an event after being processed by Lambda
- More details (AWS)
-
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
andDynamoDB
only
- Maximum number of tries between -1 (infinite, default) to 10,000 before a record is discarded;
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
orNONE
- Type of authentication that the function URL will use, either
-
Cors
(object)- Cross-origin resource sharing settings
- More details (AWS)
-
InvokeMode
(string)- Specify how the function will be invoked, either
BUFFERED
(default, uses theInvoke
API operation) orRESPONSE_STREAM
(streams results as they become available, uses theInvokeWithResponseStream
API operation) - More details (AWS)
- Specify how the function will be invoked, either
-
Qualifier
(string)- Specify a version or alias to invoke a published version of the function
Please help out by opening a PR!