cdk-private-s3-hosting 0.0.3__tar.gz → 0.0.5__tar.gz

{cdk_private_s3_hosting-0.0.3/src/cdk_private_s3_hosting.egg-info → cdk_private_s3_hosting-0.0.5}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: cdk-private-s3-hosting
-Version: 0.0.3
+Version: 0.0.5
 Summary: CDK Construct for a private frontend hosting S3 bucket
 Home-page: https://github.com/badmintoncryer/cdk-private-s3-hosting.git
 Author: Kazuho CryerShinozuka<malaysia.cryer@gmail.com>
@@ -114,3 +114,37 @@ After deploying the stack, you can access the website using the `domainName` you
 ```
 
 **Note**: All access to the path pattern `*/` will be redirected to `/index.html`. Therefore, it will function correctly even when the path is set on the frontend and the page is reloaded.
+
+## Setup DNS
+
+This construct creates Route53 hosted zone and an A record for the domain name you specified by default.
+
+If you want to use your own DNS settings(e.g. using a corporate DNS server),
+you can disable the Route53 hosted zone creation by setting the `enablePrivateDns` property to `false`.
+
+```python
+import { PrivateS3Hosting } from 'cdk-private-s3-hosting';
+
+const privateS3Hosting = new PrivateS3Hosting(this, 'PrivateS3Hosting', {
+  domainName: 'cryer-nao-domain.com',
+  enablePrivateDns: false,
+});
+```
+
+## TLS Certificate
+
+If you want to use HTTPS, you need to create a TLS certificate in ACM and pass it to the `certificate` property.
+
+```python
+import * as acm from 'aws-cdk-lib/aws-certificatemanager';
+import { PrivateS3Hosting } from 'cdk-private-s3-hosting';
+
+declare const certificate: acm.ICertificate;
+
+const privateS3Hosting = new PrivateS3Hosting(this, 'PrivateS3Hosting', {
+  domainName: 'cryer-nao-domain.com',
+  certificate,
+});
+```
+
+Of course, specified domain name (`domainName` and `subDomain`) must be the same as the domain name of the certificate.

{cdk_private_s3_hosting-0.0.3 → cdk_private_s3_hosting-0.0.5}/README.md

@@ -86,3 +86,37 @@ After deploying the stack, you can access the website using the `domainName` you
 ```
 
 **Note**: All access to the path pattern `*/` will be redirected to `/index.html`. Therefore, it will function correctly even when the path is set on the frontend and the page is reloaded.
+
+## Setup DNS
+
+This construct creates Route53 hosted zone and an A record for the domain name you specified by default.
+
+If you want to use your own DNS settings(e.g. using a corporate DNS server),
+you can disable the Route53 hosted zone creation by setting the `enablePrivateDns` property to `false`.
+
+```python
+import { PrivateS3Hosting } from 'cdk-private-s3-hosting';
+
+const privateS3Hosting = new PrivateS3Hosting(this, 'PrivateS3Hosting', {
+  domainName: 'cryer-nao-domain.com',
+  enablePrivateDns: false,
+});
+```
+
+## TLS Certificate
+
+If you want to use HTTPS, you need to create a TLS certificate in ACM and pass it to the `certificate` property.
+
+```python
+import * as acm from 'aws-cdk-lib/aws-certificatemanager';
+import { PrivateS3Hosting } from 'cdk-private-s3-hosting';
+
+declare const certificate: acm.ICertificate;
+
+const privateS3Hosting = new PrivateS3Hosting(this, 'PrivateS3Hosting', {
+  domainName: 'cryer-nao-domain.com',
+  certificate,
+});
+```
+
+Of course, specified domain name (`domainName` and `subDomain`) must be the same as the domain name of the certificate.

{cdk_private_s3_hosting-0.0.3 → cdk_private_s3_hosting-0.0.5}/setup.py

