Skip to content

Commit 147fabc

Browse files
actions-userLinter Bot
actions-user
authored and
Linter Bot
committed
Apply automatic changes
1 parent 36bf92e commit 147fabc

File tree

3 files changed

+64
-23
lines changed

3 files changed

+64
-23
lines changed

‎README.md‎

Lines changed: 32 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -58,34 +58,51 @@ region = "us-east-1"
5858

5959
| Name | Version |
6060
|------|---------|
61-
| terraform | >= 0.13 |
62-
| aws | ~> 3.15.0 |
61+
| <a name="requirement_terraform"></a> [terraform](#requirement\_terraform) | >= 0.13 |
62+
| <a name="requirement_aws"></a> [aws](#requirement\_aws) | ~> 3.15.0 |
6363

6464
## Providers
6565

6666
| Name | Version |
6767
|------|---------|
68-
| aws | ~> 3.15.0 |
68+
| <a name="provider_aws"></a> [aws](#provider\_aws) | ~> 3.15.0 |
69+
70+
## Modules
71+
72+
No modules.
73+
74+
## Resources
75+
76+
| Name | Type |
77+
|------|------|
78+
| [aws_dynamodb_table.this](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/dynamodb_table) | resource |
79+
| [aws_kms_alias.this](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/kms_alias) | resource |
80+
| [aws_kms_key.this](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/kms_key) | resource |
81+
| [aws_s3_bucket.this](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/s3_bucket) | resource |
82+
| [aws_s3_bucket_policy.this](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/s3_bucket_policy) | resource |
83+
| [aws_s3_bucket_public_access_block.this](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/s3_bucket_public_access_block) | resource |
84+
| [aws_caller_identity.current](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/data-sources/caller_identity) | data source |
85+
| [aws_iam_policy_document.key](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/data-sources/iam_policy_document) | data source |
86+
| [aws_iam_policy_document.this](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/data-sources/iam_policy_document) | data source |
6987

7088
## Inputs
7189

7290
| Name | Description | Type | Default | Required |
7391
|------|-------------|------|---------|:--------:|
74-
| allowed\_account\_ids | Account IDs that are allowed to access the bucket/KMS key | `list(string)` | `[]` | no |
75-
| bucket | Name of bucket to create (do not provide if using `remote_bucket`) | `string` | `""` | no |
76-
| kms\_alias\_name | Name of KMS Alias | `string` | `""` | no |
77-
| kms\_key\_id | ARN for KMS key for all encryption operations. | `string` | `""` | no |
78-
| logging\_target\_bucket | The name of the bucket that will receive the log objects | `string` | `null` | no |
79-
| logging\_target\_prefix | A key prefix for log objects | `string` | `"TFStateLogs/"` | no |
80-
| remote\_bucket | If specified, the remote bucket will be used for the backend. A new bucket will not be created | `string` | `""` | no |
81-
| table | Name of Dynamo Table to create | `string` | `"tf-locktable"` | no |
82-
| tags | Mapping of any extra tags you want added to resources | `map(string)` | `{}` | no |
92+
| <a name="input_allowed_account_ids"></a> [allowed\_account\_ids](#input\_allowed\_account\_ids) | Account IDs that are allowed to access the bucket/KMS key | `list(string)` | `[]` | no |
93+
| <a name="input_bucket"></a> [bucket](#input\_bucket) | Name of bucket to create (do not provide if using `remote_bucket`) | `string` | `""` | no |
94+
| <a name="input_kms_alias_name"></a> [kms\_alias\_name](#input\_kms\_alias\_name) | Name of KMS Alias | `string` | `""` | no |
95+
| <a name="input_kms_key_id"></a> [kms\_key\_id](#input\_kms\_key\_id) | ARN for KMS key for all encryption operations. | `string` | `""` | no |
96+
| <a name="input_logging_target_bucket"></a> [logging\_target\_bucket](#input\_logging\_target\_bucket) | The name of the bucket that will receive the log objects | `string` | `null` | no |
97+
| <a name="input_logging_target_prefix"></a> [logging\_target\_prefix](#input\_logging\_target\_prefix) | A key prefix for log objects | `string` | `"TFStateLogs/"` | no |
98+
| <a name="input_remote_bucket"></a> [remote\_bucket](#input\_remote\_bucket) | If specified, the remote bucket will be used for the backend. A new bucket will not be created | `string` | `""` | no |
99+
| <a name="input_table"></a> [table](#input\_table) | Name of Dynamo Table to create | `string` | `"tf-locktable"` | no |
100+
| <a name="input_tags"></a> [tags](#input\_tags) | Mapping of any extra tags you want added to resources | `map(string)` | `{}` | no |
83101

84102
## Outputs
85103

86104
| Name | Description |
87105
|------|-------------|
88-
| kms\_key\_arn | ARN of KMS Key for S3 bucket |
89-
| s3\_bucket\_backend | S3 bucket |
90-
106+
| <a name="output_kms_key_arn"></a> [kms\_key\_arn](#output\_kms\_key\_arn) | ARN of KMS Key for S3 bucket |
107+
| <a name="output_s3_bucket_backend"></a> [s3\_bucket\_backend](#output\_s3\_bucket\_backend) | S3 bucket |
91108
<!-- END OF PRE-COMMIT-TERRAFORM DOCS HOOK -->

‎examples/basic/README.md‎

Lines changed: 17 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -10,14 +10,27 @@ No requirements.
1010

1111
| Name | Version |
1212
|------|---------|
13-
| aws | n/a |
13+
| <a name="provider_aws"></a> [aws](#provider\_aws) | n/a |
14+
15+
## Modules
16+
17+
| Name | Source | Version |
18+
|------|--------|---------|
19+
| <a name="module_backend"></a> [backend](#module\_backend) | ../.. | |
20+
| <a name="module_tags"></a> [tags](#module\_tags) | rhythmictech/tags/terraform | 1.0.0 |
21+
22+
## Resources
23+
24+
| Name | Type |
25+
|------|------|
26+
| [aws_caller_identity.current](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/data-sources/caller_identity) | data source |
27+
| [aws_region.current](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/data-sources/region) | data source |
1428

1529
## Inputs
1630

17-
No input.
31+
No inputs.
1832

1933
## Outputs
2034

21-
No output.
22-
35+
No outputs.
2336
<!-- END OF PRE-COMMIT-TERRAFORM DOCS HOOK -->

‎examples/external-logging/README.md‎

Lines changed: 15 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -9,14 +9,25 @@ No requirements.
99

1010
## Providers
1111

12-
No provider.
12+
No providers.
13+
14+
## Modules
15+
16+
| Name | Source | Version |
17+
|------|--------|---------|
18+
| <a name="module_backend"></a> [backend](#module\_backend) | ../.. | |
19+
| <a name="module_bucket"></a> [bucket](#module\_bucket) | rhythmictech/s3logging-bucket/aws | 2.0.0 |
20+
| <a name="module_tags"></a> [tags](#module\_tags) | rhythmictech/tags/terraform | 1.0.0 |
21+
22+
## Resources
23+
24+
No resources.
1325

1426
## Inputs
1527

16-
No input.
28+
No inputs.
1729

1830
## Outputs
1931

20-
No output.
21-
32+
No outputs.
2233
<!-- END OF PRE-COMMIT-TERRAFORM DOCS HOOK -->

0 commit comments

Comments
 (0)