Skip to content

Commit f79b34e

Browse files
mkolarekmkolarek
committed
Restructure repository so it follows tf registry guidelines
1 parent 1eff24d commit f79b34e

File tree

10 files changed

+67
-50
lines changed

10 files changed

+67
-50
lines changed

‎README.md

Lines changed: 0 additions & 50 deletions
Original file line numberDiff line numberDiff line change
@@ -1,52 +1,2 @@
11
# terraform-aws-datasync
22

3-
A simple terraform module that facilitates migrating data between two S3 buckets, located in two different AWS accounts, across two different regions.
4-
5-
## Requirements
6-
7-
| Name | Version |
8-
|------|---------|
9-
| <a name="requirement_terraform"></a> [terraform](#requirement\_terraform) | >= 1.0 |
10-
| <a name="requirement_aws"></a> [aws](#requirement\_aws) | ~> 5.0 |
11-
12-
## Providers
13-
14-
| Name | Version |
15-
|------|---------|
16-
| <a name="provider_aws.destination-profile-destination-region"></a> [aws.destination-profile-destination-region](#provider\_aws.destination-profile-destination-region) | 5.58.0 |
17-
| <a name="provider_aws.source-profile-destination-region"></a> [aws.source-profile-destination-region](#provider\_aws.source-profile-destination-region) | 5.58.0 |
18-
| <a name="provider_aws.source-profile-source-region"></a> [aws.source-profile-source-region](#provider\_aws.source-profile-source-region) | 5.58.0 |
19-
20-
## Modules
21-
22-
No modules.
23-
24-
## Resources
25-
26-
| Name | Type |
27-
|------|------|
28-
| [aws_cloudwatch_log_group.datasync-task](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/cloudwatch_log_group) | resource |
29-
| [aws_datasync_location_s3.destination-location](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/datasync_location_s3) | resource |
30-
| [aws_datasync_location_s3.source-location](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/datasync_location_s3) | resource |
31-
| [aws_datasync_task.mongodb](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/datasync_task) | resource |
32-
| [aws_iam_role.datasync-role](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/iam_role) | resource |
33-
| [aws_s3_bucket_policy.destination_bucket_policy](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/s3_bucket_policy) | resource |
34-
| [aws_s3_bucket.destination](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/data-sources/s3_bucket) | data source |
35-
| [aws_s3_bucket.source](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/data-sources/s3_bucket) | data source |
36-
37-
## Inputs
38-
39-
| Name | Description | Type | Default | Required |
40-
|------|-------------|------|---------|:--------:|
41-
| <a name="input_destination_bucket"></a> [destination\_bucket](#input\_destination\_bucket) | Name of the destination S3 bucket. | `string` | n/a | yes |
42-
| <a name="input_destination_profile"></a> [destination\_profile](#input\_destination\_profile) | Profile name of the destination AWS account, as defined in the shared configuration file. | `string` | n/a | yes |
43-
| <a name="input_destination_region"></a> [destination\_region](#input\_destination\_region) | AWS region of the destination AWS account. | `string` | n/a | yes |
44-
| <a name="input_shared_config_files"></a> [shared\_config\_files](#input\_shared\_config\_files) | Path to the AWS CLI shared configuration file. | `string` | n/a | yes |
45-
| <a name="input_shared_credentials_files"></a> [shared\_credentials\_files](#input\_shared\_credentials\_files) | Path to the AWS CLI shared credentials file. | `string` | n/a | yes |
46-
| <a name="input_source_bucket"></a> [source\_bucket](#input\_source\_bucket) | Name of the source S3 bucket. | `string` | n/a | yes |
47-
| <a name="input_source_profile"></a> [source\_profile](#input\_source\_profile) | Profile name of the source AWS account, as defined in the shared configuration file. | `string` | n/a | yes |
48-
| <a name="input_source_region"></a> [source\_region](#input\_source\_region) | AWS region of the source AWS account. | `string` | n/a | yes |
49-
50-
## Outputs
51-
52-
No outputs.

‎examples/datasync-across-two-regions/README.md

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
# Example with two accounts across two regions
2+
3+
The following example creates all the necessary AWS DataSync resources, along with S3 bucket policies, IAM roles, and CloudWatch logs.
4+
5+
## Usage
6+
7+
This module (and therefore this example) depend on pre-existing S3 buckets in the source and destination accounts. This is by design, since we do not want to tie-in the life cycle of the S3 buckets to the DataSync resources, in case we're performing a one-off migration.
8+
9+
To run this example you need to execute:
10+
11+
```terraform
12+
$ terraform init
13+
$ terraform plan
14+
$ terraform apply
15+
```

‎examples/example_two_regions/main.tf renamed to ‎examples/datasync-across-two-regions/main.tf

File renamed without changes.

‎modules/datasync-across-regions/README.md

Lines changed: 52 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,52 @@
1+
# terraform-aws-datasync
2+
3+
A simple terraform module that facilitates migrating data between two S3 buckets, located in two different AWS accounts, across two different regions.
4+
5+
## Requirements
6+
7+
| Name | Version |
8+
|------|---------|
9+
| <a name="requirement_terraform"></a> [terraform](#requirement\_terraform) | >= 1.0 |
10+
| <a name="requirement_aws"></a> [aws](#requirement\_aws) | ~> 5.0 |
11+
12+
## Providers
13+
14+
| Name | Version |
15+
|------|---------|
16+
| <a name="provider_aws.destination-profile-destination-region"></a> [aws.destination-profile-destination-region](#provider\_aws.destination-profile-destination-region) | 5.58.0 |
17+
| <a name="provider_aws.source-profile-destination-region"></a> [aws.source-profile-destination-region](#provider\_aws.source-profile-destination-region) | 5.58.0 |
18+
| <a name="provider_aws.source-profile-source-region"></a> [aws.source-profile-source-region](#provider\_aws.source-profile-source-region) | 5.58.0 |
19+
20+
## Modules
21+
22+
No modules.
23+
24+
## Resources
25+
26+
| Name | Type |
27+
|------|------|
28+
| [aws_cloudwatch_log_group.datasync-task](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/cloudwatch_log_group) | resource |
29+
| [aws_datasync_location_s3.destination-location](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/datasync_location_s3) | resource |
30+
| [aws_datasync_location_s3.source-location](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/datasync_location_s3) | resource |
31+
| [aws_datasync_task.mongodb](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/datasync_task) | resource |
32+
| [aws_iam_role.datasync-role](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/iam_role) | resource |
33+
| [aws_s3_bucket_policy.destination_bucket_policy](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/s3_bucket_policy) | resource |
34+
| [aws_s3_bucket.destination](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/data-sources/s3_bucket) | data source |
35+
| [aws_s3_bucket.source](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/data-sources/s3_bucket) | data source |
36+
37+
## Inputs
38+
39+
| Name | Description | Type | Default | Required |
40+
|------|-------------|------|---------|:--------:|
41+
| <a name="input_destination_bucket"></a> [destination\_bucket](#input\_destination\_bucket) | Name of the destination S3 bucket. | `string` | n/a | yes |
42+
| <a name="input_destination_profile"></a> [destination\_profile](#input\_destination\_profile) | Profile name of the destination AWS account, as defined in the shared configuration file. | `string` | n/a | yes |
43+
| <a name="input_destination_region"></a> [destination\_region](#input\_destination\_region) | AWS region of the destination AWS account. | `string` | n/a | yes |
44+
| <a name="input_shared_config_files"></a> [shared\_config\_files](#input\_shared\_config\_files) | Path to the AWS CLI shared configuration file. | `string` | n/a | yes |
45+
| <a name="input_shared_credentials_files"></a> [shared\_credentials\_files](#input\_shared\_credentials\_files) | Path to the AWS CLI shared credentials file. | `string` | n/a | yes |
46+
| <a name="input_source_bucket"></a> [source\_bucket](#input\_source\_bucket) | Name of the source S3 bucket. | `string` | n/a | yes |
47+
| <a name="input_source_profile"></a> [source\_profile](#input\_source\_profile) | Profile name of the source AWS account, as defined in the shared configuration file. | `string` | n/a | yes |
48+
| <a name="input_source_region"></a> [source\_region](#input\_source\_region) | AWS region of the source AWS account. | `string` | n/a | yes |
49+
50+
## Outputs
51+
52+
No outputs.

‎cloudwatch.tf renamed to ‎modules/datasync-across-regions/cloudwatch.tf

File renamed without changes.

‎datasync.tf renamed to ‎modules/datasync-across-regions/datasync.tf

File renamed without changes.

‎main.tf renamed to ‎modules/datasync-across-regions/main.tf

File renamed without changes.

‎providers.tf renamed to ‎modules/datasync-across-regions/providers.tf

File renamed without changes.

‎s3.tf renamed to ‎modules/datasync-across-regions/s3.tf

File renamed without changes.

‎variables.tf renamed to ‎modules/datasync-across-regions/variables.tf

File renamed without changes.

0 commit comments

Comments
 (0)