cdk-simplewebsite-deploy 2.1.9 → 2.2.0

package/.tool-versions

@@ -1 +1,4 @@
 python 3.13.1t
+nodejs 24.14.1
+maven 3.9.14
+java corretto-21.0.7.6.1

package/API.md

@@ -43,10 +43,11 @@ new CreateBasicSite(scope: Construct, id: string, props: BasicSiteConfiguration)
 | **Name** | **Description** |
 | --- | --- |
 | <code><a href="#cdk-simplewebsite-deploy.CreateBasicSite.toString">toString</a></code> | Returns a string representation of this construct. |
+| <code><a href="#cdk-simplewebsite-deploy.CreateBasicSite.with">with</a></code> | Applies one or more mixins to this construct. |
 
 ---
 
-##### `toString` <a name="toString" id="cdk-simplewebsite-deploy.CreateBasicSite.toString"></a>
+##### ~~`toString`~~ <a name="toString" id="cdk-simplewebsite-deploy.CreateBasicSite.toString"></a>
 
 ```typescript
 public toString(): string
@@ -54,6 +55,27 @@ public toString(): string
 
 Returns a string representation of this construct.
 
+##### ~~`with`~~ <a name="with" id="cdk-simplewebsite-deploy.CreateBasicSite.with"></a>
+
+```typescript
+public with(mixins: ...IMixin[]): IConstruct
+```
+
+Applies one or more mixins to this construct.
+
+Mixins are applied in order. The list of constructs is captured at the
+start of the call, so constructs added by a mixin will not be visited.
+Use multiple `with()` calls if subsequent mixins should apply to added
+constructs.
+
+###### `mixins`<sup>Required</sup> <a name="mixins" id="cdk-simplewebsite-deploy.CreateBasicSite.with.parameter.mixins"></a>
+
+- *Type:* ...constructs.IMixin[]
+
+The mixins to apply.
+
+---
+
 #### Static Functions <a name="Static Functions" id="Static Functions"></a>
 
 | **Name** | **Description** |
@@ -62,7 +84,7 @@ Returns a string representation of this construct.
 
 ---
 
-##### `isConstruct` <a name="isConstruct" id="cdk-simplewebsite-deploy.CreateBasicSite.isConstruct"></a>
+##### ~~`isConstruct`~~ <a name="isConstruct" id="cdk-simplewebsite-deploy.CreateBasicSite.isConstruct"></a>
 
 ```typescript
 import { CreateBasicSite } from 'cdk-simplewebsite-deploy'
@@ -102,7 +124,9 @@ Any object.
 
 ---
 
