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
|[aws_iam_policy_document.aggregated_policy](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/data-sources/iam_policy_document)| data source |
242
+
|[aws_iam_policy_document.bucket_policy](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/data-sources/iam_policy_document)| data source |
243
+
|[aws_iam_policy_document.replication](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/data-sources/iam_policy_document)| data source |
244
+
|[aws_iam_policy_document.replication_sts](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/data-sources/iam_policy_document)| data source |
245
+
|[aws_region.current](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/data-sources/region)| data source |
246
+
247
+
## Inputs
248
+
249
+
| Name | Description | Type | Default | Required |
| <aname="input_acl"></a> [acl](#input\_acl)| The canned ACL to apply to the S3 bucket |`string`|`"private"`| no |
252
+
| <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 |
253
+
| <aname="input_arn_format"></a> [arn\_format](#input\_arn\_format)| ARN format to be used. May be changed to support deployment in GovCloud/China regions. |`string`|`"arn:aws"`| no |
254
+
| <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 |
255
+
| <aname="input_billing_mode"></a> [billing\_mode](#input\_billing\_mode)| DynamoDB billing mode |`string`|`"PAY_PER_REQUEST"`| no |
256
+
| <aname="input_block_public_acls"></a> [block\_public\_acls](#input\_block\_public\_acls)| Whether Amazon S3 should block public ACLs for this bucket |`bool`|`true`| no |
257
+
| <aname="input_block_public_policy"></a> [block\_public\_policy](#input\_block\_public\_policy)| Whether Amazon S3 should block public bucket policies for this bucket |`bool`|`true`| no |
258
+
| <aname="input_bucket_enabled"></a> [bucket\_enabled](#input\_bucket\_enabled)| Whether to create the S3 bucket. |`bool`|`true`| no |
259
+
| <aname="input_bucket_ownership_enforced_enabled"></a> [bucket\_ownership\_enforced\_enabled](#input\_bucket\_ownership\_enforced\_enabled)| Set bucket object ownership to "BucketOwnerEnforced". Disables ACLs. |`bool`|`true`| no |
260
+
| <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 |
261
+
| <aname="input_deletion_protection_enabled"></a> [deletion\_protection\_enabled](#input\_deletion\_protection\_enabled)| A boolean that enables deletion protection for DynamoDB table |`bool`|`false`| no |
262
+
| <aname="input_delimiter"></a> [delimiter](#input\_delimiter)| Delimiter to be used between ID elements.<br/>Defaults to `-` (hyphen). Set to `""` to use no delimiter at all. |`string`|`null`| no |
263
+
| <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 |
264
+
| <aname="input_dynamodb_enabled"></a> [dynamodb\_enabled](#input\_dynamodb\_enabled)| Whether to create the DynamoDB table. |`bool`|`true`| no |
265
+
| <aname="input_dynamodb_table_name"></a> [dynamodb\_table\_name](#input\_dynamodb\_table\_name)| Override the name of the DynamoDB table which defaults to using `module.dynamodb_table_label.id`|`string`|`null`| no |
266
+
| <aname="input_enable_point_in_time_recovery"></a> [enable\_point\_in\_time\_recovery](#input\_enable\_point\_in\_time\_recovery)| Enable DynamoDB point-in-time recovery |`bool`|`true`| no |
267
+
| <aname="input_enable_public_access_block"></a> [enable\_public\_access\_block](#input\_enable\_public\_access\_block)| Enable Bucket Public Access Block |`bool`|`true`| no |
268
+
| <aname="input_enabled"></a> [enabled](#input\_enabled)| Set to false to prevent the module from creating any resources |`bool`|`null`| no |
269
+
| <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 |
270
+
| <aname="input_force_destroy"></a> [force\_destroy](#input\_force\_destroy)| A boolean that indicates the S3 bucket can be destroyed even if it contains objects. These objects are not recoverable |`bool`|`false`| no |
271
+
| <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 |
272
+
| <aname="input_ignore_public_acls"></a> [ignore\_public\_acls](#input\_ignore\_public\_acls)| Whether Amazon S3 should ignore public ACLs for this bucket |`bool`|`true`| no |
273
+
| <aname="input_kms_master_key_id"></a> [kms\_master\_key\_id](#input\_kms\_master\_key\_id)| AWS KMS master key ID used for the SSE-KMS encryption.<br/>This can only be used when you set the value of sse\_algorithm as aws:kms. |`string`|`null`| no |
274
+
| <aname="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 |
275
+
| <aname="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 |
276
+
| <aname="input_label_value_case"></a> [label\_value\_case](#input\_label\_value\_case)| Controls the letter case of ID elements (labels) as included in `id`,<br/>set as tag values, and output by this module individually.<br/>Does not affect values of tags passed in via the `tags` input.<br/>Possible values: `lower`, `title`, `upper` and `none` (no transformation).<br/>Set this to `title` and set `delimiter` to `""` to yield Pascal Case IDs.<br/>Default value: `lower`. |`string`|`null`| no |
277
+
| <aname="input_labels_as_tags"></a> [labels\_as\_tags](#input\_labels\_as\_tags)| Set of labels (ID elements) to include as tags in the `tags` output.<br/>Default is to include all labels.<br/>Tags with empty values will not be included in the `tags` output.<br/>Set to `[]` to suppress all generated tags.<br/>**Notes:**<br/> The value of the `name` tag, if included, will be the `id`, not the `name`.<br/> Unlike other `null-label` inputs, the initial setting of `labels_as_tags` cannot be<br/> changed in later chained modules. Attempts to change it will be silently ignored. |`set(string)`| <pre>[<br/> "default"<br/>]</pre> | no |
278
+
| <aname="input_logging"></a> [logging](#input\_logging)| Destination (S3 bucket name and prefix) for S3 Server Access Logs for the S3 bucket. | <pre>list(object({<br/> target_bucket = string<br/> target_prefix = string<br/> }))</pre> |`[]`| no |
279
+
| <aname="input_mfa_delete"></a> [mfa\_delete](#input\_mfa\_delete)| A boolean that indicates that versions of S3 objects can only be deleted with MFA. ( Terraform cannot apply changes of this value; https://github.com/terraform-providers/terraform-provider-aws/issues/629 ) |`bool`|`false`| no |
280
+
| <aname="input_name"></a> [name](#input\_name)| ID element. Usually the component or solution name, e.g. 'app' or 'jenkins'.<br/>This is the only ID element not also included as a `tag`.<br/>The "name" tag is set to the full `id` string. There is no tag with the value of the `name` input. |`string`|`null`| no |
281
+
| <aname="input_namespace"></a> [namespace](#input\_namespace)| ID element. Usually an abbreviation of your organization name, e.g. 'eg' or 'cp', to help ensure generated IDs are globally unique |`string`|`null`| no |
282
+
| <aname="input_permissions_boundary"></a> [permissions\_boundary](#input\_permissions\_boundary)| ARN of the policy that is used to set the permissions boundary for the IAM replication role |`string`|`""`| no |
283
+
| <aname="input_prevent_unencrypted_uploads"></a> [prevent\_unencrypted\_uploads](#input\_prevent\_unencrypted\_uploads)| Prevent uploads of unencrypted objects to S3 |`bool`|`true`| no |
284
+
| <aname="input_profile"></a> [profile](#input\_profile)| AWS profile name as set in the shared credentials file |`string`|`""`| no |
285
+
| <aname="input_read_capacity"></a> [read\_capacity](#input\_read\_capacity)| DynamoDB read capacity units when using provisioned mode |`number`|`5`| no |
286
+
| <aname="input_regex_replace_chars"></a> [regex\_replace\_chars](#input\_regex\_replace\_chars)| Terraform regular expression (regex) string.<br/>Characters matching the regex will be removed from the ID elements.<br/>If not set, `"/[^a-zA-Z0-9-]/"` is used to remove all characters other than hyphens, letters and digits. |`string`|`null`| no |
287
+
| <aname="input_restrict_public_buckets"></a> [restrict\_public\_buckets](#input\_restrict\_public\_buckets)| Whether Amazon S3 should restrict public bucket policies for this bucket |`bool`|`true`| no |
288
+
| <aname="input_role_arn"></a> [role\_arn](#input\_role\_arn)| The role to be assumed |`string`|`""`| no |
289
+
| <aname="input_s3_bucket_name"></a> [s3\_bucket\_name](#input\_s3\_bucket\_name)| S3 bucket name. If not provided, the name will be generated from the context by the label module. |`string`|`""`| no |
290
+
| <aname="input_s3_replica_bucket_arn"></a> [s3\_replica\_bucket\_arn](#input\_s3\_replica\_bucket\_arn)| The ARN of the S3 replica bucket (destination) |`string`|`""`| no |
291
+
| <aname="input_s3_replication_enabled"></a> [s3\_replication\_enabled](#input\_s3\_replication\_enabled)| Set this to true and specify `s3_replica_bucket_arn` to enable replication |`bool`|`false`| no |
292
+
| <aname="input_source_policy_documents"></a> [source\_policy\_documents](#input\_source\_policy\_documents)| List of IAM policy documents (in JSON format) that are merged together into the generated S3 bucket policy.<br/>Statements must have unique SIDs.<br/>Statement having SIDs that match policy SIDs generated by this module will override them. |`list(string)`|`[]`| no |
293
+
| <aname="input_sse_encryption"></a> [sse\_encryption](#input\_sse\_encryption)| The server-side encryption algorithm to use.<br/>Valid values are `AES256`, `aws:kms`, and `aws:kms:dsse`. |`string`|`"AES256"`| no |
294
+
| <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 |
295
+
| <aname="input_tags"></a> [tags](#input\_tags)| Additional tags (e.g. `{'BusinessUnit': 'XYZ'}`).<br/>Neither the tag keys nor the tag values will be modified by this module. |`map(string)`|`{}`| no |
296
+
| <aname="input_tenant"></a> [tenant](#input\_tenant)| ID element \_(Rarely used, not included by default)\_. A customer identifier, indicating who this instance of a resource is for |`string`|`null`| no |
297
+
| <aname="input_terraform_backend_config_file_name"></a> [terraform\_backend\_config\_file\_name](#input\_terraform\_backend\_config\_file\_name)| (Deprecated) Name of terraform backend config file to generate |`string`|`"terraform.tf"`| no |
298
+
| <aname="input_terraform_backend_config_file_path"></a> [terraform\_backend\_config\_file\_path](#input\_terraform\_backend\_config\_file\_path)| (Deprecated) Directory for the terraform backend config file, usually `.`. The default is to create no file. |`string`|`""`| no |
299
+
| <aname="input_terraform_backend_config_template_file"></a> [terraform\_backend\_config\_template\_file](#input\_terraform\_backend\_config\_template\_file)| (Deprecated) The path to the template used to generate the config file |`string`|`""`| no |
300
+
| <aname="input_terraform_state_file"></a> [terraform\_state\_file](#input\_terraform\_state\_file)| The path to the state file inside the bucket |`string`|`"terraform.tfstate"`| no |
301
+
| <aname="input_terraform_version"></a> [terraform\_version](#input\_terraform\_version)| The minimum required terraform version |`string`|`"1.0.0"`| no |
302
+
| <aname="input_write_capacity"></a> [write\_capacity](#input\_write\_capacity)| DynamoDB write capacity units when using provisioned mode |`number`|`5`| no |
| <aname="output_s3_bucket_domain_name"></a> [s3\_bucket\_domain\_name](#output\_s3\_bucket\_domain\_name)| S3 bucket domain name |
313
+
| <aname="output_s3_bucket_id"></a> [s3\_bucket\_id](#output\_s3\_bucket\_id)| S3 bucket ID |
314
+
| <aname="output_s3_replication_role_arn"></a> [s3\_replication\_role\_arn](#output\_s3\_replication\_role\_arn)| The ARN of the IAM Role created for replication, if enabled. |
0 commit comments