VOOZH about

URL: https://docs.datadoghq.com/infrastructure/resource_catalog/aws_lambda_function/

⇱

For AI agents: A markdown version of this page is available at https://docs.datadoghq.com/infrastructure/resource_catalog/aws_lambda_function.md. A documentation index is available at /llms.txt.

aws_lambda_function

account_id

Type: STRING

architectures

Type: UNORDERED_LIST_STRING
Provider name: Architectures
Description: The instruction set architecture that the function supports. Architecture is a string array with one of the valid values. The default architecture value is x86_64.

capacity_provider_config

Type: STRUCT
Provider name: CapacityProviderConfig
Description: Configuration for the capacity provider that manages compute resources for Lambda functions.

  • lambda_managed_instances_capacity_provider_config
    Type: STRUCT
    Provider name: LambdaManagedInstancesCapacityProviderConfig
    Description: Configuration for Lambda-managed instances used by the capacity provider.
    • capacity_provider_arn
      Type: STRING
      Provider name: CapacityProviderArn
      Description: The Amazon Resource Name (ARN) of the capacity provider.
    • execution_environment_memory_gib_per_v_cpu
      Type: DOUBLE
      Provider name: ExecutionEnvironmentMemoryGiBPerVCpu
      Description: The amount of memory in GiB allocated per vCPU for execution environments.
    • per_execution_environment_max_concurrency
      Type: INT32
      Provider name: PerExecutionEnvironmentMaxConcurrency
      Description: The maximum number of concurrent execution environments that can run on each compute instance.

code_sha256

Type: STRING
Provider name: CodeSha256
Description: The SHA256 hash of the function’s deployment package.

code_size

Type: INT64
Provider name: CodeSize
Description: The size of the function’s deployment package, in bytes.

config_sha256

Type: STRING
Provider name: ConfigSha256
Description: The SHA256 hash of the function configuration.

dead_letter_config

Type: STRUCT
Provider name: DeadLetterConfig
Description: The function’s dead letter queue.

  • target_arn
    Type: STRING
    Provider name: TargetArn
    Description: The Amazon Resource Name (ARN) of an Amazon SQS queue or Amazon SNS topic.

description

Type: STRING
Provider name: Description
Description: The function’s description.

destination_config

Type: STRUCT
Provider name: DestinationConfig
Description: A destination for events after they have been sent to a function for processing.

Destinations

  • Function - The Amazon Resource Name (ARN) of a Lambda function.
  • Queue - The ARN of a standard SQS queue.
  • Bucket - The ARN of an Amazon S3 bucket.
  • Topic - The ARN of a standard SNS topic.
  • Event Bus - The ARN of an Amazon EventBridge event bus.

  • on_failure
    Type: STRUCT
    Provider name: OnFailure
    Description: The destination configuration for failed invocations.
    • destination
      Type: STRING
      Provider name: Destination
      Description: The Amazon Resource Name (ARN) of the destination resource. To retain records of failed invocations from Kinesis, DynamoDB, self-managed Apache Kafka, or Amazon MSK, you can configure an Amazon SNS topic, Amazon SQS queue, Amazon S3 bucket, or Kafka topic as the destination. To retain records of failed invocations from Kinesis, DynamoDB, self-managed Kafka or Amazon MSK, you can configure an Amazon SNS topic, Amazon SQS queue, or Amazon S3 bucket as the destination.
  • on_success
    Type: STRUCT
    Provider name: OnSuccess
    Description: The destination configuration for successful invocations. Not supported in CreateEventSourceMapping or UpdateEventSourceMapping.
    • destination
      Type: STRING
      Provider name: Destination
      Description: The Amazon Resource Name (ARN) of the destination resource.

durable_config

