@mavogel/awscdk-rootmail 0.0.214 → 0.0.215

package/.jsii

@@ -3522,7 +3522,7 @@
   },
   "name": "@mavogel/awscdk-rootmail",
   "readme": {
-    "markdown": "# awscdk-rootmail\n\nA single rootmail box for all your AWS accounts. The cdk implementation and **adaption** of the [superwerker](https://superwerker.cloud/) rootmail feature. See [here](docs/adrs/rootmail.md) for a detailed Architectural Decision Record ([ADR](https://adr.github.io/))\n\n- [TL;DR](#tldr)\n- [Usage](#usage)\n  - [Dependencies](#dependencies)\n  - [Deploy](#deploy)\n    - [CDK](#cdk)\n    - [Cloudformation](#cloudformation)\n- [Solution design: Version 1 - Domain in the same AWS account](#solution-design-version-1---domain-in-the-same-aws-account)\n- [Solution design: Version 2 - external DNS provider](#solution-design-version-2---external-dns-provider)\n- [Uninstall](#uninstall)\n- [Known issues](#known-issues)\n- [Related projects](#related-projects)\n\n## TL;DR\nEach AWS account needs one unique email address (the so-called \"AWS account root user email address\").\n\nAccess to these email addresses must be adequately secured since they provide privileged access to AWS accounts, such as account deletion procedures.\n\nThis is why you only need 1 mailing list for the AWS Management (formerly *root*) account,\nwe recommend the following pattern `aws-roots+<uuid>@mycompany.test`\n\n> [!NOTE]\n> Maximum **64** characters are allowed for the whole address.\n\nAnd as you own the domain `mycompany.test` you can add a subdomain, e.g. `aws`, for which all EMails will then be received with this solution within this particular AWS Management account.\n\n## Usage\n### Dependencies\nAdministrative access to an AWS account and the following tools:\n```sh\nbrew install aws-cli node@18 esbuild\n```\n\n<details>\n  <summary>... or a longer listing</summary>\n\n- Access to a development environment.  It is recommended to use AWS Cloud9 to avoid having to set up the tools needed to deploy the solution.  See [Getting started with AWS Cloud9](https://aws.amazon.com/cloud9/getting-started/).\n- Using Cloud9, all of the following have already been configured for you.  If you choose not to use Cloud9, you will need to install the following.\n    - AWS CLI. See [Installing, updating and uninstalling the AWS CLI version 2](https://docs.aws.amazon.com/cli/latest/userguide/install-cliv2.html)\n    - Set up the AWS CLI with IAM access credentials. See [Configuring the AWS CLI](https://docs.aws.amazon.com/cli/latest/userguide/cli-chap-configure.html)\n    - Node.js version 10.13.0 or later\n    - AWS CDK version 2.90.0 or later. For installation instructions see [Getting Started with the AWS CDK](https://docs.aws.amazon.com/cdk/latest/guide/getting_started.html#getting_started_install)\n    - Docker version 20.10.x or later **OR** [esbuild](https://esbuild.github.io/)\n</details>\n\n### Deploy\nYou can chose via embedding the construct in your cdk-app or use is directly via Cloudformation.\n#### CDK\n1. To start a new project we recommend using [projen](https://projen.io/).\n   1. Create a new projen project\n   ```sh\n   npx projen new awscdk-app-ts\n   ```\n   2. Add `@mavogel/awscdk-rootmail` as a dependency to your project in the `.projenrc.ts` file\n   3. Run `npm run projen` to install it\n2. In you `main.ts` file add the following code\n```ts\nimport { Rootmail } from '@mavogel/awscdk-rootmail';\nimport {\n  App,\n  Stack,\n  StackProps,\n  aws_route53 as r53,\n} from 'aws-cdk-lib';\nimport { Construct } from 'constructs';\n\nexport class MyStack extends Stack {\n  constructor(scope: Construct, id: string, props: StackProps = {}) {\n    super(scope, id, props);\n\n    const domain = 'mycompany.com'\n\n    const hostedZone = r53.HostedZone.fromLookup(this, 'rootmail-parent-hosted-zone', {\n      domainName: domain,\n    });\n\n    new Rootmail(this, 'rootmail', {\n      // 1. a domain you own, registered via Route53 in the SAME account\n      domain: domain,\n      // 2. so the subdomain will be aws.mycompany.test and\n      subdomain: 'aws',\n      // 3. wired / delegated automatically to\n      wireDNSToHostedZoneID: hostedZone.hostedZoneId,\n    });\n  }\n}\n```\n2. run on your commandline\n```sh\nnpm run deploy\n```\n1. No need to do anything, the NS records are **automatically** propagated as the parent Hosted Zone is in the same account!\n2. The `hosted-zone-dkim-propagation-provider.is-complete-handler` Lambda function checks every 10 seconds if the DNS for the subdomain is propagated. Details are in the Cloudwatch log group.\n\n### CDK with your own receiver function\nYou might also want to pass in you own function on what to do when an EMail is received\n\nfile `functions/custom-ses-receive-function.ts` which gets the 2 environment variables populated\n- `EMAIL_BUCKET`\n- `EMAIL_BUCKET_ARN`\n\nas well as `s3:GetObject` on the `RootMail/*` objects in the created Rootmail `S3` bucket.\n\n```ts\nimport { S3 } from '@aws-sdk/client-s3';\nimport { ParsedMail, simpleParser } from 'mailparser';\n// populated by default\nconst emailBucket = process.env.EMAIL_BUCKET;\nconst emailBucketArn = process.env.EMAIL_BUCKET_ARN;\nconst s3 = new S3();\n\n// SESEventRecordsToLambda\n// from https://docs.aws.amazon.com/ses/latest/dg/receiving-email-action-lambda-event.html\nexport const handler = async (event: SESEventRecordsToLambda) => {\n    for (const record of event.Records) {\n\n        const id = record.ses.mail.messageId;\n        const key = `RootMail/${id}`;\n        const response = await s3.getObject({ Bucket: emailBucket as string, Key: key });\n\n        const msg: ParsedMail = await simpleParser(response.Body as unknown as Buffer);\n\n        let title = msg.subject;\n        console.log(`Title: ${title} from emailBucketArn: ${emailBucketArn}`);\n        // use the content of the email body\n        const body = msg.html;\n        // add your custom code here ...\n\n        // dummy example: list s3 buckets\n        const buckets = await s3.listBuckets({});\n        if (!buckets.Buckets) {\n            console.log('No buckets found');\n            return;\n        }\n        console.log('Buckets:');\n        for (const bucket of buckets.Buckets || []) {\n            console.log(bucket.Name);\n        }\n    }\n\n};\n```\nand you create a separate `NodejsFunction` as follows with the additionally needed IAM permissions:\n```ts\nconst customSesReceiveFunction = new NodejsFunction(stackUnderTest, 'custom-ses-receive-function', {\n  functionName: PhysicalName.GENERATE_IF_NEEDED,\n  entry: path.join(__dirname, 'functions', 'custom-ses-receive-function.ts'),\n  runtime: lambda.Runtime.NODEJS_18_X,\n  logRetention: 1,\n  timeout: Duration.seconds(30),\n});\n\n// Note: any additional permissions you need to add to the function yourself!\ncustomSesReceiveFunction.addToRolePolicy(new iam.PolicyStatement({\n  actions: [\n    's3:List*',\n  ],\n  resources: ['*'],\n}))\n```\nand then pass it into the `Rootmail` Stack\n```ts\nexport class MyStack extends Stack {\n  constructor(scope: Construct, id: string, props: StackProps = {}) {\n    super(scope, id, props);\n\n    const domain = 'mycompany.test'\n    const hostedZone = r53.HostedZone.fromLookup(this, 'rootmail-parent-hosted-zone', {\n      domainName: domain,\n    });\n\n    const rootmail = new Rootmail(this, 'rootmail-stack', {\n      domain: domain;\n      autowireDNSParentHostedZoneID: hostedZone.hostedZoneId,\n      env: {\n        region: 'eu-west-1',\n      },\n      customSesReceiveFunction: customSesReceiveFunction, // <- pass it in here\n    });\n  }\n}\n```\n\n#### Cloudformation\nor use it directly a Cloudformation template `yaml` from the URL [here](https://mvc-test4-bucket-eu-west-1.s3.eu-west-1.amazonaws.com/rootmail/0.0.13-DEVELOPMENT/rootmailStack.template.yaml).\n\n\n<details>\n  <summary>... click to expand</summary>\n\nand fill out the parameters\n![cloudformation-template](docs/img/cloudformation-tpl-min.png)\n\n</details>\n\n## Solution design: Version 1 - Domain in the same AWS account\n![rootmail-solution-diagram-v1](docs/img/awscdk-rootmail-v1-min.png)\n\n1. You own a domain, e.g., `mycompany.test`, registered via `Route53` in the **same** AWS account.\n2. The stack creates a `Route53` public Hosted Zone for the subdomain, e.g., `aws.mycompany.test`. It also automatically adds the `TXT` and `CNAME` records for verifying the domain towards SES **and** adds the NS server entries automatically to the main domain `mycompany.test`.\n3. When the subdomain `aws.mycompany.test` is successfully propagated, the stack creates a verified Domain in AWS SES and adds a recipient rule for `root@aws.mycompany.test`. On a successful propagation you will get a mail as follows to the root Email address of the account you are installing the stack 👇\n![domain-verification](docs/img/3-domain-verification-min.png)\n4. Now, any mail going to `root+<any-string>@aws.mycompany.test` will be processed by OpsSanta 🎅🏽 Lambda function and also stored in the rootmail S3 bucket 🪣.\n5. The OpsSanta function verifies the verdicts (DKIM etc.) of the sender, also skips AWS Account welcome EMails, and processes all other EMails. If it is a password reset link EMail it stores the link in the parameter store (and does *not* create an OpsItem for now). For all other mails, which are not skipped an OpsItem is created to have a central location for all items.\n> [!NOTE]\n> You can also connect your Jira to the OpsCenter.\n6. The bucket where all mail to `root@aws.mycompany.test` are stored.\n7. The [SSM parameter store](https://docs.aws.amazon.com/systems-manager/latest/userguide/systems-manager-parameter-store.html) for the password reset links.\n![ssm-pw-reset-link](docs/img/4-ssm-pw-reset-link-min.png)\n8. The OpsItem which is created. It is open and shall be further processed either in the OpsCenter or any other issue tracker.\n![opts-item](docs/img/4-opts-items-min.png)\n\n> [!NOTE]\n> SES support alias, so mail to `root+random-string@aws.mycompany.test` will also be catched and forwarded.\n\n## Solution design: Version 2 - external DNS provider\n<details>\n  <summary>open for details</summary>\n\n![rootmail-solution-diagram-v2](docs/img/awscdk-rootmail-v2-min.png)\n\n```ts\nconst rootmail = new Rootmail(this, 'rootmail-stack', {\n  // 1. a domain you own, registered via Route53 in the same account\n  domain: 'mycompany.test';\n  // 2. '' is the default, so you can also remove it\n  // autowireDNSParentHostedZoneID: '',\n  env: {\n  // 3. or any other region SES is available\n    region: 'eu-west-1',\n  },\n});\n```\n\n1. You own a domain, e.g., `mycompany.test`. It can be at any registrar such as `godaddy`, also `Route53` itself in another AWS account.\n2. The stack creates a `Route53` public Hosted Zone for the subdomain, e.g., `aws.mycompany.test`. It also automatically adds the TXT and CNAME records (for DKIM etc.) for verifying the domain towards SES. **NOTE:** You must now add the NS server entries into the Domain provider which owns the main domain `mycompany.test`.\n3. items 3-7 are the same as in `v1`\n\n\n> [!NOTE]\n> After running `npm run deploy` you need to do the following steps manually:\n\n1. watch out for the hosted zone  `aws.mycompany.test` to be created\n![subdomain-hosted-zone](docs/img/1-use-ns-from-hz-min.png) By default you have **2 hours** to wire the DNS!\n2. Then create the NS record in your domain `mycompany.test` for the subdomain `aws.mycompany.test`. Here for Route53 in AWS:\n![create-ns-records](docs/img/2-create-ns-records-min.png)\n3. You can test it yourself via\n```sh\ndig +short NS 8.8.8.8 aws.mycompany.test\n# should return something like\nns-1111.your-dns-provider-10.org.\nns-2222.your-dns-provider-21.co.uk.\nns-33.your-dns-provider-04.com.\nns-444.your-dns-provider-12.net.\n```\nand also by sending an EMail, e.g. from Gmail to `root@aws.mycompany.test`\n\n</details>\n\n## Uninstall\n1. Delete the stack, the custom resources will delete most resources\n2. And by design you need to manually delete the S3 Bucket containing the mails. This is to prevent accidental deletion of the mails. You can find the bucket name in the stack output.\n![s3-bucket](docs/img/4-s3-bucket-min.png)\n3. Furthermore, the cloudwatch log groups are not deleted, since they might contain valuable information. You can delete them manually.\n![log-groups](docs/img/5-log-groups-min.png)\n## Known issues\n- [jsii/2071](https://github.com/aws/jsii/issues/2071): so adding  `compilerOptions.\"esModuleInterop\": true,` in `tsconfig.json` is not possible. See aws-cdk usage with[typescript](https://docs.aws.amazon.com/AWSJavaScriptSDK/latest/#Usage_with_TypeScript). So we needed to change import from `import AWS from 'aws-sdk';` -> `import * as AWS from 'aws-sdk';` to be able to compile.\n\n## Related projects\n- [aws-account-factory-email](https://github.com/aws-samples/aws-account-factory-email): a similar approach with SES, however you need to manually configure it upfront and also it about delivering root mails for a specific account to a specific mailing list and mainly decouples the real email address from the one of the AWS account. The main difference is that we do not *hide* or decouple the email address, but more make those as unique and unguessable/bruteforable as possible (with `uuids`)."
+    "markdown": "# awscdk-rootmail\n\nA single rootmail box for all your AWS accounts. The cdk implementation and **adaption** of the [superwerker](https://superwerker.cloud/) rootmail feature. See [here](docs/adrs/rootmail.md) for a detailed Architectural Decision Record ([ADR](https://adr.github.io/))\n\n- [TL;DR](#tldr)\n- [Usage](#usage)\n  - [Dependencies](#dependencies)\n  - [Deploy](#deploy)\n    - [CDK](#cdk)\n    - [Cloudformation](#cloudformation)\n- [Solution design: Version 1 - Domain in the same AWS account](#solution-design-version-1---domain-in-the-same-aws-account)\n- [Solution design: Version 2 - external DNS provider](#solution-design-version-2---external-dns-provider)\n- [Uninstall](#uninstall)\n- [Known issues](#known-issues)\n- [Related projects](#related-projects)\n\n## TL;DR\nEach AWS account needs one unique email address (the so-called \"AWS account root user email address\").\n\nAccess to these email addresses must be adequately secured since they provide privileged access to AWS accounts, such as account deletion procedures.\n\nThis is why you only need 1 mailing list for the AWS Management (formerly *root*) account,\nwe recommend the following pattern `aws-roots+<uuid>@mycompany.test`\n\n> [!NOTE]\n> Maximum **64** characters are allowed for the whole address.\n\nAnd as you own the domain `mycompany.test` you can add a subdomain, e.g. `aws`, for which all EMails will then be received with this solution within this particular AWS Management account.\n\n## Usage\n### Dependencies\nAdministrative access to an AWS account and the following tools:\n```sh\nbrew install aws-cli node@18 esbuild\n```\n\n<details>\n  <summary>... or a longer listing</summary>\n\n- Access to a development environment.  It is recommended to use AWS Cloud9 to avoid having to set up the tools needed to deploy the solution.  See [Getting started with AWS Cloud9](https://aws.amazon.com/cloud9/getting-started/).\n- Using Cloud9, all of the following have already been configured for you.  If you choose not to use Cloud9, you will need to install the following.\n    - AWS CLI. See [Installing, updating and uninstalling the AWS CLI version 2](https://docs.aws.amazon.com/cli/latest/userguide/install-cliv2.html)\n    - Set up the AWS CLI with IAM access credentials. See [Configuring the AWS CLI](https://docs.aws.amazon.com/cli/latest/userguide/cli-chap-configure.html)\n    - Node.js version 10.13.0 or later\n    - AWS CDK version 2.90.0 or later. For installation instructions see [Getting Started with the AWS CDK](https://docs.aws.amazon.com/cdk/latest/guide/getting_started.html#getting_started_install)\n    - Docker version 20.10.x or later **OR** [esbuild](https://esbuild.github.io/)\n</details>\n\n### Deploy\nYou can chose via embedding the construct in your cdk-app or use is directly via Cloudformation.\n#### CDK\n1. To start a new project we recommend using [projen](https://projen.io/).\n   1. Create a new projen project\n   ```sh\n   npx projen new awscdk-app-ts\n   ```\n   2. Add `@mavogel/awscdk-rootmail` as a dependency to your project in the `.projenrc.ts` file\n   3. Run `yarn run projen` to install it\n2. In you `main.ts` file add the following code\n```ts\nimport { Rootmail } from '@mavogel/awscdk-rootmail';\nimport {\n  App,\n  Stack,\n  StackProps,\n  aws_route53 as r53,\n} from 'aws-cdk-lib';\nimport { Construct } from 'constructs';\n\nexport class MyStack extends Stack {\n  constructor(scope: Construct, id: string, props: StackProps = {}) {\n    super(scope, id, props);\n\n    const domain = 'mycompany.com'\n\n    const hostedZone = r53.HostedZone.fromLookup(this, 'rootmail-parent-hosted-zone', {\n      domainName: domain,\n    });\n\n    new Rootmail(this, 'rootmail', {\n      // 1. a domain you own, registered via Route53 in the SAME account\n      domain: domain,\n      // 2. so the subdomain will be aws.mycompany.test and\n      subdomain: 'aws',\n      // 3. wired / delegated automatically to\n      wireDNSToHostedZoneID: hostedZone.hostedZoneId,\n    });\n  }\n}\n```\n2. run on your commandline\n```sh\nyarn run deploy\n```\n1. No need to do anything, the NS records are **automatically** propagated as the parent Hosted Zone is in the same account!\n2. The `hosted-zone-dkim-propagation-provider.is-complete-handler` Lambda function checks every 10 seconds if the DNS for the subdomain is propagated. Details are in the Cloudwatch log group.\n\n### CDK with your own receiver function\nYou might also want to pass in you own function on what to do when an EMail is received\n\nfile `functions/custom-ses-receive-function.ts` which gets the 2 environment variables populated\n- `EMAIL_BUCKET`\n- `EMAIL_BUCKET_ARN`\n\nas well as `s3:GetObject` on the `RootMail/*` objects in the created Rootmail `S3` bucket.\n\n```ts\nimport { S3 } from '@aws-sdk/client-s3';\nimport { ParsedMail, simpleParser } from 'mailparser';\n// populated by default\nconst emailBucket = process.env.EMAIL_BUCKET;\nconst emailBucketArn = process.env.EMAIL_BUCKET_ARN;\nconst s3 = new S3();\n\n// SESEventRecordsToLambda\n// from https://docs.aws.amazon.com/ses/latest/dg/receiving-email-action-lambda-event.html\nexport const handler = async (event: SESEventRecordsToLambda) => {\n    for (const record of event.Records) {\n\n        const id = record.ses.mail.messageId;\n        const key = `RootMail/${id}`;\n        const response = await s3.getObject({ Bucket: emailBucket as string, Key: key });\n\n        const msg: ParsedMail = await simpleParser(response.Body as unknown as Buffer);\n\n        let title = msg.subject;\n        console.log(`Title: ${title} from emailBucketArn: ${emailBucketArn}`);\n        // use the content of the email body\n        const body = msg.html;\n        // add your custom code here ...\n\n        // dummy example: list s3 buckets\n        const buckets = await s3.listBuckets({});\n        if (!buckets.Buckets) {\n            console.log('No buckets found');\n            return;\n        }\n        console.log('Buckets:');\n        for (const bucket of buckets.Buckets || []) {\n            console.log(bucket.Name);\n        }\n    }\n\n};\n```\nand you create a separate `NodejsFunction` as follows with the additionally needed IAM permissions:\n```ts\nconst customSesReceiveFunction = new NodejsFunction(stackUnderTest, 'custom-ses-receive-function', {\n  functionName: PhysicalName.GENERATE_IF_NEEDED,\n  entry: path.join(__dirname, 'functions', 'custom-ses-receive-function.ts'),\n  runtime: lambda.Runtime.NODEJS_18_X,\n  logRetention: 1,\n  timeout: Duration.seconds(30),\n});\n\n// Note: any additional permissions you need to add to the function yourself!\ncustomSesReceiveFunction.addToRolePolicy(new iam.PolicyStatement({\n  actions: [\n    's3:List*',\n  ],\n  resources: ['*'],\n}))\n```\nand then pass it into the `Rootmail` Stack\n```ts\nexport class MyStack extends Stack {\n  constructor(scope: Construct, id: string, props: StackProps = {}) {\n    super(scope, id, props);\n\n    const domain = 'mycompany.test'\n    const hostedZone = r53.HostedZone.fromLookup(this, 'rootmail-parent-hosted-zone', {\n      domainName: domain,\n    });\n\n    const rootmail = new Rootmail(this, 'rootmail-stack', {\n      domain: domain;\n      autowireDNSParentHostedZoneID: hostedZone.hostedZoneId,\n      env: {\n        region: 'eu-west-1',\n      },\n      customSesReceiveFunction: customSesReceiveFunction, // <- pass it in here\n    });\n  }\n}\n```\n\n#### Cloudformation\nor use it directly a Cloudformation template `yaml` from the URL [here](https://mvc-test4-bucket-eu-west-1.s3.eu-west-1.amazonaws.com/rootmail/0.0.13-DEVELOPMENT/rootmailStack.template.yaml).\n\n\n<details>\n  <summary>... click to expand</summary>\n\nand fill out the parameters\n![cloudformation-template](docs/img/cloudformation-tpl-min.png)\n\n</details>\n\n## Solution design: Version 1 - Domain in the same AWS account\n![rootmail-solution-diagram-v1](docs/img/awscdk-rootmail-v1-min.png)\n\n1. You own a domain, e.g., `mycompany.test`, registered via `Route53` in the **same** AWS account.\n2. The stack creates a `Route53` public Hosted Zone for the subdomain, e.g., `aws.mycompany.test`. It also automatically adds the `TXT` and `CNAME` records for verifying the domain towards SES **and** adds the NS server entries automatically to the main domain `mycompany.test`.\n3. When the subdomain `aws.mycompany.test` is successfully propagated, the stack creates a verified Domain in AWS SES and adds a recipient rule for `root@aws.mycompany.test`. On a successful propagation you will get a mail as follows to the root Email address of the account you are installing the stack 👇\n![domain-verification](docs/img/3-domain-verification-min.png)\n4. Now, any mail going to `root+<any-string>@aws.mycompany.test` will be processed by OpsSanta 🎅🏽 Lambda function and also stored in the rootmail S3 bucket 🪣.\n5. The OpsSanta function verifies the verdicts (DKIM etc.) of the sender, also skips AWS Account welcome EMails, and processes all other EMails. If it is a password reset link EMail it stores the link in the parameter store (and does *not* create an OpsItem for now). For all other mails, which are not skipped an OpsItem is created to have a central location for all items.\n> [!NOTE]\n> You can also connect your Jira to the OpsCenter.\n6. The bucket where all mail to `root@aws.mycompany.test` are stored.\n7. The [SSM parameter store](https://docs.aws.amazon.com/systems-manager/latest/userguide/systems-manager-parameter-store.html) for the password reset links.\n![ssm-pw-reset-link](docs/img/4-ssm-pw-reset-link-min.png)\n8. The OpsItem which is created. It is open and shall be further processed either in the OpsCenter or any other issue tracker.\n![opts-item](docs/img/4-opts-items-min.png)\n\n> [!NOTE]\n> SES support alias, so mail to `root+random-string@aws.mycompany.test` will also be catched and forwarded.\n\n## Solution design: Version 2 - external DNS provider\n<details>\n  <summary>open for details</summary>\n\n![rootmail-solution-diagram-v2](docs/img/awscdk-rootmail-v2-min.png)\n\n```ts\nconst rootmail = new Rootmail(this, 'rootmail-stack', {\n  // 1. a domain you own, registered via Route53 in the same account\n  domain: 'mycompany.test';\n  // 2. '' is the default, so you can also remove it\n  // autowireDNSParentHostedZoneID: '',\n  env: {\n  // 3. or any other region SES is available\n    region: 'eu-west-1',\n  },\n});\n```\n\n1. You own a domain, e.g., `mycompany.test`. It can be at any registrar such as `godaddy`, also `Route53` itself in another AWS account.\n2. The stack creates a `Route53` public Hosted Zone for the subdomain, e.g., `aws.mycompany.test`. It also automatically adds the TXT and CNAME records (for DKIM etc.) for verifying the domain towards SES. **NOTE:** You must now add the NS server entries into the Domain provider which owns the main domain `mycompany.test`.\n3. items 3-7 are the same as in `v1`\n\n\n> [!NOTE]\n> After running `yarn run deploy` you need to do the following steps manually:\n\n1. watch out for the hosted zone  `aws.mycompany.test` to be created\n![subdomain-hosted-zone](docs/img/1-use-ns-from-hz-min.png) By default you have **2 hours** to wire the DNS!\n2. Then create the NS record in your domain `mycompany.test` for the subdomain `aws.mycompany.test`. Here for Route53 in AWS:\n![create-ns-records](docs/img/2-create-ns-records-min.png)\n3. You can test it yourself via\n```sh\ndig +short NS 8.8.8.8 aws.mycompany.test\n# should return something like\nns-1111.your-dns-provider-10.org.\nns-2222.your-dns-provider-21.co.uk.\nns-33.your-dns-provider-04.com.\nns-444.your-dns-provider-12.net.\n```\nand also by sending an EMail, e.g. from Gmail to `root@aws.mycompany.test`\n\n</details>\n\n## Uninstall\n1. Delete the stack, the custom resources will delete most resources\n2. And by design you need to manually delete the S3 Bucket containing the mails. This is to prevent accidental deletion of the mails. You can find the bucket name in the stack output.\n![s3-bucket](docs/img/4-s3-bucket-min.png)\n3. Furthermore, the cloudwatch log groups are not deleted, since they might contain valuable information. You can delete them manually.\n![log-groups](docs/img/5-log-groups-min.png)\n## Known issues\n- [jsii/2071](https://github.com/aws/jsii/issues/2071): so adding  `compilerOptions.\"esModuleInterop\": true,` in `tsconfig.json` is not possible. See aws-cdk usage with[typescript](https://docs.aws.amazon.com/AWSJavaScriptSDK/latest/#Usage_with_TypeScript). So we needed to change import from `import AWS from 'aws-sdk';` -> `import * as AWS from 'aws-sdk';` to be able to compile.\n\n## Related projects\n- [aws-account-factory-email](https://github.com/aws-samples/aws-account-factory-email): a similar approach with SES, however you need to manually configure it upfront and also it about delivering root mails for a specific account to a specific mailing list and mainly decouples the real email address from the one of the AWS account. The main difference is that we do not *hide* or decouple the email address, but more make those as unique and unguessable/bruteforable as possible (with `uuids`)."
   },
   "repository": {
     "type": "git",
@@ -3548,7 +3548,7 @@
         },
         "locationInModule": {
           "filename": "src/rootmail.ts",
-          "line": 65
+          "line": 72
         },
         "parameters": [
           {
@@ -3574,7 +3574,7 @@
       "kind": "class",
       "locationInModule": {
         "filename": "src/rootmail.ts",
-        "line": 61
+        "line": 68
       },
       "name": "Rootmail",
       "properties": [
@@ -3585,7 +3585,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/rootmail.ts",
-            "line": 63
+            "line": 70
           },
           "name": "emailBucket",
           "type": {
@@ -3599,7 +3599,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/rootmail.ts",
-            "line": 62
+            "line": 69
           },
           "name": "hostedZoneParameterName",
           "type": {
@@ -3656,6 +3656,24 @@
             "fqn": "aws-cdk-lib.aws_lambda.Function"
           }
         },
+        {
+          "abstract": true,
+          "docs": {
+            "default": "RemovalPolicy.RETAIN",
+            "stability": "stable",
+            "summary": "The removal policy for the email bucket."
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/rootmail.ts",
+            "line": 58
+          },
+          "name": "emailBucketDeletePolicy",
+          "optional": true,
+          "type": {
+            "fqn": "aws-cdk-lib.RemovalPolicy"
+          }
+        },
         {
           "abstract": true,
           "docs": {
@@ -3667,7 +3685,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/rootmail.ts",
-            "line": 58
+            "line": 65
           },
           "name": "setDestroyPolicyToAllResources",
           "optional": true,
@@ -3877,6 +3895,6 @@
       "symbolId": "src/ses-receive:SESReceiveProps"
     }
   },
