@ndlib/ndlib-cdk2 1.0.0

package/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "{}"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2018 University of Notre Dame
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/README.md

@@ -0,0 +1,398 @@
+# NDLIB CDK
+
+[![Maintainability](https://api.codeclimate.com/v1/badges/7404f79e4247119dbc59/maintainability)](https://codeclimate.com/github/ndlib/ndlib-cdk2/maintainability)
+[![Test Coverage](https://api.codeclimate.com/v1/badges/7404f79e4247119dbc59/test_coverage)](https://codeclimate.com/github/ndlib/ndlib-cdk2/test_coverage)
+
+## Stack Tags
+
+Creates an Aspect that will apply stack level tags to all stacks in the application based on our defined required tags. Values for these tags are read from the following expected context keys:
+
+| Key         | Value                                                      |
+| ----------- | ---------------------------------------------------------- |
+| projectName | Name of the overall project that the stacks belong to      |
+| description | A description for the stacks                               |
+| contact     | Contact information for the person(s) deploying this stack |
+| owner       | Name or CLID of the person deploying this stack            |
+
+Example usage:
+
+```typescript
+import cdk = require('aws-cdk-lib/core')
+import { StackTags } from '@ndlib/ndlib-cdk2'
+const app = new cdk.App()
+Aspects.of(app).add(new StackTags())
+```
+
+## HTTPS Application Load Balancer
+
+Creates a common construction of an ALB that will redirect all traffic from HTTP to HTTPS, and will by default respond with a 404 until additional listener rules are added. This can be used within a single stack that routes to multiple services in that stack, or it can be created in a parent stack where one or more child stacks then attach new services to the ALB.
+
+Example usage:
+
+```typescript
+import cdk = require('aws-cdk-lib/core')
+import ec2 = require('aws-cdk-lib/aws-ec2')
+import { HttpsAlb } from '@ndlib/ndlib-cdk2'
+const stack = new cdk.Stack()
+const vpc = new ec2.Vpc(stack, 'Vpc')
+const alb = new HttpsAlb(stack, 'PublicLoadBalancer', {
+  certificateArns: ['MyCertificateArn'],
+  internetFacing: true,
+  vpc,
+})
+```
+
+## Archive S3 Bucket
+
+Creates an S3 Bucket with no public access that immediately transitions all deposited objects to Glacier or Glacier Deep Archive. The public access policies can be overridden should it be necessary.
+
+The following example will immediately move objects to Glacier:
+
+```typescript
+import cdk = require('aws-cdk-lib/core')
+import { ArchiveBucket } from '@ndlib/ndlib-cdk2'
+
+const stack = new cdk.Stack()
+const bucket = new ArchiveBucket(stack, 'Bucket')
+```
+
+The following example will immediately move objects to Glacier Deep Archive, while overriding the default public access behavior of the bucket:
+
+```typescript
+import cdk = require('aws-cdk-lib/core')
+import { ArchiveBucket } from '@ndlib/ndlib-cdk2'
+
+const stack = new cdk.Stack()
+const overrides = { blockPublicAccess: BlockPublicAccess.BLOCK_ACLS, deepArchive: true }
+const bucket = new ArchiveBucket(stack, 'Bucket', { ...overrides })
+```
+
+## CodePipeline Email Notifications
+
+Adds a basic email notification construct to watch a CodePipeline for state changes. Note: Currently does not watch any of the actions for specific state changes.
+
+Example message:
+
+> The pipeline my-test-pipeline-142PEPTENTABF has changed state to STARTED. To view the pipeline, go to https://us-east-1.console.aws.amazon.com/codepipeline/home?region=us-east-1#/view/my-test-pipeline-142PEPTENTABF.
+
+Example usage:
+
+```typescript
+import cdk = require('aws-cdk-lib/core')
+import { Pipeline } from 'aws-cdk-lib/aws-codepipeline'
+import { PipelineNotifications } from '@ndlib/ndlib-cdk2'
+const stack = new cdk.Stack()
+const pipeline = Pipeline(stack, { ... })
+const notifications = new PipelineNotifications(stack, 'TestPipelineNotifications', {
+  pipeline,
+  receivers: 'me@myhost.com',
+})
+```
+
+## CodePipeline Slack Approval
+
+Attaches a [Slack Approval Bot](https://github.com/ndlib/codepipeline-approvals/blob/master/slack_approval.md) to a CodePipeline's approval SNS Topic.
+
+Note: This assumes that you've already deployed an [approval lambda](https://github.com/ndlib/codepipeline-approvals/blob/master/slack_approval.md#deploy-the-approval-lambda) and a [notifier](https://github.com/ndlib/codepipeline-approvals/blob/master/slack_approval.md#deploy-the-notifier-lambda) for the channel you want to push messages to.
+
+Example usage:
+
+```typescript
+import cdk = require('aws-cdk-lib/core')
+import { Pipeline } from 'aws-cdk-lib/aws-codepipeline'
+import { Topic } from 'aws-cdk-lib/aws-sns'
+import { SlackApproval } from '@ndlib/ndlib-cdk2'
+const stack = new cdk.Stack()
+const approvalTopic = new Topic(this, 'ApprovalTopic')
+const pipeline = Pipeline(stack, { ... })
+const slackApproval = new SlackApproval(this, 'SlackApproval', {
+  approvalTopic,
+  notifyStackName: 'slack-deployment-channel-notifier',
+})
+```
+
+## Service Level Objectives
+
+Creates Cloudwatch Dashboards and Alarms from a list of SLOs based on the Google SRE workbook for [Alerting on SLOs](https://landing.google.com/sre/workbook/chapters/alerting-on-slos/)
+
+```typescript
+const slos = [
+  {
+    type: 'CloudfrontAvailability',
+    distributionId: 'E123456789ABC',
+    title: 'My Website',
+    sloThreshold: 0.999,
+  },
+  {
+    type: 'CloudfrontLatency',
+    distributionId: 'E123456789ABC',
+    title: 'My Website',
+    sloThreshold: 0.95,
+    latencyThreshold: 200,
+  },
+]
+const stack = new cdk.Stack()
+
+// Create a dashboard that shows the 30 day performance of all of our SLOs
+const perfDash = new SLOPerformanceDashboard(stack, 'PerformanceDashboard', {
+  slos,
+  dashboardName: 'PerformanceDashboard',
+})
+
+// Create the multi-window alarms for each of the SLOs. This will also create an SNS topic that will
+// receive the alerts. The alarm will include links to the dashboards and runbooks given in its
+// description.
+const alarms = new SLOAlarms(stack, 'Alarms', {
+  slos,
+  dashboardLink: 'https://console.aws.amazon.com/cloudwatch/home?region=us-east-1#dashboards:name=My-Website',
+  runbookLink: 'https://github.com/myorg/myrunbooks',
+})
+```
+
+For more info see the [Service Level Objectives Readme](/src/slos/README.md)
+
+## Artifact S3 Bucket
+
+Creates an S3 Bucket with no public access and requires secure transport to take any action. This is a common construct across many applications, where a build process requires a place to store its output.
+
+The following example will create a standard artifact bucket:
+
+```typescript
+import cdk = require('aws-cdk-lib/core')
+import { ArtifactBucket } from '@ndlib/ndlib-cdk2'
+
+const stack = new cdk.Stack()
+const bucket = new ArtifactBucket(stack, 'Bucket')
+```
+
+## Docker CodeBuild Action
+
+This is a factory helper method to ease the creation of CodeBuild projects that use authenticated methods to pull from DockerHub. This method requires following the [Official AWS Documentation on solving the "error pulling image configuration: toomanyrequests" error](https://aws.amazon.com/premiumsupport/knowledge-center/codebuild-docker-pull-image-error/) in the "Store your DockerHub credentials with AWS Secrets Manager" section.
+
+The following example will create a Linux CodeBuild project, using DockerHub authentication credentials stored in Secrets Manager (under the `/test/credentials` path) and the `PipelineProject` CDK construct, that leverages the `alpine:3` DockerHub Image:
+
+```typescript
+import cdk = require('aws-cdk-lib/core')
+import { PipelineProject } from 'aws-cdk-lib/aws-codebuild'
+import { DockerCodeBuildAction } from '@ndlib/ndlib-cdk2'
+
+const stack = new cdk.Stack()
+const project = new PipelineProject(stack, 'test-project', {
+  environment: {
+    buildImage: DockerCodeBuildAction.fromLinuxDockerImage(stack, 'alpine-build-image', {
+      image: 'alpine:3',
+      credentialsContextKeyName: '/test/credentials',
+    }),
+  },
+})
+```
+
+The following example will create a Windows CodeBuild project, using DockerHub authentication credentials stored in Secrets Manager (under the `/test/credentials` path) and the `Project` CDK construct, that leverages the `mcr.microsoft.com/windows/servercore/iis` DockerHub Image:
+
+```typescript
+import cdk = require('aws-cdk-lib/core')
+import { Project, BuildSpec } from 'aws-cdk-lib/aws-codebuild'
+import { DockerCodeBuildAction } from '@ndlib/ndlib-cdk2'
+
+const stack = new cdk.Stack()
+const project = new Project(stack, 'test-project', {
+  buildSpec: BuildSpec.fromObject({
+    phases: {
+      build: {
+        commands: ['echo hello'],
+      },
+    },
+    version: '0.2',
+  }),
+  environment: {
+    buildImage: DockerCodeBuildAction.fromWindowsDockerImage(stack, 'iis-build-image', {
+      image: 'mcr.microsoft.com/windows/servercore/iis',
+      credentialsContextKeyName: '/test/credentials',
+    }),
+  },
+})
+```
+
+## Static Host
+
+Creates a CloudFront, buckets, and other relevant resources for hosting a site with a static host.
+
+Lambda@Edge functions can also be connected to the CloudFront, but must be defined first in your stack definition. See [Edge Lambdas](#edge-lambdas) section for reusable lambdas that may be particularly relevant for static hosts.
+
+Example usage:
+
+```typescript
+import cdk = require('aws-cdk-lib/core')
+import { Certificate } from 'aws-cdk-lib/aws-certificatemanager'
+import { StaticHost, TransclusionLambda } from '@ndlib/ndlib-cdk2'
+
+const stack = new cdk.Stack()
+const transclusionLambda = new TransclusionLambda(stack, 'Transclusion', {
+  isDefaultBehavior: true,
+})
+const host = new StaticHost(stack, 'MyStaticHost', {
+  hostnamePrefix: 'my-site',
+  domainName: 'domain.org',
+  websiteCertificate: Certificate.fromCertificateArn(stack, 'ACMCert', 'arn:aws:acm:::certificate/example'),
+  indexFilename: 'index.shtml',
+  edgeLambdas: [transclusionLambda],
+})
+```
+
+## Edge Lambdas
+
+These lambdas are standardized code which may be useful for multiple projects. They should be paired with one or more cloudfronts.
+
+The current list of edge lambdas are:
+
+- SpaRedirectionLambda – Requesting a page other than the index redirects to the origin to serve up the root index file. This is useful for SPAs which handle their own routing.
+- TransclusionLambda – Requesting .shtml files with server-side includes (SSI) triggers this lambda. Include tags in the HTML are replaced with the body of the page file they are requesting, so the origin serves up a flat HTML file.
+
+These are especially useful to pair with a StaticHost construct. Alternatively, you can attach a custom lambda by implementing the IEdgeLambda interface. It will create the function, as well as define a Behavior which can then be used in configuring a CloudFront.
+
+See [Static Host](#static-host) for example.
+
+## Newman Runner
+
+This construct creates a CodeBuild project and an action which can be used in a pipeline to run newman tests. This is typically used for smoke tests to verify the service deployed by the pipeline is operational.
+
+Example usage:
+
+```typescript
+import { Pipeline } from 'aws-cdk-lib/aws-codepipeline'
+import { Stack }from 'aws-cdk-lib'
+import { NewmanPipelineProject } from '@ndlib/ndlib-cdk2'
+
+const stack = new Stack()
+const pipeline = Pipeline(stack, 'MyPipeline')
+const appSourceArtifact = new codepipeline.Artifact('AppCode')
+// ...
+const newmanRunner = new NewmanRunner(stack, 'TestProject', {
+  sourceArtifact: appSourceArtifact,
+  collectionPath: 'test/newman/collection.json',
+  collectionVariables: {
+    hostname: 'https://www.example.com',
+    foo: 'bar',
+  },
+})
+pipeline.addStage({
+  stageName: 'Build',
+  actions: [buildAction, newmanRunner.action, approvalAction],
+})
+```
+
+## Pipeline S3 Sync
+
+This construct creates a codebuild project which takes an input artifact and pushes the contents to an s3 bucket. This is useful in pipelines for static sites, as well as sites that need to be compiled earlier in the pipeline. The concept is similar to a [BucketDeployment](https://docs.aws.amazon.com/cdk/api/latest/docs/@aws-cdk_aws-s3-deployment.BucketDeployment.html), but works around the issue of deploying large files since BucketDeployment relies on a Lambda.
+
+Example:
+
+```typescript
+import { Artifact, Pipeline } from 'aws-cdk-lib/aws-codepipeline'
+import { Stack }from 'aws-cdk-lib'
+import { PipelineS3Sync } from '@ndlib/ndlib-cdk2'
+
+const stack = new Stack()
+const pipeline = Pipeline(stack, 'MyPipeline')
+const appSourceArtifact = new Artifact('AppCode')
+// ...
+const s3Sync = new PipelineS3Sync(this, 'S3SyncProd', {
+  bucketNamePrefix: this.stackName,
+  bucketParamPath: '/all/stacks/targetStackName/site-bucket-name',
+  cloudFrontParamPath: '/all/stacks/targetStackName/distribution-id',
+  inputBuildArtifact: appSourceArtifact,
+})
+pipeline.addStage({
+  stageName: 'Deploy',
+  actions: [s3Sync.action],
+})
+```
+
+PipelineS3Sync also handles assigning content types based on filename patterns. To do so, provide an array of patterns with the content type they should be assigned like so:
+
+```typescript
+new PipelineS3Sync(this, 'S3SyncProd', {
+  // ...
+  contentTypePatterns: [
+    {
+      pattern: '*.pdf',
+      contentType: 'application/pdf',
+    },
+    {
+      pattern: '*.csv',
+      contentType: 'text/plain',
+    },
+  ],
+})
+```
+
+## Source Watcher
+
+The SourceWatcher construct creates necessary resources to monitor a GitHub repository for changes. Based on the changes that are made, one or more pipelines may be invoked according to the configuration. This is similar to how CodePipelines can have a Webhook on the source action, except that it allows for _conditional_ triggering depending on where the changes reside within the repo. Therefore, if multiple pipelines share a repo, a change to files which only impact one do not have to trigger the unmodified pipeline.
+
+Example:
+
+```typescript
+import { Stack }from 'aws-cdk-lib'
+import { SourceWatcher } from '@ndlib/ndlib-cdk2'
+
+const stack = new Stack()
+new SourceWatcher(stack, 'TestProject', {
+  triggers: [
+    {
+      triggerPatterns: ['my/test/**/pattern.js', 'example/*.*'],
+      pipelineStackName: 'pipeline-a',
+    },
+    {
+      triggerPatterns: ['src/anotherExample.ts'],
+      pipelineStackName: 'pipeline-b',
+    },
+  ],
+  targetRepo: 'ndlib/myRepo',
+  targetBranch: 'main',
+  gitTokenPath: '/all/github/ndlib-git',
+  webhookResourceStackName: 'github-webhook-custom-resource-prod',
+})
+```
+
+NOTE: `webhookResourceStackName` refers to a stack which will manage contains the backend for a CustomResource webhook. Prior to using this construct, an instance of [ndlib/aws-github-webhook](https://github.com/ndlib/aws-github-webhook) should be deployed to the AWS account. One stack can be used for any number of SourceWatcher constructs.
+
+
+## EC2 server with access to RDS
+
+The EC2withDatabase construct builds an EC2 server similar to those used in a large number of our services. The basic concept is to build the server with security group access to an AWS RDS database server. The server is built within an existing VPC. Parameters allow for AMI ID, instance type, root disk storage, IP address, networking, and security group rules for the server upon build. The server is created with the OS only; further configuration will need to be performed, often using ansible.
+
+Example usage:
+
+```typescript
+import 'source-map-support/register';
+import { App, Aspects }from 'aws-cdk-lib';
+import * as ec2 from 'aws-cdk-lib/aws-ec2';
+import { EC2withDatabase } from '@ndlib/ndlib-cdk2';
+
+const app = new App();
+
+new EC2withDatabase (app, 'StackName', {
+  env: { account: 'AccountID', region: 'us-east-1' },
+  amiId: "Valid AMI Id",
+  availabilityZones: [ "us-east-1c" ],
+  instanceClass: ec2.InstanceClass.T3A,
+  instanceSize: ec2.InstanceSize.MEDIUM,
+  instanceName: "InstanceName",
+  keyName: "libnd",
+  privateIpAddress: "IPAddress",
+  publicSubnetIds:  [ "ValidSubnet in VPC" ],
+  volumeSize: 50,
+  vpcId: "Valid VPC ID",
+  sg_ingress_db: 'Security Group of database for access',
+  sg_ingress_db_port: PortNumber,
+  sg_ingress_rules: [
+      {
+      "ipv4": "10.32.0.0/11",
+      "port": 22,
+      "description": "SSH access from campus"
+      },
+  ],
+});
+```
+

package/lib/archive-bucket.d.ts

@@ -0,0 +1,19 @@
+import { aws_s3 } from 'aws-cdk-lib';
+import { Construct } from 'constructs';
+export interface IArchiveBucketProps extends aws_s3.BucketProps {
+    /**
+     * When false (default), will use standard Glacier. If true, will use deep archive.
+     * See https://aws.amazon.com/s3/storage-classes/#Archive for a comparison.
+     */
+    readonly deepArchive?: boolean;
+}
+export declare class ArchiveBucket extends aws_s3.Bucket {
+    /**
+     * Class is designed to create a Glacier or Deep Archive archival system - immediately transitioning
+     * objects from S3 to Glacier upon deposit. This is not designed to leave objects
+     * in S3, and should not be leveraged for a tiered storage system as no objects should
+     * remain in S3. It is merely designed to provide a mechanism to easily deposit items
+     * into an Archive, which could be via console, CLI, or an API
+     */
+    constructor(scope: Construct, id: string, props?: IArchiveBucketProps);
+}

package/lib/archive-bucket.js

@@ -0,0 +1,30 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ArchiveBucket = void 0;
+const aws_cdk_lib_1 = require("aws-cdk-lib");
+const defaults = {
+    blockPublicAccess: aws_cdk_lib_1.aws_s3.BlockPublicAccess.BLOCK_ALL,
+    deepArchive: false,
+};
+class ArchiveBucket extends aws_cdk_lib_1.aws_s3.Bucket {
+    /**
+     * Class is designed to create a Glacier or Deep Archive archival system - immediately transitioning
+     * objects from S3 to Glacier upon deposit. This is not designed to leave objects
+     * in S3, and should not be leveraged for a tiered storage system as no objects should
+     * remain in S3. It is merely designed to provide a mechanism to easily deposit items
+     * into an Archive, which could be via console, CLI, or an API
+     */
+    constructor(scope, id, props) {
+        super(scope, id, { ...defaults, ...props });
+        const storageClass = props && props.deepArchive === true ? aws_cdk_lib_1.aws_s3.StorageClass.DEEP_ARCHIVE : aws_cdk_lib_1.aws_s3.StorageClass.GLACIER;
+        this.addLifecycleRule({
+            transitions: [
+                {
+                    storageClass,
+                    transitionAfter: aws_cdk_lib_1.Duration.hours(0),
+                },
+            ],
+        });
+    }
+}
+exports.ArchiveBucket = ArchiveBucket;

package/lib/artifact-bucket.d.ts

@@ -0,0 +1,13 @@
+import { aws_s3 } from 'aws-cdk-lib';
+import { Construct } from 'constructs';
+export declare class ArtifactBucket extends aws_s3.Bucket {
+    /**
+     *
+     * Class is designed to create a standard bucket for holding
+     * built artifacts from CodeBuild or CodePipeline.
+     * It is a fairly standard item and needed for any project with CI/CD,
+     * so it is a good idea to create a construct to ensure that this is done
+     * in the same way with each project.
+     */
+    constructor(scope: Construct, id: string, props: aws_s3.BucketProps);
+}