@aws-solutions-constructs/aws-route53-apigateway 2.85.2 → 2.85.4

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/.jsii CHANGED
@@ -8,7 +8,7 @@
8
8
  "url": "https://aws.amazon.com"
9
9
  },
10
10
  "dependencies": {
11
- "@aws-solutions-constructs/core": "2.85.2",
11
+ "@aws-solutions-constructs/core": "2.85.4",
12
12
  "aws-cdk-lib": "^2.193.0",
13
13
  "constructs": "^10.0.0"
14
14
  },
@@ -3993,7 +3993,7 @@
3993
3993
  },
3994
3994
  "name": "@aws-solutions-constructs/aws-route53-apigateway",
3995
3995
  "readme": {
3996
- "markdown": "# aws-route53-apigateway module\n<!--BEGIN STABILITY BANNER-->\n\n---\n\n![Stability: Experimental](https://img.shields.io/badge/stability-Experimental-important.svg?style=for-the-badge)\n\n> All classes are under active development and subject to non-backward compatible changes or removal in any\n> future version. These are not subject to the [Semantic Versioning](https://semver.org/) model.\n> 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.\n\n---\n<!--END STABILITY BANNER-->\n\n| **Reference Documentation**:| <span style=\"font-weight: normal\">https://docs.aws.amazon.com/solutions/latest/constructs/</span>|\n|:-------------|:-------------|\n<div style=\"height:8px\"></div>\n\n| **Language** | **Package** |\n|:-------------|-----------------|\n|![Python Logo](https://docs.aws.amazon.com/cdk/api/latest/img/python32.png) Python|`aws_solutions_constructs.aws_route53_apigateway`|\n|![Typescript Logo](https://docs.aws.amazon.com/cdk/api/latest/img/typescript32.png) Typescript|`@aws-solutions-constructs/aws-route53-apigateway`|\n|![Java Logo](https://docs.aws.amazon.com/cdk/api/latest/img/java32.png) Java|`software.amazon.awsconstructs.services.route53apigateway`|\n\n## Overview\n\nThis AWS Solutions Construct implements an Amazon Route 53 connected to a configured Amazon API Gateway REST API.\n\nHere is a minimal deployable pattern definition:\n\nTypescript\n``` typescript\nimport { Construct } from 'constructs';\nimport { Stack, StackProps } from 'aws-cdk-lib';\nimport * as route53 from \"aws-cdk-lib/aws-route53\";\nimport * as acm from \"aws-cdk-lib/aws-certificatemanager\";\nimport { Route53ToApiGateway } from '@aws-solutions-constructs/aws-route53-apigateway';\n\n// The construct requires an existing REST API, this can be created in raw CDK or extracted\n// from a previously instantiated construct that created an API Gateway REST API\nconst existingRestApi = previouslyCreatedApigatewayToLambdaConstruct.apiGateway;\n\n// domainName must match existing hosted zone in your account and the existing certificate\nconst ourHostedZone = route53.HostedZone.fromLookup(this, 'HostedZone', {\n domainName: \"example.com\",\n});\n\nconst certificate = acm.Certificate.fromCertificateArn(\n this,\n \"fake-cert\",\n \"arn:aws:acm:us-east-1:123456789012:certificate/11112222-3333-1234-1234-123456789012\"\n);\n\n// This construct can only be attached to a configured API Gateway.\nnew Route53ToApiGateway(this, 'Route53ToApiGatewayPattern', {\n existingApiGatewayInterface: existingRestApi,\n existingHostedZoneInterface: ourHostedZone,\n publicApi: true,\n existingCertificateInterface: certificate\n});\n```\n\nPython\n```python\nfrom aws_solutions_constructs.aws_route53_apigateway import Route53ToApiGateway\nfrom aws_cdk import (\n aws_route53 as route53,\n aws_certificatemanager as acm,\n Stack\n)\nfrom constructs import Construct\n\n# The construct requires an existing REST API, this can be created in raw CDK or extracted\n# from a previously instantiated construct that created an API Gateway REST API\nexistingRestApi = previouslyCreatedApigatewayToLambdaConstruct.apiGateway\n\n# domain_name must match existing hosted zone in your account and the existing certificate\nourHostedZone = route53.HostedZone.from_lookup(self, 'HostedZone',\n domain_name=\"example.com\",\n )\n\n# Obtain a pre-existing certificate from your account\ncertificate = acm.Certificate.from_certificate_arn(\n self,\n 'existing-cert',\n \"arn:aws:acm:us-east-1:123456789012:certificate/11112222-3333-1234-1234-123456789012\"\n)\n\n# This construct can only be attached to a configured API Gateway.\nRoute53ToApiGateway(self, 'Route53ToApigatewayPattern',\n existing_api_gateway_interface=existingRestApi,\n existing_hosted_zone_interface=ourHostedZone,\n public_api=True,\n existing_certificate_interface=certificate\n )\n\n```\n\nJava\n``` java\nimport software.constructs.Construct;\n\nimport software.amazon.awscdk.Stack;\nimport software.amazon.awscdk.StackProps;\nimport software.amazon.awscdk.services.route53.*;\nimport software.amazon.awscdk.services.apigateway.*;\nimport software.amazon.awscdk.services.certificatemanager.*;\nimport software.amazon.awsconstructs.services.route53apigateway.*;\n\n// The construct requires an existing REST API, this can be created in raw CDK\n// or extracted from a previously instantiated construct that created an API\n// Gateway REST API\nfinal IRestApi existingRestApi = previouslyCreatedApigatewayToLambdaConstruct.getApiGateway();\n\n// domainName must match existing hosted zone in your account and the existing certificate\nfinal IHostedZone ourHostedZone = HostedZone.fromLookup(this, \"HostedZone\",\n new HostedZoneProviderProps.Builder()\n .domainName(\"example.com\")\n .build());\n\n// Obtain a pre-existing certificate from your account\nfinal ICertificate certificate = Certificate.fromCertificateArn(\n this,\n \"existing-cert\",\n \"arn:aws:acm:us-east-1:123456789012:certificate/11112222-3333-1234-1234-123456789012\");\n\n// This construct can only be attached to a configured API Gateway.\nnew Route53ToApiGateway(this, \"Route53ToApiGatewayPattern\",\n new Route53ToApiGatewayProps.Builder()\n .existingApiGatewayInterface(existingRestApi)\n .existingHostedZoneInterface(ourHostedZone)\n .publicApi(true)\n .existingCertificateInterface(certificate)\n .build());\n```\n\n## Pattern Construct Props\n\nThis 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.\n\nThis 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.\n\n| **Name** | **Type** | **Description** |\n|:-------------|:----------------|-----------------|\n| publicApi | boolean | Whether the construct is deploying a private or public API. This has implications for the Hosted Zone and VPC. |\n| privateHostedZoneProps? | [route53.PrivateHostedZoneProps](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.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. |\n| existingHostedZoneInterface? | [route53.IHostedZone](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.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.|\n| existingVpc? | [ec2.IVpc](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_ec2.IVpc.html) | An existing VPC in which to deploy the construct.|\n|existingApiGatewayInterface|[api.IRestApi](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.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.*|\n| existingCertificateInterface |[certificatemanager.ICertificate](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_certificatemanager.ICertificate.html)| An existing AWS Certificate Manager certificate for your custom domain name.|\n\n## Pattern Properties\n\n| **Name** | **Type** | **Description** |\n|:-------------|:----------------|-----------------|\n|hostedZone|[route53.IHostedZone](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_route53.IHostedZone.html)|The hosted zone used by the construct (whether created by the construct or provided by the client) |\n| vpc? | [ec2.IVpc](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_ec2.IVpc.html) | The VPC used by the construct. |\n|apiGateway|[api.RestApi](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_apigateway.RestApi.html)|Returns an instance of the API Gateway REST API created by the pattern.|\n|certificate|[certificatemanager.ICertificate](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_certificatemanager.ICertificate.html)| THe certificate used by the construct (whether create by the construct or provided by the client)\n\n## Default settings\nOut of the box implementation of the Construct without any override will set the following defaults:\n\n### Amazon Route53\n* Adds an ALIAS record to the new or provided Hosted Zone that routes to the construct's API Gateway\n\n### Amazon API Gateway\n* User provided API Gateway object is used as-is\n* Sets up custom domain name mapping to API\n\n## Architecture\n\n![Architecture Diagram](architecture.png)\n\n***\n&copy; Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.\n"
3996
+ "markdown": "Documentation for this pattern can be found [here](https://github.com/awslabs/aws-solutions-constructs/blob/main/source/patterns/%40aws-solutions-constructs/aws-route53-apigateway/README.adoc)\n"
3997
3997
  },