-  "version": "0.0.214",
-  "fingerprint": "oo+VbQ7TNtneSeLgHpe29dyaWDpi6lco+HEPLMv/LIs="
+  "version": "0.0.215",
+  "fingerprint": "10wDZZMD6arcR6VL6jgkP79b1Sa4sARpdAkLc2Xocjs="
 }

package/API.md

@@ -240,6 +240,7 @@ const rootmailProps: RootmailProps = { ... }
 | --- | --- | --- |
 | <code><a href="#@mavogel/awscdk-rootmail.RootmailProps.property.domain">domain</a></code> | <code>string</code> | Domain used for root mail feature. |
 | <code><a href="#@mavogel/awscdk-rootmail.RootmailProps.property.customSesReceiveFunction">customSesReceiveFunction</a></code> | <code>aws-cdk-lib.aws_lambda.Function</code> | The custom SES receive function to use. |
+| <code><a href="#@mavogel/awscdk-rootmail.RootmailProps.property.emailBucketDeletePolicy">emailBucketDeletePolicy</a></code> | <code>aws-cdk-lib.RemovalPolicy</code> | The removal policy for the email bucket. |
 | <code><a href="#@mavogel/awscdk-rootmail.RootmailProps.property.setDestroyPolicyToAllResources">setDestroyPolicyToAllResources</a></code> | <code>boolean</code> | Whether to set all removal policies to DESTROY. |
 | <code><a href="#@mavogel/awscdk-rootmail.RootmailProps.property.subdomain">subdomain</a></code> | <code>string</code> | Subdomain used for root mail feature. |
 | <code><a href="#@mavogel/awscdk-rootmail.RootmailProps.property.totalTimeToWireDNS">totalTimeToWireDNS</a></code> | <code>aws-cdk-lib.Duration</code> | The total time to wait for the DNS records to be available/wired. |