-##### `node`<sup>Required</sup> <a name="node" id="cdk-simplewebsite-deploy.CreateBasicSite.property.node"></a>
+##### ~~`node`~~<sup>Required</sup> <a name="node" id="cdk-simplewebsite-deploy.CreateBasicSite.property.node"></a>
+
+- *Deprecated:* Use CreateCloudfrontSite instead. CreateBasicSite configures a public S3 website endpoint.
 
 ```typescript
 public readonly node: Node;
@@ -156,6 +180,7 @@ new CreateCloudfrontSite(scope: Construct, id: string, props: CloudfrontSiteConf
 | **Name** | **Description** |
 | --- | --- |
 | <code><a href="#cdk-simplewebsite-deploy.CreateCloudfrontSite.toString">toString</a></code> | Returns a string representation of this construct. |
+| <code><a href="#cdk-simplewebsite-deploy.CreateCloudfrontSite.with">with</a></code> | Applies one or more mixins to this construct. |
 
 ---
 
@@ -167,6 +192,27 @@ public toString(): string
 
 Returns a string representation of this construct.
 
+##### `with` <a name="with" id="cdk-simplewebsite-deploy.CreateCloudfrontSite.with"></a>
+
+```typescript
+public with(mixins: ...IMixin[]): IConstruct
+```
+
+Applies one or more mixins to this construct.
+
+Mixins are applied in order. The list of constructs is captured at the
+start of the call, so constructs added by a mixin will not be visited.
+Use multiple `with()` calls if subsequent mixins should apply to added
+constructs.
+
+###### `mixins`<sup>Required</sup> <a name="mixins" id="cdk-simplewebsite-deploy.CreateCloudfrontSite.with.parameter.mixins"></a>
+
+- *Type:* ...constructs.IMixin[]
+
+The mixins to apply.
+
+---
+
 #### Static Functions <a name="Static Functions" id="Static Functions"></a>
 
 | **Name** | **Description** |
@@ -324,7 +370,9 @@ const cloudfrontSiteConfiguration: CloudfrontSiteConfiguration = { ... }
 | <code><a href="#cdk-simplewebsite-deploy.CloudfrontSiteConfiguration.property.enableLogging">enableLogging</a></code> | <code>boolean</code> | Enable CloudFront access logging. |
 | <code><a href="#cdk-simplewebsite-deploy.CloudfrontSiteConfiguration.property.enableSecurityHeaders">enableSecurityHeaders</a></code> | <code>boolean</code> | Enable response headers policy for security headers. |
 | <code><a href="#cdk-simplewebsite-deploy.CloudfrontSiteConfiguration.property.errorDoc">errorDoc</a></code> | <code>string</code> | The error document of the website. |
+| <code><a href="#cdk-simplewebsite-deploy.CloudfrontSiteConfiguration.property.functionAssociations">functionAssociations</a></code> | <code>aws-cdk-lib.aws_cloudfront.FunctionAssociation[]</code> | CloudFront Functions to associate with the default behavior. |
 | <code><a href="#cdk-simplewebsite-deploy.CloudfrontSiteConfiguration.property.logsBucket">logsBucket</a></code> | <code>aws-cdk-lib.aws_s3.IBucket</code> | S3 bucket for CloudFront access logs. |
+| <code><a href="#cdk-simplewebsite-deploy.CloudfrontSiteConfiguration.property.originAccessLevels">originAccessLevels</a></code> | <code>aws-cdk-lib.aws_cloudfront.AccessLevel[]</code> | Additional permissions granted to the CloudFront Origin Access Control for the website bucket. |
 | <code><a href="#cdk-simplewebsite-deploy.CloudfrontSiteConfiguration.property.priceClass">priceClass</a></code> | <code>aws-cdk-lib.aws_cloudfront.PriceClass</code> | The price class determines how many edge locations CloudFront will use for your distribution. |
 | <code><a href="#cdk-simplewebsite-deploy.CloudfrontSiteConfiguration.property.subDomain">subDomain</a></code> | <code>string</code> | The subdomain name you want to deploy. |
 | <code><a href="#cdk-simplewebsite-deploy.CloudfrontSiteConfiguration.property.webAclId">webAclId</a></code> | <code>string</code> | Optional WAF Web ACL ARN for enhanced security. |
@@ -462,6 +510,19 @@ The error document of the website.
 
 ---
 
+##### `functionAssociations`<sup>Optional</sup> <a name="functionAssociations" id="cdk-simplewebsite-deploy.CloudfrontSiteConfiguration.property.functionAssociations"></a>
+
+```typescript
+public readonly functionAssociations: FunctionAssociation[];
+```
+
+- *Type:* aws-cdk-lib.aws_cloudfront.FunctionAssociation[]
+- *Default:* No CloudFront Function associations.
+
+CloudFront Functions to associate with the default behavior.
+
+---
+
 ##### `logsBucket`<sup>Optional</sup> <a name="logsBucket" id="cdk-simplewebsite-deploy.CloudfrontSiteConfiguration.property.logsBucket"></a>
 
 ```typescript
@@ -477,6 +538,19 @@ If not provided and logging is enabled, a new bucket will be created.
 
 ---
 