3998
3998
  "repository": {
3999
3999
  "directory": "source/patterns/@aws-solutions-constructs/aws-route53-apigateway",
@@ -4250,6 +4250,6 @@
4250
4250
  "symbolId": "lib/index:Route53ToApiGatewayProps"
4251
4251
  }
4252
4252
  },
4253
- "version": "2.85.2",
4254
- "fingerprint": "Zl6RLtrg5rIHKFTphJeJaxHibB5Q+vVEjgF4RmqIegU="
4253
+ "version": "2.85.4",
4254
+ "fingerprint": "mKdUYsmrcMVxXxYjQiwQhtHwY6oKYea1CBcsGffDYuE="
4255
4255
  }
package/README.adoc ADDED
@@ -0,0 +1,267 @@
1
+ //!!NODE_ROOT <section>
2
+ //== aws-route53-apigateway module
3
+
4
+ [.topic]
5
+ = aws-route53-apigateway
6
+ :info_doctype: section
7
+ :info_title: aws-route53-apigateway
8
+
9
+
10
+ image:https://img.shields.io/badge/stability-Experimental-important.svg?style=for-the-badge[Stability:Experimental]
11
+
12
+ ____
13
+ All classes are under active development and subject to non-backward
14
+ compatible changes or removal in any future version. These are not
15
+ subject to the https://semver.org/[Semantic Versioning] model. This
16
+ means that while you may use them, you may need to update your source
17
+ code when upgrading to a newer version of this package.
18
+ ____
19
+
20
+ [width="100%",cols="<50%,<50%",options="header",]
21
+ |===
22
+ |*Reference Documentation*:
23
+ |https://docs.aws.amazon.com/solutions/latest/constructs/
24
+ |===
25
+
26
+ [width="100%",cols="<46%,54%",options="header",]
27
+ |===
28
+ |*Language* |*Package*
29
+ |image:https://docs.aws.amazon.com/cdk/api/latest/img/python32.png[Python
30
+ Logo] Python
31
+ |`aws_solutions_constructs.aws_route53_apigateway`
32
+
33
+ |image:https://docs.aws.amazon.com/cdk/api/latest/img/typescript32.png[Typescript
34
+ Logo] Typescript |`@aws-solutions-constructs/aws-route53-apigateway`
35
+
36
+ |image:https://docs.aws.amazon.com/cdk/api/latest/img/java32.png[Java
37
+ Logo] Java |`software.amazon.awsconstructs.services.route53apigateway`
38
+ |===
39
+
40
+ == Overview
41
+
42
+ This AWS Solutions Construct implements an Amazon Route 53 connected to
43
+ a configured Amazon API Gateway REST API.
44
+
45
+ Here is a minimal deployable pattern definition:
46
+
47
+ ====
48
+ [role="tablist"]
49
+ Typescript::
50
+ +
51
+ [source,typescript]
52
+ ----
53
+ import { Construct } from 'constructs';
54
+ import { Stack, StackProps } from 'aws-cdk-lib';
55
+ import * as route53 from "aws-cdk-lib/aws-route53";
56
+ import * as acm from "aws-cdk-lib/aws-certificatemanager";
57
+ import { Route53ToApiGateway } from '@aws-solutions-constructs/aws-route53-apigateway';
58
+
59
+ // The construct requires an existing REST API, this can be created in raw CDK or extracted
60
+ // from a previously instantiated construct that created an API Gateway REST API
61
+ const existingRestApi = previouslyCreatedApigatewayToLambdaConstruct.apiGateway;
62
+
63
+ // domainName must match existing hosted zone in your account and the existing certificate
64
+ const ourHostedZone = route53.HostedZone.fromLookup(this, 'HostedZone', {
65
+ domainName: "example.com",
66
+ });
67
+
68
+ const certificate = acm.Certificate.fromCertificateArn(
69
+ this,
70
+ "fake-cert",
71
+ "arn:aws:acm:us-east-1:123456789012:certificate/11112222-3333-1234-1234-123456789012"
72
+ );
73
+
74
+ // This construct can only be attached to a configured API Gateway.
75
+ new Route53ToApiGateway(this, 'Route53ToApiGatewayPattern', {
76
+ existingApiGatewayInterface: existingRestApi,
77
+ existingHostedZoneInterface: ourHostedZone,
78
+ publicApi: true,
79
+ existingCertificateInterface: certificate
80
+ });
81
+ ----
82
+
83
+ Python::
84
+ +
85
+ [source,python]
86
+ ----
87
+ from aws_solutions_constructs.aws_route53_apigateway import Route53ToApiGateway
88
+ from aws_cdk import (
89
+ aws_route53 as route53,
90
+ aws_certificatemanager as acm,
91
+ Stack
92
+ )
93
+ from constructs import Construct
94
+
95
+ # The construct requires an existing REST API, this can be created in raw CDK or extracted
96
+ # from a previously instantiated construct that created an API Gateway REST API
97
+ existingRestApi = previouslyCreatedApigatewayToLambdaConstruct.apiGateway
98
+
99
+ # domain_name must match existing hosted zone in your account and the existing certificate
100
+ ourHostedZone = route53.HostedZone.from_lookup(self, 'HostedZone',
101
+ domain_name="example.com",
102
+ )
103
+
104
+ # Obtain a pre-existing certificate from your account
105
+ certificate = acm.Certificate.from_certificate_arn(
106
+ self,
107
+ 'existing-cert',
108
+ "arn:aws:acm:us-east-1:123456789012:certificate/11112222-3333-1234-1234-123456789012"
109
+ )
110
+
111
+ # This construct can only be attached to a configured API Gateway.
112
+ Route53ToApiGateway(self, 'Route53ToApigatewayPattern',
113
+ existing_api_gateway_interface=existingRestApi,
114
+ existing_hosted_zone_interface=ourHostedZone,
115
+ public_api=True,
116
+ existing_certificate_interface=certificate
117
+ )
118
+ ----
119
+
120
+ Java::
121
+ +
122
+ [source,java]
123
+ ----
124
+ import software.constructs.Construct;
125
+
126
+ import software.amazon.awscdk.Stack;
127
+ import software.amazon.awscdk.StackProps;
128
+ import software.amazon.awscdk.services.route53.*;
129
+ import software.amazon.awscdk.services.apigateway.*;
130
+ import software.amazon.awscdk.services.certificatemanager.*;
131
+ import software.amazon.awsconstructs.services.route53apigateway.*;
132
+
133
+ // The construct requires an existing REST API, this can be created in raw CDK
134
+ // or extracted from a previously instantiated construct that created an API
135
+ // Gateway REST API
136
+ final IRestApi existingRestApi = previouslyCreatedApigatewayToLambdaConstruct.getApiGateway();
137
+
138
+ // domainName must match existing hosted zone in your account and the existing certificate
139
+ final IHostedZone ourHostedZone = HostedZone.fromLookup(this, "HostedZone",
140
+ new HostedZoneProviderProps.Builder()
141
+ .domainName("example.com")
142
+ .build());
143
+
144
+ // Obtain a pre-existing certificate from your account
145
+ final ICertificate certificate = Certificate.fromCertificateArn(
146
+ this,
147
+ "existing-cert",
148
+ "arn:aws:acm:us-east-1:123456789012:certificate/11112222-3333-1234-1234-123456789012");
149
+
150
+ // This construct can only be attached to a configured API Gateway.
151
+ new Route53ToApiGateway(this, "Route53ToApiGatewayPattern",
152
+ new Route53ToApiGatewayProps.Builder()
153
+ .existingApiGatewayInterface(existingRestApi)
154
+ .existingHostedZoneInterface(ourHostedZone)
155
+ .publicApi(true)
156
+ .existingCertificateInterface(certificate)
157
+ .build());
158
+ ----
159
+ ====
160
+
161
+ == Pattern Construct Props
162
+
163
+ This construct cannot create a new Public Hosted Zone, if you are
164
+ creating a public API you must supply an existing Public Hosted Zone
165
+ that will be reconfigured with a new Alias record. Public Hosted Zones
166
+ are configured with public domain names and are not well suited to be
167
+ launched and torn down dynamically, so this construct will only
168
+ reconfigure existing Public Hosted Zones.
169
+
170
+ This construct can create Private Hosted Zones. If you want a Private
171
+ Hosted Zone, then you can either provide an existing Private Hosted Zone
172
+ or a privateHostedZoneProps value with at least the Domain Name defined.
173
+ If you are using privateHostedZoneProps, an existing wildcard
174
+ certificate (*.example.com) must be issued from a previous domain to
175
+ be used in the newly created Private Hosted Zone. New certificate
176
+ creation and validation do not take place in this construct. A private
177
+ Rest API already exists in a VPC, so that VPC must be provided in the
178
+ existingVpc prop. There is no scenario where this construct can create a
179
+ new VPC (since it can’t create a new API), so the vpcProps property is
180
+ not supported on this construct.
181
+
182
+ [width="100%",cols="<30%,<35%,35%",options="header",]
183
+ |===
184
+ |*Name* |*Type* |*Description*
185
+ |publicApi |boolean |Whether the construct is deploying a private or
186
+ public API. This has implications for the Hosted Zone and VPC.
187
+
188
+ |privateHostedZoneProps?
189
+ |https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_route53.PrivateHostedZoneProps.html[route53.PrivateHostedZoneProps]
190
+ |Optional custom properties for a new Private Hosted Zone. Cannot be
191
+ specified for a public API. Cannot specify a VPC, it will use the VPC in
192
+ existingVpc or the VPC created by the construct. Providing both this and
193
+ existingHostedZoneInterface is an error.
194
+
195
+ |existingHostedZoneInterface?
196
+ |https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_route53.IHostedZone.html[route53.IHostedZone]
197
+ |Existing Public or Private Hosted Zone (type must match publicApi
198
+ setting). Specifying both this and privateHostedZoneProps is an error.
199
+ If this is a Private Hosted Zone, the associated VPC must be provided as
200
+ the existingVpc property.
201
+
202
+ |existingVpc?
203
+ |https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_ec2.IVpc.html[ec2.IVpc]
204
+ |An existing VPC in which to deploy the construct.
205
+
206
+ |existingApiGatewayInterface
207
+ |https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_apigateway.IRestApi.html[api.IRestApi]
208
+ |The existing API Gateway instance that will be connected to the Route
209
+ 53 hosted zone. _Note that Route 53 can only be connected to a
210
+ configured API Gateway, so this construct only accepts an existing
211
+ IRestApi and does not accept apiGatewayProps._
212
+
213
+ |existingCertificateInterface
214
+ |https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_certificatemanager.ICertificate.html[certificatemanager.ICertificate]
215
+ |An existing AWS Certificate Manager certificate for your custom domain
216
+ name.
217
+ |===
218
+
219
+ == Pattern Properties
220
+
221
+ [width="100%",cols="<30%,<35%,35%",options="header",]
222
+ |===
223
+ |*Name* |*Type* |*Description*
224
+ |hostedZone
225
+ |https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_route53.IHostedZone.html[route53.IHostedZone]
226
+ |The hosted zone used by the construct (whether created by the construct
227
+ or provided by the client)
228
+
229
+ |vpc?
230
+ |https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_ec2.IVpc.html[ec2.IVpc]
231
+ |The VPC used by the construct.
232
+
233
+ |apiGateway
234
+ |https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_apigateway.RestApi.html[api.RestApi]
235
+ |Returns an instance of the API Gateway REST API created by the pattern.
236
+
237
+ |certificate
238
+ |https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_certificatemanager.ICertificate.html[certificatemanager.ICertificate]
239
+ |THe certificate used by the construct (whether create by the construct
240
+ or provided by the client)
241
+ |===
242
+
243
+ == Default settings
244
+
245
+ Out of the box implementation of the Construct without any override will
246
+ set the following defaults:
247
+
248
+ === Amazon Route53
249
+
250
+ * Adds an ALIAS record to the new or provided Hosted Zone that routes to
251
+ the construct’s API Gateway
252
+
253
+ === Amazon API Gateway
254
+
255
+ * User provided API Gateway object is used as-is
256
+ * Sets up custom domain name mapping to API
257
+
258
+ == Architecture
259
+
260
+
261
+ image::aws-route53-apigateway.png["Diagram showing the Route53 ALIAS record in an existing hosted zone and API Gateway api created by the construct",scaledwidth=100%]
262
+
263
+ // github block
264
+
265
+ '''''
266
+
267
+ © Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
package/README.md CHANGED
@@ -1,176 +1 @@
1
- # aws-route53-apigateway module
2
- <!--BEGIN STABILITY BANNER-->
3
-
4
- ---
5
-
6
- ![Stability: Experimental](https://img.shields.io/badge/stability-Experimental-important.svg?style=for-the-badge)
7
-
8
- > All classes are under active development and subject to non-backward compatible changes or removal in any
9
- > future version. These are not subject to the [Semantic Versioning](https://semver.org/) model.
10
- > 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.
11
-
12
- ---
13
- <!--END STABILITY BANNER-->
14
-
15
- | **Reference Documentation**:| <span style="font-weight: normal">https://docs.aws.amazon.com/solutions/latest/constructs/</span>|
16
- |:-------------|:-------------|
17
- <div style="height:8px"></div>
18
-
19
- | **Language** | **Package** |
20
- |:-------------|-----------------|
21
- |![Python Logo](https://docs.aws.amazon.com/cdk/api/latest/img/python32.png) Python|`aws_solutions_constructs.aws_route53_apigateway`|
22
- |![Typescript Logo](https://docs.aws.amazon.com/cdk/api/latest/img/typescript32.png) Typescript|`@aws-solutions-constructs/aws-route53-apigateway`|
23
- |![Java Logo](https://docs.aws.amazon.com/cdk/api/latest/img/java32.png) Java|`software.amazon.awsconstructs.services.route53apigateway`|
24
-
25
- ## Overview
26
-
27
- This AWS Solutions Construct implements an Amazon Route 53 connected to a configured Amazon API Gateway REST API.
28
-
29
- Here is a minimal deployable pattern definition:
30
-
31
- Typescript
32
- ``` typescript
33
- import { Construct } from 'constructs';
34
- import { Stack, StackProps } from 'aws-cdk-lib';
35
- import * as route53 from "aws-cdk-lib/aws-route53";
36
- import * as acm from "aws-cdk-lib/aws-certificatemanager";
37
- import { Route53ToApiGateway } from '@aws-solutions-constructs/aws-route53-apigateway';
38
-
39
- // The construct requires an existing REST API, this can be created in raw CDK or extracted
40
- // from a previously instantiated construct that created an API Gateway REST API
41
- const existingRestApi = previouslyCreatedApigatewayToLambdaConstruct.apiGateway;
42
-
43
- // domainName must match existing hosted zone in your account and the existing certificate
44
- const ourHostedZone = route53.HostedZone.fromLookup(this, 'HostedZone', {
45
- domainName: "example.com",
46
- });
47
-
48
- const certificate = acm.Certificate.fromCertificateArn(
49
- this,
50
- "fake-cert",
51
- "arn:aws:acm:us-east-1:123456789012:certificate/11112222-3333-1234-1234-123456789012"
52
- );
53
-
54
- // This construct can only be attached to a configured API Gateway.
55
- new Route53ToApiGateway(this, 'Route53ToApiGatewayPattern', {
56
- existingApiGatewayInterface: existingRestApi,
57
- existingHostedZoneInterface: ourHostedZone,
58
- publicApi: true,
59
- existingCertificateInterface: certificate
60
- });
61
- ```
62
-
63
- Python
64
- ```python
65
- from aws_solutions_constructs.aws_route53_apigateway import Route53ToApiGateway
66
- from aws_cdk import (
67
- aws_route53 as route53,
68
- aws_certificatemanager as acm,
69
- Stack
70
- )
71
- from constructs import Construct
72
-
73
- # The construct requires an existing REST API, this can be created in raw CDK or extracted
74
- # from a previously instantiated construct that created an API Gateway REST API
75
- existingRestApi = previouslyCreatedApigatewayToLambdaConstruct.apiGateway
76
-
77
- # domain_name must match existing hosted zone in your account and the existing certificate
78
- ourHostedZone = route53.HostedZone.from_lookup(self, 'HostedZone',
79
- domain_name="example.com",
80
- )
81
-
82
- # Obtain a pre-existing certificate from your account
83
- certificate = acm.Certificate.from_certificate_arn(
84
- self,
85
- 'existing-cert',
86
- "arn:aws:acm:us-east-1:123456789012:certificate/11112222-3333-1234-1234-123456789012"
87
- )
88
-
89
- # This construct can only be attached to a configured API Gateway.
90
- Route53ToApiGateway(self, 'Route53ToApigatewayPattern',
91
- existing_api_gateway_interface=existingRestApi,
92
- existing_hosted_zone_interface=ourHostedZone,
93
- public_api=True,
94
- existing_certificate_interface=certificate
95
- )
96
-
97
- ```
98
-
99
- Java
100
- ``` java
101
- import software.constructs.Construct;
102
-
103
- import software.amazon.awscdk.Stack;
104
- import software.amazon.awscdk.StackProps;
105
- import software.amazon.awscdk.services.route53.*;
106
- import software.amazon.awscdk.services.apigateway.*;
107
- import software.amazon.awscdk.services.certificatemanager.*;
108
- import software.amazon.awsconstructs.services.route53apigateway.*;
109
-
110
- // The construct requires an existing REST API, this can be created in raw CDK
111
- // or extracted from a previously instantiated construct that created an API
112
- // Gateway REST API
113
- final IRestApi existingRestApi = previouslyCreatedApigatewayToLambdaConstruct.getApiGateway();
114
-
115
- // domainName must match existing hosted zone in your account and the existing certificate
116
- final IHostedZone ourHostedZone = HostedZone.fromLookup(this, "HostedZone",
117
- new HostedZoneProviderProps.Builder()
118
- .domainName("example.com")
119
- .build());
120
-
121
- // Obtain a pre-existing certificate from your account
122
- final ICertificate certificate = Certificate.fromCertificateArn(
123
- this,
124
- "existing-cert",
125
- "arn:aws:acm:us-east-1:123456789012:certificate/11112222-3333-1234-1234-123456789012");
126
-
127
- // This construct can only be attached to a configured API Gateway.
128
- new Route53ToApiGateway(this, "Route53ToApiGatewayPattern",
129
- new Route53ToApiGatewayProps.Builder()
130
- .existingApiGatewayInterface(existingRestApi)
131
- .existingHostedZoneInterface(ourHostedZone)
132
- .publicApi(true)
133
- .existingCertificateInterface(certificate)
134
- .build());
135
- ```
136
-
137
- ## Pattern Construct Props
138
-
139
- 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.
140
-
141
- 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.
142
-
143
- | **Name** | **Type** | **Description** |
144
- |:-------------|:----------------|-----------------|
145
- | publicApi | boolean | Whether the construct is deploying a private or public API. This has implications for the Hosted Zone and VPC. |
146
- | privateHostedZoneProps? | [route53.PrivateHostedZoneProps](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.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. |
147
- | existingHostedZoneInterface? | [route53.IHostedZone](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.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.|
148
- | existingVpc? | [ec2.IVpc](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_ec2.IVpc.html) | An existing VPC in which to deploy the construct.|
149
- |existingApiGatewayInterface|[api.IRestApi](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.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.*|
150
- | existingCertificateInterface |[certificatemanager.ICertificate](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_certificatemanager.ICertificate.html)| An existing AWS Certificate Manager certificate for your custom domain name.|
151
-
152
- ## Pattern Properties
153
-
154
- | **Name** | **Type** | **Description** |
155
- |:-------------|:----------------|-----------------|
156
- |hostedZone|[route53.IHostedZone](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_route53.IHostedZone.html)|The hosted zone used by the construct (whether created by the construct or provided by the client) |
157
- | vpc? | [ec2.IVpc](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_ec2.IVpc.html) | The VPC used by the construct. |
158
- |apiGateway|[api.RestApi](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_apigateway.RestApi.html)|Returns an instance of the API Gateway REST API created by the pattern.|
159
- |certificate|[certificatemanager.ICertificate](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_certificatemanager.ICertificate.html)| THe certificate used by the construct (whether create by the construct or provided by the client)
160
-
161
- ## Default settings
162
- Out of the box implementation of the Construct without any override will set the following defaults:
163
-
164
- ### Amazon Route53
165
- * Adds an ALIAS record to the new or provided Hosted Zone that routes to the construct's API Gateway
166
-
167
- ### Amazon API Gateway
168
- * User provided API Gateway object is used as-is
169
- * Sets up custom domain name mapping to API
170
-
171
- ## Architecture
172
-
173
- ![Architecture Diagram](architecture.png)
174
-
175
- ***
176
- &copy; Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
1
+ Documentation for this pattern can be found [here](https://github.com/awslabs/aws-solutions-constructs/blob/main/source/patterns/%40aws-solutions-constructs/aws-route53-apigateway/README.adoc)
package/lib/index.js CHANGED
@@ -78,5 +78,5 @@ class Route53ToApiGateway extends constructs_1.Construct {
78
78
  }
79
79
  exports.Route53ToApiGateway = Route53ToApiGateway;
80
80
  _a = JSII_RTTI_SYMBOL_1;
81
- Route53ToApiGateway[_a] = { fqn: "@aws-solutions-constructs/aws-route53-apigateway.Route53ToApiGateway", version: "2.85.2" };
81
+ Route53ToApiGateway[_a] = { fqn: "@aws-solutions-constructs/aws-route53-apigateway.Route53ToApiGateway", version: "2.85.4" };
82
82
  //# sourceMappingURL=data:application/json;base64,{"version":3,"file":"index.js","sourceRoot":"","sources":["index.ts"],"names":[],"mappings":";;;;;AAeA,mDAAmD;AACnD,2DAA2D;AAE3D,2DAA2D;AAE3D,wFAAwF;AACxF,2CAAuC;AA+CvC;;GAEG;AACH,MAAa,mBAAoB,SAAQ,sBAAS;IAKhD;;;;;;;OAOG;IACH,YAAY,KAAgB,EAAE,EAAU,EAAE,KAA+B;QACvE,KAAK,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC;QAEjB,IAAI,CAAC,WAAW,GAAG,KAAK,CAAC,4BAA4B,CAAC;QAEtD,IAAI,KAAK,CAAC,WAAW,EAAE,CAAC;YACtB,IAAI,CAAC,GAAG,GAAG,KAAK,CAAC,WAAW,CAAC;QAC/B,CAAC;QAED,yCAAyC;QACzC,IAAI,KAAK,CAAC,2BAA2B,EAAE,CAAC;YACtC,IAAI,CAAC,UAAU,GAAG,KAAK,CAAC,2BAA2B,CAAC;YACpD,IAAI,CAAC,2BAA2B,CAAC,KAAK,CAAC,CAAC;QAE1C,CAAC;aAAM,CAAC,CAAC,iCAAiC;YACxC,IAAI,CAAC,4BAA4B,CAAC,KAAK,CAAC,CAAC;YACzC,MAAM,iBAAiB,GAAmC,QAAQ,CAAC,aAAa,CAAC,KAAK,CAAC,sBAAsB,EAAE,EAAE,GAAG,EAAE,IAAI,CAAC,GAAG,EAAE,CAAC,CAAC;YAClI,IAAI,CAAC,UAAU,GAAG,IAAI,OAAO,CAAC,iBAAiB,CAAC,IAAI,EAAE,GAAG,EAAE,OAAO,EAAE,iBAAiB,CAAC,CAAC;QACzF,CAAC;QAED,8BAA8B;QAC9B,IAAI,CAAC,UAAU,GAAG,KAAK,CAAC,2BAA0C,CAAC;QAEnE,wCAAwC;QACxC,IAAI,CAAC,UAAU,CAAC,aAAa,CAAC,kBAAkB,EAAE;YAChD,UAAU,EAAE,IAAI,CAAC,UAAU,CAAC,QAAQ;YACpC,WAAW,EAAE,IAAI,CAAC,WAAW;SAC9B,CAAC,CAAC;QAEH,MAAM,YAAY,GAAyB;YACzC,IAAI,EAAE,IAAI,CAAC,UAAU;YACrB,MAAM,EAAE,OAAO,CAAC,YAAY,CAAC,SAAS,CAAC,IAAI,OAAO,CAAC,UAAU,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;SAChF,CAAC;QAEF,mEAAmE;QACnE,IAAI,OAAO,CAAC,OAAO,CAAC,IAAI,EAAE,yBAAyB,EAAE,YAAY,CAAC,CAAC,CAAC,UAAU;IAChF,CAAC;IAEO,2BAA2B,CAAC,KAA+B;QACjE,IAAI,KAAK,CAAC,WAAW,EAAE,CAAC;YACtB,MAAM,IAAI,KAAK,CAAC,oEAAoE,CAAC,CAAC;QACxF,CAAC;QACD,IAAI,KAAK,CAAC,sBAAsB,EAAE,CAAC;YACjC,MAAM,IAAI,KAAK,CAAC,0FAA0F,CAAC,CAAC;QAC9G,CAAC;IACH,CAAC;IAEO,4BAA4B,CAAC,KAA+B;QAClE,IAAI,KAAK,CAAC,SAAS,EAAE,CAAC;YACpB,MAAM,IAAI,KAAK,CAAC,0EAA0E,CAAC,CAAC;QAC9F,CAAC;QACD,IAAI,CAAC,KAAK,CAAC,sBAAsB,EAAE,CAAC;YAClC,MAAM,IAAI,KAAK,CAAC,4EAA4E,CAAC,CAAC;QAChG,CAAC;QACD,IAAI,KAAK,CAAC,sBAAsB,CAAC,GAAG,EAAE,CAAC;YACrC,MAAM,IAAI,KAAK,CAAC,oFAAoF,CAAC,CAAC;QACxG,CAAC;QACD,IAAI,CAAC,KAAK,CAAC,sBAAsB,CAAC,QAAQ,EAAE,CAAC;YAC3C,MAAM,IAAI,KAAK,CAAC,qDAAqD,CAAC,CAAC;QACzE,CAAC;QACD,IAAI,CAAC,IAAI,CAAC,GAAG,EAAE,CAAC;YACd,MAAM,IAAI,KAAK,CAAC,iFAAiF,CAAC,CAAC;QACrG,CAAC;IACH,CAAC;;AA5EH,kDA6EC","sourcesContent":["/**\n *  Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.\n *\n *  Licensed under the Apache License, Version 2.0 (the \"License\"). You may not use this file except in compliance\n *  with the License. A copy of the License is located at\n *\n *      http://www.apache.org/licenses/LICENSE-2.0\n *\n *  or in the 'license' file accompanying this file. This file is distributed on an 'AS IS' BASIS, WITHOUT WARRANTIES\n *  OR CONDITIONS OF ANY KIND, express or implied. See the License for the specific language governing permissions\n *  and limitations under the License.\n */\n\n// Imports\nimport * as api from 'aws-cdk-lib/aws-apigateway';\nimport * as route53 from \"aws-cdk-lib/aws-route53\";\nimport * as targets from 'aws-cdk-lib/aws-route53-targets';\nimport * as ec2 from 'aws-cdk-lib/aws-ec2';\nimport * as defaults from '@aws-solutions-constructs/core';\nimport * as certificatemanager from 'aws-cdk-lib/aws-certificatemanager';\n// Note: To ensure CDKv2 compatibility, keep the import statement for Construct separate\nimport { Construct } from 'constructs';\n\n/**\n * The properties for the Route53ToApiGateway class.\n */\nexport interface Route53ToApiGatewayProps {\n  /**\n   * Whether to create a public or private API. This value has implications\n   * for the VPC, the type of Hosted Zone and the Application Load Balancer\n   */\n  readonly publicApi: boolean\n  /**\n   * Optional custom properties for a new Private Hosted Zone. Cannot be specified for a\n   * public API. Cannot specify a VPC, it will use the VPC in existingVpc or the VPC created by the construct.\n   * Providing both this and existingHostedZoneInterface is an error.\n   *\n   * @default - None\n   */\n  readonly privateHostedZoneProps?: route53.PrivateHostedZoneProps | any,\n  /**\n   * Existing Public or Private Hosted Zone. If a Private Hosted Zone, must\n   * exist in the same VPC specified in existingVpc\n   *\n   * @default - None\n   */\n  readonly existingHostedZoneInterface?: route53.IHostedZone,\n  /**\n   * An existing VPC. If an existing Private Hosted Zone is provided,\n   * this value must be the VPC associated with those resources.\n   *\n   * @default - None\n   */\n  readonly existingVpc?: ec2.IVpc,\n  /**\n   * The existing API Gateway instance that will be protected with the Route 53 hosted zone.\n   *\n   * @default - None\n   */\n  readonly existingApiGatewayInterface: api.IRestApi,\n  /**\n   * An existing AWS Certificate Manager certificate for your custom domain name.\n   *\n   * @default - None\n   */\n  readonly existingCertificateInterface: certificatemanager.ICertificate;\n}\n\n/**\n * @summary The Route53ToApiGateway class.\n */\nexport class Route53ToApiGateway extends Construct {\n  public readonly hostedZone: route53.IHostedZone;\n  public readonly vpc?: ec2.IVpc;\n  public readonly apiGateway: api.RestApi;\n  public readonly certificate: certificatemanager.ICertificate;\n  /**\n   * @summary Constructs a new instance of the Route53ToApiGateway class.\n   * @param {cdk.App} scope - represents the scope for all the resources.\n   * @param {string} id - this is a a scope-unique id.\n   * @param {Route53ToApiGatewayProps} props - user provided props for the construct\n   * @since 0.8.0\n   * @access public\n   */\n  constructor(scope: Construct, id: string, props: Route53ToApiGatewayProps) {\n    super(scope, id);\n\n    this.certificate = props.existingCertificateInterface;\n\n    if (props.existingVpc) {\n      this.vpc = props.existingVpc;\n    }\n\n    // Existing Public or Private Hosted Zone\n    if (props.existingHostedZoneInterface) {\n      this.hostedZone = props.existingHostedZoneInterface;\n      this.ExistingHostedZonePropCheck(props);\n\n    } else { // Creating a Private Hosted Zone\n      this.PrivateHostedZonePropsChecks(props);\n      const manufacturedProps: route53.PrivateHostedZoneProps = defaults.overrideProps(props.privateHostedZoneProps, { vpc: this.vpc });\n      this.hostedZone = new route53.PrivateHostedZone(this, `${id}-zone`, manufacturedProps);\n    }\n\n    // Convert IRestApi to RestApi\n    this.apiGateway = props.existingApiGatewayInterface as api.RestApi;\n\n    // Add custom domain name in API Gateway\n    this.apiGateway.addDomainName('CustomDomainName', {\n      domainName: this.hostedZone.zoneName,\n      certificate: this.certificate\n    });\n\n    const arecordProps: route53.ARecordProps = {\n      zone: this.hostedZone,\n      target: route53.RecordTarget.fromAlias(new targets.ApiGateway(this.apiGateway))\n    };\n\n    // Create A Record in custom domain to route traffic to API Gateway\n    new route53.ARecord(this, 'CustomDomainAliasRecord', arecordProps); // NOSONAR\n  }\n\n  private ExistingHostedZonePropCheck(props: Route53ToApiGatewayProps) {\n    if (props.existingVpc) {\n      throw new Error('Cannot provide an existing VPC to an existing Private Hosted Zone.');\n    }\n    if (props.privateHostedZoneProps) {\n      throw new Error('Must provide either existingHostedZoneInterface or privateHostedZoneProps, but not both.');\n    }\n  }\n\n  private PrivateHostedZonePropsChecks(props: Route53ToApiGatewayProps) {\n    if (props.publicApi) {\n      throw new Error('Public APIs require an existingHostedZone be passed in the Props object.');\n    }\n    if (!props.privateHostedZoneProps) {\n      throw new Error('Must provide either existingHostedZoneInterface or privateHostedZoneProps.');\n    }\n    if (props.privateHostedZoneProps.vpc) {\n      throw new Error('All VPC specs must be provided at the Construct level in Route53ToApiGatewayProps.');\n    }\n    if (!props.privateHostedZoneProps.zoneName) {\n      throw new Error('Must supply zoneName for Private Hosted Zone Props.');\n    }\n    if (!this.vpc) {\n      throw new Error('Must specify an existingVPC for the Private Hosted Zone in the construct props.');\n    }\n  }\n}\n"]}
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@aws-solutions-constructs/aws-route53-apigateway",
3
- "version": "2.85.2",
3
+ "version": "2.85.4",
4
4
  "description": "CDK constructs for connecting an Amazon Route53 domain to an API Gateway.",
5
5
  "main": "lib/index.js",
6
6
  "types": "lib/index.d.ts",
@@ -22,12 +22,13 @@
22
22
  "test": "jest --coverage",
23
23
  "clean": "tsc -b --clean",
24
24
  "watch": "tsc -b -w",
25
+ "asciidoc": "asciidoctor --failure-level WARNING -o /dev/null README.adoc",
25
26
  "integ": "integ-runner --update-on-failed",
26
27
  "integ-no-clean": "integ-runner --update-on-failed --no-clean",
27
28
  "integ-assert": "integ-runner",
28
29
  "jsii": "jsii",
29
30
  "jsii-pacmak": "jsii-pacmak",
30
- "build+lint+test": "npm run jsii && npm run lint && npm test && npm run integ-assert",
31
+ "build+lint+test": "npm run jsii && npm run lint && npm run asciidoc && npm test && npm run integ-assert",
31
32
  "blt": "npm run build+lint+test",
32
33
  "snapshot-update": "npm run jsii && npm test -- -u && npm run integ-assert"
33
34
  },
@@ -54,7 +55,7 @@
54
55
  }
55
56
  },
56
57
  "dependencies": {
57
- "@aws-solutions-constructs/core": "2.85.2",
58
+ "@aws-solutions-constructs/core": "2.85.4",
58
59
  "constructs": "^10.0.0"
59
60
  },
60
61
  "devDependencies": {
@@ -78,7 +79,7 @@
78
79
  ]
79
80
  },
80
81
  "peerDependencies": {
81
- "@aws-solutions-constructs/core": "2.85.2",
82
+ "@aws-solutions-constructs/core": "2.85.4",
82
83
  "constructs": "^10.0.0",
83
84
  "aws-cdk-lib": "^2.193.0"
84
85
  },