Skip to main content

functions

Creates, updates, deletes or gets a function resource or lists functions in a region

Overview​

Namefunctions
TypeResource
Description
The AWS::Lambda::Function resource creates a Lambda function. To create a function, you need a deployment package and an execution role. The deployment package is a .zip file archive or container image that contains your function code. The execution role grants the function permission to use AWS services, such as Amazon CloudWatch Logs for log streaming and AWS X-Ray for request tracing.You set the package type to Image if the deployment package is a container image. For these functions, include the URI of the container image in the ECR registry in the ImageUri property of the Code property. You do not need to specify the handler and runtime properties.
You set the package type to Zip if the deployment package is a .zip file archive. For these functions, specify the S3 location of your .zip file in the Code property. Alternatively, for Node.js and Python functions, you can define your function inline in the ZipFile property of the Code property. In both cases, you must also specify the handler and runtime properties.
You can use code signing if your deployment package is a .zip file archive. To enable code signing for this function, specify the ARN of a code-signing configuration. When a user attempts to deploy a code package with UpdateFunctionCode, Lambda checks that the code package has a valid signature from a trusted publisher. The code-signing configuration includes a set of signing profiles, which define the trusted publishers for this function.
When you update a AWS::Lambda::Function resource, CFNshort calls the UpdateFunctionConfiguration and UpdateFunctionCodeLAM APIs under the hood. Because these calls happen sequentially, and invocations can happen between these calls, your function may encounter errors in the time between the calls. For example, if you remove an environment variable, and the code that references that environment variable in the same CFNshort update, you may see invocation errors related to a missing environment variable. To work around this, you can invoke your function against a version or alias by default, rather than the $LATEST version.
Note that you configure provisioned concurrency on a AWS::Lambda::Version or a AWS::Lambda::Alias.
For a complete introduction to Lambda functions, see What is Lambda? in the Lambda developer guide.
Idawscc.lambda.functions

Fields​

NameDatatypeDescription
descriptionstringA description of the function.
▶tracing_configobjectSet Mode to Active to sample and trace a subset of incoming requests with X-Ray.
▶vpc_configobjectFor network connectivity to AWS resources in a VPC, specify a list of security groups and subnets in the VPC. When you connect a function to a VPC, it can access resources and the internet only through that VPC. For more information, see Configuring a Lambda function to access resources in a VPC.
▶runtime_management_configobjectSets the runtime management configuration for a function's version. For more information, see Runtime updates.
reserved_concurrent_executionsintegerThe number of simultaneous executions to reserve for the function.
▶snap_startobjectThe function's SnapStart setting.
▶file_system_configsarray
Connection settings for an Amazon EFS file system. To connect a function to a file system, a mount target must be available in every Availability Zone that your function connects to. If your template contains an AWS::EFS::MountTarget resource, you must also specify a DependsOn attribute to ensure that the mount target is created or updated before the function.For more information about using the DependsOn attribute, see DependsOn Attribute.
function_namestring
The name of the Lambda function, up to 64 characters in length. If you don't specify a name, CFN generates one.If you specify a name, you cannot perform updates that require replacement of this resource. You can perform updates that require no or some interruption. If you must replace the resource, specify a new name.
runtimestring
The identifier of the function's runtime. Runtime is required if the deployment package is a .zip file archive. Specifying a runtime results in an error if you're deploying a function using a container image.The following list includes deprecated runtimes. Lambda blocks creating new functions and updating existing functions shortly after each runtime is deprecated. For more information, see Runtime use after deprecation.
For a list of all currently supported runtimes, see Supported runtimes.
kms_key_arnstring
The ARN of the KMSlong (KMS) customer managed key that's used to encrypt the following resources:+ The function's environment variables.
+ The function's Lambda SnapStart snapshots.
+ When used with SourceKMSKeyArn, the unzipped version of the .zip deployment package that's used for function invocations. For more information, see Specifying a customer managed key for Lambda.
+ The optimized version of the container image that's used for function invocations. Note that this is not the same key that's used to protect your container image in the Amazon Elastic Container Registry (Amazon ECR). For more information, see Function lifecycle.
If you don't provide a customer managed key, Lambda uses an owned key or an [](https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#aws-managed-cmk).
package_typestringThe type of deployment package. Set to Image for container image and set Zip for .zip file archive.
code_signing_config_arnstringTo enable code signing for this function, specify the ARN of a code-signing configuration. A code-signing configuration includes a set of signing profiles, which define the trusted publishers for this function.
layersarrayA list of function layers to add to the function's execution environment. Specify each layer by its ARN, including the version.
▶tagsarray
A list of tags to apply to the function.You must have the lambda:TagResource, lambda:UntagResource, and lambda:ListTags permissions for your principal to manage the CFN stack. If you don't have these permissions, there might be unexpected behavior with stack-level tags propagating to the resource during resource creation and update.
▶image_configobjectConfiguration values that override the container image Dockerfile settings. For more information, see Container image settings.
memory_sizeintegerThe amount of memory available to the function at runtime. Increasing the function memory also increases its CPU allocation. The default value is 128 MB. The value can be any multiple of 1 MB. Note that new AWS accounts have reduced concurrency and memory quotas. AWS raises these quotas automatically based on your usage. You can also request a quota increase.
▶dead_letter_configobjectA dead-letter queue configuration that specifies the queue or topic where Lambda sends asynchronous events when they fail processing. For more information, see Dead-letter queues.
timeoutintegerThe amount of time (in seconds) that Lambda allows a function to run before stopping it. The default is 3 seconds. The maximum allowed value is 900 seconds. For more information, see Lambda execution environment.
handlerstringThe name of the method within your code that Lambda calls to run your function. Handler is required if the deployment package is a .zip file archive. The format includes the file name. It can also include namespaces and other qualifiers, depending on the runtime. For more information, see Lambda programming model.
▶snap_start_responseobjectThe function's SnapStart setting.
▶codeobject
The code for the function. You can define your function code in multiple ways:+ For .zip deployment packages, you can specify the S3 location of the .zip file in the S3Bucket, S3Key, and S3ObjectVersion properties.
+ For .zip deployment packages, you can alternatively define the function code inline in the ZipFile property. This method works only for Node.js and Python functions.
+ For container images, specify the URI of your container image in the ECR registry in the ImageUri property.
rolestringThe Amazon Resource Name (ARN) of the function's execution role.
▶logging_configobjectThe function's Amazon CloudWatch Logs configuration settings.
recursive_loopstring
The status of your function's recursive loop detection configuration.When this value is set to Allowand Lambda detects your function being invoked as part of a recursive loop, it doesn't take any action.
When this value is set to Terminate and Lambda detects your function being invoked as part of a recursive loop, it stops your function being invoked and notifies you.
▶environmentobjectEnvironment variables that are accessible from function code during execution.
arnstring
▶ephemeral_storageobjectThe size of the function's /tmp directory in MB. The default value is 512, but it can be any whole number between 512 and 10,240 MB.
architecturesarrayThe instruction set architecture that the function supports. Enter a string array with one of the valid values (arm64 or x86_64). The default value is x86_64.
regionstringAWS region.

