s3-secure-bucket
v0.3.6
Published
S3 Secure Bucket is a construct that creates a secure bucket with encryption, logging, and other security features.
Readme
S3 Secure Bucket (AWS CDK v2)
AWS CDK v2 construct library: an s3.Bucket with security-focused defaults (private ACLs, block public access, TLS-only access, encryption, versioning, BucketOwnerEnforced, RemovalPolicy.RETAIN). Use bucketType so encryption and bucket policies match pipeline artifacts, CloudFront origins, centralized access logs, and CloudWatch Logs export archives.
Features
- Private access, block public access, and deny insecure transport (
enforceSSL) - Default bucket: KMS-managed encryption (
aws:kms) unless overridden - Log / origin / archive types: S3-managed encryption (
AES256) forACCESS_LOG_BUCKET,CLOUDFRONT_ORIGIN_BUCKET, andCLOUD_WATCH_LOG_ARCHIVE_BUCKET - Versioning on by default; object ownership
BucketOwnerEnforcedby default RemovalPolicy.RETAINon the bucket- Optional EventBridge notifications via
eventBridgeEnabled(applied through an L1 property override whentrue) bucketTypepresetsDEFAULT_BUCKET: general-purpose secure bucket (KMS-managed encryption by default)DEPLOYMENT_PIPELINE_ARTIFACT_BUCKET: optionals3:*grant for the CDK deploy role when using a non-default bootstrap qualifierCLOUDFRONT_ORIGIN_BUCKET: S3-managed encryption for typical CloudFront origin useACCESS_LOG_BUCKET:s3:PutObjectonAWSLogs/<account>/*for ALB/NLB (logdelivery.elasticloadbalancing.amazonaws.com+ regional ELBv2 account fromaws-cdk-lib/region-infowhen known), CloudFront standard logging (delivery.logs.amazonaws.com), and S3 server access logging (logging.s3.amazonaws.com)CLOUD_WATCH_LOG_ARCHIVE_BUCKET:s3:GetBucketAclands3:PutObject(bucket-owner-full-control) for CloudWatch Logs export tasks (logs.<region>.amazonaws.com, same-account log groups in the stack Region)
accessLogBucketPolicyDependable(access-log buckets only): use withloadBalancer.node.addDependency(...)so ALB/NLB access-log enablement runs after the bucket policy exists (avoids validationPutObjectfailures)
Installation
npm
npm install s3-secure-bucketyarn
yarn add s3-secure-bucketUsage
Default secure bucket
import { Stack } from 'aws-cdk-lib';
import { S3SecureBucket } from 's3-secure-bucket';
declare const stack: Stack;
const bucket = new S3SecureBucket(stack, 'S3SecureBucket', {
bucketName: 'example-secure-bucket',
});CDK deployment pipeline artifact bucket
When the stack uses a non-default CDK bootstrap qualifier, the construct grants s3:* on the bucket to the regional cdk-<qualifier>-deploy-role.
import { Stack } from 'aws-cdk-lib';
import { S3SecureBucket, S3SecureBucketType } from 's3-secure-bucket';
declare const stack: Stack;
const artifactBucket = new S3SecureBucket(stack, 'ArtifactBucket', {
bucketType: S3SecureBucketType.DEPLOYMENT_PIPELINE_ARTIFACT_BUCKET,
});CloudFront origin bucket
import { Stack } from 'aws-cdk-lib';
import { S3SecureBucket, S3SecureBucketType } from 's3-secure-bucket';
declare const stack: Stack;
const originBucket = new S3SecureBucket(stack, 'OriginBucket', {
bucketType: S3SecureBucketType.CLOUDFRONT_ORIGIN_BUCKET,
});Wire the bucket to CloudFront (for example origins.S3Origin) using your usual approach. This library only configures the bucket defaults and encryption.
Centralized access log bucket (ALB / NLB / CloudFront / S3)
For ACCESS_LOG_BUCKET, the stack env.region must be a concrete region at synthesis time (not a token) so the regional ELBv2 log-delivery account ID can be resolved when the region is known.
import { Stack } from 'aws-cdk-lib';
import { S3SecureBucket, S3SecureBucketType } from 's3-secure-bucket';
declare const stack: Stack;
const accessLogBucket = new S3SecureBucket(stack, 'AccessLogBucket', {
bucketType: S3SecureBucketType.ACCESS_LOG_BUCKET,
});
// After creating your load balancer (e.g. elbv2.ApplicationLoadBalancer), depend on the bucket policy
// so ELB's validation PutObject runs after the policy exists:
// loadBalancer.node.addDependency(accessLogBucket.accessLogBucketPolicyDependable!);Wire logging on the load balancer using your normal approach (for example L1 attributes or another construct). This library only configures the bucket and its resource policy.
CloudWatch Logs export archive bucket
Store log data exported from CloudWatch Logs via export tasks. The bucket must be in the same Region as the log groups you export. Create export tasks with your usual workflow (console, CLI, or API); this library configures the bucket and resource policy for same-account exports.
import { Stack } from 'aws-cdk-lib';
import { S3SecureBucket, S3SecureBucketType } from 's3-secure-bucket';
declare const stack: Stack;
const logArchiveBucket = new S3SecureBucket(stack, 'LogArchiveBucket', {
bucketType: S3SecureBucketType.CLOUD_WATCH_LOG_ARCHIVE_BUCKET,
});For cross-account export, extend the bucket policy with additional aws:SourceAccount and aws:SourceArn entries per AWS documentation.
Options
S3SecureBucket accepts S3SecureBucketProps, which extends s3.BucketProps. Standard options such as bucketName, versioned, encryption, lifecycleRules, and eventBridgeEnabled work as usual alongside the secure defaults. When eventBridgeEnabled is true, EventBridge notification is enabled via an L1 override on the underlying AWS::S3::Bucket.
Construct props (S3SecureBucketProps)
| Property | Type | Default | Description |
| --- | --- | --- | --- |
| bucketType | S3SecureBucketType | DEFAULT_BUCKET | Selects encryption defaults and optional resource-policy statements. |
| (inherited) | s3.BucketProps | — | All other Bucket properties are passed through (some receive overrides inside the construct). |
S3SecureBucketType values
| Constant | Use case |
| --- | --- |
| S3SecureBucketType.DEFAULT_BUCKET | General-purpose secure bucket |
| S3SecureBucketType.DEPLOYMENT_PIPELINE_ARTIFACT_BUCKET | CDK pipeline artifact bucket (custom bootstrap qualifier) |
| S3SecureBucketType.CLOUDFRONT_ORIGIN_BUCKET | CloudFront origin bucket |
| S3SecureBucketType.ACCESS_LOG_BUCKET | Centralized access logs (AWSLogs/<account>/* writers only) |
| S3SecureBucketType.CLOUD_WATCH_LOG_ARCHIVE_BUCKET | CloudWatch Logs export archive |
Read-only: accessLogBucketPolicyDependable
| Property | Type | When set | Description |
| --- | --- | --- | --- |
| accessLogBucketPolicyDependable | IDependable \| undefined | bucketType === ACCESS_LOG_BUCKET | Depend on this from ALB/NLB so access-log configuration waits for the bucket policy resource. |
See API.md for the full API reference.
Requirements
- Node.js >= 20
- Peer dependencies:
aws-cdk-lib^2.232.0,constructs^10.5.1
License
This project is licensed under the Apache-2.0 License.
