Module: `datadog-lambda-forwarder`

Terraform module to provision all the necessary infrastructure to deploy Datadog Lambda forwarders

Sponsorship

This project is supported by the Datadog Open Source Program.

As part of this collaboration, Datadog provides a dedicated sandbox account that we use for automated integration and acceptance testing. This contribution allows us to continuously validate changes against a real Datadog environment, improving reliability and reducing the risk of regressions.

We are grateful to Datadog for supporting our open source ecosystem and helping ensure that infrastructure code for Terraform remains stable and well-tested

Usage

For a complete example, see examples/complete.

For automated tests of the complete example using bats and Terratest (which tests and deploys the example on AWS), see test.

To enable Datadog forwarder for RDS Enhanced monitoring:

module "datadog_lambda_forwarder" {
  source = "cloudposse/datadog-lambda-forwarder/aws"
  # Cloud Posse recommends pinning every module to a specific version
  # version = "x.x.x"

  forwarder_rds_enabled = true
}

To enable Datadog forwarder for a CloudTrail S3 bucket:

module "datadog_lambda_forwarder" {
  source = "cloudposse/datadog-lambda-forwarder/aws"
  # Cloud Posse recommends pinning every module to a specific version
  # version = "x.x.x"

  forwarder_log_enabled = true
  s3_buckets            = ["cloudtrail-audit-bucket"]
  s3_bucket_kms_arns    = ["arn:aws:kms:us-west-2:1234567890:key/b204f3d2-1111-2222-94333332-4444ccc222"]
}

To enable Datadog forwarder for a S3 bucket with prefix:

module "datadog_lambda_forwarder" {
  source = "cloudposse/datadog-lambda-forwarder/aws"
  # Cloud Posse recommends pinning every module to a specific version
  # version = "x.x.x"

  forwarder_log_enabled = true
  s3_buckets_with_prefixes = {
    MyBucketWithPrefix = {bucket_name = "my-bucket-with-prefix", bucket_prefix = "events/"}
    AnotherWithPrefix  = {bucket_name = "another-with-prefix", bucket_prefix = "records/"}
  }
  s3_bucket_kms_arns       = ["arn:aws:kms:us-west-2:1234567890:key/b204f3d2-1111-2222-94333332-4444ccc222"]
}

To enable Datadog forwarder for RDS authentication CloudWatch logs:

module "datadog_lambda_forwarder" {
  source = "cloudposse/datadog-lambda-forwarder/aws"
  # Cloud Posse recommends pinning every module to a specific version
  # version = "x.x.x"

  forwarder_log_enabled = true
  cloudwatch_forwarder_log_groups = {
    postgres = {
      name           = "/aws/rds/cluster/pg-main/postgresql"
      filter_pattern = ""
    }
  }
}

To enable Datadog forwarder for VPC Flow Logs CloudWatch logs:

module "datadog_lambda_forwarder" {
  source = "cloudposse/datadog-lambda-forwarder/aws"
  # Cloud Posse recommends pinning every module to a specific version
  # version = "x.x.x"

  forwarder_vpc_logs_enabled   = true
  vpclogs_cloudwatch_log_group = "/aws/vpc/flowlogs/vpc1"
}

To use a local copy of the lambda code you can specify the artifact url:

module "datadog_lambda_forwarder" {
  source = "cloudposse/datadog-lambda-forwarder/aws"
  # Cloud Posse recommends pinning every module to a specific version
  # version = "x.x.x"

  forwarder_rds_enabled      = true
  forwarder_rds_artifact_url = file("${path.module}/function.zip")
}

Examples

Here is an example of using this module:

examples/complete - complete example of using this module

Variables

Required Variables

Optional Variables

api_key_ssm_arn (string) optional

ARN of the SSM parameter for the Datadog API key.
Passing this removes the need to fetch the key from the SSM parameter store.
This could be the case if the SSM Key is in a different region than the lambda.

Default value: null

cloudwatch_forwarder_event_patterns optional

Map of title => CloudWatch Event patterns to forward to Datadog. Event structure from here: https://docs.aws.amazon.com/AmazonCloudWatch/latest/events/CloudWatchEventsandEventPatterns.html#CloudWatchEventsPatterns
Example:

cloudwatch_forwarder_event_rules = {<br/>
  "guardduty" = {<br/>
    source = ["aws.guardduty"]<br/>
    detail-type = ["GuardDuty Finding"]<br/>
  }<br/>
  "ec2-terminated" = {<br/>
    source = ["aws.ec2"]<br/>
    detail-type = ["EC2 Instance State-change Notification"]<br/>
    detail = {<br/>
      state = ["terminated"]<br/>
    }<br/>
  }<br/>
}<br/>
```<br/>
<br/>
<br/>

**Type:**
```hcl
map(object({
version     = optional(list(string))
id          = optional(list(string))
detail-type = optional(list(string))
source      = optional(list(string))
account     = optional(list(string))
time        = optional(list(string))
region      = optional(list(string))
resources   = optional(list(string))
detail      = optional(map(list(string)))
}))

Default value: { }

cloudwatch_forwarder_log_groups optional

Map of CloudWatch Log Groups with a filter pattern that the Lambda forwarder will send logs from. For example: { mysql1 = { name = "/aws/rds/maincluster", filter_pattern = "" }

Type:

map(object({
name           = string
filter_pattern = string
}))

Default value: { }

datadog_forwarder_lambda_environment_variables (map(string)) optional

Map of environment variables to pass to the Lambda Function

Default value: { }

dd_api_key_kms_ciphertext_blob (string) optional

CiphertextBlob stored in environment variable DD_KMS_API_KEY used by the lambda function, along with the KMS key, to decrypt Datadog API key

Default value: ""

dd_api_key_source optional

One of: ARN for AWS Secrets Manager (asm) to retrieve the Datadog (DD) api key, ARN for the KMS (kms) key used to decrypt the ciphertext_blob of the api key, or the name of the SSM (ssm) parameter used to retrieve the Datadog API key

Type:

object({
resource   = string
identifier = string
})

Default value:

{
  "identifier": "",
  "resource": ""
}

dd_artifact_filename (string) optional

The Datadog artifact filename minus extension

Default value: "aws-dd-forwarder"

dd_forwarder_version (string) optional

Version tag of Datadog lambdas to use. https://github.com/DataDog/datadog-serverless-functions/releases

Default value: "3.116.0"

dd_module_name (string) optional

The Datadog GitHub repository name

Default value: "datadog-serverless-functions"

dd_tags (list(string)) optional

A list of Datadog tags to apply to all logs forwarded to Datadog

Default value: [ ]

dd_tags_map (map(string)) optional

A map of Datadog tags to apply to all logs forwarded to Datadog. This will override dd_tags.

Default value: { }

forwarder_iam_path (string) optional

Path to the IAM roles and policies created

Default value: "/"

forwarder_lambda_datadog_host (string) optional

Datadog Site to send data to. Possible values are datadoghq.com, datadoghq.eu, us3.datadoghq.com, us5.datadoghq.com and ddog-gov.com

Default value: "datadoghq.com"

forwarder_lambda_debug_enabled (bool) optional

Whether to enable or disable debug for the Lambda forwarder

Default value: false

forwarder_log_artifact_url (string) optional

The URL for the code of the Datadog forwarder for Logs. It can be a local file, URL or git repo

Default value: null

forwarder_log_enabled (bool) optional

Flag to enable or disable Datadog log forwarder

Default value: false

forwarder_log_layers (list(string)) optional

List of Lambda Layer Version ARNs (maximum of 5) to attach to Datadog log forwarder lambda function

Default value: [ ]

forwarder_log_retention_days (number) optional

Number of days to retain Datadog forwarder lambda execution logs. One of [0 1 3 5 7 14 30 60 90 120 150 180 365 400 545 731 1827 3653]

Default value: 14

forwarder_rds_artifact_url (string) optional

The URL for the code of the Datadog forwarder for RDS. It can be a local file, url or git repo

Default value: null

forwarder_rds_enabled (bool) optional

Flag to enable or disable Datadog RDS enhanced monitoring forwarder

Default value: false

forwarder_rds_filter_pattern (string) optional

Filter pattern for Lambda forwarder RDS

Default value: ""

forwarder_rds_layers (list(string)) optional

List of Lambda Layer Version ARNs (maximum of 5) to attach to Datadog RDS enhanced monitoring lambda function

Default value: [ ]

forwarder_use_cache_bucket (bool) optional

Flag to enable or disable the cache bucket for lambda tags and failed events. See https://docs.datadoghq.com/logs/guide/forwarder/?tab=cloudformation#upgrade-an-older-version-to-31060. Recommended for forwarder versions 3.106 and higher.

Default value: true

forwarder_vpc_logs_artifact_url (string) optional

The URL for the code of the Datadog forwarder for VPC Logs. It can be a local file, url or git repo

Default value: null

forwarder_vpc_logs_enabled (bool) optional

Flag to enable or disable Datadog VPC flow log forwarder

Default value: false

forwarder_vpc_logs_layers (list(string)) optional

List of Lambda Layer Version ARNs (maximum of 5) to attach to Datadog VPC flow log forwarder lambda function

Default value: [ ]

forwarder_vpclogs_filter_pattern (string) optional

Filter pattern for Lambda forwarder VPC Logs

Default value: ""

kms_key_id (string) optional

Optional KMS key ID to encrypt Datadog Lambda function logs

Default value: null

lambda_architectures (list(string)) optional

Instruction set architecture for your Lambda function. Valid values are ["x86_64"] and ["arm64"].

Default value: null

lambda_custom_policy_name (string) optional

Additional IAM policy document that can optionally be passed and merged with the created policy document

Default value: "DatadogForwarderCustomPolicy"

lambda_memory_size (number) optional

Amount of memory in MB your Lambda Function can use at runtime

Default value: 128

lambda_policy_source_json (string) optional

Additional IAM policy document that can optionally be passed and merged with the created policy document

Default value: ""

lambda_reserved_concurrent_executions (number) optional

Amount of reserved concurrent executions for the lambda function. A value of 0 disables Lambda from being triggered and -1 removes any concurrency limitations. Defaults to Unreserved Concurrency Limits -1

Default value: -1

lambda_runtime (string) optional

Runtime environment for Datadog Lambda

Default value: "python3.11"

lambda_timeout (number) optional

Amount of time your Datadog Lambda Function has to run in seconds

Default value: 120

log_permissions_boundary (string) optional

ARN of the policy that is used to set the permissions boundary for the lambda-log role managed by this module.

Default value: null

rds_permissions_boundary (string) optional

ARN of the policy that is used to set the permissions boundary for the lambda-rds role managed by this module.

Default value: null

s3_bucket_kms_arns (list(string)) optional

List of KMS key ARNs for s3 bucket encryption

Default value: [ ]

s3_buckets (list(string)) optional

The names of S3 buckets to forward logs to Datadog

Default value: [ ]

s3_buckets_with_prefixes (map(object({ bucket_name : string, bucket_prefix : string }))) optional

The names S3 buckets and prefix to forward logs to Datadog

Default value: { }

s3_notification_events (list(string)) optional

List of S3 events to trigger the Lambda notification

Default value:

[
  "s3:ObjectCreated:*"
]

security_group_ids (list(string)) optional

List of security group IDs to use when the Lambda Function runs in a VPC

Default value: null

subnet_ids (list(string)) optional

List of subnet IDs to use when deploying the Lambda Function in a VPC

Default value: null

tracing_config_mode (string) optional

Can be either PassThrough or Active. If PassThrough, Lambda will only trace the request from an upstream service if it contains a tracing header with 'sampled=1'. If Active, Lambda will respect any tracing header it receives from an upstream service

Default value: "PassThrough"

vpc_logs_permissions_boundary (string) optional

ARN of the policy that is used to set the permissions boundary for the lambda-vpc-logs role managed by this module.

Default value: null

vpclogs_cloudwatch_log_group (string) optional

The name of the CloudWatch Log Group for VPC flow logs

Default value: null

Context Variables

The following variables are defined in the context.tf file of this module and part of the terraform-null-label pattern.

additional_tag_map (map(string)) optional

Additional key-value pairs to add to each map in tags_as_list_of_maps. Not added to tags or id.
This is for some rare cases where resources want additional configuration of tags
and therefore take a list of maps with tag key, value, and additional configuration.

Required: No

Default value: { }

attributes (list(string)) optional

ID element. Additional attributes (e.g. workers or cluster) to add to id,
in the order they appear in the list. New attributes are appended to the
end of the list. The elements of the list are joined by the delimiter
and treated as a single ID element.

Required: No

Default value: [ ]

context (any) optional

Single object for setting entire context at once.
See description of individual variables for details.
Leave string and numeric variables as null to use default value.
Individual variable settings (non-null) override settings in context object,
except for attributes, tags, and additional_tag_map, which are merged.

Required: No

Default value:

{
  "additional_tag_map": {},
  "attributes": [],
  "delimiter": null,
  "descriptor_formats": {},
  "enabled": true,
  "environment": null,
  "id_length_limit": null,
  "label_key_case": null,
  "label_order": [],
  "label_value_case": null,
  "labels_as_tags": [
    "unset"
  ],
  "name": null,
  "namespace": null,
  "regex_replace_chars": null,
  "stage": null,
  "tags": {},
  "tenant": null
}

delimiter (string) optional

Delimiter to be used between ID elements.
Defaults to - (hyphen). Set to "" to use no delimiter at all.

Required: No

Default value: null

descriptor_formats (any) optional

Describe additional descriptors to be output in the descriptors output map.
Map of maps. Keys are names of descriptors. Values are maps of the form
\{<br/> format = string<br/> labels = list(string)<br/> \}
(Type is any so the map values can later be enhanced to provide additional options.)
format is a Terraform format string to be passed to the format() function.
labels is a list of labels, in order, to pass to format() function.
Label values will be normalized before being passed to format() so they will be
identical to how they appear in id.
Default is {} (descriptors output will be empty).

Required: No

Default value: { }

enabled (bool) optional

Set to false to prevent the module from creating any resources
Required: No

Default value: null

environment (string) optional

ID element. Usually used for region e.g. 'uw2', 'us-west-2', OR role 'prod', 'staging', 'dev', 'UAT'
Required: No

Default value: null

id_length_limit (number) optional

Limit id to this many characters (minimum 6).
Set to 0 for unlimited length.
Set to null for keep the existing setting, which defaults to 0.
Does not affect id_full.

Required: No

Default value: null

label_key_case (string) optional

Controls the letter case of the tags keys (label names) for tags generated by this module.
Does not affect keys of tags passed in via the tags input.
Possible values: lower, title, upper.
Default value: title.

Required: No

Default value: null

label_order (list(string)) optional

The order in which the labels (ID elements) appear in the id.
Defaults to ["namespace", "environment", "stage", "name", "attributes"].
You can omit any of the 6 labels ("tenant" is the 6th), but at least one must be present.

Required: No

Default value: null

label_value_case (string) optional

Controls the letter case of ID elements (labels) as included in id,
set as tag values, and output by this module individually.
Does not affect values of tags passed in via the tags input.
Possible values: lower, title, upper and none (no transformation).
Set this to title and set delimiter to "" to yield Pascal Case IDs.
Default value: lower.

Required: No

Default value: null

labels_as_tags (set(string)) optional

Set of labels (ID elements) to include as tags in the tags output.
Default is to include all labels.
Tags with empty values will not be included in the tags output.
Set to [] to suppress all generated tags.
Notes:
The value of the name tag, if included, will be the id, not the name.
Unlike other null-label inputs, the initial setting of labels_as_tags cannot be
changed in later chained modules. Attempts to change it will be silently ignored.

Required: No

Default value:

[
  "default"
]

name (string) optional

ID element. Usually the component or solution name, e.g. 'app' or 'jenkins'.
This is the only ID element not also included as a tag.
The "name" tag is set to the full id string. There is no tag with the value of the name input.

Required: No

Default value: null

namespace (string) optional

ID element. Usually an abbreviation of your organization name, e.g. 'eg' or 'cp', to help ensure generated IDs are globally unique
Required: No

Default value: null

regex_replace_chars (string) optional

Terraform regular expression (regex) string.
Characters matching the regex will be removed from the ID elements.
If not set, "/[^a-zA-Z0-9-]/" is used to remove all characters other than hyphens, letters and digits.

Required: No

Default value: null

stage (string) optional

ID element. Usually used to indicate role, e.g. 'prod', 'staging', 'source', 'build', 'test', 'deploy', 'release'
Required: No

Default value: null

tags (map(string)) optional

Additional tags (e.g. {'BusinessUnit': 'XYZ'}).
Neither the tag keys nor the tag values will be modified by this module.

Required: No

Default value: { }

tenant (string) optional

ID element (Rarely used, not included by default). A customer identifier, indicating who this instance of a resource is for
Required: No

Default value: null

Outputs

lambda_forwarder_log_function_arn: Datadog Lambda forwarder CloudWatch/S3 function ARN
lambda_forwarder_log_function_name: Datadog Lambda forwarder CloudWatch/S3 function name
lambda_forwarder_rds_enhanced_monitoring_function_name: Datadog Lambda forwarder RDS Enhanced Monitoring function name
lambda_forwarder_rds_function_arn: Datadog Lambda forwarder RDS Enhanced Monitoring function ARN
lambda_forwarder_vpc_log_function_arn: Datadog Lambda forwarder VPC Flow Logs function ARN
lambda_forwarder_vpc_log_function_name: Datadog Lambda forwarder VPC Flow Logs function name

Dependencies

Requirements

terraform, version: >= 1.3.0
archive, version: >= 2.2.0
aws, version: >= 3.0

Providers

archive, version: >= 2.2.0
aws, version: >= 3.0

Modules

Name	Version	Source	Description
`cloudwatch_event`	0.6.1	`cloudposse/cloudwatch-events/aws`	n/a
`forwarder_log_artifact`	0.8.0	`cloudposse/module-artifact/external`	n/a
`forwarder_log_label`	0.25.0	`cloudposse/label/null`	n/a
`forwarder_log_s3_label`	0.25.0	`cloudposse/label/null`	n/a
`forwarder_rds_artifact`	0.8.0	`cloudposse/module-artifact/external`	n/a
`forwarder_rds_label`	0.25.0	`cloudposse/label/null`	n/a
`forwarder_vpclogs_artifact`	0.8.0	`cloudposse/module-artifact/external`	n/a
`forwarder_vpclogs_label`	0.25.0	`cloudposse/label/null`	n/a
`tags_cache_s3_bucket`	4.2.0	`cloudposse/s3-bucket/aws`	n/a
`this`	0.25.0	`cloudposse/label/null`	n/a

Resources

The following resources are used by this module:

aws_cloudwatch_log_group.forwarder_log (resource)
aws_cloudwatch_log_group.forwarder_rds (resource)
aws_cloudwatch_log_group.forwarder_vpclogs (resource)
aws_cloudwatch_log_subscription_filter.cloudwatch_log_subscription_filter (resource)
aws_cloudwatch_log_subscription_filter.datadog_log_subscription_filter_rds (resource)
aws_cloudwatch_log_subscription_filter.datadog_log_subscription_filter_vpclogs (resource)
aws_iam_policy.datadog_custom_policy (resource)
aws_iam_policy.lambda_forwarder_log (resource)
aws_iam_policy.lambda_forwarder_log_s3 (resource)
aws_iam_policy.lambda_forwarder_rds (resource)
aws_iam_policy.lambda_forwarder_vpclogs (resource)
aws_iam_role.lambda_forwarder_log (resource)
aws_iam_role.lambda_forwarder_rds (resource)
aws_iam_role.lambda_forwarder_vpclogs (resource)
aws_iam_role_policy_attachment.datadog_s3 (resource)
aws_iam_role_policy_attachment.lambda_forwarder_log (resource)
aws_iam_role_policy_attachment.lambda_forwarder_rds (resource)
aws_iam_role_policy_attachment.lambda_forwarder_vpclogs (resource)
aws_lambda_function.forwarder_log (resource)
aws_lambda_function.forwarder_rds (resource)
aws_lambda_function.forwarder_vpclogs (resource)
aws_lambda_permission.allow_eventbridge (resource)
aws_lambda_permission.allow_s3_bucket (resource)
aws_lambda_permission.cloudwatch_enhanced_rds_monitoring (resource)
aws_lambda_permission.cloudwatch_groups (resource)
aws_lambda_permission.cloudwatch_vpclogs (resource)
aws_s3_bucket_notification.s3_bucket_notification (resource)
aws_s3_bucket_notification.s3_bucket_notification_with_prefixes (resource)

Data Sources

The following data sources are used by this module:

archive_file.forwarder_rds (data source)
archive_file.forwarder_vpclogs (data source)
aws_caller_identity.current (data source)
aws_iam_policy_document.assume_role (data source)
aws_iam_policy_document.lambda_default (data source)
aws_iam_policy_document.s3_log_bucket (data source)
aws_partition.current (data source)
aws_region.current (data source)
aws_ssm_parameter.api_key (data source)

Module: datadog-lambda-forwarder

Sponsorship​

Usage​

Examples​

Variables​

Required Variables​

Optional Variables​

Context Variables​

Outputs​

Dependencies​

Requirements​

Providers​

Modules​

Resources​

Data Sources​

Module: `datadog-lambda-forwarder`

Sponsorship

Usage

Examples

Variables

Required Variables

Optional Variables

Context Variables

Outputs

Dependencies

Requirements

Providers

Modules

Resources

Data Sources