Metadata-Version: 2.1
Name: cdk-spa-deploy
Version: 1.65.0
Summary: This is an AWS CDK Construct to make deploying a single page website (Angular/React/Vue) to AWS S3 behind SSL/Cloudfront as easy as 5 lines of code.
Home-page: https://github.com/nideveloper/CDK-SPA-Deploy.git
Author: hi@cdkpatterns.com
License: MIT
Project-URL: Source, https://github.com/nideveloper/CDK-SPA-Deploy.git
Description: # CDK-SPA-Deploy
        
        [![npm](https://img.shields.io/npm/dt/cdk-spa-deploy)](https://www.npmjs.com/package/cdk-spa-deploy)
        [![Vulnerabilities](https://img.shields.io/snyk/vulnerabilities/npm/cdk-spa-deploy)](https://www.npmjs.com/package/cdk-spa-deploy)
        
        This is an AWS CDK Construct to make deploying a single page website (Angular/React/Vue) to AWS S3 behind SSL/Cloudfront as easy as 5 lines of code.
        
        ## Installation and Usage
        
        ### Typescript
        
        npm install --save cdk-spa-deploy
        
        ![cdk-spa-deploy example](https://raw.githubusercontent.com/nideveloper/cdk-spa-deploy/master/img/spadeploy.png)
        
        ### Python
        
        pip install cdk-spa-deploy
        
        ![cdk-spa-deploy python example](https://raw.githubusercontent.com/nideveloper/cdk-spa-deploy/master/img/python.png)
        
        ## Advanced Usage
        
        ### Auto Deploy From Hosted Zone Name
        
        If you purchased your domain through route 53 and already have a hosted zone then just use the name to deploy your site behind cloudfront. This handles the SSL cert and everything for you.
        
        ![cdk-spa-deploy alias](https://raw.githubusercontent.com/nideveloper/cdk-spa-deploy/master/img/fromHostedZone.PNG)
        
        ### Custom Domain and SSL Certificates
        
        You can also pass the ARN for an SSL certification and your alias routes to cloudfront
        
        ![cdk-spa-deploy alias](https://raw.githubusercontent.com/nideveloper/cdk-spa-deploy/master/img/cdkdeploy-alias.png)
        
        ### Encrypted S3 Bucket
        
        Pass in one boolean to tell SPA Deploy to encrypt your website bucket
        
        ![cdk-spa-deploy encryption](https://raw.githubusercontent.com/nideveloper/cdk-spa-deploy/master/img/encryption.PNG)
        
        ### Custom Origin Behaviors
        
        Pass in an array of CloudFront Behaviors
        
        ```python
        # Example automatically generated without compilation. See https://github.com/aws/jsii/issues/826
        deploy.create_site_with_cloudfront(
            index_doc="index.html",
            website_folder="website",
            cf_behaviors=[{
                "is_default_behavior": True,
                "allowed_methods": cf.CloudFrontAllowedMethods.ALL,
                "forwarded_values": {
                    "query_string": True,
                    "cookies": {"forward": "all"},
                    "headers": ["*"]
                }
            }, {
                "path_pattern": "/virtual-path",
                "allowed_methods": cf.CloudFrontAllowedMethods.GET_HEAD,
                "cached_methods": cf.CloudFrontAllowedCachedMethods.GET_HEAD
            }
            ]
        )
        ```
        
        ### Restrict Access to Known IPs
        
        Pass in a boolean and an array of IP addresses and your site is locked down!
        
        ![cdk-spa-deploy ipfilter](https://raw.githubusercontent.com/nideveloper/cdk-spa-deploy/master/img/ipfilter.png)
        
        ### Modifying S3 Bucket Created in Construct
        
        An object is now returned containing relevant artifacts created if you need to make any further modifications:
        
        * The S3 bucket is present for all of the methods
        * When a CloudFront Web distribution is created it will be present in the return object
        
        ```python
        # Example automatically generated without compilation. See https://github.com/aws/jsii/issues/826
        ```
        
        ## Issues / Feature Requests
        
        https://github.com/nideveloper/CDK-SPA-Deploy
        
Platform: UNKNOWN
Classifier: Intended Audience :: Developers
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: JavaScript
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Typing :: Typed
Classifier: License :: OSI Approved
Requires-Python: >=3.6
Description-Content-Type: text/markdown
