Skip to content

Latest commit

 

History

History
126 lines (99 loc) · 5.81 KB

API_FunctionConfiguration.md

File metadata and controls

126 lines (99 loc) · 5.81 KB

FunctionConfiguration

A complex type that describes function metadata.

Contents

CodeSha256 It is the SHA256 hash of your function deployment package.
Type: String
Required: No

CodeSize The size, in bytes, of the function .zip file you uploaded.
Type: Long
Required: No

DeadLetterConfig The parent object that contains the target ARN (Amazon Resource Name) of an Amazon SQS queue or Amazon SNS topic. For more information, see Dead Letter Queues.
Type: DeadLetterConfig object
Required: No

Description The user-provided description.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 256.
Required: No

Environment The parent object that contains your environment's configuration settings.
Type: EnvironmentResponse object
Required: No

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

FunctionName The name of the function. Note that the length constraint applies only to the ARN. If you specify only the function name, it is limited to 64 characters in length.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 170.
Pattern: (arn:aws:lambda:)?([a-z]{2}-[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 Amazon Resource Name (ARN) of the KMS key used to encrypt your function's environment variables. If empty, it means you are using the AWS Lambda default service key.
Type: String
Pattern: (arn:aws:[a-z0-9-.]+:.*)|()
Required: No

LastModified The time stamp of the last time you updated the function. The time stamp is conveyed as a string complying with ISO-8601 in this way YYYY-MM-DDThh:mm:ssTZD (e.g., 1997-07-16T19:20:30+01:00). For more information, see Date and Time Formats.
Type: String
Required: No

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

MemorySize The memory size, in MB, you configured for the function. Must be a multiple of 64 MB.
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 Amazon Resource Name (ARN) of the IAM role that Lambda assumes when it executes your function to access any other Amazon Web Services (AWS) resources.
Type: String
Pattern: arn:aws: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 | java8 | python2.7 | python3.6 | dotnetcore1.0 | dotnetcore2.0 | nodejs4.3-edge | go1.x
Required: No

Timeout The function execution time at which Lambda should terminate the function. Because the execution time has cost implications, we recommend you set this value based on your expected execution time. The default is 3 seconds.
Type: Integer
Valid Range: Minimum value of 1.
Required: No

TracingConfig The parent object that contains your function's tracing settings.
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 VPC configuration associated with your Lambda function.
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: