Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/cloudandthings/terraform-aws-s3-bucket-replication

Last synced: 4 days ago
JSON representation

Host: GitHub
URL: https://github.com/cloudandthings/terraform-aws-s3-bucket-replication
Owner: cloudandthings
Created: 2023-03-06T08:17:33.000Z (over 1 year ago)
Default Branch: main
Last Pushed: 2023-12-19T07:41:02.000Z (11 months ago)
Last Synced: 2023-12-19T10:27:14.384Z (11 months ago)
Language: Python
Size: 70.3 KB
Stars: 5
Watchers: 2
Forks: 3
Open Issues: 0
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: .github/contributing.md

Awesome Lists containing this project

README

        # terraform-aws-s3-bucket-replication

## Description

Terraform module for enabling S3 replication between two buckets.

Will be used for *HashiTalks: Africa 2023*.

Features:

 - Enable S3 replication between buckets

 - Allow cross-region replication

 - Allow cross-account replication

 - Multiple destinations are supported

[AWS documentation](https://docs.aws.amazon.com...)

----

## Prerequisites

You will need to create 2 S3 buckets. The examples show possible ways to achieve this.

----

## Usage

See `examples` dropdown on Terraform Cloud, or [browse here](/examples/).

----

## Testing

This module is tested during development using [`pytest`](https://docs.pytest.org/en/7.2.x/) and [`tftest`](https://pypi.org/project/tftest/). See the `tests` folder for further details, and in particular the [testing readme](./tests/README.md).

----

## Notes

*This repo was created from [terraform-aws-template](https://github.com/cloudandthings/terraform-aws-template)*

----

## Known issues

This project is currently unlicenced. Please contact the maintaining team to add a licence.

----

## Contributing

Direct contributions are welcome.

See [`CONTRIBUTING.md`](./.github/CONTRIBUTING.md) for further information.

----

## Documentation

----

### Inputs

| Name | Description | Type | Default | Required |

|------|-------------|------|---------|:--------:|

|  [aws\_iam\_role\_permissions\_boundary](#input\_aws\_iam\_role\_permissions\_boundary) | AWS IAM Role permissions boundary. | `string` | `null` | no |

|  [create\_iam\_resources](#input\_create\_iam\_resources) | Whether to create IAM resources. | `bool` | `true` | no |

|  [name\_for\_created\_iam\_resources](#input\_name\_for\_created\_iam\_resources) | Name for created IAM resources. | `string` | n/a | yes |

|  [replication\_configuration](#input\_replication\_configuration) | Replication configuration, in priority order. See the comments in `variables.tf` for usage. | 
list(object({

    destination_bucket_name = string

    # S3 bucket prefix to replicate.
    prefix = string # coalesced to ""

    # Destination S3 bucket KMS Key ARN if applicable.
    destination_bucket_kms_key_arn = string

    # Destination AWS Account ID. Only use for cross-account replication. When specified, replica object ownership will be set to this account.
    destination_aws_account_id = string

    # Destination S3 bucket region. If unspecified, then the provider region is used.
    destination_bucket_region = string

    # Whether delete markers are replicated.
    enable_delete_marker_replication = bool # coalesced to true

    # Whether to enable S3 Replication Time Control (S3 RTC) and Replication Metrics.
    enable_replication_time_control_and_metrics = bool # coalesced to false
    })
  ) | n/a | yes |

|  [replication\_role\_arn](#input\_replication\_role\_arn) | IAM Role ARN for replication role. | `string` | `null` | no |

|  [source\_bucket\_kms\_key\_arn](#input\_source\_bucket\_kms\_key\_arn) | Source S3 bucket KMS Key ARN | `string` | `null` | no |

|  [source\_bucket\_name](#input\_source\_bucket\_name) | Source S3 bucket name | `string` | n/a | yes |

|  [source\_bucket\_region](#input\_source\_bucket\_region) | Source S3 bucket region. If unspecified, then the provider region is used. | `string` | `null` | no |

|  [tags](#input\_tags) | Map of additional tags to assign to created resources. If configured with a provider `default_tags` configuration block present, tags with matching keys will overwrite those defined at the provider-level. | `map(string)` | n/a | yes |

----

### Modules

No modules.

----

### Outputs

No outputs.

----

### Providers

| Name | Version |

|------|---------|

|  [aws](#provider\_aws) | ~> 5.0 |

----

### Requirements

| Name | Version |

|------|---------|

|  [terraform](#requirement\_terraform) | >= 0.15.5 |

|  [aws](#requirement\_aws) | ~> 5.0 |

----

### Resources

| Name | Type |

|------|------|

| [aws_iam_policy.this](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/iam_policy) | resource |

| [aws_iam_role.this](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/iam_role) | resource |

| [aws_iam_role_policy_attachment.this](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/iam_role_policy_attachment) | resource |

| [aws_s3_bucket_replication_configuration.this](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/s3_bucket_replication_configuration) | resource |

| [aws_iam_policy_document.replication_role_assume_role_policy](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/data-sources/iam_policy_document) | data source |

| [aws_iam_policy_document.replication_role_policy_document](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 |

----