cdk-private-s3-hosting 0.0.3__py3-none-any.whl → 0.0.5__py3-none-any.whl

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/_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.dist-info → cdk_private_s3_hosting-0.0.5.dist-info}/METADATA

@@ -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.5.dist-info/RECORD

@@ -0,0 +1,9 @@
+cdk-private-s3-hosting/__init__.py,sha256=_S8L0sQ8xd3UNwVaHqKYqVWaSu5gJiIAlQzOgpSOcag,19720
+cdk-private-s3-hosting/py.typed,sha256=AbpHGcgLb-kRsJGnwFEktk7uzpZOCcBY74-YBdrKVGs,1
+cdk-private-s3-hosting/_jsii/__init__.py,sha256=g2UfCtjznbsd3zYoGIawtnsIWTIEmI1b9O9uZmW0sc4,1468
+cdk-private-s3-hosting/_jsii/cdk-private-s3-hosting@0.0.5.jsii.tgz,sha256=VHVg9N6KApECGuehqGf7ZprxZju43qixpHi_S5keKQU,46183
+cdk_private_s3_hosting-0.0.5.dist-info/LICENSE,sha256=z8d0m5b2O9McPEK1xHG_dWgUBT6EfBDz6wA0F7xSPTA,11358
+cdk_private_s3_hosting-0.0.5.dist-info/METADATA,sha256=qrH7343XzCwdQLRujgOAW9HMXWxqMPAt74bWTQiKPqI,6074
+cdk_private_s3_hosting-0.0.5.dist-info/WHEEL,sha256=eOLhNAGa2EW3wWl_TU484h7q1UNgy0JXjjoqKoxAAQc,92
+cdk_private_s3_hosting-0.0.5.dist-info/top_level.txt,sha256=Garilimgavjx7-oTth2AD47uG-twwl6dTXCfLYQ1lqY,23
+cdk_private_s3_hosting-0.0.5.dist-info/RECORD,,

cdk_private_s3_hosting-0.0.3.dist-info/RECORD

@@ -1,9 +0,0 @@
-cdk-private-s3-hosting/__init__.py,sha256=KVYIsrHhVTui9cHN0bWH-gcfJ-qoHdpEGdN433NQKE0,18634
-cdk-private-s3-hosting/py.typed,sha256=AbpHGcgLb-kRsJGnwFEktk7uzpZOCcBY74-YBdrKVGs,1
-cdk-private-s3-hosting/_jsii/__init__.py,sha256=BMn_jI-Ic0syX1-JugApDXJ3P3QavzZRUk27iKwrfRc,1468
-cdk-private-s3-hosting/_jsii/cdk-private-s3-hosting@0.0.3.jsii.tgz,sha256=ptyZUvyql5Il-9iGuLvtUNGAQ0XeQBla2TQhRaa6PWk,45621
-cdk_private_s3_hosting-0.0.3.dist-info/LICENSE,sha256=z8d0m5b2O9McPEK1xHG_dWgUBT6EfBDz6wA0F7xSPTA,11358
-cdk_private_s3_hosting-0.0.3.dist-info/METADATA,sha256=vZfnssKY6BdOYA5ZVL9JyYVK_Jwe_lWXWILIGT8gFik,4988
-cdk_private_s3_hosting-0.0.3.dist-info/WHEEL,sha256=eOLhNAGa2EW3wWl_TU484h7q1UNgy0JXjjoqKoxAAQc,92
-cdk_private_s3_hosting-0.0.3.dist-info/top_level.txt,sha256=Garilimgavjx7-oTth2AD47uG-twwl6dTXCfLYQ1lqY,23
-cdk_private_s3_hosting-0.0.3.dist-info/RECORD,,