Type: STRUCT
Provider name: DurableConfig
Description: The function’s durable execution configuration settings, if the function is configured for durability.

  • execution_timeout
    Type: INT32
    Provider name: ExecutionTimeout
    Description: The maximum time (in seconds) that a durable execution can run before timing out. This timeout applies to the entire durable execution, not individual function invocations.
  • retention_period_in_days
    Type: INT32
    Provider name: RetentionPeriodInDays
    Description: The number of days to retain execution history after a durable execution completes. After this period, execution history is no longer available through the GetDurableExecutionHistory API.

environment

Type: STRUCT
Provider name: Environment
Description: The function’s environment variables. Omitted from CloudTrail logs.

  • error
    Type: STRUCT
    Provider name: Error
    Description: Error messages for environment variables that couldn’t be applied.
    • error_code
      Type: STRING
      Provider name: ErrorCode
      Description: The error code.
    • message
      Type: STRING
      Provider name: Message
      Description: The error message.
  • variables
    Type: MAP_STRING_STRING
    Provider name: Variables
    Description: Environment variable key-value pairs. Omitted from CloudTrail logs.

ephemeral_storage

Type: STRUCT
Provider name: EphemeralStorage
Description: The size of the function’s /tmp directory in MB. The default value is 512, but can be any whole number between 512 and 10,240 MB. For more information, see Configuring ephemeral storage (console).

  • size
    Type: INT32
    Provider name: Size
    Description: The size of the function’s /tmp directory.

file_system_configs

Type: UNORDERED_LIST_STRUCT
Provider name: FileSystemConfigs
Description: Connection settings for an Amazon EFS file system.

  • arn
    Type: STRING
    Provider name: Arn
    Description: The Amazon Resource Name (ARN) of the Amazon EFS access point that provides access to the file system.
  • local_mount_path
    Type: STRING
    Provider name: LocalMountPath
    Description: The path where the function can access the file system, starting with /mnt/.

function_arn

Type: STRING
Provider name: FunctionArn
Description: The Amazon Resource Name (ARN) of the function.

function_name

Type: STRING
Provider name: FunctionName
Description: The name of the function.

function_url_configs

Type: UNORDERED_LIST_STRUCT
Provider name: FunctionUrlConfigs
Description: A list of function URL configurations.

  • auth_type
    Type: STRING
    Provider name: AuthType
    Description: 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. For more information, see Security and auth model for Lambda function URLs.
  • cors
    Type: STRUCT
    Provider name: Cors
    Description: The cross-origin resource sharing (CORS) settings for your function URL.
    • allow_credentials
      Type: BOOLEAN
      Provider name: AllowCredentials
      Description: Whether to allow cookies or other credentials in requests to your function URL. The default is false.
    • allow_headers
      Type: UNORDERED_LIST_STRING
      Provider name: AllowHeaders
      Description: The HTTP headers that origins can include in requests to your function URL. For example: Date, Keep-Alive, X-Custom-Header.
    • allow_methods
      Type: UNORDERED_LIST_STRING
      Provider name: AllowMethods
      Description: The HTTP methods that are allowed when calling your function URL. For example: GET, POST, DELETE, or the wildcard character (*).
    • allow_origins
      Type: UNORDERED_LIST_STRING
      Provider name: AllowOrigins
      Description: The origins that can access your function URL. You can list any number of specific origins, separated by a comma. For example: https://www.example.com, http://localhost:60905. Alternatively, you can grant access to all origins using the wildcard character (*).
    • expose_headers
      Type: UNORDERED_LIST_STRING
      Provider name: ExposeHeaders
      Description: The HTTP headers in your function response that you want to expose to origins that call your function URL. For example: Date, Keep-Alive, X-Custom-Header.
    • max_age
      Type: INT32
      Provider name: MaxAge
      Description: The maximum amount of time, in seconds, that web browsers can cache results of a preflight request. By default, this is set to 0, which means that the browser doesn’t cache results.
  • creation_time
    Type: STRING
    Provider name: CreationTime
    Description: When the function URL was created, in ISO-8601 format (YYYY-MM-DDThh:mm:ss.sTZD).
  • function_arn
    Type: STRING
    Provider name: FunctionArn
    Description: The Amazon Resource Name (ARN) of your function.
  • function_url
    Type: STRING
    Provider name: FunctionUrl
    Description: The HTTP URL endpoint for your function.
  • invoke_mode
    Type: STRING
    Provider name: InvokeMode
    Description: Use one of the following options:
    • BUFFERED – This is the default option. Lambda invokes your function using the Invoke API operation. Invocation results are available when the payload is complete. The maximum payload size is 6 MB.
    • RESPONSE_STREAM – Your function streams payload results as they become available. Lambda invokes your function using the InvokeWithResponseStream API operation. The maximum response payload size is 200 MB.
  • last_modified_time
    Type: STRING
    Provider name: LastModifiedTime
    Description: When the function URL configuration was last updated, in ISO-8601 format (YYYY-MM-DDThh:mm:ss.sTZD).

