You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+1-5
Original file line number
Diff line number
Diff line change
@@ -180,9 +180,7 @@ Available targets:
180
180
| <aname="input_additional_tag_map"></a> [additional\_tag\_map](#input\_additional\_tag\_map)| Additional key-value pairs to add to each map in `tags_as_list_of_maps`. Not added to `tags` or `id`.<br>This is for some rare cases where resources want additional configuration of tags<br>and therefore take a list of maps with tag key, value, and additional configuration. |`map(string)`|`{}`| no |
181
181
| <aname="input_architectures"></a> [architectures](#input\_architectures)| Instruction set architecture for your Lambda function. Valid values are ["x86\_64"] and ["arm64"].<br> Default is ["x86\_64"]. Removing this attribute, function's architecture stay the same. |`list(string)`|`null`| no |
182
182
| <aname="input_attributes"></a> [attributes](#input\_attributes)| ID element. Additional attributes (e.g. `workers` or `cluster`) to add to `id`,<br>in the order they appear in the list. New attributes are appended to the<br>end of the list. The elements of the list are joined by the `delimiter`<br>and treated as a single ID element. |`list(string)`|`[]`| no |
183
-
| <aname="input_cloudwatch_event_rules"></a> [cloudwatch\_event\_rules](#input\_cloudwatch\_event\_rules)| Creates EventBridge (CloudWatch Events) rules for invoking the Lambda Function along with the required permissions. |`map(any)`|`{}`| no |
184
183
| <aname="input_cloudwatch_lambda_insights_enabled"></a> [cloudwatch\_lambda\_insights\_enabled](#input\_cloudwatch\_lambda\_insights\_enabled)| Enable CloudWatch Lambda Insights for the Lambda Function. |`bool`|`false`| no |
185
-
| <aname="input_cloudwatch_log_subscription_filters"></a> [cloudwatch\_log\_subscription\_filters](#input\_cloudwatch\_log\_subscription\_filters)| CloudWatch Logs subscription filter resources. Currently supports only Lambda functions as destinations. |`map(any)`|`{}`| no |
186
184
| <aname="input_cloudwatch_logs_kms_key_arn"></a> [cloudwatch\_logs\_kms\_key\_arn](#input\_cloudwatch\_logs\_kms\_key\_arn)| The ARN of the KMS Key to use when encrypting log data. |`string`|`null`| no |
187
185
| <aname="input_cloudwatch_logs_retention_in_days"></a> [cloudwatch\_logs\_retention\_in\_days](#input\_cloudwatch\_logs\_retention\_in\_days)| Specifies the number of days you want to retain log events in the specified log group. Possible values are:<br> 1, 3, 5, 7, 14, 30, 60, 90, 120, 150, 180, 365, 400, 545, 731, 1827, 3653, and 0. If you select 0, the events in the<br> log group are always retained and never expire. |`number`|`null`| no |
188
186
| <aname="input_context"></a> [context](#input\_context)| Single object for setting entire context at once.<br>See description of individual variables for details.<br>Leave string and numeric variables as `null` to use default value.<br>Individual variable settings (non-null) override settings in context object,<br>except for attributes, tags, and additional\_tag\_map, which are merged. |`any`| <pre>{<br> "additional_tag_map": {},<br> "attributes": [],<br> "delimiter": null,<br> "descriptor_formats": {},<br> "enabled": true,<br> "environment": null,<br> "id_length_limit": null,<br> "label_key_case": null,<br> "label_order": [],<br> "label_value_case": null,<br> "labels_as_tags": [<br> "unset"<br> ],<br> "name": null,<br> "namespace": null,<br> "regex_replace_chars": null,<br> "stage": null,<br> "tags": {},<br> "tenant": null<br>}</pre> | no |
@@ -193,13 +191,12 @@ Available targets:
193
191
| <aname="input_descriptor_formats"></a> [descriptor\_formats](#input\_descriptor\_formats)| Describe additional descriptors to be output in the `descriptors` output map.<br>Map of maps. Keys are names of descriptors. Values are maps of the form<br>`{<br> format = string<br> labels = list(string)<br>}`<br>(Type is `any` so the map values can later be enhanced to provide additional options.)<br>`format` is a Terraform format string to be passed to the `format()` function.<br>`labels` is a list of labels, in order, to pass to `format()` function.<br>Label values will be normalized before being passed to `format()` so they will be<br>identical to how they appear in `id`.<br>Default is `{}` (`descriptors` output will be empty). |`any`|`{}`| no |
194
192
| <aname="input_enabled"></a> [enabled](#input\_enabled)| Set to false to prevent the module from creating any resources |`bool`|`null`| no |
195
193
| <aname="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 |
196
-
| <aname="input_event_source_mappings"></a> [event\_source\_mappings](#input\_event\_source\_mappings)|Creates event source mappings to allow the Lambda function to get events from Kinesis, DynamoDB and SQS. The IAM role<br> of this Lambda function will be enhanced with necessary minimum permissions to get those events. |`any`|`{}`| no |
194
+
| <aname="input_ephemeral_storage_size"></a> [ephemeral\_storage\_size](#input\_ephemeral\_storage\_size)|The size of the Lambda function Ephemeral storage (/tmp) represented in MB.<br> The minimum supported ephemeral\_storage value defaults to 512MB and the maximum supported value is 10240MB. |`number`|`null`| no |
197
195
| <aname="input_filename"></a> [filename](#input\_filename)| The path to the function's deployment package within the local filesystem. If defined, The s3\_-prefixed options and image\_uri cannot be used. |`string`|`null`| no |
198
196
| <aname="input_function_name"></a> [function\_name](#input\_function\_name)| Unique name for the Lambda Function. |`string`| n/a | yes |
199
197
| <aname="input_handler"></a> [handler](#input\_handler)| The function entrypoint in your code. |`string`|`null`| no |
200
198
| <aname="input_iam_policy_description"></a> [iam\_policy\_description](#input\_iam\_policy\_description)| Description of the IAM policy for the Lambda IAM role |`string`|`"Provides minimum SSM read permissions."`| no |
201
199
| <aname="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 |
202
-
| <aname="input_ignore_external_function_updates"></a> [ignore\_external\_function\_updates](#input\_ignore\_external\_function\_updates)| Ignore updates to the Lambda Function executed externally to the Terraform lifecycle. Set this to `true` if you're<br> using CodeDeploy, aws CLI or other external tools to update the Lambda Function code." |`bool`|`false`| no |
203
200
| <aname="input_image_config"></a> [image\_config](#input\_image\_config)| The Lambda OCI [image configurations](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/lambda_function#image_config)<br> block with three (optional) arguments:<br> - *entry\_point* - The ENTRYPOINT for the docker image (type `list(string)`).<br> - *command* - The CMD for the docker image (type `list(string)`).<br> - *working\_directory* - The working directory for the docker image (type `string`). |`any`|`{}`| no |
204
201
| <aname="input_image_uri"></a> [image\_uri](#input\_image\_uri)| The ECR image URI containing the function's deployment package. Conflicts with filename, s3\_bucket, s3\_key, and s3\_object\_version. |`string`|`null`| no |
205
202
| <aname="input_kms_key_arn"></a> [kms\_key\_arn](#input\_kms\_key\_arn)| Amazon Resource Name (ARN) of the AWS Key Management Service (KMS) key that is used to encrypt environment variables.<br> If this configuration is not provided when environment variables are in use, AWS Lambda uses a default service key.<br> If this configuration is provided when environment variables are not in use, the AWS Lambda API does not save this<br> configuration and Terraform will show a perpetual difference of adding the key. To fix the perpetual difference,<br> remove this configuration. |`string`|`""`| no |
@@ -222,7 +219,6 @@ Available targets:
222
219
| <aname="input_s3_bucket"></a> [s3\_bucket](#input\_s3\_bucket)| The S3 bucket location containing the function's deployment package. Conflicts with filename and image\_uri.<br> This bucket must reside in the same AWS region where you are creating the Lambda function. |`string`|`null`| no |
223
220
| <aname="input_s3_key"></a> [s3\_key](#input\_s3\_key)| The S3 key of an object containing the function's deployment package. Conflicts with filename and image\_uri. |`string`|`null`| no |
224
221
| <aname="input_s3_object_version"></a> [s3\_object\_version](#input\_s3\_object\_version)| The object version containing the function's deployment package. Conflicts with filename and image\_uri. |`string`|`null`| no |
225
-
| <aname="input_sns_subscriptions"></a> [sns\_subscriptions](#input\_sns\_subscriptions)| Creates subscriptions to SNS topics which trigger the Lambda Function. Required Lambda invocation permissions will be generated. |`map(any)`|`{}`| no |
226
222
| <aname="input_source_code_hash"></a> [source\_code\_hash](#input\_source\_code\_hash)| Used to trigger updates. Must be set to a base64-encoded SHA256 hash of the package file specified with either<br> filename or s3\_key. The usual way to set this is filebase64sha256('file.zip') where 'file.zip' is the local filename<br> of the lambda function source archive. |`string`|`""`| no |
227
223
| <aname="input_ssm_parameter_names"></a> [ssm\_parameter\_names](#input\_ssm\_parameter\_names)| List of AWS Systems Manager Parameter Store parameter names. The IAM role of this Lambda function will be enhanced<br> with read permissions for those parameters. Parameters must start with a forward slash and can be encrypted with the<br> default KMS key. |`list(string)`|`null`| no |
228
224
| <aname="input_stage"></a> [stage](#input\_stage)| ID element. Usually used to indicate role, e.g. 'prod', 'staging', 'source', 'build', 'test', 'deploy', 'release' |`string`|`null`| no |
Copy file name to clipboardExpand all lines: docs/terraform.md
+1-5
Original file line number
Diff line number
Diff line change
@@ -45,9 +45,7 @@
45
45
| <aname="input_additional_tag_map"></a> [additional\_tag\_map](#input\_additional\_tag\_map)| Additional key-value pairs to add to each map in `tags_as_list_of_maps`. Not added to `tags` or `id`.<br>This is for some rare cases where resources want additional configuration of tags<br>and therefore take a list of maps with tag key, value, and additional configuration. |`map(string)`|`{}`| no |
46
46
| <aname="input_architectures"></a> [architectures](#input\_architectures)| Instruction set architecture for your Lambda function. Valid values are ["x86\_64"] and ["arm64"].<br> Default is ["x86\_64"]. Removing this attribute, function's architecture stay the same. |`list(string)`|`null`| no |
47
47
| <aname="input_attributes"></a> [attributes](#input\_attributes)| ID element. Additional attributes (e.g. `workers` or `cluster`) to add to `id`,<br>in the order they appear in the list. New attributes are appended to the<br>end of the list. The elements of the list are joined by the `delimiter`<br>and treated as a single ID element. |`list(string)`|`[]`| no |
48
-
| <aname="input_cloudwatch_event_rules"></a> [cloudwatch\_event\_rules](#input\_cloudwatch\_event\_rules)| Creates EventBridge (CloudWatch Events) rules for invoking the Lambda Function along with the required permissions. |`map(any)`|`{}`| no |
49
48
| <aname="input_cloudwatch_lambda_insights_enabled"></a> [cloudwatch\_lambda\_insights\_enabled](#input\_cloudwatch\_lambda\_insights\_enabled)| Enable CloudWatch Lambda Insights for the Lambda Function. |`bool`|`false`| no |
50
-
| <aname="input_cloudwatch_log_subscription_filters"></a> [cloudwatch\_log\_subscription\_filters](#input\_cloudwatch\_log\_subscription\_filters)| CloudWatch Logs subscription filter resources. Currently supports only Lambda functions as destinations. |`map(any)`|`{}`| no |
51
49
| <aname="input_cloudwatch_logs_kms_key_arn"></a> [cloudwatch\_logs\_kms\_key\_arn](#input\_cloudwatch\_logs\_kms\_key\_arn)| The ARN of the KMS Key to use when encrypting log data. |`string`|`null`| no |
52
50
| <aname="input_cloudwatch_logs_retention_in_days"></a> [cloudwatch\_logs\_retention\_in\_days](#input\_cloudwatch\_logs\_retention\_in\_days)| Specifies the number of days you want to retain log events in the specified log group. Possible values are:<br> 1, 3, 5, 7, 14, 30, 60, 90, 120, 150, 180, 365, 400, 545, 731, 1827, 3653, and 0. If you select 0, the events in the<br> log group are always retained and never expire. |`number`|`null`| no |
53
51
| <aname="input_context"></a> [context](#input\_context)| Single object for setting entire context at once.<br>See description of individual variables for details.<br>Leave string and numeric variables as `null` to use default value.<br>Individual variable settings (non-null) override settings in context object,<br>except for attributes, tags, and additional\_tag\_map, which are merged. |`any`| <pre>{<br> "additional_tag_map": {},<br> "attributes": [],<br> "delimiter": null,<br> "descriptor_formats": {},<br> "enabled": true,<br> "environment": null,<br> "id_length_limit": null,<br> "label_key_case": null,<br> "label_order": [],<br> "label_value_case": null,<br> "labels_as_tags": [<br> "unset"<br> ],<br> "name": null,<br> "namespace": null,<br> "regex_replace_chars": null,<br> "stage": null,<br> "tags": {},<br> "tenant": null<br>}</pre> | no |
@@ -58,13 +56,12 @@
58
56
| <aname="input_descriptor_formats"></a> [descriptor\_formats](#input\_descriptor\_formats)| Describe additional descriptors to be output in the `descriptors` output map.<br>Map of maps. Keys are names of descriptors. Values are maps of the form<br>`{<br> format = string<br> labels = list(string)<br>}`<br>(Type is `any` so the map values can later be enhanced to provide additional options.)<br>`format` is a Terraform format string to be passed to the `format()` function.<br>`labels` is a list of labels, in order, to pass to `format()` function.<br>Label values will be normalized before being passed to `format()` so they will be<br>identical to how they appear in `id`.<br>Default is `{}` (`descriptors` output will be empty). |`any`|`{}`| no |
59
57
| <aname="input_enabled"></a> [enabled](#input\_enabled)| Set to false to prevent the module from creating any resources |`bool`|`null`| no |
60
58
| <aname="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 |
61
-
| <aname="input_event_source_mappings"></a> [event\_source\_mappings](#input\_event\_source\_mappings)|Creates event source mappings to allow the Lambda function to get events from Kinesis, DynamoDB and SQS. The IAM role<br> of this Lambda function will be enhanced with necessary minimum permissions to get those events. |`any`|`{}`| no |
59
+
| <aname="input_ephemeral_storage_size"></a> [ephemeral\_storage\_size](#input\_ephemeral\_storage\_size)|The size of the Lambda function Ephemeral storage (/tmp) represented in MB.<br> The minimum supported ephemeral\_storage value defaults to 512MB and the maximum supported value is 10240MB. |`number`|`null`| no |
62
60
| <aname="input_filename"></a> [filename](#input\_filename)| The path to the function's deployment package within the local filesystem. If defined, The s3\_-prefixed options and image\_uri cannot be used. |`string`|`null`| no |
63
61
| <aname="input_function_name"></a> [function\_name](#input\_function\_name)| Unique name for the Lambda Function. |`string`| n/a | yes |
64
62
| <aname="input_handler"></a> [handler](#input\_handler)| The function entrypoint in your code. |`string`|`null`| no |
65
63
| <aname="input_iam_policy_description"></a> [iam\_policy\_description](#input\_iam\_policy\_description)| Description of the IAM policy for the Lambda IAM role |`string`|`"Provides minimum SSM read permissions."`| no |
66
64
| <aname="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 |
67
-
| <aname="input_ignore_external_function_updates"></a> [ignore\_external\_function\_updates](#input\_ignore\_external\_function\_updates)| Ignore updates to the Lambda Function executed externally to the Terraform lifecycle. Set this to `true` if you're<br> using CodeDeploy, aws CLI or other external tools to update the Lambda Function code." |`bool`|`false`| no |
68
65
| <aname="input_image_config"></a> [image\_config](#input\_image\_config)| The Lambda OCI [image configurations](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/lambda_function#image_config)<br> block with three (optional) arguments:<br> - *entry\_point* - The ENTRYPOINT for the docker image (type `list(string)`).<br> - *command* - The CMD for the docker image (type `list(string)`).<br> - *working\_directory* - The working directory for the docker image (type `string`). |`any`|`{}`| no |
69
66
| <aname="input_image_uri"></a> [image\_uri](#input\_image\_uri)| The ECR image URI containing the function's deployment package. Conflicts with filename, s3\_bucket, s3\_key, and s3\_object\_version. |`string`|`null`| no |
70
67
| <aname="input_kms_key_arn"></a> [kms\_key\_arn](#input\_kms\_key\_arn)| Amazon Resource Name (ARN) of the AWS Key Management Service (KMS) key that is used to encrypt environment variables.<br> If this configuration is not provided when environment variables are in use, AWS Lambda uses a default service key.<br> If this configuration is provided when environment variables are not in use, the AWS Lambda API does not save this<br> configuration and Terraform will show a perpetual difference of adding the key. To fix the perpetual difference,<br> remove this configuration. |`string`|`""`| no |
@@ -87,7 +84,6 @@
87
84
| <aname="input_s3_bucket"></a> [s3\_bucket](#input\_s3\_bucket)| The S3 bucket location containing the function's deployment package. Conflicts with filename and image\_uri.<br> This bucket must reside in the same AWS region where you are creating the Lambda function. |`string`|`null`| no |
88
85
| <aname="input_s3_key"></a> [s3\_key](#input\_s3\_key)| The S3 key of an object containing the function's deployment package. Conflicts with filename and image\_uri. |`string`|`null`| no |
89
86
| <aname="input_s3_object_version"></a> [s3\_object\_version](#input\_s3\_object\_version)| The object version containing the function's deployment package. Conflicts with filename and image\_uri. |`string`|`null`| no |
90
-
| <aname="input_sns_subscriptions"></a> [sns\_subscriptions](#input\_sns\_subscriptions)| Creates subscriptions to SNS topics which trigger the Lambda Function. Required Lambda invocation permissions will be generated. |`map(any)`|`{}`| no |
91
87
| <aname="input_source_code_hash"></a> [source\_code\_hash](#input\_source\_code\_hash)| Used to trigger updates. Must be set to a base64-encoded SHA256 hash of the package file specified with either<br> filename or s3\_key. The usual way to set this is filebase64sha256('file.zip') where 'file.zip' is the local filename<br> of the lambda function source archive. |`string`|`""`| no |
92
88
| <aname="input_ssm_parameter_names"></a> [ssm\_parameter\_names](#input\_ssm\_parameter\_names)| List of AWS Systems Manager Parameter Store parameter names. The IAM role of this Lambda function will be enhanced<br> with read permissions for those parameters. Parameters must start with a forward slash and can be encrypted with the<br> default KMS key. |`list(string)`|`null`| no |
93
89
| <aname="input_stage"></a> [stage](#input\_stage)| ID element. Usually used to indicate role, e.g. 'prod', 'staging', 'source', 'build', 'test', 'deploy', 'release' |`string`|`null`| no |
0 commit comments