@aws-lite/lambda
Maintained by: @architect
Install
npm i @aws-lite/lambda
Optionally install types:
npm i -D @aws-lite/lambda-types
Methods
AddLayerVersionPermission
Properties
Action
(string) [required]-
The API action that grants access to the layer, for example
lambda:GetLayerVersion
LayerName
(string) [required]-
Name or ARN of the layer
StatementId
(string) [required]-
ID to distinguish the policy from other policies on the same layer version
VersionNumber
(number) [required]-
The version number of the layer
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 theOrganizationId
to grant permissions to all accounts in the specified organization 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
Example
await aws.Lambda.AddLayerVersionPermission({
Action: String, // required
LayerName: String, // required
StatementId: String, // required
VersionNumber: Number, // required
OrganizationId: String,
Principal: String,
RevisionId: String,
})
AddPermission
Properties
Action
(string) [required]-
Action that the principal can use on the function; for example,
lambda:InvokeFunction
FunctionName
(string) [required]-
The name of the Lambda function, version, or alias
Principal
(string) [required]-
The AWS service or AWS account that invokes the function
StatementId
(string) [required]-
A statement identifier that differentiates the statement from others in the same policy
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
PrincipalOrgID
(string)-
The identifier for your organization in AWS Organizations
Qualifier
(string)-
Specify a version or alias to invoke a published version 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 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
Example
await aws.Lambda.AddPermission({
Action: String, // required
FunctionName: String, // required
Principal: String, // required
StatementId: String, // required
EventSourceToken: String,
FunctionUrlAuthType: String,
PrincipalOrgID: String,
Qualifier: String,
RevisionId: String,
SourceAccount: String,
SourceArn: String,
})
CreateAlias
Properties
FunctionName
(string) [required]-
The name of the Lambda function, version, or alias
FunctionVersion
(string) [required]-
Version of the aliased function
Name
(string) [required]-
Name of the alias
Description
(string)-
Description of the function
RoutingConfig
(object)-
Configure function version weights
- Example
await aws.Lambda.CreateAlias({ FunctionName: String, // required FunctionVersion: String, // required Name: String, // required Description: String, RoutingConfig: Object, })
CreateCodeSigningConfig
Properties
AllowedPublishers
(object) [required]-
Signing profiles for this code signing configuration
- More details (AWS)
Description
(string)-
Description of the function
Example
await aws.Lambda.CreateCodeSigningConfig({
AllowedPublishers: Object, // required
CodeSigningPolicies: Object,
Description: String,
})
CreateEventSourceMapping
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)
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)
Enabled
(boolean)-
Set to
false
to disable event source upon creation EventSourceArn
(string)-
ARN of the event source
FilterCriteria
(object)-
Define how incoming events will be filtered
- 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)
SelfManagedEventSource
(object)-
A self managed
Apache Kafka
cluster to receive records from - 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 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) - Example
await aws.Lambda.CreateEventSourceMapping({ FunctionName: String, // required AmazonManagedKafkaEventSourceConfig: Object, BatchSize: Number, BisectBatchOnFunctionError: Boolean, DestinationConfig: Object, DocumentDBEventSourceConfig: Object, Enabled: Boolean, EventSourceArn: String, FilterCriteria: Object, FunctionResponseTypes: Array, MaximumBatchingWindowInSeconds: Number, MaximumRecordAgeInSeconds: Number, MaximumRetryAttempts: Number, ParallelizationFactor: Number, Queues: Array, ScalingConfig: Object, SelfManagedEventSource: Object, SelfManagedKafkaEventSourceConfig: Object, SourceAccessConfigurations: Array, StartingPosition: String, StartingPositionTimestamp: Object, Topics: Array, TumblingWindowInSeconds: Number, })
CreateFunction
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)
Description
(string)-
Description of the function
Environment
(object)-
Environment variable configuration
- More details (AWS)
FileSystemConfigs
(array)-
EFS file system connection settings
- More details (AWS)
ImageConfig
(object)-
Container image configuration (overrides Docker file)
- More details (AWS)
SnapStart
(object)-
SnapStart settings
- More details (AWS)
VpcConfig
(object)-
VPC networking configuration
- Example
await aws.Lambda.CreateFunction({ Code: Object, // required FunctionName: String, // required Role: String, // required Architectures: Array, CodeSigningConfigArn: String, DeadLetterConfig: Object, Description: String, Environment: Object, EphemeralStorage: Object, FileSystemConfigs: Array, Handler: String, ImageConfig: Object, KMSKeyArn: String, Layers: Array, MemorySize: Number, PackageType: String, Publish: Boolean, Runtime: String, SnapStart: Object, Tags: Array, Timeout: Number, TracingConfig: Object, VpcConfig: Object, })
CreateFunctionUrlConfig
Properties
AuthType
(string) [required]-
Type of authentication that the function URL will use, either
AWS_IAM
orNONE
FunctionName
(string) [required]-
The name of the Lambda function, version, or alias
Cors
(object)-
Cross-origin resource sharing settings
- More details (AWS)
Qualifier
(string)-
Specify a version or alias to invoke a published version of the function
Example
await aws.Lambda.CreateFunctionUrlConfig({
AuthType: String, // required
FunctionName: String, // required
Cors: Object,
InvokeMode: String,
Qualifier: String,
})
DeleteAlias
Properties
FunctionName
(string) [required]-
The name of the Lambda function, version, or alias
Name
(string) [required]-
Name of the alias
Example
await aws.Lambda.DeleteAlias({
FunctionName: String, // required
Name: String, // required
})
DeleteCodeSigningConfig
Properties
CodeSigningConfigArn
(string) [required]-
ARN of the code signing configuration
Example
await aws.Lambda.DeleteCodeSigningConfig({
CodeSigningConfigArn: String, // required
})
DeleteEventSourceMapping
Properties
UUID
(string) [required]-
UUID of the event source mapping
Example
await aws.Lambda.DeleteEventSourceMapping({
UUID: String, // required
})
DeleteFunction
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
Example
await aws.Lambda.DeleteFunction({
FunctionName: String, // required
Qualifier: String,
})
DeleteFunctionCodeSigningConfig
Properties
FunctionName
(string) [required]-
The name of the Lambda function, version, or alias
Example
await aws.Lambda.DeleteFunctionCodeSigningConfig({
FunctionName: String, // required
})
DeleteFunctionConcurrency
Properties
FunctionName
(string) [required]-
The name of the Lambda function, version, or alias
Example
await aws.Lambda.DeleteFunctionConcurrency({
FunctionName: String, // required
})
DeleteFunctionEventInvokeConfig
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
Example
await aws.Lambda.DeleteFunctionEventInvokeConfig({
FunctionName: String, // required
Qualifier: String,
})
DeleteFunctionUrlConfig
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
Example
await aws.Lambda.DeleteFunctionUrlConfig({
FunctionName: String, // required
Qualifier: String,
})
DeleteLayerVersion
Properties
LayerName
(string) [required]-
Name or ARN of the layer
VersionNumber
(number) [required]-
The version number of the layer
Example
await aws.Lambda.DeleteLayerVersion({
LayerName: String, // required
VersionNumber: Number, // required
})
DeleteProvisionedConcurrencyConfig
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
Example
await aws.Lambda.DeleteProvisionedConcurrencyConfig({
FunctionName: String, // required
Qualifier: String, // required
})
GetAccountSettings
Properties
Example
await aws.Lambda.GetAccountSettings()
GetAlias
Properties
FunctionName
(string) [required]-
The name of the Lambda function, version, or alias
Name
(string) [required]-
Name of the function alias
Example
await aws.Lambda.GetAlias({
FunctionName: String, // required
Name: String, // required
})
GetCodeSigningConfig
Properties
CodeSigningConfigArn
(string) [required]-
ARN of the code signing configuration
Example
await aws.Lambda.GetCodeSigningConfig({
CodeSigningConfigArn: String, // required
})
GetEventSourceMapping
Properties
UUID
(string) [required]-
ARN of the event source mapping
Example
await aws.Lambda.GetEventSourceMapping({
UUID: String, // required
})
GetFunction
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
Example
await aws.Lambda.GetFunction({
FunctionName: String, // required
Qualifier: String,
})
GetFunctionCodeSigningConfig
Properties
FunctionName
(string) [required]-
The name of the Lambda function, version, or alias
Example
await aws.Lambda.GetFunctionCodeSigningConfig({
FunctionName: String, // required
})
GetFunctionConcurrency
Properties
FunctionName
(string) [required]-
The name of the Lambda function, version, or alias
Example
await aws.Lambda.GetFunctionConcurrency({
FunctionName: String, // required
})
GetFunctionConfiguration
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
Example
await aws.Lambda.GetFunctionConfiguration({
FunctionName: String, // required
Qualifier: String,
})
GetFunctionEventInvokeConfig
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
Example
await aws.Lambda.GetFunctionEventInvokeConfig({
FunctionName: String, // required
Qualifier: String,
})
GetFunctionUrlConfig
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
Example
await aws.Lambda.GetFunctionUrlConfig({
FunctionName: String, // required
Qualifier: String,
})
GetLayerVersion
Properties
LayerName
(string) [required]-
Name or ARN of the layer
VersionNumber
(number) [required]-
The version number of the layer
Example
await aws.Lambda.GetLayerVersion({
LayerName: String, // required
VersionNumber: Number, // required
})
GetLayerVersionByArn
Properties
Arn
(string) [required]-
The ARN of the layer version
Example
await aws.Lambda.GetLayerVersionByArn({
Arn: String, // required
})
GetLayerVersionPolicy
Properties
LayerName
(string) [required]-
Name or ARN of the layer
VersionNumber
(number) [required]-
The version number of the layer
Example
await aws.Lambda.GetLayerVersionPolicy({
LayerName: String, // required
VersionNumber: Number, // required
})
GetPolicy
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
Example
await aws.Lambda.GetPolicy({
FunctionName: String, // required
Qualifier: String,
})
GetProvisionedConcurrencyConfig
Properties
FunctionName
(string) [required]-
The name of the Lambda function, version, or alias
Qualifier
(string) [required]-
The version number or alias name
Example
await aws.Lambda.GetProvisionedConcurrencyConfig({
FunctionName: String, // required
Qualifier: String, // required
})
GetRuntimeManagementConfig
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
Example
await aws.Lambda.GetRuntimeManagementConfig({
FunctionName: String, // required
Qualifier: String,
})
Invoke
Properties
FunctionName
(string) [required]-
The name of the Lambda function, version, or alias
Payload
(array, object) [required]-
Event payload to invoke function with
ClientContext
(string)-
Up to 3,583 bytes of base64-encoded data to pass to the function in the context object
InvocationType
(string)-
Set invocation type to one of:
RequestResponse
(default, synchronous),Event
(asynchronous),DryRun
(validate invoke request only) LogType
(string)-
Set to
Tail
to include the execution log in theX-Amz-Log-Result
response header of synchronously invoked functions Qualifier
(string)-
Specify a version or alias to invoke a published version of the function
Example
await aws.Lambda.Invoke({
FunctionName: String, // required
Payload: Array || Object, // required
ClientContext: String,
InvocationType: String,
LogType: String,
Qualifier: String,
})
ListAliases
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
Example
await aws.Lambda.ListAliases({
FunctionName: String, // required
FunctionVersion: String,
Marker: String,
MaxItems: Number,
paginate: Boolean || String,
})
ListCodeSigningConfigs
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
Example
await aws.Lambda.ListCodeSigningConfigs({
Marker: String,
MaxItems: Number,
paginate: Boolean || String,
})
ListEventSourceMappings
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
Example
await aws.Lambda.ListEventSourceMappings({
EventSourceArn: String,
FunctionName: String,
Marker: String,
MaxItems: Number,
paginate: Boolean || String,
})
ListFunctionEventInvokeConfigs
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
Example
await aws.Lambda.ListFunctionEventInvokeConfigs({
FunctionName: String, // required
Marker: String,
MaxItems: Number,
paginate: Boolean || String,
})
ListFunctions
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 - Example
await aws.Lambda.ListFunctions({ FunctionVersion: String, Marker: String, MasterRegion: String, MaxItems: Number, paginate: Boolean || String, })
ListFunctionsByCodeSigningConfig
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
Example
await aws.Lambda.ListFunctionsByCodeSigningConfig({
CodeSigningConfigArn: String, // required
Marker: String,
MaxItems: Number,
paginate: Boolean || String,
})
ListFunctionUrlConfigs
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
Example
await aws.Lambda.ListFunctionUrlConfigs({
FunctionName: String, // required
Marker: String,
MaxItems: Number,
paginate: Boolean || String,
})
ListLayers
Properties
CompatibleArchitecture
(string)-
Set instruction set architecture to one of:
x86_64
,arm64
CompatibleRuntime
(string)-
Set the runtime identifier
- Example
await aws.Lambda.ListLayers({ CompatibleArchitecture: String, CompatibleRuntime: String, Marker: String, MaxItems: Number, paginate: Boolean || String, })
ListLayerVersions
Properties
LayerName
(string) [required]-
Name or ARN of the layer
CompatibleArchitecture
(string)-
Set instruction set architecture to one of:
x86_64
,arm64
CompatibleRuntime
(string)-
Set the runtime identifier
- Example
await aws.Lambda.ListLayerVersions({ LayerName: String, // required CompatibleArchitecture: String, CompatibleRuntime: String, Marker: String, MaxItems: Number, paginate: Boolean || String, })
ListProvisionedConcurrencyConfigs
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
Example
await aws.Lambda.ListProvisionedConcurrencyConfigs({
FunctionName: String, // required
Marker: String,
MaxItems: Number,
paginate: Boolean || String,
})
ListTags
Properties
Resource
(string) [required]-
ARN of the lambda function
Example
await aws.Lambda.ListTags({
Resource: String, // required
})
ListVersionsByFunction
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
Example
await aws.Lambda.ListVersionsByFunction({
FunctionName: String, // required
Marker: String,
MaxItems: Number,
paginate: Boolean || String,
})
PublishLayerVersion
Properties
Content
(object) [required]-
Contents of the layer; object can contain:
S3Bucket
,S3Key
,S3ObjectVersion
, orZipFile
(base64-encoded zip) - More details (AWS)
CompatibleRuntimes
(array)-
Array with a maximum of 15 strings specifying compatible runtime environments
- More details (AWS)
Example
await aws.Lambda.PublishLayerVersion({
Content: Object, // required
CompatibleArchitectures: Array,
CompatibleRuntimes: Array,
Description: String,
LiscenceInfo: String,
})
PublishVersion
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
- Example
await aws.Lambda.PublishVersion({ FunctionName: String, // required CodeSha256: String, Description: String, RevisionId: String, })
PutFunctionCodeSigningConfig
Properties
CodeSigningConfigArn
(string) [required]-
ARN of the code signing configuration
FunctionName
(string) [required]-
The name of the Lambda function, version, or alias
Example
await aws.Lambda.PutFunctionCodeSigningConfig({
CodeSigningConfigArn: String, // required
FunctionName: String, // required
})
PutFunctionConcurrency
Properties
FunctionName
(string) [required]-
The name of the Lambda function, version, or alias
ReservedConcurrentExecutions
(number) [required]-
number of simultaneous executions to reserve
Example
await aws.Lambda.PutFunctionConcurrency({
FunctionName: String, // required
ReservedConcurrentExecutions: Number, // required
})
PutFunctionEventInvokeConfig
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
- Example
await aws.Lambda.PutFunctionEventInvokeConfig({ FunctionName: String, // required DestinationConfig: Object, MaximumEventAgeInSeconds: Number, MaximumRetryAttempts: Number, Qualifier: String, })
PutProvisionedConcurrencyConfig
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
Example
await aws.Lambda.PutProvisionedConcurrencyConfig({
FunctionName: String, // required
ProvisionedConcurrentExecutions: Number, // required
Qualifier: String, // required
})
PutRuntimeManagementConfig
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)
RuntimeVersionArn
(string)-
ARN of the runtime version the function will use
Example
await aws.Lambda.PutRuntimeManagementConfig({
FunctionName: String, // required
UpdateRuntimeOn: String, // required
Qualifier: String,
RuntimeVersionArn: String,
})
RemoveLayerVersionPermission
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
Example
await aws.Lambda.RemoveLayerVersionPermission({
LayerName: String, // required
StatementId: String, // required
VersionNumber: Number, // required
RevisionId: String,
})
RemovePermission
Properties
FunctionName
(string) [required]-
The name of the Lambda function, version, or alias
StatementId
(string) [required]-
Statement ID of the permission to remove
Qualifier
(string)-
Specify a version or alias to invoke a published version 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
Example
await aws.Lambda.RemovePermission({
FunctionName: String, // required
StatementId: String, // required
Qualifier: String,
RevisionId: String,
})
TagResource
Properties
Resource
(string) [required]-
ARN of the lambda function
Tags
(object) [required]-
Record of tags to be applied to the function
- Example
await aws.Lambda.TagResource({ Resource: String, // required Tags: Object, // required })
UntagResource
Properties
Resource
(string) [required]-
ARN of the lambda function
TagKeys
(array) [required]-
Array of tag keys (strings) to removed from the function
Example
await aws.Lambda.UntagResource({
Resource: String, // required
TagKeys: Array, // required
})
UpdateAlias
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)-
Configure function version weights
- Example
await aws.Lambda.UpdateAlias({ FunctionName: String, // required Name: String, // required Description: String, FunctionVersion: String, RevisionId: String, RoutingConfig: Object, })
UpdateCodeSigningConfig
Properties
CodeSigningConfigArn
(string) [required]-
ARN of the code signing configuration
AllowedPublishers
(object)-
Signing profiles for this code signing configuration
- More details (AWS)
Description
(string)-
Description of the function
Example
await aws.Lambda.UpdateCodeSigningConfig({
CodeSigningConfigArn: String, // required
AllowedPublishers: Object,
CodeSigningPolicies: Object,
Description: String,
})
UpdateEventSourceMapping
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)
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)
Enabled
(boolean)-
Set to
false
to disable event source upon creation FilterCriteria
(object)-
Define how incoming events will be filtered
- 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)
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
andKinesis
event stream sources
Example
await aws.Lambda.UpdateEventSourceMapping({
UUID: String, // required
AmazonManagedKafkaEventSourceConfig: Object,
BatchSize: Number,
BisectBatchOnFunctionError: Boolean,
DestinationConfig: Object,
DocumentDBEventSourceConfig: Object,
Enabled: Boolean,
FilterCriteria: Object,
FunctionName: String,
FunctionResponseTypes: Array,
MaximumBatchingWindowInSeconds: Number,
MaximumRecordAgeInSeconds: Number,
MaximumRetryAttempts: Number,
ParallelizationFactor: Number,
Queues: Array,
ScalingConfig: Object,
SourceAccessConfigurations: Array,
TumblingWindowInSeconds: Number,
})
UpdateFunctionCode
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
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 callingPublishVersion
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
Example
await aws.Lambda.UpdateFunctionCode({
FunctionName: String, // required
Architectures: Array,
DryRun: String,
ImageUri: String,
Publish: Boolean,
RevisionId: String,
S3Bucket: String,
S3Key: String,
S3ObjectVersion: String,
ZipFile: String || Buffer,
})
UpdateFunctionConfiguration
Properties
FunctionName
(string) [required]-
The name of the Lambda function, version, or alias
DeadLetterConfig
(object)-
Dead-letter queue configuration
- More details (AWS)
EphemeralStorage
(object)-
Size of the function
/tmp
directory (in MB), from 512 (default) to 10240 - 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)
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)-
Runtime identifier
- 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)
Example
await aws.Lambda.UpdateFunctionConfiguration({
FunctionName: String, // required
DeadLetterConfig: Object,
Description: String,
Environment: Object,
EphemeralStorage: Object,
FileSystemConfigs: Array,
Handler: String,
ImageConfig: Object,
KMSKeyArn: String,
Layers: Array,
MemorySize: Number,
RevisionId: String,
Role: String,
Runtime: String,
SnapStart: Object,
Timeout: Number,
TracingConfig: Object,
VpcConfig: Object,
})
UpdateFunctionEventInvokeConfig
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
- Example
await aws.Lambda.UpdateFunctionEventInvokeConfig({ FunctionName: String, // required DestinationConfig: Object, MaximumEventAgeInSeconds: Number, MaximumRetryAttempts: Number, })
UpdateFunctionUrlConfig
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
Cors
(object)-
Cross-origin resource sharing settings
- More details (AWS)
Qualifier
(string)-
Specify a version or alias to invoke a published version of the function
Example
await aws.Lambda.UpdateFunctionUrlConfig({
FunctionName: String, // required
AuthType: String,
Cors: Object,
InvokeMode: String,
Qualifier: String,
})
Deprecated methods
Methods yet to be implemented
Please help out by opening a PR!