Skip to content

Latest commit

 

History

History
127 lines (103 loc) · 5.26 KB

API_FunctionConfiguration.md

File metadata and controls

127 lines (103 loc) · 5.26 KB

FunctionConfiguration

A Lambda function's configuration settings.

Contents

CodeSha256 The SHA256 hash of the function's deployment package.
Type: String
Required: No

CodeSize The size of the function's deployment package in bytes.
Type: Long
Required: No

DeadLetterConfig The function's dead letter queue.
Type: DeadLetterConfig object
Required: No

Description The function's description.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 256.
Required: No

Environment The function's environment variables.
Type: EnvironmentResponse object
Required: No

FunctionArn The function's Amazon Resource Name.
Type: String
Pattern: arn:(aws[a-zA-Z-]*)?:lambda:[a-z]{2}(-gov)?-[a-z]+-\d{1}:\d{12}:function:[a-zA-Z0-9-_\.]+(:(\$LATEST|[a-zA-Z0-9-_]+))?
Required: No

FunctionName The name of the function.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 170.
Pattern: (arn:(aws[a-zA-Z-]*)?:lambda:)?([a-z]{2}(-gov)?-[a-z]+-\d{1}:)?(\d{12}:)?(function:)?([a-zA-Z0-9-_\.]+)(:(\$LATEST|[a-zA-Z0-9-_]+))?
Required: No

Handler The function Lambda calls to begin executing your function.
Type: String
Length Constraints: Maximum length of 128.
Pattern: [^\s]+
Required: No

KMSKeyArn The KMS key used to encrypt the function's environment variables. Only returned if you've configured a customer managed CMK.
Type: String
Pattern: (arn:(aws[a-zA-Z-]*)?:[a-z0-9-.]+:.*)|()
Required: No

LastModified The date and time that the function was last updated, in ISO-8601 format (YYYY-MM-DDThh:mm:ss.sTZD).
Type: String
Required: No

Layers A list of function layers.
Type: Array of Layer objects
Required: No

MasterArn The ARN of the master function.
Type: String
Pattern: arn:(aws[a-zA-Z-]*)?:lambda:[a-z]{2}(-gov)?-[a-z]+-\d{1}:\d{12}:function:[a-zA-Z0-9-_]+(:(\$LATEST|[a-zA-Z0-9-_]+))?
Required: No

MemorySize The memory allocated to the function
Type: Integer
Valid Range: Minimum value of 128. Maximum value of 3008.
Required: No

RevisionId Represents the latest updated revision of the function or alias.
Type: String
Required: No

Role The function's execution role.
Type: String
Pattern: arn:(aws[a-zA-Z-]*)?:iam::\d{12}:role/?[a-zA-Z_0-9+=,.@\-_/]+
Required: No

Runtime The runtime environment for the Lambda function.
Type: String
Valid Values: nodejs | nodejs4.3 | nodejs6.10 | nodejs8.10 | java8 | python2.7 | python3.6 | python3.7 | dotnetcore1.0 | dotnetcore2.0 | dotnetcore2.1 | nodejs4.3-edge | go1.x | ruby2.5 | provided
Required: No

Timeout The amount of time that Lambda allows a function to run before terminating it.
Type: Integer
Valid Range: Minimum value of 1.
Required: No

TracingConfig The function's AWS X-Ray tracing configuration.
Type: TracingConfigResponse object
Required: No

Version The version of the Lambda function.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1024.
Pattern: (\$LATEST|[0-9]+)
Required: No

VpcConfig The function's networking configuration.
Type: VpcConfigResponse object
Required: No

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: