Skip to content

Commit 489515e

Browse files
committed
docs: Remove '$${lambda_arn}' reference from the docs
Dynamic Lambda ARN repalcements bring no value for Lambda IAM execution roles, as typically you'd like to list other AWS resources/services there, not the Lambda itself.
1 parent b219f28 commit 489515e

File tree

2 files changed

+2
-2
lines changed

2 files changed

+2
-2
lines changed

modules/lambda@edge/README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -73,7 +73,7 @@ module "lambda_at_edge" {
7373
| <a name="input_destruction_delay"></a> [destruction\_delay](#input\_destruction\_delay) | The delay, in [Golang ParseDuration](https://pkg.go.dev/time#ParseDuration) format, to wait before destroying the Lambda@Edge<br>functions.<br><br>This delay is meant to circumvent Lambda@Edge functions not being immediately deletable following their dissociation from<br>a CloudFront distribution, since they are replicated to CloudFront Edge servers around the world.<br><br>If set to `null`, no delay will be introduced.<br><br>By default, the delay is 20 minutes. This is because it takes about 3 minutes to destroy a CloudFront distribution, and<br>around 15 minutes until the Lambda@Edge function is available for deletion, in most cases.<br><br>For more information, see: https://github.com/hashicorp/terraform-provider-aws/issues/1721. | `string` | `"20m"` | no |
7474
| <a name="input_enabled"></a> [enabled](#input\_enabled) | Set to false to prevent the module from creating any resources | `bool` | `null` | no |
7575
| <a name="input_environment"></a> [environment](#input\_environment) | ID element. Usually used for region e.g. 'uw2', 'us-west-2', OR role 'prod', 'staging', 'dev', 'UAT' | `string` | `null` | no |
76-
| <a name="input_functions"></a> [functions](#input\_functions) | Lambda@Edge functions to create.<br><br>The key of this map is the name label of the Lambda@Edge function.<br><br>One of `source`, `source_dir` or `source_zip` should be specified. These variables are mutually exclusive.<br><br>`source.filename` and `source.content` dictate the name and content of the files that will make up the Lambda function<br>source, respectively.<br><br>`source_dir` contains path to whole directory that has to be archived.<br><br>`source_zip` contains path to zip file with lambda source.<br><br>`runtime`, `handler`, `memory_size` and `timeout` correspond to the attributes of the same name in the [lambda\_function](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/lambda_function)<br>resource. See [here](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/lambda-at-edge-function-restrictions.html) for Lambda@Edge function restrictions.<br><br>`additional_policy` contains additional policies for Lambda@Edge function. If included in the policies, the variable `$${lambda_arn}` will be substituted. It's also possible to override default policy statement by providing your own statement with `LambdaWriteCloudWatchLogs` sid.<br><br>`event_type` and `include_body` correspond to the attributes of the same name in the [Lambda Function association block<br>of the cloudfront\_distribution](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/cloudfront_distribution#lambda-function-association)<br>resource. | <pre>map(object({<br> source = optional(list(object({<br> filename = string<br> content = string<br> })))<br> source_dir = optional(string)<br> source_zip = optional(string)<br> runtime = string<br> handler = string<br> memory_size = optional(number, 128)<br> timeout = optional(number, 3)<br> additional_policy = optional(string, "{}")<br> event_type = string<br> include_body = bool<br> }))</pre> | n/a | yes |
76+
| <a name="input_functions"></a> [functions](#input\_functions) | Lambda@Edge functions to create.<br><br>The key of this map is the name label of the Lambda@Edge function.<br><br>One of `source`, `source_dir` or `source_zip` should be specified. These variables are mutually exclusive.<br><br>`source.filename` and `source.content` dictate the name and content of the files that will make up the Lambda function<br>source, respectively.<br><br>`source_dir` contains path to whole directory that has to be archived.<br><br>`source_zip` contains path to zip file with lambda source.<br><br>`runtime`, `handler`, `memory_size` and `timeout` correspond to the attributes of the same name in the [lambda\_function](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/lambda_function)<br>resource. See [here](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/lambda-at-edge-function-restrictions.html) for Lambda@Edge function restrictions.<br><br>`additional_policy` contains additional IAM policies for Lambda@Edge function. If included in the policies, the variable `$${lambda_arn}` will be substituted. It's also possible to override default policy statement by providing your own statement with `LambdaWriteCloudWatchLogs` sid.<br><br>`event_type` and `include_body` correspond to the attributes of the same name in the [Lambda Function association block<br>of the cloudfront\_distribution](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/cloudfront_distribution#lambda-function-association)<br>resource. | <pre>map(object({<br> source = optional(list(object({<br> filename = string<br> content = string<br> })))<br> source_dir = optional(string)<br> source_zip = optional(string)<br> runtime = string<br> handler = string<br> memory_size = optional(number, 128)<br> timeout = optional(number, 3)<br> additional_policy = optional(string, "{}")<br> event_type = string<br> include_body = bool<br> }))</pre> | n/a | yes |
7777
| <a name="input_id_length_limit"></a> [id\_length\_limit](#input\_id\_length\_limit) | Limit `id` to this many characters (minimum 6).<br>Set to `0` for unlimited length.<br>Set to `null` for keep the existing setting, which defaults to `0`.<br>Does not affect `id_full`. | `number` | `null` | no |
7878
| <a name="input_label_key_case"></a> [label\_key\_case](#input\_label\_key\_case) | Controls the letter case of the `tags` keys (label names) for tags generated by this module.<br>Does not affect keys of tags passed in via the `tags` input.<br>Possible values: `lower`, `title`, `upper`.<br>Default value: `title`. | `string` | `null` | no |
7979
| <a name="input_label_order"></a> [label\_order](#input\_label\_order) | The order in which the labels (ID elements) appear in the `id`.<br>Defaults to ["namespace", "environment", "stage", "name", "attributes"].<br>You can omit any of the 6 labels ("tenant" is the 6th), but at least one must be present. | `list(string)` | `null` | no |

modules/lambda@edge/variables.tf

+1-1
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ variable "functions" {
1616
`runtime`, `handler`, `memory_size` and `timeout` correspond to the attributes of the same name in the [lambda_function](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/lambda_function)
1717
resource. See [here](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/lambda-at-edge-function-restrictions.html) for Lambda@Edge function restrictions.
1818
19-
`additional_policy` contains additional policies for Lambda@Edge function. If included in the policies, the variable `$${lambda_arn}` will be substituted. It's also possible to override default policy statement by providing your own statement with `LambdaWriteCloudWatchLogs` sid.
19+
`additional_policy` contains additional IAM policies for Lambda@Edge function. It's possible to override default policy statement by providing your own statement with `LambdaWriteCloudWatchLogs` sid.
2020
2121
`event_type` and `include_body` correspond to the attributes of the same name in the [Lambda Function association block
2222
of the cloudfront_distribution](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/cloudfront_distribution#lambda-function-association)

0 commit comments

Comments
 (0)