@@ -271,6 +272,19 @@ The custom SES receive function to use.
 
 ---
 
+##### `emailBucketDeletePolicy`<sup>Optional</sup> <a name="emailBucketDeletePolicy" id="@mavogel/awscdk-rootmail.RootmailProps.property.emailBucketDeletePolicy"></a>
+
+```typescript
+public readonly emailBucketDeletePolicy: RemovalPolicy;
+```
+
+- *Type:* aws-cdk-lib.RemovalPolicy
+- *Default:* RemovalPolicy.RETAIN
+
+The removal policy for the email bucket.
+
+---
+
 ##### `setDestroyPolicyToAllResources`<sup>Optional</sup> <a name="setDestroyPolicyToAllResources" id="@mavogel/awscdk-rootmail.RootmailProps.property.setDestroyPolicyToAllResources"></a>
 
 ```typescript

package/CONTRIBUTING.md

@@ -31,9 +31,9 @@ To send us a pull request, please:
 
 1. Fork the repository.
 2. Modify the source; please focus on the specific change you are contributing. If you also reformat all the code, it will be hard for us to focus on your change.
-3. Ensure local tests pass -> `npm run test`
-4. Ensure integ tests pass in your own aws account (see also the [integ-tests/README](integ/tests/README.md)) for details
-5. Build the project -> `npm run build` to also update the `API.md` file.
+3. Ensure local tests pass -> `yarn run test`
+4. The integ tests will run separately in the AWS account of the owner of the project.
+5. Build the project -> `yarn run build` to also update the `API.md` file.
 6. Commit to your fork using clear commit messages.
 7. Send us a pull request, answering any default questions in the pull request interface.
 8. Pay attention to any automated CI failures reported in the pull request, and stay involved in the conversation.

package/README.md

@@ -55,7 +55,7 @@ You can chose via embedding the construct in your cdk-app or use is directly via
    npx projen new awscdk-app-ts
    ```
    2. Add `@mavogel/awscdk-rootmail` as a dependency to your project in the `.projenrc.ts` file
