cdk-private-s3-hosting 0.0.0__py3-none-any.whl → 0.0.2__py3-none-any.whl

cdk-private-s3-hosting/__init__.py

@@ -7,10 +7,26 @@ You can use this construct for a enterprise use case where you want to host a st
 
 Original idea is from [this blog post](https://aws.amazon.com/jp/blogs/networking-and-content-delivery/hosting-internal-https-static-websites-with-alb-s3-and-privatelink/).
 
+[![View on Construct Hub](https://constructs.dev/badge?package=cdk-private-s3-hosting)](https://constructs.dev/packages/cdk-private-s3-hosting)
+[![Open in Visual Studio Code](https://img.shields.io/static/v1?logo=visualstudiocode&label=&message=Open%20in%20Visual%20Studio%20Code&labelColor=2c2c32&color=007acc&logoColor=007acc)](https://open.vscode.dev/badmintoncryer/cdk-private-s3-hosting)
+[![npm version](https://badge.fury.io/js/cdk-private-s3-hosting.svg)](https://badge.fury.io/js/cdk-private-s3-hosting)
+[![Build Status](https://github.com/badmintoncryer/cdk-private-s3-hosting/actions/workflows/build.yml/badge.svg)](https://github.com/badmintoncryer/cdk-private-s3-hosting/actions/workflows/build.yml)
+[![Release Status](https://github.com/badmintoncryer/cdk-private-s3-hosting/actions/workflows/release.yml/badge.svg)](https://github.com/badmintoncryer/cdk-private-s3-hosting/actions/workflows/release.yml)
+[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)
+[![npm downloads](https://img.shields.io/npm/dm/cdk-private-s3-hosting.svg?style=flat)](https://www.npmjs.com/package/cdk-private-s3-hosting)
+
 ## Architecture
 
 ![Architecture](./images/private_s3_hosting.png)
 
+## Installation
+
+You can install the package via npm:
+
+```sh
+npm install cdk-private-s3-hosting
+```
+
 ## Usage
 
 To create a private S3 bucket and an ALB with a listener rule that forwards requests to the S3 bucket, you can use the following code:
@@ -93,6 +109,7 @@ from ._jsii import *
 import aws_cdk.aws_certificatemanager as _aws_cdk_aws_certificatemanager_ceddda9d
 import aws_cdk.aws_ec2 as _aws_cdk_aws_ec2_ceddda9d
 import aws_cdk.aws_elasticloadbalancingv2 as _aws_cdk_aws_elasticloadbalancingv2_ceddda9d
+import aws_cdk.aws_route53 as _aws_cdk_aws_route53_ceddda9d
 import aws_cdk.aws_s3 as _aws_cdk_aws_s3_ceddda9d
 import constructs as _constructs_77d1e7e8
 
@@ -114,16 +131,18 @@ class PrivateS3Hosting(
         certificate: typing.Optional[_aws_cdk_aws_certificatemanager_ceddda9d.ICertificate] = None,
         enable_private_dns: typing.Optional[builtins.bool] = None,
         internet_facing: typing.Optional[builtins.bool] = None,
+        sub_domain: typing.Optional[builtins.str] = None,
         vpc: typing.Optional[_aws_cdk_aws_ec2_ceddda9d.IVpc] = None,
     ) -> None:
         '''
         :param scope: -
         :param id: -
         :param bucket_props: The properties for the S3 bucket. Default: - use default properties
-        :param domain_name: The domain name for the website. This will be used to create the S3 bucket and the ALB listener
+        :param domain_name: The domain name for the website. S3 bucket name will be created with ``domainName``. If ``enablePrivateDns`` is enabled, a private hosted zone also will be created for the ``domainName`` and an A record has been created from ``domainName`` to the ALB DNS name.". If ``subDomein`` is provided, these names will be ``${subDomain}.${domainName}``.
         :param certificate: The certificate for the website. Default: - use HTTP
         :param enable_private_dns: Enable private DNS for the website. By eneabling this, a private hosted zone will be created for the domain name and an alias record will be created for the ALB You can access to the alb by the ``http(s)://<domainName>`` from the VPC Default: true
         :param internet_facing: Whether the ALB is internet facing. Default: false
+        :param sub_domain: The sub domain for the website. S3 bucket name will be created with ``${subDomain}.{domainName}``. If ``enablePrivateDns`` is enabled, a private hosted zone also will be created for the ``domainName`` and an A record has been created from ``${subDomain}.${domainName}`` to the ALB DNS name.". Default: - no sub domain
         :param vpc: The VPC for the website. Default: - create a new VPC with 2 AZs and 0 NAT gateways
         '''
         if __debug__:
@@ -136,6 +155,7 @@ class PrivateS3Hosting(
             certificate=certificate,
             enable_private_dns=enable_private_dns,
             internet_facing=internet_facing,
+            sub_domain=sub_domain,
             vpc=vpc,
         )
 
@@ -161,6 +181,12 @@ class PrivateS3Hosting(
         '''The VPC.'''
         return typing.cast(_aws_cdk_aws_ec2_ceddda9d.IVpc, jsii.get(self, "vpc"))
 
+    @builtins.property
+    @jsii.member(jsii_name="hostedZone")
+    def hosted_zone(self) -> typing.Optional[_aws_cdk_aws_route53_ceddda9d.IHostedZone]:
+        '''The hosted zone for the website.'''
+        return typing.cast(typing.Optional[_aws_cdk_aws_route53_ceddda9d.IHostedZone], jsii.get(self, "hostedZone"))
+
 
 @jsii.data_type(
     jsii_type="cdk-private-s3-hosting.PrivateS3HostingProps",
@@ -171,6 +197,7 @@ class PrivateS3Hosting(
         "certificate": "certificate",
         "enable_private_dns": "enablePrivateDns",
         "internet_facing": "internetFacing",
+        "sub_domain": "subDomain",
         "vpc": "vpc",
     },
 )
@@ -183,15 +210,17 @@ class PrivateS3HostingProps:
         certificate: typing.Optional[_aws_cdk_aws_certificatemanager_ceddda9d.ICertificate] = None,
         enable_private_dns: typing.Optional[builtins.bool] = None,
         internet_facing: typing.Optional[builtins.bool] = None,
+        sub_domain: typing.Optional[builtins.str] = None,
         vpc: typing.Optional[_aws_cdk_aws_ec2_ceddda9d.IVpc] = None,
     ) -> None:
         '''Properties for PrivateS3Hosting.
 
         :param bucket_props: The properties for the S3 bucket. Default: - use default properties
-        :param domain_name: The domain name for the website. This will be used to create the S3 bucket and the ALB listener
+        :param domain_name: The domain name for the website. S3 bucket name will be created with ``domainName``. If ``enablePrivateDns`` is enabled, a private hosted zone also will be created for the ``domainName`` and an A record has been created from ``domainName`` to the ALB DNS name.". If ``subDomein`` is provided, these names will be ``${subDomain}.${domainName}``.
         :param certificate: The certificate for the website. Default: - use HTTP
         :param enable_private_dns: Enable private DNS for the website. By eneabling this, a private hosted zone will be created for the domain name and an alias record will be created for the ALB You can access to the alb by the ``http(s)://<domainName>`` from the VPC Default: true
         :param internet_facing: Whether the ALB is internet facing. Default: false
+        :param sub_domain: The sub domain for the website. S3 bucket name will be created with ``${subDomain}.{domainName}``. If ``enablePrivateDns`` is enabled, a private hosted zone also will be created for the ``domainName`` and an A record has been created from ``${subDomain}.${domainName}`` to the ALB DNS name.". Default: - no sub domain
         :param vpc: The VPC for the website. Default: - create a new VPC with 2 AZs and 0 NAT gateways
         '''
         if isinstance(bucket_props, dict):
@@ -203,6 +232,7 @@ class PrivateS3HostingProps:
             check_type(argname="argument certificate", value=certificate, expected_type=type_hints["certificate"])
             check_type(argname="argument enable_private_dns", value=enable_private_dns, expected_type=type_hints["enable_private_dns"])
             check_type(argname="argument internet_facing", value=internet_facing, expected_type=type_hints["internet_facing"])
+            check_type(argname="argument sub_domain", value=sub_domain, expected_type=type_hints["sub_domain"])
             check_type(argname="argument vpc", value=vpc, expected_type=type_hints["vpc"])
         self._values: typing.Dict[builtins.str, typing.Any] = {
             "bucket_props": bucket_props,
@@ -214,6 +244,8 @@ class PrivateS3HostingProps:
             self._values["enable_private_dns"] = enable_private_dns
         if internet_facing is not None:
             self._values["internet_facing"] = internet_facing
+        if sub_domain is not None:
+            self._values["sub_domain"] = sub_domain
         if vpc is not None:
             self._values["vpc"] = vpc
 
@@ -231,7 +263,13 @@ class PrivateS3HostingProps:
     def domain_name(self) -> builtins.str:
         '''The domain name for the website.
 
-        This will be used to create the S3 bucket and the ALB listener
+        S3 bucket name will be created with ``domainName``.
+
+        If ``enablePrivateDns`` is enabled,
+        a private hosted zone also will be created for the ``domainName``
+        and an A record has been created from ``domainName`` to the ALB DNS name.".
+
+        If ``subDomein`` is provided, these names will be ``${subDomain}.${domainName}``.
         '''
         result = self._values.get("domain_name")
         assert result is not None, "Required property 'domain_name' is missing"
@@ -271,6 +309,21 @@ class PrivateS3HostingProps:
         result = self._values.get("internet_facing")
         return typing.cast(typing.Optional[builtins.bool], result)
 
+    @builtins.property
+    def sub_domain(self) -> typing.Optional[builtins.str]:
+        '''The sub domain for the website.
+
+        S3 bucket name will be created with ``${subDomain}.{domainName}``.
+
+        If ``enablePrivateDns`` is enabled,
+        a private hosted zone also will be created for the ``domainName``
+        and an A record has been created from ``${subDomain}.${domainName}`` to the ALB DNS name.".
+
+        :default: - no sub domain
+        '''
+        result = self._values.get("sub_domain")
+        return typing.cast(typing.Optional[builtins.str], result)
+
     @builtins.property
     def vpc(self) -> typing.Optional[_aws_cdk_aws_ec2_ceddda9d.IVpc]:
         '''The VPC for the website.
@@ -308,6 +361,7 @@ def _typecheckingstub__1f6a3822c2541f3c785fce5f3187d688039409f4677b681948fb4a3ae
     certificate: typing.Optional[_aws_cdk_aws_certificatemanager_ceddda9d.ICertificate] = None,
     enable_private_dns: typing.Optional[builtins.bool] = None,
     internet_facing: typing.Optional[builtins.bool] = None,
+    sub_domain: typing.Optional[builtins.str] = None,
     vpc: typing.Optional[_aws_cdk_aws_ec2_ceddda9d.IVpc] = None,
 ) -> None:
     """Type checking stubs"""
@@ -320,6 +374,7 @@ def _typecheckingstub__5f3ff047cbd8e8c18995347a63899f04375c4e4a279cffb2f203e5b10
     certificate: typing.Optional[_aws_cdk_aws_certificatemanager_ceddda9d.ICertificate] = None,
     enable_private_dns: typing.Optional[builtins.bool] = None,
     internet_facing: typing.Optional[builtins.bool] = None,
+    sub_domain: typing.Optional[builtins.str] = None,
     vpc: typing.Optional[_aws_cdk_aws_ec2_ceddda9d.IVpc] = None,
 ) -> None:
     """Type checking stubs"""

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.0",
+    "0.0.2",
     __name__[0:-6],
-    "cdk-private-s3-hosting@0.0.0.jsii.tgz",
+    "cdk-private-s3-hosting@0.0.2.jsii.tgz",
 )
 
 __all__ = [

{cdk_private_s3_hosting-0.0.0.dist-info → cdk_private_s3_hosting-0.0.2.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: cdk-private-s3-hosting
-Version: 0.0.0
+Version: 0.0.2
 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>
@@ -34,10 +34,26 @@ You can use this construct for a enterprise use case where you want to host a st
 
 Original idea is from [this blog post](https://aws.amazon.com/jp/blogs/networking-and-content-delivery/hosting-internal-https-static-websites-with-alb-s3-and-privatelink/).
 
+[![View on Construct Hub](https://constructs.dev/badge?package=cdk-private-s3-hosting)](https://constructs.dev/packages/cdk-private-s3-hosting)
+[![Open in Visual Studio Code](https://img.shields.io/static/v1?logo=visualstudiocode&label=&message=Open%20in%20Visual%20Studio%20Code&labelColor=2c2c32&color=007acc&logoColor=007acc)](https://open.vscode.dev/badmintoncryer/cdk-private-s3-hosting)
+[![npm version](https://badge.fury.io/js/cdk-private-s3-hosting.svg)](https://badge.fury.io/js/cdk-private-s3-hosting)
+[![Build Status](https://github.com/badmintoncryer/cdk-private-s3-hosting/actions/workflows/build.yml/badge.svg)](https://github.com/badmintoncryer/cdk-private-s3-hosting/actions/workflows/build.yml)
+[![Release Status](https://github.com/badmintoncryer/cdk-private-s3-hosting/actions/workflows/release.yml/badge.svg)](https://github.com/badmintoncryer/cdk-private-s3-hosting/actions/workflows/release.yml)
+[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)
+[![npm downloads](https://img.shields.io/npm/dm/cdk-private-s3-hosting.svg?style=flat)](https://www.npmjs.com/package/cdk-private-s3-hosting)
+
 ## Architecture
 
 ![Architecture](./images/private_s3_hosting.png)
 
+## Installation
+
+You can install the package via npm:
+
+```sh
+npm install cdk-private-s3-hosting
+```
+
 ## Usage
 
 To create a private S3 bucket and an ALB with a listener rule that forwards requests to the S3 bucket, you can use the following code:

cdk_private_s3_hosting-0.0.2.dist-info/RECORD

@@ -0,0 +1,9 @@
+cdk-private-s3-hosting/__init__.py,sha256=mQsZ-xyYmP7nweN9vIH6fotdCzRkfvY9h3v2KxmjGSo,18130
+cdk-private-s3-hosting/py.typed,sha256=AbpHGcgLb-kRsJGnwFEktk7uzpZOCcBY74-YBdrKVGs,1
+cdk-private-s3-hosting/_jsii/__init__.py,sha256=6256oRzj6EVzyss4i-lfQxMgs-3l3loSpRraDPXMYYU,1468
+cdk-private-s3-hosting/_jsii/cdk-private-s3-hosting@0.0.2.jsii.tgz,sha256=1oaAusIUmVvdjG6hxongv0sbxTu0RNOM_em7CzP15JQ,44766
+cdk_private_s3_hosting-0.0.2.dist-info/LICENSE,sha256=z8d0m5b2O9McPEK1xHG_dWgUBT6EfBDz6wA0F7xSPTA,11358
+cdk_private_s3_hosting-0.0.2.dist-info/METADATA,sha256=sC2FPtVEUqR8LXnI48XAQSVIYiDPocQ1A0SlhwnmKYM,4484
+cdk_private_s3_hosting-0.0.2.dist-info/WHEEL,sha256=eOLhNAGa2EW3wWl_TU484h7q1UNgy0JXjjoqKoxAAQc,92
+cdk_private_s3_hosting-0.0.2.dist-info/top_level.txt,sha256=Garilimgavjx7-oTth2AD47uG-twwl6dTXCfLYQ1lqY,23
+cdk_private_s3_hosting-0.0.2.dist-info/RECORD,,

cdk_private_s3_hosting-0.0.0.dist-info/RECORD

@@ -1,9 +0,0 @@
-cdk-private-s3-hosting/__init__.py,sha256=0E0ebc4eyTwCrP2dkjoWDvR21eax1Rd94o4901qgba8,13927
-cdk-private-s3-hosting/py.typed,sha256=AbpHGcgLb-kRsJGnwFEktk7uzpZOCcBY74-YBdrKVGs,1
-cdk-private-s3-hosting/_jsii/__init__.py,sha256=qgUE_8RUQ9641T_uEvgydrQnBQCPcQ2Ruprl7LjAlZA,1468
-cdk-private-s3-hosting/_jsii/cdk-private-s3-hosting@0.0.0.jsii.tgz,sha256=_eo4mRwUAIh6oreMLMrSF8R16vp4sNy9sDMyBBxhMmQ,42789
-cdk_private_s3_hosting-0.0.0.dist-info/LICENSE,sha256=z8d0m5b2O9McPEK1xHG_dWgUBT6EfBDz6wA0F7xSPTA,11358
-cdk_private_s3_hosting-0.0.0.dist-info/METADATA,sha256=esybgyfS6WQ8SAV0i9lT_7xlQhMRvDGsTUsHKjX4dAM,3205
-cdk_private_s3_hosting-0.0.0.dist-info/WHEEL,sha256=eOLhNAGa2EW3wWl_TU484h7q1UNgy0JXjjoqKoxAAQc,92
-cdk_private_s3_hosting-0.0.0.dist-info/top_level.txt,sha256=Garilimgavjx7-oTth2AD47uG-twwl6dTXCfLYQ1lqY,23
-cdk_private_s3_hosting-0.0.0.dist-info/RECORD,,