Skip to content

Commit 947860a

Browse files
committed
Add documentation
1 parent 02e95c0 commit 947860a

File tree

2 files changed

+22
-0
lines changed

2 files changed

+22
-0
lines changed

CHANGELOG.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
77

88
## [Unreleased]
99

10+
- Add `route53` config parameter to manage domains and certifiactes automatically using route53
1011

1112
## [0.8.0] - 2021-1-28
1213
Thanks @pecirep, @miguel-a-calles-mba, @superandrew213

README.md

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -58,6 +58,7 @@ custom:
5858
fullstack:
5959
domain: my-custom-domain.com
6060
certificate: arn:aws:acm:us-east-1:... # The ARN for the SSL cert to use form AWS CertificateManager
61+
route53: false # Use route53 to manage domains and certificates
6162
bucketName: webapp-deploy # Unique name for the S3 bucket to host the client assets
6263
distributionFolder: client/dist # Path to the client assets to be uploaded to S3
6364
indexDocument: index.html # The index document to use
@@ -259,6 +260,26 @@ The custom domain for your fullstack serverless app.
259260

260261
---
261262

263+
**route53**
264+
265+
_optional_, default: `false`
266+
267+
```yaml
268+
custom:
269+
fullstack:
270+
...
271+
route53: true
272+
...
273+
```
274+
275+
Use this parameter if you want the plugin to manage domains via route53, including automatic SSL certificate requesting and validation (this means you can omit the `certificateArn` parameter).
276+
Note: if an issued SSL certificate for the requested domain(s) already exists in ACM, it will be reused.
277+
278+
If one or more domains aren't managed by a Hosted Zone in your account, the required DNS entries will be written to the console.
279+
If there is no issued SSL certificate for all domains combined and one or more aren't managed by a Hosted Zone in your account, deployment will wait for the DNS entries to be added manually and the certificate to be issued.
280+
281+
---
282+
262283
**errorDocument**
263284

264285
_optional_, default: `error.html`

0 commit comments

Comments
 (0)