Components

Type: aws:core:s3Bucket

Synopsis

Create an AWS S3 Bucket.

Description

A simple way to create a managed S3 buckets within a project.

The bucket will be configured with the following:
    .blockPublicAccess(BlockPublicAccess.BLOCK_ALL)
    .encryption(BucketEncryption.S3_MANAGED)
    .enforceSsl(true)

bucketName: a globally unique name
    The unique name of the S3 bucket to create.

versioned: true|false
    Whether this bucket should have versioning turned on or not.

enableEventBridge: true|false
    Whether this bucket should send notifications to Amazon EventBridge or not.
    As of CDK 2.64.0 a lambda is installed: https://github.com/aws/aws-cdk/issues/24086

removeOnDestroy: true|false
    Configured with the following:
        .removalPolicy(removeOnDestroy ? RemovalPolicy.DESTROY : RemovalPolicy.RETAIN)
        .autoDeleteObjects(removeOnDestroy) // cdk adds a lambda if true

tags: { key: value, ... }
    Tags to apply to the bucket.

Template

Required

{
  "type" : "aws:core:s3Bucket",
  "name" : null,
  "bucketName" : null
}

All

{
  "type" : "aws:core:s3Bucket",
  "name" : null,
  "exclude" : false,
  "bucketName" : null,
  "versioned" : false,
  "enableEventBridge" : true,
  "removeOnDestroy" : false,
  "tags" : { }
}