handler

Type: STRING
Provider name: Handler
Description: The function that Lambda calls to begin running your function.

image_config_response

Type: STRUCT
Provider name: ImageConfigResponse
Description: The function’s image configuration values.

  • error
    Type: STRUCT
    Provider name: Error
    Description: Error response to GetFunctionConfiguration.
    • error_code
      Type: STRING
      Provider name: ErrorCode
      Description: Error code.
    • message
      Type: STRING
      Provider name: Message
      Description: Error message.
  • image_config
    Type: STRUCT
    Provider name: ImageConfig
    Description: Configuration values that override the container image Dockerfile.
    • command
      Type: UNORDERED_LIST_STRING
      Provider name: Command
      Description: Specifies parameters that you want to pass in with ENTRYPOINT.
    • entry_point
      Type: UNORDERED_LIST_STRING
      Provider name: EntryPoint
      Description: Specifies the entry point to their application, which is typically the location of the runtime executable.
    • working_directory
      Type: STRING
      Provider name: WorkingDirectory
      Description: Specifies the working directory.

kms_key_arn

Type: STRING
Provider name: KMSKeyArn
Description: The ARN of the Key Management Service (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 Amazon Web Services owned key or an Amazon Web Services managed key.

last_modified

Type: STRING
Provider name: LastModified
Description: The date and time that the configuration was last updated.

last_update_status

Type: STRING
Provider name: LastUpdateStatus
Description: The status of the last update that was performed on the function. This is first set to Successful after function creation completes.

last_update_status_reason

Type: STRING
Provider name: LastUpdateStatusReason
Description: The reason for the last update that was performed on the function.

last_update_status_reason_code

Type: STRING
Provider name: LastUpdateStatusReasonCode
Description: The reason code for the last update that was performed on the function.

layers

Type: UNORDERED_LIST_STRUCT
Provider name: Layers
Description: The function’s layers.

  • arn
    Type: STRING
    Provider name: Arn
    Description: The Amazon Resource Name (ARN) of the function layer.
  • code_size
    Type: INT64
    Provider name: CodeSize
    Description: The size of the layer archive in bytes.
  • signing_job_arn
    Type: STRING
    Provider name: SigningJobArn
    Description: The Amazon Resource Name (ARN) of a signing job.
  • signing_profile_version_arn
    Type: STRING
    Provider name: SigningProfileVersionArn
    Description: The Amazon Resource Name (ARN) for a signing profile version.

logging_config

Type: STRUCT
Provider name: LoggingConfig
Description: The function’s Amazon CloudWatch Logs configuration settings.

  • application_log_level
    Type: STRING
    Provider name: ApplicationLogLevel
    Description: Set this property to filter the application logs for your function that Lambda sends to CloudWatch. Lambda only sends application logs at the selected level of detail and lower, where TRACE is the highest level and FATAL is the lowest.
  • log_format
    Type: STRING
    Provider name: LogFormat
    Description: The format in which Lambda sends your function’s application and system logs to CloudWatch. Select between plain text and structured JSON.
  • log_group
    Type: STRING
    Provider name: LogGroup
    Description: The name of the Amazon CloudWatch log group the function sends logs to. By default, Lambda functions send logs to a default log group named /aws/lambda/<function name>. To use a different log group, enter an existing log group or enter a new log group name.
  • system_log_level
    Type: STRING
    Provider name: SystemLogLevel
    Description: Set this property to filter the system logs for your function that Lambda sends to CloudWatch. Lambda only sends system logs at the selected level of detail and lower, where DEBUG is the highest level and WARN is the lowest.

master_arn

Type: STRING
Provider name: MasterArn
Description: For Lambda@Edge functions, the ARN of the main function.

maximum_event_age_in_seconds

Type: INT32
Provider name: MaximumEventAgeInSeconds
Description: The maximum age of a request that Lambda sends to a function for processing.

maximum_retry_attempts

Type: INT32
Provider name: MaximumRetryAttempts
Description: The maximum number of times to retry when the function returns an error.

memory_size

Type: INT32
Provider name: MemorySize
Description: The amount of memory available to the function at runtime.

package_type

Type: STRING
Provider name: PackageType
Description: The type of deployment package. Set to Image for container image and set Zip for .zip file archive.

policies

Type: UNORDERED_LIST_STRUCT

  • account_id
    Type: STRING
  • condition
    Type: MAP_STRING_STRING
  • policy_id
    Type: STRING
  • policy_not_principal
    Type: STRUCT
    • policy_id
      Type: STRING
    • principal
      Type: STRING
    • principal_aws
      Type: UNORDERED_LIST_STRING
    • principal_canonical_user
      Type: UNORDERED_LIST_STRING
    • principal_federated
      Type: UNORDERED_LIST_STRING
    • principal_service
      Type: UNORDERED_LIST_STRING
  • policy_principal
    Type: STRUCT
    • policy_id
      Type: STRING
    • principal
      Type: STRING
    • principal_aws
      Type: UNORDERED_LIST_STRING
    • principal_canonical_user
      Type: UNORDERED_LIST_STRING
    • principal_federated
      Type: UNORDERED_LIST_STRING
    • principal_service
      Type: UNORDERED_LIST_STRING
  • principal_aws
    Type: UNORDERED_LIST_STRING
  • statement_action
    Type: UNORDERED_LIST_STRING
  • statement_effect
    Type: STRING
  • statement_has_condition
    Type: BOOLEAN
  • statement_id
    Type: INT32
  • statement_not_action
    Type: UNORDERED_LIST_STRING
  • statement_not_resource
    Type: UNORDERED_LIST_STRING
  • statement_resource
    Type: UNORDERED_LIST_STRING
  • statement_sid
    Type: STRING
  • version_id
    Type: STRING

policy

Type: STRUCT

  • policy
    Type: STRING
  • revision_id
    Type: STRING

provisioned_concurrency_configs

Type: UNORDERED_LIST_STRUCT
Provider name: ProvisionedConcurrencyConfigs
Description: A list of provisioned concurrency configurations.

  • allocated_provisioned_concurrent_executions
    Type: INT32
    Provider name: AllocatedProvisionedConcurrentExecutions
    Description: The amount of provisioned concurrency allocated. When a weighted alias is used during linear and canary deployments, this value fluctuates depending on the amount of concurrency that is provisioned for the function versions.
  • available_provisioned_concurrent_executions
    Type: INT32
    Provider name: AvailableProvisionedConcurrentExecutions
    Description: The amount of provisioned concurrency available.
  • function_arn
    Type: STRING
    Provider name: FunctionArn
    Description: The Amazon Resource Name (ARN) of the alias or version.
  • last_modified
    Type: STRING
    Provider name: LastModified
    Description: The date and time that a user last updated the configuration, in ISO 8601 format.
  • requested_provisioned_concurrent_executions
    Type: INT32
    Provider name: RequestedProvisionedConcurrentExecutions
    Description: The amount of provisioned concurrency requested.
  • status
    Type: STRING
    Provider name: Status
    Description: The status of the allocation process.
  • status_reason
    Type: STRING
    Provider name: StatusReason
    Description: For failed allocations, the reason that provisioned concurrency could not be allocated.

revision_id

Type: STRING
Provider name: RevisionId
Description: A unique identifier for the current revision of the policy.

role

Type: STRING
Provider name: Role
Description: The function’s execution role.

runtime

Type: STRING
Provider name: Runtime
Description: 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.

runtime_version_config

Type: STRUCT
Provider name: RuntimeVersionConfig
Description: The ARN of the runtime and any errors that occured.

  • error
    Type: STRUCT
    Provider name: Error
    Description: Error response when Lambda is unable to retrieve the runtime version for a function.
    • error_code
      Type: STRING
      Provider name: ErrorCode
      Description: The error code.
    • message
      Type: STRING
      Provider name: Message
      Description: The error message.
  • runtime_version_arn
    Type: STRING
    Provider name: RuntimeVersionArn
    Description: The ARN of the runtime version you want the function to use.

signing_job_arn

Type: STRING
Provider name: SigningJobArn
Description: The ARN of the signing job.

signing_profile_version_arn

Type: STRING
Provider name: SigningProfileVersionArn
Description: The ARN of the signing profile version.

snap_start

Type: STRUCT
Provider name: SnapStart
Description: Set ApplyOn to PublishedVersions to create a snapshot of the initialized execution environment when you publish a function version. For more information, see Improving startup performance with Lambda SnapStart.

  • apply_on
    Type: STRING
    Provider name: ApplyOn
    Description: When set to PublishedVersions, Lambda creates a snapshot of the execution environment when you publish a function version.
  • optimization_status
    Type: STRING
    Provider name: OptimizationStatus
    Description: When you provide a qualified Amazon Resource Name (ARN), this response element indicates whether SnapStart is activated for the specified function version.

state

Type: STRING
Provider name: State
Description: The current state of the function. When the state is Inactive, you can reactivate the function by invoking it.

state_reason

Type: STRING
Provider name: StateReason
Description: The reason for the function’s current state.

state_reason_code

Type: STRING
Provider name: StateReasonCode
Description: The reason code for the function’s current state. When the code is Creating, you can’t invoke or modify the function.

tags

Type: UNORDERED_LIST_STRING

tenancy_config

Type: STRUCT
Provider name: TenancyConfig
Description: The function’s tenant isolation configuration settings. Determines whether the Lambda function runs on a shared or dedicated infrastructure per unique tenant.

  • tenant_isolation_mode
    Type: STRING
    Provider name: TenantIsolationMode
    Description: Tenant isolation mode allows for invocation to be sent to a corresponding execution environment dedicated to a specific tenant ID.

timeout

Type: INT32
Provider name: Timeout
Description: The amount of time in seconds that Lambda allows a function to run before stopping it.

tracing_config

Type: STRUCT
Provider name: TracingConfig
Description: The function’s X-Ray tracing configuration.

  • mode
    Type: STRING
    Provider name: Mode
    Description: The tracing mode.

version

Type: STRING
Provider name: Version
Description: The version of the Lambda function.

vpc_config

Type: STRUCT
Provider name: VpcConfig
Description: The function’s networking configuration.

  • ipv6_allowed_for_dual_stack
    Type: BOOLEAN
    Provider name: Ipv6AllowedForDualStack
    Description: Allows outbound IPv6 traffic on VPC functions that are connected to dual-stack subnets.
  • security_group_ids
    Type: UNORDERED_LIST_STRING
    Provider name: SecurityGroupIds
    Description: A list of VPC security group IDs.
  • subnet_ids
    Type: UNORDERED_LIST_STRING
    Provider name: SubnetIds
    Description: A list of VPC subnet IDs.
  • vpc_id
    Type: STRING
    Provider name: VpcId
    Description: The ID of the VPC.