Merge pull request #27 from aws-ia/fix_0.0.4

prabirsekhri · web-flow · commit 798960e3c17b · 2024-09-13T15:46:49.000-04:00
diff --git a/.header.md b/.header.md
@@ -2,6 +2,8 @@
 
 This repository contains Terraform code which creates resources required to run a [DataSync task](https://https://aws.amazon.com/datasync/) to sync data within AWS and from on premises to AWS or vise-versa.
 
+![AWS Datasync](./datasync-main.png)
+
 AWS DataSync supports a wide variety of file and object storage systems on-premise and in AWS to facilitate data transfer.
 
 For on-premises storage transfers : DataSync works with the following on-premises storage systems:
diff --git a/README.md b/README.md
@@ -3,6 +3,8 @@
 
 This repository contains Terraform code which creates resources required to run a [DataSync task](https://https://aws.amazon.com/datasync/) to sync data within AWS and from on premises to AWS or vise-versa.
 
+![AWS Datasync](./datasync-main.png)
+
 AWS DataSync supports a wide variety of file and object storage systems on-premise and in AWS to facilitate data transfer.
 
 For on-premises storage transfers : DataSync works with the following on-premises storage systems:
diff --git a/VERSION b/VERSION
@@ -1,2 +1 @@
-v0.0.3
-
+v0.0.4
diff --git a/datasync-main.png b/datasync-main.png
diff --git a/examples/efs-to-s3/.header.md b/examples/efs-to-s3/.header.md
@@ -0,0 +1,5 @@
+# EFS to S3
+
+This example demonstrates how to create an EFS to S3 replication scenario using the AWS DataSync module.
+
+![AWS Datasync EFS to S3](./datasync-examples-efs-to-s3.png)
diff --git a/examples/efs-to-s3/.terraform-docs.yaml b/examples/efs-to-s3/.terraform-docs.yaml
@@ -0,0 +1,20 @@
+formatter: markdown
+header-from: .header.md
+settings:
+  anchor: true
+  color: true
+  default: true
+  escape: true
+  html: true
+  indent: 2
+  required: true
+  sensitive: true
+  type: true
+
+sort:
+  enabled: true
+  by: required
+
+output:
+  file: README.md
+  mode: replace
diff --git a/examples/efs-to-s3/README.md b/examples/efs-to-s3/README.md
@@ -1,4 +1,10 @@
 <!-- BEGIN_TF_DOCS -->
+# EFS to S3
+
+This example demonstrates how to create an EFS to S3 replication scenario using the AWS DataSync module.
+
+![AWS Datasync EFS to S3](./datasync-examples-efs-to-s3.png)
+
 ## Requirements
 
 | Name | Version |
@@ -11,8 +17,8 @@
 
 | Name | Version |
 |------|---------|
-| <a name="provider_aws"></a> [aws](#provider\_aws) | >= 3.72.0 |
-| <a name="provider_random"></a> [random](#provider\_random) | n/a |
+| <a name="provider_aws"></a> [aws](#provider\_aws) | 5.65.0 |
+| <a name="provider_random"></a> [random](#provider\_random) | 3.6.2 |
 
 ## Modules
 
diff --git a/examples/efs-to-s3/datasync-examples-efs-to-s3.png b/examples/efs-to-s3/datasync-examples-efs-to-s3.png
diff --git a/examples/efs-to-s3/main.tf b/examples/efs-to-s3/main.tf
@@ -57,6 +57,7 @@ module "backup_tasks" {
         posix_permissions = "NONE"
         uid               = "NONE"
         gid               = "NONE"
+        verify_mode       = "ONLY_FILES_TRANSFERRED"
       }
       schedule_expression = "cron(0 6 ? * MON-FRI *)" # Run at 6:00 am (UTC) every Monday through Friday:
     }
diff --git a/examples/s3-to-s3-cross-account/.header.md b/examples/s3-to-s3-cross-account/.header.md
@@ -0,0 +1,5 @@
+# S3 to S3 Cross account
+
+This example demonstrates how to create a S3 to S3 replication scenario across AWS Accounts using the AWS DataSync module.
+
+![AWS Datasync S3 to S3 Cross Account](./datasync-examples-cross-account.png)
diff --git a/examples/s3-to-s3-cross-account/.terraform-docs.yaml b/examples/s3-to-s3-cross-account/.terraform-docs.yaml
@@ -0,0 +1,20 @@
+formatter: markdown
+header-from: .header.md
+settings:
+  anchor: true
+  color: true
+  default: true
+  escape: true
+  html: true
+  indent: 2
+  required: true
+  sensitive: true
+  type: true
+
+sort:
+  enabled: true
+  by: required
+
+output:
+  file: README.md
+  mode: replace
diff --git a/examples/s3-to-s3-cross-account/README.md b/examples/s3-to-s3-cross-account/README.md
@@ -1,4 +1,10 @@
 <!-- BEGIN_TF_DOCS -->
+# S3 to S3 Cross account
+
+This example demonstrates how to create a S3 to S3 replication scenario across AWS Accounts using the AWS DataSync module.
+
+![AWS Datasync S3 to S3 Cross Account](./datasync-examples-cross-account.png)
+
 ## Requirements
 
 | Name | Version |
diff --git a/examples/s3-to-s3-cross-account/datasync-examples-cross-account.png b/examples/s3-to-s3-cross-account/datasync-examples-cross-account.png
diff --git a/examples/s3-to-s3-cross-account/main.tf b/examples/s3-to-s3-cross-account/main.tf
@@ -209,8 +209,9 @@ module "backup_tasks" {
         posix_permissions = "NONE"
         uid               = "NONE"
         gid               = "NONE"
+        verify_mode       = "ONLY_FILES_TRANSFERRED"
       }
-      schedule_expression = "rate(1 hour)" # Run every hour
+      schedule_expression = "rate(1 days)" # Run daily
       includes = {
         "filter_type" = "SIMPLE_PATTERN"
         "value"       = "/projects/important-folder"
diff --git a/examples/s3-to-s3/.header.md b/examples/s3-to-s3/.header.md
@@ -0,0 +1,5 @@
+# S3 to S3
+
+This example demonstrates how to create a S3 to S3 replication scenario using the AWS DataSync module.
+
+![AWS Datasync S3 to S3](./datasync-examples-S3.png)
diff --git a/examples/s3-to-s3/.terraform-docs.yaml b/examples/s3-to-s3/.terraform-docs.yaml
@@ -0,0 +1,20 @@
+formatter: markdown
+header-from: .header.md
+settings:
+  anchor: true
+  color: true
+  default: true
+  escape: true
+  html: true
+  indent: 2
+  required: true
+  sensitive: true
+  type: true
+
+sort:
+  enabled: true
+  by: required
+
+output:
+  file: README.md
+  mode: replace
diff --git a/examples/s3-to-s3/README.md b/examples/s3-to-s3/README.md
@@ -1,4 +1,10 @@
 <!-- BEGIN_TF_DOCS -->
+# S3 to S3
+
+This example demonstrates how to create a S3 to S3 replication scenario using the AWS DataSync module.
+
+![AWS Datasync S3 to S3](./datasync-examples-S3.png)
+
 ## Requirements
 
 | Name | Version |
diff --git a/examples/s3-to-s3/datasync-examples-S3.png b/examples/s3-to-s3/datasync-examples-S3.png
diff --git a/examples/s3-to-s3/main.tf b/examples/s3-to-s3/main.tf
@@ -48,8 +48,9 @@ module "backup_tasks" {
         posix_permissions = "NONE"
         uid               = "NONE"
         gid               = "NONE"
+        verify_mode       = "ONLY_FILES_TRANSFERRED"
       }
-      schedule_expression = "rate(1 hour)" # Run every hour
+      schedule_expression = "rate(1 days)" # Run daily
       includes = {
         "filter_type" = "SIMPLE_PATTERN"
         "value"       = "/logs/"

Original file line number	Diff line number	Diff line change
`@@ -57,6 +57,7 @@ module "backup_tasks" {`
`57`	`57`	`posix_permissions = "NONE"`
`58`	`58`	`uid = "NONE"`
`59`	`59`	`gid = "NONE"`
	`60`	`+ verify_mode = "ONLY_FILES_TRANSFERRED"`
`60`	`61`	`}`
`61`	`62`	`schedule_expression = "cron(0 6 ? * MON-FRI *)" # Run at 6:00 am (UTC) every Monday through Friday:`
`62`	`63`	`}`