diff --git a/.gitignore b/.gitignore index 1ae602b..14bd6d3 100644 --- a/.gitignore +++ b/.gitignore @@ -13,3 +13,4 @@ logs common/README.md OLD/ +X diff --git a/CHANGELOG.md b/CHANGELOG.md index 2ce3418..60b9a8d 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,5 +1,5 @@ # Versions -* v1.0.0 -- {{ yyyy-mm-dd }} +- 1.0.0 -- 2025-08-13 - initial creation diff --git a/README.md b/README.md index 45a5336..5774e3f 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,54 @@ # About aws-app-ditd-darhts-s3-transfer +# Usage + +```hcl +module "darhts-s3-transfer" { + source = "git@github.e.it.census.gov:terraform-modules/aws-app-ditd-darhts-s3-transfer.git" + + api_client_id = "3M1234.12343x" + api_client_secret = "C1D66" + environment_label = "ite" + secret_name = "/app/ditd-darhts/ite/salesforce-api" + secret_key_name = "ditd-darhts-ite-salesforce-api" + input_resource_label = "ditd-darhts-ite" + output_resource_label = "adsd-dapps-ite" + input_resource_tags = { + finops_project_number = "fs1234567890" + finops_project_name = "adsd_darhts" + } + output_resource_tags = { + finops_project_number = "fs0123456789" + finops_project_name = "adsd_dapps" + } + settings = { + guardduty-move = {} + guardduty-notify = { + environment = "ite" + secret_name = "/app/ditd-darhts/ite/salesforce-api" + auth_url = "https://census-darhts--ite.sandbox.my.salesforce.com/services/oauth2/token" + salesforce_api_version = "64.0" + platform_event_name = "GuardDutyObjectScan__e" + } + s3-tag = { + environment = "ite" + trigger_tags = { + GuardDutyMalwareScanStatus = "NO_THREATS_FOUND" + darhts_certified = "true" + } + } + s3 = { + environment = "ite" + secret_name = "/app/ditd-darhts/ite/salesforce-api" + auth_url = "https://census-darhts--ite.sandbox.my.salesforce.com/services/oauth2/token" + salesforce_api_version = "64.0" + platform_event_name = "DARHTSCleanCreateObjectEvent__e" + } + } +} +``` + ## Requirements | Name | Version | diff --git a/examples/main.tf b/examples/main.tf new file mode 100644 index 0000000..26e5cf8 --- /dev/null +++ b/examples/main.tf @@ -0,0 +1,44 @@ +module "darhts-s3-transfer" { + source = "git@github.e.it.census.gov:terraform-modules/aws-app-ditd-darhts-s3-transfer.git" + + api_client_id = "3M1234.12343x" + api_client_secret = "C1D66" + environment_label = "ite" + secret_name = "/app/ditd-darhts/ite/salesforce-api" + secret_key_name = "ditd-darhts-ite-salesforce-api" + input_resource_label = "ditd-darhts-ite" + output_resource_label = "adsd-dapps-ite" + input_resource_tags = { + finops_project_number = "fs1234567890" + finops_project_name = "adsd_darhts" + } + output_resource_tags = { + finops_project_number = "fs0123456789" + finops_project_name = "adsd_dapps" + } + settings = { + guardduty-move = {} + guardduty-notify = { + environment = "ite" + secret_name = "/app/ditd-darhts/ite/salesforce-api" + auth_url = "https://census-darhts--ite.sandbox.my.salesforce.com/services/oauth2/token" + salesforce_api_version = "64.0" + platform_event_name = "GuardDutyObjectScan__e" + } + s3-tag = { + environment = "ite" + trigger_tags = { + GuardDutyMalwareScanStatus = "NO_THREATS_FOUND" + darhts_certified = "true" + } + } + s3 = { + environment = "ite" + secret_name = "/app/ditd-darhts/ite/salesforce-api" + auth_url = "https://census-darhts--ite.sandbox.my.salesforce.com/services/oauth2/token" + salesforce_api_version = "64.0" + platform_event_name = "DARHTSCleanCreateObjectEvent__e" + } + } +} + diff --git a/main.tf b/main.tf index 1f7c49e..e75176b 100644 --- a/main.tf +++ b/main.tf @@ -1,6 +1,53 @@ /* * # About aws-app-ditd-darhts-s3-transfer * +* # Usage +* +* ```hcl +* module "darhts-s3-transfer" { +* source = "git@github.e.it.census.gov:terraform-modules/aws-app-ditd-darhts-s3-transfer.git" +* +* api_client_id = "3M1234.12343x" +* api_client_secret = "C1D66" +* environment_label = "ite" +* secret_name = "/app/ditd-darhts/ite/salesforce-api" +* secret_key_name = "ditd-darhts-ite-salesforce-api" +* input_resource_label = "ditd-darhts-ite" +* output_resource_label = "adsd-dapps-ite" +* input_resource_tags = { +* finops_project_number = "fs1234567890" +* finops_project_name = "adsd_darhts" +* } +* output_resource_tags = { +* finops_project_number = "fs0123456789" +* finops_project_name = "adsd_dapps" +* } +* settings = { +* guardduty-move = {} +* guardduty-notify = { +* environment = "ite" +* secret_name = "/app/ditd-darhts/ite/salesforce-api" +* auth_url = "https://census-darhts--ite.sandbox.my.salesforce.com/services/oauth2/token" +* salesforce_api_version = "64.0" +* platform_event_name = "GuardDutyObjectScan__e" +* } +* s3-tag = { +* environment = "ite" +* trigger_tags = { +* GuardDutyMalwareScanStatus = "NO_THREATS_FOUND" +* darhts_certified = "true" +* } +* } +* s3 = { +* environment = "ite" +* secret_name = "/app/ditd-darhts/ite/salesforce-api" +* auth_url = "https://census-darhts--ite.sandbox.my.salesforce.com/services/oauth2/token" +* salesforce_api_version = "64.0" +* platform_event_name = "DARHTSCleanCreateObjectEvent__e" +* } +* } +* } +* ``` */ locals { @@ -16,3 +63,4 @@ locals { "boc:tf_module_name" = local._module_name } } + diff --git a/version.tf b/version.tf index e7bbb9e..758b5ab 100644 --- a/version.tf +++ b/version.tf @@ -1,4 +1,4 @@ locals { _module_name = "aws-app-ditd-darhts-s3-transfer" - _module_version = "0.9.12" + _module_version = "1.0.0" }