For more information, see AWS::Lambda::Function.

Methods​

NameResourceAccessible byRequired Params
create_resourcefunctionsINSERTCode, Role, region
delete_resourcefunctionsDELETEIdentifier, region
update_resourcefunctionsUPDATEIdentifier, PatchDocument, region
list_resourcesfunctions_list_onlySELECTregion
get_resourcefunctionsSELECTIdentifier, region

SELECT examples​

Gets all properties from an individual function.

SELECT
  region,
  description,
  tracing_config,
  vpc_config,
  runtime_management_config,
  reserved_concurrent_executions,
  snap_start,
  file_system_configs,
  function_name,
  runtime,
  kms_key_arn,
  package_type,
  code_signing_config_arn,
  layers,
  tags,
  image_config,
  memory_size,
  dead_letter_config,
  timeout,
  handler,
  snap_start_response,
  code,
  role,
  logging_config,
  recursive_loop,
  environment,
  arn,
  ephemeral_storage,
  architectures
FROM awscc.lambda.functions
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ function_name }}';

INSERT example​

Use the following StackQL query and manifest file to create a new function resource, using stack-deploy.

/*+ create */
INSERT INTO awscc.lambda.functions (
  Code,
  Role,
  region
)
SELECT
  '{{ code }}',
  '{{ role }}',
  '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

UPDATE example​

Use the following StackQL query and manifest file to update a function resource, using stack-deploy.

/*+ update */
UPDATE awscc.lambda.functions
SET PatchDocument = string('{{ {
    "Description": description,
    "TracingConfig": tracing_config,
    "VpcConfig": vpc_config,
    "RuntimeManagementConfig": runtime_management_config,
    "ReservedConcurrentExecutions": reserved_concurrent_executions,
    "SnapStart": snap_start,
    "FileSystemConfigs": file_system_configs,
    "Runtime": runtime,
    "KmsKeyArn": kms_key_arn,
    "CodeSigningConfigArn": code_signing_config_arn,
    "Layers": layers,
    "Tags": tags,
    "ImageConfig": image_config,
    "MemorySize": memory_size,
    "DeadLetterConfig": dead_letter_config,
    "Timeout": timeout,
    "Handler": handler,
    "Code": code,
    "Role": role,
    "LoggingConfig": logging_config,
    "RecursiveLoop": recursive_loop,
    "Environment": environment,
    "EphemeralStorage": ephemeral_storage,
    "Architectures": architectures
} | generate_patch_document }}')
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ function_name }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

DELETE example​

/*+ delete */
DELETE FROM awscc.lambda.functions
WHERE
  Identifier = '{{ function_name }}' AND
  region = '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

Additional Parameters​

Mutable resources in the Cloud Control provider support additional optional parameters which can be supplied with INSERT, UPDATE, or DELETE operations. These include:

ParameterDescription
ClientToken
A unique identifier to ensure the idempotency of the resource request.This allows the provider to accurately distinguish between retries and new requests.
A client token is valid for 36 hours once used.
After that, a resource request with the same client token is treated as a new request.
If you do not specify a client token, one is generated for inclusion in the request.
RoleArn
The ARN of the IAM role used to perform this resource operation.The role specified must have the permissions required for this operation.
If you do not specify a role, a temporary session is created using your AWS user credentials.
TypeVersionId
For private resource types, the type version to use in this resource operation.If you do not specify a resource version, the default version is used.

Permissions​

To operate on the functions resource, the following permissions are required:

lambda:GetFunction,
lambda:GetFunctionCodeSigningConfig,
lambda:GetFunctionRecursionConfig