-   3. Run `npm run projen` to install it
+   3. Run `yarn run projen` to install it
 2. In you `main.ts` file add the following code
 ```ts
 import { Rootmail } from '@mavogel/awscdk-rootmail';
@@ -90,7 +90,7 @@ export class MyStack extends Stack {
 ```
 2. run on your commandline
 ```sh
-npm run deploy
+yarn run deploy
 ```
 1. No need to do anything, the NS records are **automatically** propagated as the parent Hosted Zone is in the same account!
 2. The `hosted-zone-dkim-propagation-provider.is-complete-handler` Lambda function checks every 10 seconds if the DNS for the subdomain is propagated. Details are in the Cloudwatch log group.
@@ -241,7 +241,7 @@ const rootmail = new Rootmail(this, 'rootmail-stack', {
 
 
 > [!NOTE]
-> After running `npm run deploy` you need to do the following steps manually:
+> After running `yarn run deploy` you need to do the following steps manually:
 
 1. watch out for the hosted zone  `aws.mycompany.test` to be created
 ![subdomain-hosted-zone](docs/img/1-use-ns-from-hz-min.png) By default you have **2 hours** to wire the DNS!

package/integ-tests/README.md

@@ -1,22 +1,24 @@
 # integ-tests
 
+Still WIP!
+
 ## run
 ### changes
 1. do the changes in the `*.ts` files
 2. from the root of the project run
 ```bash
 # run the dry-run to see changes if they are destructive
-npm run integ-test -- --dry-run
+yarn run integ-test -- --dry-run
 # NOTE: undo the changes in the integ.snapshot so the next call
 # will really run the tests with the update
 # run the tests
-npm run integ-test
+yarn run integ-test
 ```
 
 ### changes in CR
 the `integ-runner` does not detect the changes, this is why we need to run all test via the `--force` flag
 ```bash
-npm run integ-test -- --force
+yarn run integ-test -- --force
 ```
 
 ## clean up manually
@@ -31,8 +33,13 @@ pip3 install -r requirements.tx
 aws s3 ls | grep rootmailinteg
 # empty and remove the bucket
 python3 cleanup/empty-and-delete-s3-bucket.py rootmailintegteststack-testrootmailemailbucket<suffix>
+# or short in fish
+for bucket in $(aws s3 ls | grep rootmailinteg |  awk '{ print $3 }'); echo $bucket; python3 cleanup/empty-and-delete-s3-bucket.py $bucket; end
 # remove the log groups. generic or more specific with 'rootmailinteg' and 'SetupTest'
-python3 cleanup/delete-log-groups.py IntegTest eu-west-2
+python3 cleanup/delete-log-groups.py Integ eu-west-1
+python3 cleanup/delete-log-groups.py Integ eu-west-2
+# or short in fish
+for lgregion in eu-west-1 eu-west-2; echo $lgregion; python3 cleanup/delete-log-groups.py Integ $lgregion; end
 
 # when your done deactive the virtual env via
 # see https://stackoverflow.com/questions/990754/how-to-leave-exit-deactivate-a-python-virtualenv

package/integ-tests/common.ts

@@ -0,0 +1,2 @@
+export const testDomain = 'rootmail-test.mavogel.xyz';
+export const hostedZoneId = 'Z01336592122MNIWKOZSV';

package/integ-tests/create-e2e-cfn-stack.bash

@@ -0,0 +1,35 @@
+#!/bin/bash
+
+RELEASE_VERSION=$1
+if [ -z "$RELEASE_VERSION" ]; then
+    echo "Please provide the release version as the first argument."
+    exit 1
+fi
+echo "Using release version: '$RELEASE_VERSION'"
+
+echo "Running E2E test for CloudFormation template."
+aws cloudformation create-stack \
+    --stack-name rootmail-cfn-test \
+    --template-url https://mvc-dev-releases.s3.eu-central-1.amazonaws.com/rootmail/${RELEASE_VERSION}/awscdk-rootmail.template.json \
+    --parameters ParameterKey=Domain,ParameterValue=rootmail-test.mavogel.xyz ParameterKey=Subdomain,ParameterValue=zft23-eu-central-1 ParameterKey=WireDNSToHostedZoneID,ParameterValue=Z01336592122MNIWKOZSV \
+    --disable-rollback \
+    --capabilities CAPABILITY_AUTO_EXPAND CAPABILITY_IAM CAPABILITY_NAMED_IAM \
+    --no-cli-pager \
+    --region eu-central-1
+
+# get the status of the stack
+count=0
+max_create_count=60 # 10min
+while [[ ! "$STACK_STATUS" == *"_FAILED" ]] && [[ ! "$STACK_STATUS" == *"_COMPLETE" ]]; do
+    sleep 10
+    count=$((count+1))
+    STACK_STATUS=$(aws cloudformation describe-stacks --stack-name rootmail-cfn-test --query 'Stacks[0].StackStatus' --output text --region eu-central-1)
+    echo "($count/$max_create_count) Stack status: $STACK_STATUS at $(date)"
+    if [ $count -eq $max_create_count ]; then
+        echo "Max retries reached. Stack creation failed."
+        exit 1
+    fi
+done
+
+echo "Stack creation successful. Sleep for 5 seconds."
+sleep 5

package/integ-tests/delete-e2e-cfn-stack.bash

@@ -0,0 +1,26 @@
+#!/bin/bash
+
+echo "Deleting the stack."
+aws cloudformation delete-stack --stack-name rootmail-cfn-test --region eu-central-1
+
+# wait for the stack to be deleted
+count=0
+max_delete_count=60 # 10min
+STACK_STATUS="undefined"
+while [[ ! "$STACK_STATUS" == *"_FAILED" ]] && [[ ! "$STACK_STATUS" == *"_COMPLETE" ]]; do
+    sleep 10
+    count=$((count+1))
+    STACK_STATUS=$(aws cloudformation describe-stacks --stack-name rootmail-cfn-test --query 'Stacks[0].StackStatus' --output text --region eu-central-1)
+    echo "($count/$max_delete_count) Stack status: $STACK_STATUS at $(date)"
+    # if STACK_STATUS is empty, the stack does not exist anymore
+    if [ -z "$STACK_STATUS" ]; then
+        echo "Stack deletion successful."
+        break
+    fi
+    if [ $count -eq $max_delete_count ]; then
+        echo "Max retries reached. Stack deletion failed."
+        exit 1
+    fi
+done
+
+echo "E2E test for CloudFormation template finished."

package/integ-tests/integ.rootmail-custom-santa.ts

@@ -11,6 +11,7 @@ import {
 } from 'aws-cdk-lib';
 import { NodejsFunction } from 'aws-cdk-lib/aws-lambda-nodejs';
 import { Rootmail } from '../src/rootmail';
+import { testDomain, hostedZoneId } from './common';
 // CDK App for Integration Tests
 const app = new App();
 // Stack under test
@@ -19,8 +20,6 @@ const stackUnderTest = new Stack(app, stackUnderTestName, {
   description: "This stack includes the application's resources for integration testing.",
 });
 
-const testDomain = 'rootmail-test.mavogel.xyz';
-const hostedZoneId = 'Z066250529JROZU7IIY3Q';
 const randomTestId = 'c23qgsa2';
 const testSubdomain = `${randomTestId}-${Stack.of(stackUnderTest).region}`;
 const fullDomain = `${testSubdomain}.${testDomain}`;

package/integ-tests/integ.rootmail-custom-santa.ts.snapshot/RootmailIntegTestStack.assets.json

@@ -1,15 +1,15 @@
 {
   "version": "33.0.0",
   "files": {
-    "0649b5bfaa322d6bd173d2daef3177389cf0778b556b300ac6bf451704cc3a49": {
+    "97724f55c990db7c62d85b80d4afb032e60011490da173e3551e6a131013b79d": {
       "source": {
-        "path": "asset.0649b5bfaa322d6bd173d2daef3177389cf0778b556b300ac6bf451704cc3a49",
+        "path": "asset.97724f55c990db7c62d85b80d4afb032e60011490da173e3551e6a131013b79d",
         "packaging": "zip"
       },
       "destinations": {
         "current_account-current_region": {
           "bucketName": "cdk-hnb659fds-assets-${AWS::AccountId}-${AWS::Region}",
-          "objectKey": "0649b5bfaa322d6bd173d2daef3177389cf0778b556b300ac6bf451704cc3a49.zip",
+          "objectKey": "97724f55c990db7c62d85b80d4afb032e60011490da173e3551e6a131013b79d.zip",
           "assumeRoleArn": "arn:${AWS::Partition}:iam::${AWS::AccountId}:role/cdk-hnb659fds-file-publishing-role-${AWS::AccountId}-${AWS::Region}"
         }
       }
@@ -27,15 +27,15 @@
         }
       }
     },
-    "f9b17c134d24cf60e1d26c033b5f4f247b759149619ac0aac341b950a10ccf14": {
+    "f75274dd7677b6ef41f29d2dfc2c885b4f4e069d3fb8e67636bd89efd3f0fcad": {
       "source": {
-        "path": "asset.f9b17c134d24cf60e1d26c033b5f4f247b759149619ac0aac341b950a10ccf14",
+        "path": "asset.f75274dd7677b6ef41f29d2dfc2c885b4f4e069d3fb8e67636bd89efd3f0fcad",
         "packaging": "zip"
       },
       "destinations": {
         "current_account-current_region": {
           "bucketName": "cdk-hnb659fds-assets-${AWS::AccountId}-${AWS::Region}",
-          "objectKey": "f9b17c134d24cf60e1d26c033b5f4f247b759149619ac0aac341b950a10ccf14.zip",
+          "objectKey": "f75274dd7677b6ef41f29d2dfc2c885b4f4e069d3fb8e67636bd89efd3f0fcad.zip",
           "assumeRoleArn": "arn:${AWS::Partition}:iam::${AWS::AccountId}:role/cdk-hnb659fds-file-publishing-role-${AWS::AccountId}-${AWS::Region}"
         }
       }
@@ -144,7 +144,7 @@
         }
       }
     },
-    "29df648400c115f86c87fc9f5bdb95120b46d2d1c8adfa2b2064e33731fb830b": {
+    "c8ec203309c2c203c70b59d98084241414aa0642a0880d346858b3467db17aa9": {
       "source": {
         "path": "RootmailIntegTestStack.template.json",
         "packaging": "file"
@@ -152,7 +152,7 @@
       "destinations": {
         "current_account-current_region": {
           "bucketName": "cdk-hnb659fds-assets-${AWS::AccountId}-${AWS::Region}",
-          "objectKey": "29df648400c115f86c87fc9f5bdb95120b46d2d1c8adfa2b2064e33731fb830b.json",
+          "objectKey": "c8ec203309c2c203c70b59d98084241414aa0642a0880d346858b3467db17aa9.json",
           "assumeRoleArn": "arn:${AWS::Partition}:iam::${AWS::AccountId}:role/cdk-hnb659fds-file-publishing-role-${AWS::AccountId}-${AWS::Region}"
         }
       }

package/integ-tests/integ.rootmail-custom-santa.ts.snapshot/RootmailIntegTestStack.template.json

@@ -60,7 +60,7 @@
      "S3Bucket": {
       "Fn::Sub": "cdk-hnb659fds-assets-${AWS::AccountId}-${AWS::Region}"
      },
-     "S3Key": "0649b5bfaa322d6bd173d2daef3177389cf0778b556b300ac6bf451704cc3a49.zip"
+     "S3Key": "97724f55c990db7c62d85b80d4afb032e60011490da173e3551e6a131013b79d.zip"
     },
     "Environment": {
      "Variables": {
@@ -621,7 +621,7 @@
       ]
      ]
     },
-    "ParentHostedZoneId": "Z066250529JROZU7IIY3Q",
+    "ParentHostedZoneId": "Z01336592122MNIWKOZSV",
     "HostedZoneParameterName": {
      "Ref": "testRootmailHostedZoneSSMParameter574DA41C"
     },
@@ -918,7 +918,7 @@
      "S3Bucket": {
       "Fn::Sub": "cdk-hnb659fds-assets-${AWS::AccountId}-${AWS::Region}"
      },
-     "S3Key": "f9b17c134d24cf60e1d26c033b5f4f247b759149619ac0aac341b950a10ccf14.zip"
+     "S3Key": "f75274dd7677b6ef41f29d2dfc2c885b4f4e069d3fb8e67636bd89efd3f0fcad.zip"
     },
     "Environment": {
      "Variables": {
@@ -1482,7 +1482,7 @@
         "route53:ListResourceRecordSets"
        ],
        "Effect": "Allow",
-       "Resource": "arn:aws:route53:::hostedzone/Z066250529JROZU7IIY3Q"
+       "Resource": "arn:aws:route53:::hostedzone/Z01336592122MNIWKOZSV"
       }
      ],
      "Version": "2012-10-17"

package/integ-tests/integ.rootmail-custom-santa.ts.snapshot/SetupTestIntegStackDefaultTestDeployAssert6EB6FF77.assets.json

@@ -14,7 +14,7 @@
         }
       }
     },
