Skip to content

gammarers/aws-secure-bucket

Repository files navigation

AWS Secure Bucket

GitHub npm (scoped) PyPI Nuget GitHub Workflow Status (branch) GitHub release (latest SemVer)

View on Construct Hub

This is a Simple S3 Secure Bucket.

  • Bucket Access Control is Private
  • Public Read Access is false
  • Enforce SSL
  • All Block public access
  • Require encryption

Additional Properties

Name Type Default Description
bucketType SecureBucketType SecureBucketType.DEFAULT_BUCKET The type of the bucket.
Available types: DEFAULT(⚠️ Deprecated: Use bucketType property instead.),
SINGLE_PIPELINE_ARTIFACT(⚠️ Deprecated: Use bucketType property instead.),
MULTI_PIPELINE_ARTIFACT(⚠️ Deprecated: Use bucketType property instead.),
CLOUD_FRONT_ORIGIN(⚠️ Deprecated: Use bucketType property instead.),
The type of the bucket.
Available types: DEFAULT_BUCKET,
SINGLE_REGION_DEPLOYMENT_PIPELINE_ARTIFACT_BUCKET,
MULTI_REGION_DEPLOYMENT_PIPELINE_ARTIFACT_BUCKET,
CLOUD_FRONT_ORIGIN_BUCKET
isPipelineArtifactBucket boolean false ⚠️ Deprecated: Use bucketType property instead. If you are setting a custom Qualifier and using it as the artifact bucket for the CDK pipeline, set it to true.
isCloudFrontOriginBucket boolean false ⚠️ Deprecated: Use bucketType property instead. If you are using it as the CloudFront origin bucket, set it to true.

Install

TypeScript

install by npm

npm install @gammarers/aws-secure-bucket

install by yarn

yarn add @gammarers/aws-secure-bucket

Python

pip install gammarers.aws-secure-bucket

C# / .Net

dotnet add package Gammarers.CDK.AWS.SecureBucket

Example

import { SecureBucket } from '@gammarers/aws-secure-bucket';

const bucket = new SecureBucket(stack, 'SecureBucket', {
  bucketName: 'example-secure-bucket',
});