Skip to content

Commit

Permalink
pre-commit
Browse files Browse the repository at this point in the history
  • Loading branch information
vijay-stephen committed Jul 30, 2024
1 parent 9ed8881 commit d617003
Show file tree
Hide file tree
Showing 7 changed files with 71 additions and 90 deletions.
92 changes: 28 additions & 64 deletions README.md

Large diffs are not rendered by default.

21 changes: 12 additions & 9 deletions examples/replication/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,9 @@ No providers.

| Name | Source | Version |
|------|--------|---------|
| <a name="module_arc-s3"></a> [arc-s3](#module\_arc-s3) | ../ | n/a |
| <a name="module_dest_bucket"></a> [dest\_bucket](#module\_dest\_bucket) | ../../ | n/a |
| <a name="module_replication"></a> [replication](#module\_replication) | ../../ | n/a |
| <a name="module_src_bucket"></a> [src\_bucket](#module\_src\_bucket) | ../../ | n/a |
| <a name="module_tags"></a> [tags](#module\_tags) | sourcefuse/arc-tags/aws | 1.2.3 |

## Resources
Expand All @@ -27,18 +29,19 @@ No resources.

| Name | Description | Type | Default | Required |
|------|-------------|------|---------|:--------:|
| <a name="input_acl"></a> [acl](#input\_acl) | The ACL for the S3 bucket | `string` | `"private"` | no |
| <a name="input_bucket_key_enabled"></a> [bucket\_key\_enabled](#input\_bucket\_key\_enabled) | Enable or disable bucket key for the S3 bucket | `bool` | `true` | no |
| <a name="input_bucket_name"></a> [bucket\_name](#input\_bucket\_name) | The name of the S3 bucket | `string` | n/a | yes |
| <a name="input_cors_configuration"></a> [cors\_configuration](#input\_cors\_configuration) | Specifies the allowed headers, methods, origins and exposed headers when using CORS on this bucket | <pre>list(object({<br> id = optional(string)<br> allowed_headers = optional(list(string))<br> allowed_methods = optional(list(string))<br> allowed_origins = optional(list(string))<br> expose_headers = optional(list(string))<br> max_age_seconds = optional(number)<br> }))</pre> | `[]` | no |
| <a name="input_enable_notifications"></a> [enable\_notifications](#input\_enable\_notifications) | Enable or disable notifications for the S3 bucket | `bool` | `false` | no |
| <a name="input_acl"></a> [acl](#input\_acl) | ACL value | `string` | n/a | yes |
| <a name="input_dest_bucket_name"></a> [dest\_bucket\_name](#input\_dest\_bucket\_name) | Destination Bucket Name | `string` | n/a | yes |
| <a name="input_region"></a> [region](#input\_region) | AWS region | `string` | `"us-east-1"` | no |
| <a name="input_website_configuration"></a> [website\_configuration](#input\_website\_configuration) | The website configuration for the S3 bucket | `list(any)` | `[]` | no |
| <a name="input_src_bucket_name"></a> [src\_bucket\_name](#input\_src\_bucket\_name) | Source Bucket Name | `string` | n/a | yes |

## Outputs

| Name | Description |
|------|-------------|
| <a name="output_bucket_arn"></a> [bucket\_arn](#output\_bucket\_arn) | n/a |
| <a name="output_bucket_id"></a> [bucket\_id](#output\_bucket\_id) | n/a |
| <a name="output_dest_bucket_arn"></a> [dest\_bucket\_arn](#output\_dest\_bucket\_arn) | n/a |
| <a name="output_dest_bucket_id"></a> [dest\_bucket\_id](#output\_dest\_bucket\_id) | n/a |
| <a name="output_destination_buckets"></a> [destination\_buckets](#output\_destination\_buckets) | n/a |
| <a name="output_role_arn"></a> [role\_arn](#output\_role\_arn) | Role used to S3 replication |
| <a name="output_src_bucket_arn"></a> [src\_bucket\_arn](#output\_src\_bucket\_arn) | n/a |
| <a name="output_src_bucket_id"></a> [src\_bucket\_id](#output\_src\_bucket\_id) | n/a |
<!-- END OF PRE-COMMIT-TERRAFORM DOCS HOOK -->
2 changes: 1 addition & 1 deletion examples/replication/main.tf
Original file line number Diff line number Diff line change
Expand Up @@ -67,4 +67,4 @@ module "replication" {
tags = module.tags.tags

depends_on = [module.src_bucket, module.dest_bucket]
}
}
10 changes: 3 additions & 7 deletions examples/simple/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ No providers.

| Name | Source | Version |
|------|--------|---------|
| <a name="module_arc-s3"></a> [arc-s3](#module\_arc-s3) | ../ | n/a |
| <a name="module_s3"></a> [s3](#module\_s3) | ../../ | n/a |
| <a name="module_tags"></a> [tags](#module\_tags) | sourcefuse/arc-tags/aws | 1.2.3 |

## Resources
Expand All @@ -27,13 +27,9 @@ No resources.

| Name | Description | Type | Default | Required |
|------|-------------|------|---------|:--------:|
| <a name="input_acl"></a> [acl](#input\_acl) | The ACL for the S3 bucket | `string` | `"private"` | no |
| <a name="input_bucket_key_enabled"></a> [bucket\_key\_enabled](#input\_bucket\_key\_enabled) | Enable or disable bucket key for the S3 bucket | `bool` | `true` | no |
| <a name="input_bucket_name"></a> [bucket\_name](#input\_bucket\_name) | The name of the S3 bucket | `string` | n/a | yes |
| <a name="input_cors_configuration"></a> [cors\_configuration](#input\_cors\_configuration) | Specifies the allowed headers, methods, origins and exposed headers when using CORS on this bucket | <pre>list(object({<br> id = optional(string)<br> allowed_headers = optional(list(string))<br> allowed_methods = optional(list(string))<br> allowed_origins = optional(list(string))<br> expose_headers = optional(list(string))<br> max_age_seconds = optional(number)<br> }))</pre> | `[]` | no |
| <a name="input_enable_notifications"></a> [enable\_notifications](#input\_enable\_notifications) | Enable or disable notifications for the S3 bucket | `bool` | `false` | no |
| <a name="input_acl"></a> [acl](#input\_acl) | ACL value | `string` | n/a | yes |
| <a name="input_name"></a> [name](#input\_name) | Bucket Name | `string` | n/a | yes |
| <a name="input_region"></a> [region](#input\_region) | AWS region | `string` | `"us-east-1"` | no |
| <a name="input_website_configuration"></a> [website\_configuration](#input\_website\_configuration) | The website configuration for the S3 bucket | `list(any)` | `[]` | no |

## Outputs

Expand Down
25 changes: 25 additions & 0 deletions modules/bucket/.terraform.lock.hcl

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

1 change: 0 additions & 1 deletion modules/bucket/main.tf
Original file line number Diff line number Diff line change
Expand Up @@ -217,4 +217,3 @@ resource "aws_s3_bucket_lifecycle_configuration" "this" {

depends_on = [aws_s3_bucket_versioning.this]
}

10 changes: 2 additions & 8 deletions modules/bucket/variables.tf
Original file line number Diff line number Diff line change
@@ -1,9 +1,3 @@
variable "create_bucket" {
type = bool
description = "(optional) Whether to create bucket"
default = true
}

variable "name" {
type = string
description = "Bucket name. If provided, the bucket will be created with this name instead of generating the name from the context"
Expand Down Expand Up @@ -49,7 +43,7 @@ variable "public_access_config" {
restrict_public_buckets = true
}
description = <<-EOT
(Optional)
(Optional)
block_public_acls - Whether Amazon S3 should block public ACLs for this bucket. Defaults to false. Enabling this setting does not affect existing policies or ACLs. When set to true causes the following behavior:
PUT Bucket acl and PUT Object acl calls will fail if the specified ACL allows public access.
PUT Object calls will fail if the request includes an object ACL.
Expand Down Expand Up @@ -223,4 +217,4 @@ variable "transfer_acceleration_enabled" {
type = bool
description = "(optional) Whether to enable Trasfer accelaration"
default = false
}
}

0 comments on commit d617003

Please sign in to comment.