71 lines
4.5 KiB
Markdown
71 lines
4.5 KiB
Markdown
<!-- This readme file is generated with terraform-docs -->
|
|
## Requirements
|
|
|
|
| Name | Version |
|
|
|------|---------|
|
|
| terraform | >= 1.13.0 |
|
|
| aws | >= 6.38.0 |
|
|
|
|
## Providers
|
|
|
|
| Name | Version |
|
|
|------|---------|
|
|
| aws | >= 6.38.0 |
|
|
|
|
## Modules
|
|
|
|
No modules.
|
|
|
|
## Resources
|
|
|
|
| Name | Type |
|
|
|------|------|
|
|
| [aws_s3_bucket.this](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/s3_bucket) | resource |
|
|
| [aws_s3_bucket_intelligent_tiering_configuration.intel_tiering_config](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/s3_bucket_intelligent_tiering_configuration) | resource |
|
|
| [aws_s3_bucket_lifecycle_configuration.lifecycle](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/s3_bucket_lifecycle_configuration) | resource |
|
|
| [aws_s3_bucket_logging.logging](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/s3_bucket_logging) | resource |
|
|
| [aws_s3_bucket_policy.bucket_policy](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/s3_bucket_policy) | resource |
|
|
| [aws_s3_bucket_public_access_block.block_public_access](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/s3_bucket_public_access_block) | resource |
|
|
| [aws_s3_bucket_replication_configuration.replication](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/s3_bucket_replication_configuration) | resource |
|
|
| [aws_s3_bucket_server_side_encryption_configuration.encryption](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/s3_bucket_server_side_encryption_configuration) | resource |
|
|
| [aws_s3_bucket_versioning.versioning](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/s3_bucket_versioning) | resource |
|
|
| [aws_iam_policy_document.bucket_policy](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/data-sources/iam_policy_document) | data source |
|
|
|
|
## Inputs
|
|
|
|
| Name | Description | Type | Default | Required |
|
|
|------|-------------|------|---------|:--------:|
|
|
| bucket-namespace | Use global or account-regional namespace. Defaults to global | `string` | `"global"` | no |
|
|
| bucket\_name | Name of bucket | `string` | n/a | yes |
|
|
| bucket\_policy\_json | Json-encoded bucket policy. The AllowSSLRequestsOnly policy is merged with this input. | `string` | `"{}"` | no |
|
|
| current-version-archive-tier | Current version archive storage class. Valid values are GLACIER, STANDARD\_IA, ONEZONE\_IA, INTELLIGENT\_TIERING, DEEP\_ARCHIVE, GLACIER\_IR | `string` | `null` | no |
|
|
| current-version-transition-days | Days to transition current version to archive | `number` | `15` | no |
|
|
| current\_version\_expiration\_days | 731 for flowlogs | `number` | `2560` | no |
|
|
| enable\_bucket\_lifecycle | Enable s3 bucket lifecycle | `bool` | n/a | yes |
|
|
| enable\_bucket\_logging | Enable bucket logging | `bool` | n/a | yes |
|
|
| enable\_encryption | Enable encryption for s3 bucket | `bool` | n/a | yes |
|
|
| enable\_intelligent\_tiering | Enable intelligent tiering | `bool` | `false` | no |
|
|
| enable\_replication | Enable s3 bucket replication | `bool` | `false` | no |
|
|
| enable\_versioning | Enable s3 bucket versioning | `bool` | n/a | yes |
|
|
| encryption-enable-bucket-key | Enable bucket key | `bool` | `false` | no |
|
|
| encryption\_key\_arn | Leave blank to use AES256 | `string` | `""` | no |
|
|
| force-destroy | Boolean that indicates all objects should be deleted from the bucket when the bucket is destroyed | `bool` | `true` | no |
|
|
| logging\_bucket\_id | Logging bucket id | `string` | `null` | no |
|
|
| noncurrent-version-archive-tier | Non-current version archive storage class. Valid values are GLACIER, STANDARD\_IA, ONEZONE\_IA, INTELLIGENT\_TIERING, DEEP\_ARCHIVE, GLACIER\_IR | `string` | `"GLACIER"` | no |
|
|
| noncurrent-version-transition-days | Days to transition non-current version to archive | `number` | `15` | no |
|
|
| noncurrent\_version\_expiration\_days | 731 for flowlogs | `number` | `2560` | no |
|
|
| replication\_dest\_bucket\_name | Replica bucket name | `string` | `null` | no |
|
|
| replication\_destination\_aws\_account\_id | AWS account id of replica bucket | `number` | `null` | no |
|
|
| replication\_destination\_kms\_key\_arn | KMS key ARN of destination bucket | `string` | `null` | no |
|
|
| replication\_role\_arn | IAM role of s3 bucket replication | `string` | `null` | no |
|
|
|
|
## Outputs
|
|
|
|
| Name | Description |
|
|
|------|-------------|
|
|
| bucket\_arn | n/a |
|
|
| bucket\_name | n/a |
|
|
|
|
---
|
|
## Authorship
|
|
This module was developed by xpk. |