+##### `originAccessLevels`<sup>Optional</sup> <a name="originAccessLevels" id="cdk-simplewebsite-deploy.CloudfrontSiteConfiguration.property.originAccessLevels"></a>
+
+```typescript
+public readonly originAccessLevels: AccessLevel[];
+```
+
+- *Type:* aws-cdk-lib.aws_cloudfront.AccessLevel[]
+- *Default:* [cloudfront.AccessLevel.READ]
+
+Additional permissions granted to the CloudFront Origin Access Control for the website bucket.
+
+---
+
 ##### `priceClass`<sup>Optional</sup> <a name="priceClass" id="cdk-simplewebsite-deploy.CloudfrontSiteConfiguration.property.priceClass"></a>
 
 ```typescript

package/README.md

@@ -3,29 +3,30 @@
 ![Release](https://github.com/SnapPetal/cdk-simplewebsite-deploy/workflows/release/badge.svg?branch=main)
 
 # cdk-simplewebsite-deploy
-This is an AWS CDK Construct to simplify deploying a single-page website using either S3 buckets or CloudFront distributions with enhanced security, performance, and monitoring capabilities.
+This is an AWS CDK v2 construct library for deploying a single-page website with S3, CloudFront, Route 53, and ACM. `CreateCloudfrontSite` is the recommended construct because it uses a private S3 origin with CloudFront Origin Access Control (OAC), while `CreateBasicSite` is deprecated because it creates a public S3 website endpoint.
 
 ## Installation and Usage
 
-### [CreateBasicSite](https://github.com/snappetal/cdk-simplewebsite-deploy/blob/main/API.md#cdk-cloudfront-deploy-createbasicsite)
-#### Creates a simple website using S3 buckets with a domain hosted in Route 53.
+### [CreateCloudfrontSite](https://github.com/snappetal/cdk-simplewebsite-deploy/blob/main/API.md#cdk-cloudfront-deploy-createcloudfrontsite)
+#### Creates a website using a private S3 bucket, a CloudFront distribution, and DNS records in Route 53.
 ##### Typescript
 ```console
 yarn add cdk-simplewebsite-deploy
 ```
 ```typescript
 import * as cdk from 'aws-cdk-lib';
