Optional
Readonly
accessOptional
Readonly
autoWhether all objects should be automatically deleted when the bucket is removed from the stack or when the stack is deleted.
Requires the removalPolicy
to be set to RemovalPolicy.DESTROY
.
Warning if you have deployed a bucket with autoDeleteObjects: true
,
switching this to false
in a CDK version before 1.126.0
will lead to
all objects in the bucket being deleted. Be sure to update your bucket resources
by deploying with CDK version 1.126.0
or later before switching this value to false
.
false
Optional
Readonly
blockThe block public access configuration of this bucket.
https://docs.aws.amazon.com/AmazonS3/latest/dev/access-control-block-public-access.html
Optional
Readonly
bucketSpecifies whether Amazon S3 should use an S3 Bucket Key with server-side encryption using KMS (SSE-KMS) for new objects in the bucket.
Only relevant, when Encryption is set to BucketEncryption.KMS
Optional
Readonly
bucketPhysical name of this bucket.
Optional
Readonly
corsThe CORS configuration of this bucket.
https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-cors.html
Optional
Readonly
encryptionThe kind of server-side encryption to apply to this bucket.
If you choose KMS, you can specify a KMS key via encryptionKey
. If
encryption key is not specified, a key will automatically be created.
Kms
if encryptionKey
is specified, or Unencrypted
otherwise.Optional
Readonly
encryptionExternal KMS key to use for bucket encryption.
The 'encryption' property must be either not specified or set to "Kms". An error will be emitted if encryption is set to "Unencrypted" or "Managed".
Optional
Readonly
enforceSSLEnforces SSL for requests. S3.5 of the AWS Foundational Security Best Practices Regarding S3.
https://docs.aws.amazon.com/config/latest/developerguide/s3-bucket-ssl-requests-only.html
false
Optional
Readonly
eventWhether this bucket should send notifications to Amazon EventBridge or not.
false
Optional
Readonly
intelligentInteligent Tiering Configurations
https://docs.aws.amazon.com/AmazonS3/latest/userguide/intelligent-tiering.html
No Intelligent Tiiering Configurations.
Optional
Readonly
inventoriesThe inventory configuration of the bucket.
https://docs.aws.amazon.com/AmazonS3/latest/dev/storage-inventory.html
Optional
Readonly
lifecycleRules that define how Amazon S3 manages objects during their lifetime.
Optional
Readonly
metricsThe metrics configuration of this bucket.
Optional
Readonly
notificationsThe role to be used by the notifications handler
Optional
Readonly
objectThe objectOwnership of the bucket.
https://docs.aws.amazon.com/AmazonS3/latest/dev/about-object-ownership.html
Optional
Readonly
publicGrants public read access to all objects in the bucket.
Similar to calling bucket.grantPublicAccess()
false
Optional
Readonly
serverDestination bucket for the server access logs.
Optional
Readonly
serverOptional log file prefix to use for the bucket's access logs. If defined without "serverAccessLogsBucket", enables access logs to current bucket with this prefix.
Optional
Readonly
transferWhether this bucket should have transfer acceleration turned on or not.
false
Optional
Readonly
versionedWhether this bucket should have versioning turned on or not.
false
Optional
Readonly
websiteThe name of the error document (e.g. "404.html") for the website.
websiteIndexDocument
must also be set if this is set.
Optional
Readonly
websiteThe name of the index document (e.g. "index.html") for the website. Enables static website hosting for this bucket.
Optional
Readonly
websiteSpecifies the redirect behavior of all requests to a website endpoint of a bucket.
If you specify this property, you can't specify "websiteIndexDocument", "websiteErrorDocument" nor , "websiteRoutingRules".
Optional
Readonly
websiteRules that define when a redirect is applied and the redirect behavior
Generated using TypeDoc
Specifies a canned ACL that grants predefined permissions to the bucket.
Default
BucketAccessControl.PRIVATE