https://github.com/pepperize/cdk-private-bucket

This project provides a CDK construct to create an S3 Bucket with some security pre-sets.
https://github.com/pepperize/cdk-private-bucket

aws cdk s3

Last synced: 12 months ago
JSON representation

This project provides a CDK construct to create an S3 Bucket with some security pre-sets.

• Host: GitHub
• URL: https://github.com/pepperize/cdk-private-bucket
• Owner: pepperize
• License: mit
• Created: 2022-01-17T14:48:52.000Z (over 4 years ago)
• Default Branch: main
• Last Pushed: 2025-06-10T10:21:32.000Z (about 1 year ago)
• Last Synced: 2025-06-10T11:28:20.210Z (about 1 year ago)
• Topics: aws, cdk, s3
• Language: TypeScript
• Homepage:
• Size: 2.92 MB
• Stars: 3
• Watchers: 2
• Forks: 0
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
[![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat-square)](https://makeapullrequest.com)

[![GitHub](https://img.shields.io/github/license/pepperize/cdk-private-bucket?style=flat-square)](https://github.com/pepperize/cdk-private-bucket/blob/main/LICENSE)

[![npm (scoped)](https://img.shields.io/npm/v/@pepperize/cdk-private-bucket?style=flat-square)](https://www.npmjs.com/package/@pepperize/cdk-private-bucket)

[![PyPI](https://img.shields.io/pypi/v/pepperize.cdk-private-bucket?style=flat-square)](https://pypi.org/project/pepperize.cdk-private-bucket/)

[![Nuget](https://img.shields.io/nuget/v/Pepperize.CDK.PrivateBucket?style=flat-square)](https://www.nuget.org/packages/Pepperize.CDK.PrivateBucket/)

[![Sonatype Nexus (Releases)](https://img.shields.io/nexus/r/com.pepperize/cdk-private-bucket?server=https%3A%2F%2Fs01.oss.sonatype.org%2F&style=flat-square)](https://s01.oss.sonatype.org/content/repositories/releases/com/pepperize/cdk-private-bucket/)

[![GitHub Workflow Status (branch)](https://img.shields.io/github/actions/workflow/status/pepperize/cdk-private-bucket/release.yml?branch=main&label=release&style=flat-square)](https://github.com/pepperize/cdk-private-bucket/actions/workflows/release.yml)

[![GitHub release (latest SemVer)](https://img.shields.io/github/v/release/pepperize/cdk-private-bucket?sort=semver&style=flat-square)](https://github.com/pepperize/cdk-private-bucket/releases)

# AWS CDK Private Bucket

This project provides a CDK construct to create an S3 Bucket with some security pre-sets. It uses usual [s3.BucketProps](https://docs.aws.amazon.com/cdk/api/v1/docs/@aws-cdk_aws-s3.BucketProps.html) and overrides these key-value pairs:

```typescript

{

  blockPublicAccess: s3.BlockPublicAccess.BLOCK_ALL,

  enforceSSL: true,

  encryption: s3.BucketEncryption.S3_MANAGED,

}

```

The result is a privacy-oriented S3 Bucket.

## Install

### TypeScript

```shell

npm install @pepperize/cdk-private-bucket

```

or

```shell

yarn add @pepperize/cdk-private-bucket

```

### Python

```shell

pip install pepperize.cdk-private-bucket

```

### C# / .Net

```

dotnet add package Pepperize.CDK.PrivateBucket

```

### Java

```xml

  com.pepperize

  cdk-private-bucket

  ${cdkPrivateBucket.version}

```

## Example

```shell

npm install @pepperize/cdk-private-bucket

```

See [API.md](https://github.com/pepperize/cdk-private-bucket/blob/main/API.md).

```typescript

import { PrivateBucket } from "@pepperize/cdk-private-bucket";

const bucket = new PrivateBucket(this, "PrivateBucket", {});

```