-import { CreateBasicSite } from 'cdk-simplewebsite-deploy';
+import { CreateCloudfrontSite } from 'cdk-simplewebsite-deploy';
 import { Construct } from 'constructs';
 
 export class PipelineStack extends cdk.Stack {
   constructor(scope: Construct, id: string, props?: cdk.StackProps) {
     super(scope, id, props);
 
-    new CreateBasicSite(this, 'test-website', {
-      websiteFolder: './src/build',
+    new CreateCloudfrontSite(this, 'test-website', {
+      websiteFolder: './src/dist',
       indexDoc: 'index.html',
       hostedZone: 'example.com',
+      subDomain: 'www.example.com',
     });
   }
 }
@@ -36,6 +37,7 @@ dotnet add package ThonBecker.CDK.SimpleWebsiteDeploy
 ```
 ```cs
 using Amazon.CDK;
+using Constructs;
 using ThonBecker.CDK.SimpleWebsiteDeploy;
 
 namespace SimpleWebsiteDeploy
@@ -44,11 +46,12 @@ namespace SimpleWebsiteDeploy
     {
         internal PipelineStack(Construct scope, string id, IStackProps props = null) : base(scope, id, props)
         {
-            new CreateBasicSite(scope, "test-website", new BasicSiteConfiguration()
+            new CreateCloudfrontSite(scope, "test-website", new CloudfrontSiteConfiguration()
             {
                 WebsiteFolder = "./src/build",
                 IndexDoc = "index.html",
                 HostedZone = "example.com",
+                SubDomain = "www.example.com",
             });
         }
     }
@@ -65,10 +68,10 @@ namespace SimpleWebsiteDeploy
 ```java
 package com.myorg;
 
-import software.amazon.awscdk.core.Construct;
-import software.amazon.awscdk.core.Stack;
-import software.amazon.awscdk.core.StackProps;
-import com.thonbecker.simplewebsitedeploy.CreateBasicSite;
+import com.thonbecker.simplewebsitedeploy.CreateCloudfrontSite;
+import software.amazon.awscdk.Stack;
+import software.amazon.awscdk.StackProps;
+import software.constructs.Construct;
 
 public class MyProjectStack extends Stack {
     public MyProjectStack(final Construct scope, final String id) {
@@ -77,11 +80,13 @@ public class MyProjectStack extends Stack {
 
     public MyProjectStack(final Construct scope, final String id, final StackProps props) {
         super(scope, id, props);
-        
-        CreateBasicSite.Builder.create(this, "test-website")
-        		.websiteFolder("./src/build")
-        		.indexDoc("index.html")
-        		.hostedZone("example.com");
+
+        CreateCloudfrontSite.Builder.create(this, "test-website")
+                .websiteFolder("./src/build")
+                .indexDoc("index.html")
+                .hostedZone("example.com")
+                .subDomain("www.example.com")
+                .build();
     }
 }
 ```
@@ -91,38 +96,41 @@ pip install cdk-simplewebsite-deploy
 ```
 ```python
 from aws_cdk import Stack
-from cdk_simplewebsite_deploy import CreateBasicSite
+from cdk_simplewebsite_deploy import CreateCloudfrontSite
 from constructs import Construct
 
+
 class MyProjectStack(Stack):
 
     def __init__(self, scope: Construct, construct_id: str, **kwargs) -> None:
         super().__init__(scope, construct_id, **kwargs)
-        
-        CreateBasicSite(self, 'test-website', website_folder='./src/build',
-                        index_doc='index.html',
-                        hosted_zone='example.com')
+
+        CreateCloudfrontSite(self, 'test-website', website_folder='./src/build',
+                             index_doc='index.html',
+                             hosted_zone='example.com',
+                             sub_domain='www.example.com')
 ```
-### [CreateCloudfrontSite](https://github.com/snappetal/cdk-simplewebsite-deploy/blob/main/API.md#cdk-cloudfront-deploy-createcloudfrontsite)
-#### Creates a simple website using a CloudFront distribution with a domain hosted in Route 53.
+
+### [CreateBasicSite](https://github.com/snappetal/cdk-simplewebsite-deploy/blob/main/API.md#cdk-cloudfront-deploy-createbasicsite)
+#### Deprecated. Creates a website using public S3 website endpoints with a domain hosted in Route 53.
+Use `CreateCloudfrontSite` for new sites. `CreateBasicSite` configures public bucket access so Route 53 can alias directly to the S3 website endpoint.
 ##### Typescript
 ```console
 yarn add cdk-simplewebsite-deploy
 ```
 ```typescript
 import * as cdk from 'aws-cdk-lib';
-import { CreateCloudfrontSite } from 'cdk-simplewebsite-deploy';
+import { CreateBasicSite } from 'cdk-simplewebsite-deploy';
 import { Construct } from 'constructs';
 
 export class PipelineStack extends cdk.Stack {
   constructor(scope: Construct, id: string, props?: cdk.StackProps) {
     super(scope, id, props);
 
-    new CreateCloudfrontSite(this, 'test-website', {
-      websiteFolder: './src/dist',
+    new CreateBasicSite(this, 'test-website', {
+      websiteFolder: './src/build',
       indexDoc: 'index.html',
       hostedZone: 'example.com',
-      subDomain: 'www.example.com',
     });
   }
 }
@@ -133,6 +141,7 @@ dotnet add package ThonBecker.CDK.SimpleWebsiteDeploy
 ```
 ```cs
 using Amazon.CDK;
+using Constructs;
 using ThonBecker.CDK.SimpleWebsiteDeploy;
 
 namespace SimpleWebsiteDeploy
@@ -141,12 +150,11 @@ namespace SimpleWebsiteDeploy
     {
         internal PipelineStack(Construct scope, string id, IStackProps props = null) : base(scope, id, props)
         {
-            new CreateCloudfrontSite(scope, "test-website", new CloudfrontSiteConfiguration()
+            new CreateBasicSite(scope, "test-website", new BasicSiteConfiguration()
             {
                 WebsiteFolder = "./src/build",
                 IndexDoc = "index.html",
                 HostedZone = "example.com",
-                SubDomain = "www.example.com",
             });
         }
     }
@@ -163,10 +171,10 @@ namespace SimpleWebsiteDeploy
 ```java
 package com.myorg;
 
-import software.amazon.awscdk.core.Construct;
-import software.amazon.awscdk.core.Stack;
-import software.amazon.awscdk.core.StackProps;
-import com.thonbecker.simplewebsitedeploy.CreateCloudfrontSite;
+import com.thonbecker.simplewebsitedeploy.CreateBasicSite;
+import software.amazon.awscdk.Stack;
+import software.amazon.awscdk.StackProps;
+import software.constructs.Construct;
 
 public class MyProjectStack extends Stack {
     public MyProjectStack(final Construct scope, final String id) {
@@ -175,12 +183,12 @@ public class MyProjectStack extends Stack {
 
     public MyProjectStack(final Construct scope, final String id, final StackProps props) {
         super(scope, id, props);
-        
-        CreateCloudfrontSite.Builder.create(this, "test-website")
-        		.websiteFolder("./src/build")
-        		.indexDoc("index.html")
-        		.hostedZone("example.com")
-        		.subDomain("www.example.com");
+
+        CreateBasicSite.Builder.create(this, "test-website")
+                .websiteFolder("./src/build")
+                .indexDoc("index.html")
+                .hostedZone("example.com")
+                .build();
     }
 }
 ```
@@ -189,24 +197,23 @@ public class MyProjectStack extends Stack {
 pip install cdk-simplewebsite-deploy
 ```
 ```python
-from aws_cdk import core
-from cdk_simplewebsite_deploy import CreateCloudfrontSite
-
+from aws_cdk import Stack
+from cdk_simplewebsite_deploy import CreateBasicSite
+from constructs import Construct
 
-class MyProjectStack(core.Stack):
+class MyProjectStack(Stack):
 
-    def __init__(self, scope: core.Construct, construct_id: str, **kwargs) -> None:
+    def __init__(self, scope: Construct, construct_id: str, **kwargs) -> None:
         super().__init__(scope, construct_id, **kwargs)
 
-        CreateCloudfrontSite(self, 'test-website', website_folder='./src/build',
-                             index_doc='index.html',
-                             hosted_zone='example.com',
-                             sub_domain='www.example.com')
+        CreateBasicSite(self, 'test-website', website_folder='./src/build',
+                        index_doc='index.html',
+                        hosted_zone='example.com')
 ```
 
 ## 🚀 Enhanced Features
 
-The `CreateCloudfrontSite` construct now includes several optional advanced features for improved security, performance, and monitoring:
+The `CreateCloudfrontSite` construct includes optional advanced features for security, performance, and monitoring.
 
 ### Security Headers
 Enable comprehensive security headers including HSTS, X-Frame-Options, Content-Type-Options, and XSS protection:
@@ -257,6 +264,48 @@ new CreateCloudfrontSite(this, 'waf-protected-website', {
 });
 ```
 
+### Origin Access Levels
+Grant additional OAC permissions to the website bucket. This can be useful when you need CloudFront to distinguish missing objects from access-denied responses.
+
+```typescript
+import * as cloudfront from 'aws-cdk-lib/aws-cloudfront';
+
+new CreateCloudfrontSite(this, 'website-with-list-access', {
+  websiteFolder: './src/dist',
+  indexDoc: 'index.html',
+  hostedZone: 'example.com',
+  originAccessLevels: [
+    cloudfront.AccessLevel.READ,
+    cloudfront.AccessLevel.LIST,
+  ],
+});
+```
+
+### CloudFront Function Associations
+Attach CloudFront Functions to the default behavior for lightweight viewer request or viewer response logic.
+
+```typescript
+import * as cloudfront from 'aws-cdk-lib/aws-cloudfront';
+
+const rewriteFunction = new cloudfront.Function(this, 'RewriteFunction', {
+  code: cloudfront.FunctionCode.fromInline(
+    'function handler(event) { return event.request; }',
+  ),
+});
+
+new CreateCloudfrontSite(this, 'website-with-function', {
+  websiteFolder: './src/dist',
+  indexDoc: 'index.html',
+  hostedZone: 'example.com',
+  functionAssociations: [
+    {
+      eventType: cloudfront.FunctionEventType.VIEWER_REQUEST,
+      function: rewriteFunction,
+    },
+  ],
+});
+```
+
 ### Custom Cache Behaviors
 Add custom cache behaviors for different content types:
 
@@ -314,6 +363,12 @@ export class AdvancedWebsiteStack extends cdk.Stack {
   constructor(scope: Construct, id: string, props?: cdk.StackProps) {
     super(scope, id, props);
 
+    const rewriteFunction = new cloudfront.Function(this, 'RewriteFunction', {
+      code: cloudfront.FunctionCode.fromInline(
+        'function handler(event) { return event.request; }',
+      ),
+    });
+
     new CreateCloudfrontSite(this, 'advanced-website', {
       websiteFolder: './dist',
       indexDoc: 'index.html',
@@ -325,6 +380,10 @@ export class AdvancedWebsiteStack extends cdk.Stack {
       priceClass: cloudfront.PriceClass.PRICE_CLASS_ALL,
       enableSecurityHeaders: true,
       enableIpv6: true,
+      originAccessLevels: [
+        cloudfront.AccessLevel.READ,
+        cloudfront.AccessLevel.LIST,
+      ],
       
       // Monitoring & Protection
       enableLogging: true,
@@ -337,6 +396,14 @@ export class AdvancedWebsiteStack extends cdk.Stack {
           cachePolicy: cloudfront.CachePolicy.CACHING_DISABLED,
         },
       },
+
+      // Edge Logic
+      functionAssociations: [
+        {
+          eventType: cloudfront.FunctionEventType.VIEWER_REQUEST,
+          function: rewriteFunction,
+        },
+      ],
       
       // SPA Error Handling
       customErrorResponses: [
@@ -357,12 +424,14 @@ export class AdvancedWebsiteStack extends cdk.Stack {
 - **Security Headers**: Automatic HSTS, X-Frame-Options, Content-Type-Options, and XSS protection
 - **WAF Integration**: Support for AWS WAF Web ACLs for advanced threat protection
 - **Origin Access Control**: Modern S3 bucket protection (replaces deprecated OAI)
+- **Configurable OAC Permissions**: Optional origin access levels for the website bucket
 
 ### ⚡ **Optimized Performance** 
 - **Smart Caching**: Optimized cache policies for better performance
 - **HTTP/2 & HTTP/3**: Latest protocol support for faster loading
 - **Global Edge Locations**: Configurable price classes for worldwide distribution
 - **IPv6 Support**: Dual-stack networking for better connectivity
+- **CloudFront Functions**: Optional viewer request and response function associations
 
 ### 📊 **Comprehensive Monitoring**
 - **Access Logging**: CloudFront access logs for analytics

package/lib/cdk-simplewebsite-deploy.d.ts

@@ -65,6 +65,16 @@ export interface CloudfrontSiteConfiguration {
      * @default - No additional cache behaviors.
      */
     readonly additionalBehaviors?: Record<string, cloudfront.BehaviorOptions>;
+    /**
+     * Additional permissions granted to the CloudFront Origin Access Control for the website bucket.
+     * @default [cloudfront.AccessLevel.READ]
+     */
+    readonly originAccessLevels?: cloudfront.AccessLevel[];
+    /**
+     * CloudFront Functions to associate with the default behavior.
+     * @default - No CloudFront Function associations.
+     */
+    readonly functionAssociations?: cloudfront.FunctionAssociation[];
     /**
      * Enable response headers policy for security headers.
      * @default false - No security headers policy applied.
@@ -96,6 +106,9 @@ export interface CloudfrontSiteConfiguration {
      */
     readonly webAclId?: string;
 }
+/**
+ * @deprecated Use CreateCloudfrontSite instead. CreateBasicSite configures a public S3 website endpoint.
+ */
 export declare class CreateBasicSite extends Construct {
     constructor(scope: Construct, id: string, props: BasicSiteConfiguration);
 }