[![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:
```python
{
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
<dependency>
<groupId>com.pepperize</groupId>
<artifactId>cdk-private-bucket</artifactId>
<version>${cdkPrivateBucket.version}</version>
</dependency>
```
## Example
```shell
npm install @pepperize/cdk-private-bucket
```
See [API.md](https://github.com/pepperize/cdk-private-bucket/blob/main/API.md).
```python
import { PrivateBucket } from "@pepperize/cdk-private-bucket";
const bucket = new PrivateBucket(this, "PrivateBucket", {});
```
Raw data
{
"_id": null,
"home_page": "https://github.com/pepperize/cdk-private-bucket.git",
"name": "pepperize.cdk-private-bucket",
"maintainer": "",
"docs_url": null,
"requires_python": "~=3.8",
"maintainer_email": "",
"keywords": "",
"author": "Andreas Forster<andreas.forster@pepperize.com>",
"author_email": "",
"download_url": "https://files.pythonhosted.org/packages/41/06/04bb481f064c782269a3212e41f1583f613a4c4ad9c6cd73539ae6cb68a1/pepperize.cdk-private-bucket-0.0.482.tar.gz",
"platform": null,
"description": "[![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat-square)](https://makeapullrequest.com)\n[![GitHub](https://img.shields.io/github/license/pepperize/cdk-private-bucket?style=flat-square)](https://github.com/pepperize/cdk-private-bucket/blob/main/LICENSE)\n[![npm (scoped)](https://img.shields.io/npm/v/@pepperize/cdk-private-bucket?style=flat-square)](https://www.npmjs.com/package/@pepperize/cdk-private-bucket)\n[![PyPI](https://img.shields.io/pypi/v/pepperize.cdk-private-bucket?style=flat-square)](https://pypi.org/project/pepperize.cdk-private-bucket/)\n[![Nuget](https://img.shields.io/nuget/v/Pepperize.CDK.PrivateBucket?style=flat-square)](https://www.nuget.org/packages/Pepperize.CDK.PrivateBucket/)\n[![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/)\n[![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)\n[![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)\n\n# AWS CDK Private Bucket\n\nThis 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:\n\n```python\n{\n blockPublicAccess: s3.BlockPublicAccess.BLOCK_ALL,\n enforceSSL: true,\n encryption: s3.BucketEncryption.S3_MANAGED,\n}\n```\n\nThe result is a privacy-oriented S3 Bucket.\n\n## Install\n\n### TypeScript\n\n```shell\nnpm install @pepperize/cdk-private-bucket\n```\n\nor\n\n```shell\nyarn add @pepperize/cdk-private-bucket\n```\n\n### Python\n\n```shell\npip install pepperize.cdk-private-bucket\n```\n\n### C# / .Net\n\n```\ndotnet add package Pepperize.CDK.PrivateBucket\n```\n\n### Java\n\n```xml\n<dependency>\n <groupId>com.pepperize</groupId>\n <artifactId>cdk-private-bucket</artifactId>\n <version>${cdkPrivateBucket.version}</version>\n</dependency>\n```\n\n## Example\n\n```shell\nnpm install @pepperize/cdk-private-bucket\n```\n\nSee [API.md](https://github.com/pepperize/cdk-private-bucket/blob/main/API.md).\n\n```python\nimport { PrivateBucket } from \"@pepperize/cdk-private-bucket\";\n\nconst bucket = new PrivateBucket(this, \"PrivateBucket\", {});\n```\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "This project provides a CDK construct for creating private S3 bucket.",
"version": "0.0.482",
"project_urls": {
"Homepage": "https://github.com/pepperize/cdk-private-bucket.git",
"Source": "https://github.com/pepperize/cdk-private-bucket.git"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "5dd39d5ff92c2251ef280c54913b0d93f8bac014d9edc50195c22de081a9668e",
"md5": "6522d5da4339c6a59fadbe54791b8924",
"sha256": "9a46d9dce94248007a023252d087da845d690d85a934cd7214af589d77e45b87"
},
"downloads": -1,
"filename": "pepperize.cdk_private_bucket-0.0.482-py3-none-any.whl",
"has_sig": false,
"md5_digest": "6522d5da4339c6a59fadbe54791b8924",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "~=3.8",
"size": 33781,
"upload_time": "2023-12-18T10:31:57",
"upload_time_iso_8601": "2023-12-18T10:31:57.422831Z",
"url": "https://files.pythonhosted.org/packages/5d/d3/9d5ff92c2251ef280c54913b0d93f8bac014d9edc50195c22de081a9668e/pepperize.cdk_private_bucket-0.0.482-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "410604bb481f064c782269a3212e41f1583f613a4c4ad9c6cd73539ae6cb68a1",
"md5": "4553a87f679b57f15d083dbf85a95e1e",
"sha256": "68a3df23ca6fa09e0e2d96a305dcdd15817581ff0ceedb0e23acc3c456b3c7a6"
},
"downloads": -1,
"filename": "pepperize.cdk-private-bucket-0.0.482.tar.gz",
"has_sig": false,
"md5_digest": "4553a87f679b57f15d083dbf85a95e1e",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "~=3.8",
"size": 33709,
"upload_time": "2023-12-18T10:32:02",
"upload_time_iso_8601": "2023-12-18T10:32:02.004797Z",
"url": "https://files.pythonhosted.org/packages/41/06/04bb481f064c782269a3212e41f1583f613a4c4ad9c6cd73539ae6cb68a1/pepperize.cdk-private-bucket-0.0.482.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-12-18 10:32:02",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "pepperize",
"github_project": "cdk-private-bucket",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "pepperize.cdk-private-bucket"
}