feat(aws-route53-apigateway): New Construct (#511)

* created README for r53-apigw construct

* updated code in README

* updated code in README

* updated code in README

* updated README by editing architecture and removing vpcProps

* created r53-apigw construct

* fixed esline error

* updated unit tests

* added empty integ test

* added one resource to integ test

* fixed eslint

* removed certificate creation and validation

* updated license header to 2022

* changed error message and integ test

source/patterns/@aws-solutions-constructs/aws-route53-apigateway/.eslintignore

@@ -0,0 +1,4 @@
+lib/*.js
+test/*.js
+*.d.ts
+coverage

source/patterns/@aws-solutions-constructs/aws-route53-apigateway/.gitignore

@@ -0,0 +1,15 @@
+lib/*.js
+test/*.js
+*.js.map
+*.d.ts
+node_modules
+*.generated.ts
+dist
+.jsii
+
+.LAST_BUILD
+.nyc_output
+coverage
+.nycrc
+.LAST_PACKAGE
+*.snk

source/patterns/@aws-solutions-constructs/aws-route53-apigateway/.npmignore

@@ -0,0 +1,21 @@
+# Exclude typescript source and config
+*.ts
+tsconfig.json
+coverage
+.nyc_output
+*.tgz
+*.snk
+*.tsbuildinfo
+
+# Include javascript files and typescript declarations
+!*.js
+!*.d.ts
+
+# Exclude jsii outdir
+dist
+
+# Include .jsii
+!.jsii
+
+# Include .jsii
+!.jsii

source/patterns/@aws-solutions-constructs/aws-route53-apigateway/README.md

@@ -0,0 +1,112 @@
+# aws-route53-apigateway module
+<!--BEGIN STABILITY BANNER-->
+
+---
+
+![Stability: Experimental](https://img.shields.io/badge/stability-Experimental-important.svg?style=for-the-badge)
+
+> All classes are under active development and subject to non-backward compatible changes or removal in any
+> future version. These are not subject to the [Semantic Versioning](https://semver.org/) model.
+> This means that while you may use them, you may need to update your source code when upgrading to a newer version of this package.
+
+---
+<!--END STABILITY BANNER-->
+
+| **Reference Documentation**:| <span style="font-weight: normal">https://docs.aws.amazon.com/solutions/latest/constructs/</span>|
+|:-------------|:-------------|
+<div style="height:8px"></div>
+
+| **Language**     | **Package**        |
+|:-------------|-----------------|
+|![Python Logo](https://docs.aws.amazon.com/cdk/api/latest/img/python32.png) Python|`aws_solutions_constructs.aws_route53_apigateway`|
+|![Typescript Logo](https://docs.aws.amazon.com/cdk/api/latest/img/typescript32.png) Typescript|`@aws-solutions-constructs/aws-route53-apigateway`|
+|![Java Logo](https://docs.aws.amazon.com/cdk/api/latest/img/java32.png) Java|`software.amazon.awsconstructs.services.route53apigateway`|
+
+## Overview
+
+This AWS Solutions Construct implements an Amazon Route 53 connected to a configured Amazon API Gateway REST API.
+
+Here is a minimal deployable pattern definition in Typescript:
+
+``` typescript
+import * as api from '@aws-cdk/aws-apigateway';
+import * as lambda from "@aws-cdk/aws-lambda";
+import * as route53 from "@aws-cdk/aws-route53";
+import { Route53ToApigateway } from '@aws-solutions-constructs/aws-route53-apigateway';
+
+// The construct requires an existing REST API, this can be created in raw CDK or extracted
+// from a previously instantiated construct that created an API Gateway REST API
+const existingRestApi = previouslyCreatedApigatewayToLambdaConstruct.apiGateway;
+
+const ourHostedZone = route53.HostedZone.fromLookup(this, 'HostedZone', {
+    domainName: "example.com",
+  });
+
+const certificate = acm.Certificate.fromCertificateArn(
+    stack,
+    "fake-cert",
+    "arn:aws:acm:us-east-1:123456789012:certificate/11112222-3333-1234-1234-123456789012"
+  );
+
+// This construct can only be attached to a configured API Gateway.
+new Route53ToApigateway(this, 'Route53ToApigatewayPattern', {
+    existingApiGatewayObj: existingRestApi,
+    existingHostedZoneInterface: ourHostedZone,
+    publicApi: true,
+    existingCertificateInterface: certificate
+});
+
+```
+
+## Initializer
+
+``` text
+new Route53ToApigateway(scope: Construct, id: string, props: Route53ToApigatewayProps);
+```
+
+_Parameters_
+
+* scope [`Construct`](https://docs.aws.amazon.com/cdk/api/latest/docs/@aws-cdk_core.Construct.html)
+* id `string`
+* props [`Route53ToApigatewayProps`](#pattern-construct-props)
+
+## Pattern Construct Props
+
+This construct cannot create a new Public Hosted Zone, if you are creating a public API you must supply an existing Public Hosted Zone that will be reconfigured with a new Alias record. Public Hosted Zones are configured with public domain names and are not well suited to be launched and torn down dynamically, so this construct will only reconfigure existing Public Hosted Zones.
+
+This construct can create Private Hosted Zones. If you want a Private Hosted Zone, then you can either provide an existing Private Hosted Zone or a privateHostedZoneProps value with at least the Domain Name defined. If you are using privateHostedZoneProps, an existing wildcard certificate (*.example.com) must be issued from a previous domain to be used in the newly created Private Hosted Zone. New certificate creation and validation do not take place in this construct. A private Rest API already exists in a VPC, so that VPC must be provided in the existingVpc prop. There is no scenario where this construct can create a new VPC (since it can't create a new API), so the vpcProps property is not supported on this construct.
+
+| **Name**     | **Type**        | **Description** |
+|:-------------|:----------------|-----------------|
+| publicApi | boolean | Whether the construct is deploying a private or public API. This has implications for the Hosted Zone and VPC. |
+| privateHostedZoneProps? | [route53.PrivateHostedZoneProps](https://docs.aws.amazon.com/cdk/api/latest/docs/@aws-cdk_aws-route53.PrivateHostedZoneProps.html) | Optional custom properties for a new Private Hosted Zone. Cannot be specified for a public API. Cannot specify a VPC, it will use the VPC in existingVpc or the VPC created by the construct. Providing both this and existingHostedZoneInterface is an error. |
+| existingHostedZoneInterface? | [route53.IHostedZone](https://docs.aws.amazon.com/cdk/api/latest/docs/@aws-cdk_aws-route53.IHostedZone.html) | Existing Public or Private Hosted Zone (type must match publicApi setting). Specifying both this and privateHostedZoneProps is an error. If this is a Private Hosted Zone, the associated VPC must be provided as the existingVpc property.|
+| existingVpc? | [ec2.IVpc](https://docs.aws.amazon.com/cdk/api/latest/docs/@aws-cdk_aws-ec2.IVpc.html) | An existing VPC in which to deploy the construct.|
+|existingApiGatewayInterface|[api.IRestApi](https://docs.aws.amazon.com/cdk/api/latest/docs/@aws-cdk_aws-apigateway.IRestApi.html)|The existing API Gateway instance that will be connected to the Route 53 hosted zone. *Note that Route 53 can only be connected to a configured API Gateway, so this construct only accepts an existing IRestApi and does not accept apiGatewayProps.*|
+| existingCertificateInterface |[certificatemanager.ICertificate](https://docs.aws.amazon.com/cdk/api/v1/docs/@aws-cdk_aws-certificatemanager.ICertificate.html)| An existing AWS Certificate Manager certificate for your custom domain name.|
+
+## Pattern Properties
+
+| **Name**     | **Type**        | **Description** |
+|:-------------|:----------------|-----------------|
+|hostedZone|[route53.IHostedZone](https://docs.aws.amazon.com/cdk/api/latest/docs/@aws-cdk_aws-route53.IHostedZone.html)|The hosted zone used by the construct (whether created by the construct or provided by the client) |
+| vpc? | [ec2.IVpc](https://docs.aws.amazon.com/cdk/api/latest/docs/@aws-cdk_aws-ec2.IVpc.html) | The VPC used by the construct. |
+|apiGateway|[api.RestApi](https://docs.aws.amazon.com/cdk/api/latest/docs/@aws-cdk_aws-apigateway.RestApi.html)|Returns an instance of the API Gateway REST API created by the pattern.|
+|certificate|[certificatemanager.ICertificate](https://docs.aws.amazon.com/cdk/api/v1/docs/@aws-cdk_aws-certificatemanager.ICertificate.html)| THe certificate used by the construct (whether create by the construct or provided by the client)
+
+## Default settings
+Out of the box implementation of the Construct without any override will set the following defaults:
+
+### Amazon Route53
+* Adds an ALIAS record to the new or provided Hosted Zone that routes to the construct's API Gateway
+
+### Amazon API Gateway
+* User provided API Gateway object is used as-is
+* Sets up custom domain name mapping to API
+
+## Architecture
+
+![Architecture Diagram](architecture.png)
+
+***
+&copy; Copyright 2022 Amazon.com, Inc. or its affiliates. All Rights Reserved.

source/patterns/@aws-solutions-constructs/aws-route53-apigateway/lib/index.ts

@@ -0,0 +1,143 @@
+/**
+ *  Copyright 2022 Amazon.com, Inc. or its affiliates. All Rights Reserved.
+ *
+ *  Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance
+ *  with the License. A copy of the License is located at
+ *
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ *
+ *  or in the 'license' file accompanying this file. This file is distributed on an 'AS IS' BASIS, WITHOUT WARRANTIES
+ *  OR CONDITIONS OF ANY KIND, express or implied. See the License for the specific language governing permissions
+ *  and limitations under the License.
+ */
+
+// Imports
+import * as api from '@aws-cdk/aws-apigateway';
+import * as route53 from "@aws-cdk/aws-route53";
+import * as targets from '@aws-cdk/aws-route53-targets';
+import * as ec2 from '@aws-cdk/aws-ec2';
+import * as defaults from '@aws-solutions-constructs/core';
+import * as certificatemanager from '@aws-cdk/aws-certificatemanager';
+// Note: To ensure CDKv2 compatibility, keep the import statement for Construct separate
+import { Construct } from '@aws-cdk/core';
+
+/**
+ * The properties for the Route53ToApiGateway class.
+ */
+export interface Route53ToApiGatewayProps {
+  /**
+   * Whether to create a public or private API. This value has implications
+   * for the VPC, the type of Hosted Zone and the Application Load Balancer
+   *
+   * @default - None
+   */
+  readonly publicApi: boolean
+  /**
+   * Optional custom properties for a new Private Hosted Zone. Cannot be specified for a
+   * public API. Cannot specify a VPC, it will use the VPC in existingVpc or the VPC created by the construct.
+   * Providing both this and existingHostedZoneInterface is an error.
+   *
+   * @default - None
+   */
+  readonly privateHostedZoneProps?: route53.PrivateHostedZoneProps | any,
+  /**
+   * Existing Public or Private Hosted Zone. If a Private Hosted Zone, must
+   * exist in the same VPC specified in existingVpc
+   *
+   * @default - None
+   */
+  readonly existingHostedZoneInterface?: route53.IHostedZone,
+  /**
+   * An existing VPC. If an existing Private Hosted Zone is provided,
+   * this value must be the VPC associated with those resources.
+   *
+   * @default - None
+   */
+  readonly existingVpc?: ec2.IVpc,
+  /**
+   * The existing API Gateway instance that will be protected with the Route 53 hosted zone.
+   *
+   * @default - None
+   */
+  readonly existingApiGatewayInterface: api.IRestApi,
+  /**
+   * An existing AWS Certificate Manager certificate for your custom domain name.
+   *
+   * @defualt - None
+   */
+  readonly existingCertificateInterface: certificatemanager.ICertificate;
+}
+
+/**
+ * @summary The Route53ToApiGateway class.
+ */
+export class Route53ToApiGateway extends Construct {
+  public readonly hostedZone: route53.IHostedZone;
+  public readonly vpc?: ec2.IVpc;
+  public readonly apiGateway: api.RestApi;
+  public readonly certificate: certificatemanager.ICertificate;
+  /**
+   * @summary Constructs a new instance of the Route53ToApiGateway class.
+   * @param {cdk.App} scope - represents the scope for all the resources.
+   * @param {string} id - this is a a scope-unique id.
+   * @param {Route53ToApiGatewayProps} props - user provided props for the construct
+   * @since 0.8.0
+   * @access public
+   */
+  constructor(scope: Construct, id: string, props: Route53ToApiGatewayProps) {
+    super(scope, id);
+    defaults.CheckProps(props);
+
+    this.certificate = props.existingCertificateInterface;
+
+    if (props.existingVpc) {
+      this.vpc = props.existingVpc;
+    }
+
+    // Existing Public or Private Hosted Zone
+    if (props.existingHostedZoneInterface) {
+      this.hostedZone = props.existingHostedZoneInterface;
+
+      if (props.existingVpc) {
+        throw new Error('Cannot provide an existing VPC to an existing Private Hosted Zone.');
+      }
+      if (props.privateHostedZoneProps) {
+        throw new Error('Must provide either existingHostedZoneInterface or privateHostedZoneProps, but not both.');
+      }
+    } else { // Creating a Private Hosted Zone
+      if (props.publicApi) {
+        throw new Error('Public APIs require an existingHostedZone be passed in the Props object.');
+      } else {
+        if (!props.privateHostedZoneProps) {
+          throw new Error('Must provide either existingHostedZoneInterface or privateHostedZoneProps.');
+        }
+        if (props.privateHostedZoneProps.vpc) {
+          throw new Error('All VPC specs must be provided at the Construct level in Route53ToApiGatewayProps.');
+        }
+        if (!props.privateHostedZoneProps.zoneName) {
+          throw new Error('Must supply zoneName for Private Hosted Zone Props.');
+        }
+        if ( !this.vpc ) {
+          throw new Error('Must specify an existingVPC for the Private Hosted Zone in the construct props.');
+        }
+        const manufacturedProps: route53.PrivateHostedZoneProps = defaults.overrideProps(props.privateHostedZoneProps, { vpc: this.vpc });
+        this.hostedZone = new route53.PrivateHostedZone(this, `${id}-zone`, manufacturedProps);
+      }
+    }
+
+    // Convert IRestApi to RestApi
+    this.apiGateway = props.existingApiGatewayInterface as api.RestApi;
+
+    // Add custom domain name in API Gateway
+    this.apiGateway.addDomainName('CustomDomainName', {
+      domainName: this.hostedZone.zoneName,
+      certificate: this.certificate
+    });
+
+    // Create A Record in custom domain to route traffic to API Gateway
+    new route53.ARecord(this, 'CustomDomainAliasRecord', {
+      zone: this.hostedZone,
+      target: route53.RecordTarget.fromAlias(new targets.ApiGateway(this.apiGateway))
+    });
+  }
+}