-
Notifications
You must be signed in to change notification settings - Fork 2
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
3 changed files
with
126 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,34 @@ | ||
| ## Requirements | ||
|
|
||
| No requirements. | ||
|
|
||
| ## Providers | ||
|
|
||
| | Name | Version | | ||
| |------|---------| | ||
| | aws | n/a | | ||
| | null | n/a | | ||
|
|
||
| ## Inputs | ||
|
|
||
| | Name | Description | Type | Default | Required | | ||
| |------|-------------|------|---------|:--------:| | ||
| | \_module\_version | Module version number | `string` | `"2.0"` | no | | ||
| | access\_log\_bucket | Server Access Logging Bucket ID | `string` | n/a | yes | | ||
| | access\_log\_bucket\_prefix | Access log bucket prefix, to which the bucket name will be appended to make the target\_prefix | `string` | `"s3"` | no | | ||
| | allowed\_cidr | List of allowed source IPs (NOT from within the VPC) | `list(string)` | `[]` | no | | ||
| | allowed\_endpoints | List of allowed VPC endpoint IDs | `list(string)` | `[]` | no | | ||
| | bucket\_folders | List of folders (keys) to create after creation of bucket | `list(string)` | `[]` | no | | ||
| | bucket\_name | AWS Bucket Name | `string` | n/a | yes | | ||
| | force\_destroy | Sets force\_destroy to allow the bucket and contents to be deleted. The deletion may take a very long time | `bool` | `false` | no | | ||
| | kms\_key\_id | AWS KMS Key ID (one per bucket) | `string` | `""` | no | | ||
| | tags | AWS Tags | `map(string)` | `{}` | no | | ||
|
|
||
| ## Outputs | ||
|
|
||
| | Name | Description | | ||
| |------|-------------| | ||
| | kms\_key\_arn | Created KMS Key ARN | | ||
| | kms\_key\_id | Created KMS Key ID | | ||
| | s3\_bucket\_arn | Created S3 Bucket ARN | | ||
| | s3\_bucket\_id | Created S3 Bucket ID | |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,46 @@ | ||
| # About aws-s3 | ||
|
|
||
| # Usage | ||
|
|
||
| ```hcl | ||
| module "mybucket" { | ||
| source = "git@github.e.it.census.gov:terraform-modules/aws-s3//standard" | ||
| bucket_name = "mynormalbucket" | ||
| } | ||
| ``` | ||
|
|
||
| ## Requirements | ||
|
|
||
| No requirements. | ||
|
|
||
| ## Providers | ||
|
|
||
| | Name | Version | | ||
| |------|---------| | ||
| | aws | n/a | | ||
| | null | n/a | | ||
|
|
||
| ## Inputs | ||
|
|
||
| | Name | Description | Type | Default | Required | | ||
| |------|-------------|------|---------|:--------:| | ||
| | \_module\_version | Module version number | `string` | `"2.0"` | no | | ||
| | access\_log\_bucket | Server Access Logging Bucket ID | `string` | n/a | yes | | ||
| | access\_log\_bucket\_prefix | Access log bucket prefix, to which the bucket name will be appended to make the target\_prefix | `string` | `"s3"` | no | | ||
| | allowed\_cidr | List of allowed source IPs (NOT from within the VPC) | `list(string)` | `[]` | no | | ||
| | allowed\_endpoints | List of allowed VPC endpoint IDs | `list(string)` | `[]` | no | | ||
| | bucket\_folders | List of folders (keys) to create after creation of bucket | `list(string)` | `[]` | no | | ||
| | bucket\_name | AWS Bucket Name | `string` | n/a | yes | | ||
| | force\_destroy | Sets force\_destroy to allow the bucket and contents to be deleted. The deletion may take a very long time | `bool` | `false` | no | | ||
| | kms\_key\_id | AWS KMS Key ID (one per bucket) | `string` | `""` | no | | ||
| | tags | AWS Tags | `map(string)` | `{}` | no | | ||
|
|
||
| ## Outputs | ||
|
|
||
| | Name | Description | | ||
| |------|-------------| | ||
| | kms\_key\_arn | Created KMS Key ARN | | ||
| | kms\_key\_id | Created KMS Key ID | | ||
| | s3\_bucket\_arn | Created S3 Bucket ARN | | ||
| | s3\_bucket\_id | Created S3 Bucket ID | |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,46 @@ | ||
| # About aws-s3 | ||
|
|
||
| # Usage | ||
|
|
||
| ```hcl | ||
| module "mybucket" { | ||
| source = "git@github.e.it.census.gov:terraform-modules/aws-s3//title26" | ||
| bucket_name = "myt26bucket" | ||
| } | ||
| ``` | ||
|
|
||
| ## Requirements | ||
|
|
||
| No requirements. | ||
|
|
||
| ## Providers | ||
|
|
||
| | Name | Version | | ||
| |------|---------| | ||
| | aws | n/a | | ||
| | null | n/a | | ||
|
|
||
| ## Inputs | ||
|
|
||
| | Name | Description | Type | Default | Required | | ||
| |------|-------------|------|---------|:--------:| | ||
| | \_module\_version | Module version number | `string` | `"2.0"` | no | | ||
| | access\_log\_bucket | Server Access Logging Bucket ID | `string` | n/a | yes | | ||
| | access\_log\_bucket\_prefix | Access log bucket prefix, to which the bucket name will be appended to make the target\_prefix | `string` | `"s3"` | no | | ||
| | allowed\_cidr | List of allowed source IPs (NOT from within the VPC) | `list(string)` | `[]` | no | | ||
| | allowed\_endpoints | List of allowed VPC endpoint IDs | `list(string)` | `[]` | no | | ||
| | bucket\_folders | List of folders (keys) to create after creation of bucket | `list(string)` | `[]` | no | | ||
| | bucket\_name | AWS Bucket Name | `string` | n/a | yes | | ||
| | force\_destroy | Sets force\_destroy to allow the bucket and contents to be deleted. The deletion may take a very long time | `bool` | `false` | no | | ||
| | kms\_key\_id | AWS KMS Key ID (one per bucket) | `string` | `""` | no | | ||
| | tags | AWS Tags | `map(string)` | `{}` | no | | ||
|
|
||
| ## Outputs | ||
|
|
||
| | Name | Description | | ||
| |------|-------------| | ||
| | kms\_key\_arn | Created KMS Key ARN | | ||
| | kms\_key\_id | Created KMS Key ID | | ||
| | s3\_bucket\_arn | Created S3 Bucket ARN | | ||
| | s3\_bucket\_id | Created S3 Bucket ID | |