@@ -5,7 +5,7 @@ kwargs = json.loads(
     """
 {
     "name": "cdk-private-s3-hosting",
-    "version": "0.0.3",
+    "version": "0.0.5",
     "description": "CDK Construct for a private frontend hosting S3 bucket",
     "license": "Apache-2.0",
     "url": "https://github.com/badmintoncryer/cdk-private-s3-hosting.git",
@@ -26,7 +26,7 @@ kwargs = json.loads(
     ],
     "package_data": {
         "cdk-private-s3-hosting._jsii": [
-            "cdk-private-s3-hosting@0.0.3.jsii.tgz"
+            "cdk-private-s3-hosting@0.0.5.jsii.tgz"
         ],
         "cdk-private-s3-hosting": [
             "py.typed"

{cdk_private_s3_hosting-0.0.3 → cdk_private_s3_hosting-0.0.5}/src/cdk-private-s3-hosting/__init__.py

@@ -87,6 +87,40 @@ After deploying the stack, you can access the website using the `domainName` you
 ```
 
 **Note**: All access to the path pattern `*/` will be redirected to `/index.html`. Therefore, it will function correctly even when the path is set on the frontend and the page is reloaded.
+
+## Setup DNS
+
+This construct creates Route53 hosted zone and an A record for the domain name you specified by default.
+
+If you want to use your own DNS settings(e.g. using a corporate DNS server),
+you can disable the Route53 hosted zone creation by setting the `enablePrivateDns` property to `false`.
+
+```python
+import { PrivateS3Hosting } from 'cdk-private-s3-hosting';
+
+const privateS3Hosting = new PrivateS3Hosting(this, 'PrivateS3Hosting', {
+  domainName: 'cryer-nao-domain.com',
+  enablePrivateDns: false,
+});
+```
+
+## TLS Certificate
+
+If you want to use HTTPS, you need to create a TLS certificate in ACM and pass it to the `certificate` property.
+
+```python
+import * as acm from 'aws-cdk-lib/aws-certificatemanager';
+import { PrivateS3Hosting } from 'cdk-private-s3-hosting';
+
+declare const certificate: acm.ICertificate;
+
+const privateS3Hosting = new PrivateS3Hosting(this, 'PrivateS3Hosting', {
+  domainName: 'cryer-nao-domain.com',
+  certificate,
+});
+```
+
+Of course, specified domain name (`domainName` and `subDomain`) must be the same as the domain name of the certificate.
 '''
 from pkgutil import extend_path
 __path__ = extend_path(__path__, __name__)

{cdk_private_s3_hosting-0.0.3 → cdk_private_s3_hosting-0.0.5}/src/cdk-private-s3-hosting/_jsii/__init__.py

@@ -33,9 +33,9 @@ import constructs._jsii
 
 __jsii_assembly__ = jsii.JSIIAssembly.load(
     "cdk-private-s3-hosting",
-    "0.0.3",
+    "0.0.5",
     __name__[0:-6],
-    "cdk-private-s3-hosting@0.0.3.jsii.tgz",
+    "cdk-private-s3-hosting@0.0.5.jsii.tgz",
 )
 
 __all__ = [

{cdk_private_s3_hosting-0.0.3 → cdk_private_s3_hosting-0.0.5/src/cdk_private_s3_hosting.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: cdk-private-s3-hosting
-Version: 0.0.3
+Version: 0.0.5
 Summary: CDK Construct for a private frontend hosting S3 bucket
 Home-page: https://github.com/badmintoncryer/cdk-private-s3-hosting.git
 Author: Kazuho CryerShinozuka<malaysia.cryer@gmail.com>
@@ -114,3 +114,37 @@ After deploying the stack, you can access the website using the `domainName` you
 ```
 
 **Note**: All access to the path pattern `*/` will be redirected to `/index.html`. Therefore, it will function correctly even when the path is set on the frontend and the page is reloaded.
+
+## Setup DNS
+
+This construct creates Route53 hosted zone and an A record for the domain name you specified by default.
+
+If you want to use your own DNS settings(e.g. using a corporate DNS server),
+you can disable the Route53 hosted zone creation by setting the `enablePrivateDns` property to `false`.
+
+```python
+import { PrivateS3Hosting } from 'cdk-private-s3-hosting';
+
+const privateS3Hosting = new PrivateS3Hosting(this, 'PrivateS3Hosting', {
+  domainName: 'cryer-nao-domain.com',
+  enablePrivateDns: false,
+});
+```
+
+## TLS Certificate
+
+If you want to use HTTPS, you need to create a TLS certificate in ACM and pass it to the `certificate` property.
+
+```python
+import * as acm from 'aws-cdk-lib/aws-certificatemanager';
+import { PrivateS3Hosting } from 'cdk-private-s3-hosting';
+
+declare const certificate: acm.ICertificate;
+
+const privateS3Hosting = new PrivateS3Hosting(this, 'PrivateS3Hosting', {
+  domainName: 'cryer-nao-domain.com',
+  certificate,
+});
+```
+
+Of course, specified domain name (`domainName` and `subDomain`) must be the same as the domain name of the certificate.

{cdk_private_s3_hosting-0.0.3 → cdk_private_s3_hosting-0.0.5}/src/cdk_private_s3_hosting.egg-info/SOURCES.txt

@@ -6,7 +6,7 @@ setup.py
 src/cdk-private-s3-hosting/__init__.py
 src/cdk-private-s3-hosting/py.typed
 src/cdk-private-s3-hosting/_jsii/__init__.py
-src/cdk-private-s3-hosting/_jsii/cdk-private-s3-hosting@0.0.3.jsii.tgz
+src/cdk-private-s3-hosting/_jsii/cdk-private-s3-hosting@0.0.5.jsii.tgz
 src/cdk_private_s3_hosting.egg-info/PKG-INFO
 src/cdk_private_s3_hosting.egg-info/SOURCES.txt
 src/cdk_private_s3_hosting.egg-info/dependency_links.txt