121 lines
3.6 KiB
Markdown
121 lines
3.6 KiB
Markdown
## Requirements
|
|
|
|
The following requirements are needed by this module:
|
|
|
|
- <a name="requirement_aws"></a> [aws](#requirement\_aws) (~> 4.9)
|
|
|
|
## Providers
|
|
|
|
The following providers are used by this module:
|
|
|
|
- <a name="provider_aws"></a> [aws](#provider\_aws) (~> 4.9)
|
|
|
|
## Modules
|
|
|
|
The following Modules are called:
|
|
|
|
### <a name="module_states_bucket"></a> [states\_bucket](#module\_states\_bucket)
|
|
|
|
Source: terraform-aws-modules/s3-bucket/aws
|
|
|
|
Version:
|
|
|
|
## Resources
|
|
|
|
The following resources are used by this module:
|
|
|
|
- [aws_dynamodb_table.lock](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/dynamodb_table) (resource)
|
|
- [aws_iam_policy.terraform](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/iam_policy) (resource)
|
|
- [aws_kms_key.this](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/kms_key) (resource)
|
|
- [aws_iam_policy_document.access_state](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/data-sources/iam_policy_document) (data source)
|
|
- [aws_iam_policy_document.force_secure_transport](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/data-sources/iam_policy_document) (data source)
|
|
- [aws_region.current](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/data-sources/region) (data source)
|
|
|
|
## Required Inputs
|
|
|
|
No required inputs.
|
|
|
|
## Optional Inputs
|
|
|
|
The following input variables are optional (have default values):
|
|
|
|
### <a name="input_bucket_name_override"></a> [bucket\_name\_override](#input\_bucket\_name\_override)
|
|
|
|
Description: Explicit name for the remote state bucket. If not specified, the bucket will be named as {name\_prefix}-{region\_name}-states
|
|
|
|
Type: `string`
|
|
|
|
Default: `null`
|
|
|
|
### <a name="input_name_prefix"></a> [name\_prefix](#input\_name\_prefix)
|
|
|
|
Description: Resource names prefixed by this string.
|
|
|
|
Type: `string`
|
|
|
|
Default: `null`
|
|
|
|
### <a name="input_table_billing_mode"></a> [table\_billing\_mode](#input\_table\_billing\_mode)
|
|
|
|
Description: Table billing mode. Can be PAY\_PER\_REQUEST or PROVISIONED
|
|
|
|
Type: `string`
|
|
|
|
Default: `"PAY_PER_REQUEST"`
|
|
|
|
### <a name="input_table_encryption_at_rest"></a> [table\_encryption\_at\_rest](#input\_table\_encryption\_at\_rest)
|
|
|
|
Description: Wheather or not apply encryption at rest for the DynamoDB.
|
|
|
|
Type: `bool`
|
|
|
|
Default: `false`
|
|
|
|
### <a name="input_table_name_override"></a> [table\_name\_override](#input\_table\_name\_override)
|
|
|
|
Description: Explicit name for the remote state lock DynamoDB table. If not specified, the table will be named as {name\_prefix}-{region\_name}-tf-state-locks
|
|
|
|
Type: `string`
|
|
|
|
Default: `null`
|
|
|
|
### <a name="input_table_read_capacity"></a> [table\_read\_capacity](#input\_table\_read\_capacity)
|
|
|
|
Description: (Optional) The number of read units for this table. If the billing\_mode is PROVISIONED, this field is required
|
|
|
|
Type: `number`
|
|
|
|
Default: `0`
|
|
|
|
### <a name="input_table_write_capacity"></a> [table\_write\_capacity](#input\_table\_write\_capacity)
|
|
|
|
Description: (Optional) The number of write units for the lock table. If the billing\_mode is PROVISIONED, this field is required
|
|
|
|
Type: `number`
|
|
|
|
Default: `0`
|
|
|
|
## Outputs
|
|
|
|
The following outputs are exported:
|
|
|
|
### <a name="output_bucket_name"></a> [bucket\_name](#output\_bucket\_name)
|
|
|
|
Description: n/a
|
|
|
|
### <a name="output_kms_key"></a> [kms\_key](#output\_kms\_key)
|
|
|
|
Description: n/a
|
|
|
|
### <a name="output_lock_table"></a> [lock\_table](#output\_lock\_table)
|
|
|
|
Description: n/a
|
|
|
|
### <a name="output_lock_table_name"></a> [lock\_table\_name](#output\_lock\_table\_name)
|
|
|
|
Description: n/a
|
|
|
|
### <a name="output_terraform_policy"></a> [terraform\_policy](#output\_terraform\_policy)
|
|
|
|
Description: n/a
|