-    "bd5ca416acdf7bc9e351216c8692216e8915fa78d41070fc8e5bded880b1f738": {
+    "609212f0e28dcfd78dd3dab36ef82ce3dcc3d5d2b06cb4493bcc46552a5b0811": {
       "source": {
         "path": "SetupTestIntegStackDefaultTestDeployAssert6EB6FF77.template.json",
         "packaging": "file"
@@ -22,7 +22,7 @@
       "destinations": {
         "current_account-current_region": {
           "bucketName": "cdk-hnb659fds-assets-${AWS::AccountId}-${AWS::Region}",
-          "objectKey": "bd5ca416acdf7bc9e351216c8692216e8915fa78d41070fc8e5bded880b1f738.json",
+          "objectKey": "609212f0e28dcfd78dd3dab36ef82ce3dcc3d5d2b06cb4493bcc46552a5b0811.json",
           "assumeRoleArn": "arn:${AWS::Partition}:iam::${AWS::AccountId}:role/cdk-hnb659fds-file-publishing-role-${AWS::AccountId}-${AWS::Region}"
         }
       }

package/integ-tests/integ.rootmail-custom-santa.ts.snapshot/SetupTestIntegStackDefaultTestDeployAssert6EB6FF77.template.json

@@ -45,7 +45,7 @@
      }
     },
     "flattenResponse": "false",
-    "salt": "1708190598169"
+    "salt": "1732466751546"
    },
    "DependsOn": [
     "AwsApiCallSSMgetParameterd4c847c906a9dd9484fbf0d62db16d9b"
@@ -188,7 +188,7 @@
      "Name": "\"/rootmail/domain_name_servers\""
     },
     "flattenResponse": "false",
-    "salt": "1708190598169"
+    "salt": "1732466751546"
    },
    "UpdateReplacePolicy": "Delete",
    "DeletionPolicy": "Delete"