interface BucketProps

Language	Type name
.NET	`Amazon.CDK.AWS.S3.BucketProps`
Go	`github.com/aws/aws-cdk-go/awscdk/v2/awss3#BucketProps`
Java	`software.amazon.awscdk.services.s3.BucketProps`
Python	`aws_cdk.aws_s3.BucketProps`
TypeScript (source)	`aws-cdk-lib` » `aws_s3` » `BucketProps`

Example

const accessLogsBucket = new s3.Bucket(this, 'AccessLogsBucket', {
  objectOwnership: s3.ObjectOwnership.BUCKET_OWNER_ENFORCED,
});

accessLogsBucket.addToResourcePolicy(
  new iam.PolicyStatement({
    actions: ['s3:*'],
    resources: [accessLogsBucket.bucketArn, accessLogsBucket.arnForObjects('*')],
    principals: [new iam.AnyPrincipal()],
  })
)

const bucket = new s3.Bucket(this, 'MyBucket', {
  serverAccessLogsBucket: accessLogsBucket,
  serverAccessLogsPrefix: 'logs',
});

Properties

Name	Type	Description
accessControl?	`BucketAccessControl`	Specifies a canned ACL that grants predefined permissions to the bucket.
autoDeleteObjects?	`boolean`	Whether all objects should be automatically deleted when the bucket is removed from the stack or when the stack is deleted.
blockPublicAccess?	`BlockPublicAccess`	The block public access configuration of this bucket.
bucketKeyEnabled?	`boolean`	Whether Amazon S3 should use its own intermediary key to generate data keys.
bucketName?	`string`	Physical name of this bucket.
cors?	`CorsRule[]`	The CORS configuration of this bucket.
encryption?	`BucketEncryption`	The kind of server-side encryption to apply to this bucket.
encryptionKey?	`IKey`	External KMS key to use for bucket encryption.
enforceSSL?	`boolean`	Enforces SSL for requests.
eventBridgeEnabled?	`boolean`	Whether this bucket should send notifications to Amazon EventBridge or not.
intelligentTieringConfigurations?	`IntelligentTieringConfiguration[]`	Intelligent Tiering Configurations.
inventories?	`Inventory[]`	The inventory configuration of the bucket.
lifecycleRules?	`LifecycleRule[]`	Rules that define how Amazon S3 manages objects during their lifetime.
metrics?	`BucketMetrics[]`	The metrics configuration of this bucket.
minimumTLSVersion?	`number`	Enforces minimum TLS version for requests.
notificationsHandlerRole?	`IRole`	The role to be used by the notifications handler.
notificationsSkipDestinationValidation?	`boolean`	Skips notification validation of Amazon SQS, Amazon SNS, and Lambda destinations.
objectLockDefaultRetention?	`ObjectLockRetention`	The default retention mode and rules for S3 Object Lock.
objectLockEnabled?	`boolean`	Enable object lock on the bucket.
objectOwnership?	`ObjectOwnership`	The objectOwnership of the bucket.
publicReadAccess?	`boolean`	Grants public read access to all objects in the bucket.
removalPolicy?	`RemovalPolicy`	Policy to apply when the bucket is removed from this stack.
replicationRules?	`ReplicationRule[]`	A container for one or more replication rules.
serverAccessLogsBucket?	`IBucket`	Destination bucket for the server access logs.
serverAccessLogsPrefix?	`string`	Optional log file prefix to use for the bucket's access logs.
targetObjectKeyFormat?	`TargetObjectKeyFormat`	Optional key format for log objects.
transferAcceleration?	`boolean`	Whether this bucket should have transfer acceleration turned on or not.
transitionDefaultMinimumObjectSize?	`TransitionDefaultMinimumObjectSize`	Indicates which default minimum object size behavior is applied to the lifecycle configuration.
versioned?	`boolean`	Whether this bucket should have versioning turned on or not.
websiteErrorDocument?	`string`	The name of the error document (e.g. "404.html") for the website. `websiteIndexDocument` must also be set if this is set.
websiteIndexDocument?	`string`	The name of the index document (e.g. "index.html") for the website. Enables static website hosting for this bucket.
websiteRedirect?	`RedirectTarget`	Specifies the redirect behavior of all requests to a website endpoint of a bucket.
websiteRoutingRules?	`RoutingRule[]`	Rules that define when a redirect is applied and the redirect behavior.

accessControl?

Type: BucketAccessControl (optional, default: BucketAccessControl.PRIVATE)

Specifies a canned ACL that grants predefined permissions to the bucket.

autoDeleteObjects?

Type: boolean (optional, default: false)

Whether 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.

Setting autoDeleteObjects to true on a bucket will add s3:PutBucketPolicy to the bucket policy. This is because during bucket deletion, the custom resource provider needs to update the bucket policy by adding a deny policy for s3:PutObject to prevent race conditions with external bucket writers.

blockPublicAccess?

Type: BlockPublicAccess (optional, default: CloudFormation defaults will apply. New buckets and objects don't allow public access, but users can modify bucket policies or object permissions to allow public access)

The block public access configuration of this bucket.

bucketKeyEnabled?

Type: boolean (optional, default: false)

Whether Amazon S3 should use its own intermediary key to generate data keys.

Only relevant when using KMS for encryption.

If not enabled, every object GET and PUT will cause an API call to KMS (with the attendant cost implications of that).
If enabled, S3 will use its own time-limited key instead.

Only relevant, when Encryption is not set to BucketEncryption.UNENCRYPTED.

bucketName?

Type: string (optional, default: Assigned by CloudFormation (recommended).)

Physical name of this bucket.

cors?

Type: CorsRule[] (optional, default: No CORS configuration.)

The CORS configuration of this bucket.

encryption?

Type: BucketEncryption (optional, default: KMS if encryptionKey is specified, or UNENCRYPTED otherwise. But if UNENCRYPTED is specified, the bucket will be encrypted as S3_MANAGED automatically.)

The 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.

encryptionKey?

Type: IKey (optional, default: If encryption is set to KMS and this property is undefined, a new KMS key will be created and associated with this bucket.)

External KMS key to use for bucket encryption.

The encryption property must be either not specified or set to KMS or DSSE. An error will be emitted if encryption is set to UNENCRYPTED or S3_MANAGED.

enforceSSL?

Type: boolean (optional, default: false)

Enforces SSL for requests.

S3.5 of the AWS Foundational Security Best Practices Regarding S3.

eventBridgeEnabled?

Type: boolean (optional, default: false)

Whether this bucket should send notifications to Amazon EventBridge or not.

intelligentTieringConfigurations?

Type: IntelligentTieringConfiguration[] (optional, default: No Intelligent Tiiering Configurations.)

Intelligent Tiering Configurations.

inventories?

Type: Inventory[] (optional, default: No inventory configuration)

The inventory configuration of the bucket.

lifecycleRules?

Type: LifecycleRule[] (optional, default: No lifecycle rules.)

Rules that define how Amazon S3 manages objects during their lifetime.

metrics?

Type: BucketMetrics[] (optional, default: No metrics configuration.)

The metrics configuration of this bucket.

minimumTLSVersion?

Type: number (optional, default: No minimum TLS version is enforced.)

Enforces minimum TLS version for requests.

Requires enforceSSL to be enabled.

notificationsHandlerRole?

Type: IRole (optional, default: a new role will be created.)

The role to be used by the notifications handler.

notificationsSkipDestinationValidation?

Type: boolean (optional, default: false)

Skips notification validation of Amazon SQS, Amazon SNS, and Lambda destinations.

objectLockDefaultRetention?

Type: ObjectLockRetention (optional, default: no default retention period)

The default retention mode and rules for S3 Object Lock.

Default retention can be configured after a bucket is created if the bucket already has object lock enabled. Enabling object lock for existing buckets is not supported.

objectLockEnabled?

Type: boolean (optional, default: false, unless objectLockDefaultRetention is set (then, true))

Enable object lock on the bucket.

Enabling object lock for existing buckets is not supported. Object lock must be enabled when the bucket is created.

objectOwnership?

Type: ObjectOwnership (optional, default: No ObjectOwnership configuration. By default, Amazon S3 sets Object Ownership to Bucket owner enforced. This means ACLs are disabled and the bucket owner will own every object.)

The objectOwnership of the bucket.

publicReadAccess?

Type: boolean (optional, default: false)

Grants public read access to all objects in the bucket.

Similar to calling bucket.grantPublicAccess()

removalPolicy?

Type: RemovalPolicy (optional, default: The bucket will be orphaned.)

Policy to apply when the bucket is removed from this stack.

replicationRules?

Type: ReplicationRule[] (optional, default: No replication)

A container for one or more replication rules.

serverAccessLogsBucket?

Type: IBucket (optional, default: If "serverAccessLogsPrefix" undefined - access logs disabled, otherwise - log to current bucket.)

Destination bucket for the server access logs.

serverAccessLogsPrefix?

Type: string (optional, default: No log file prefix)

Optional log file prefix to use for the bucket's access logs.

If defined without "serverAccessLogsBucket", enables access logs to current bucket with this prefix.

targetObjectKeyFormat?

Type: TargetObjectKeyFormat (optional, default: the default key format is: [DestinationPrefix][YYYY]-[MM]-[DD]-[hh]-[mm]-[ss]-[UniqueString])

Optional key format for log objects.

transferAcceleration?

Type: boolean (optional, default: false)

Whether this bucket should have transfer acceleration turned on or not.

transitionDefaultMinimumObjectSize?

Type: TransitionDefaultMinimumObjectSize (optional, default: TransitionDefaultMinimumObjectSize.VARIES_BY_STORAGE_CLASS before September 2024, otherwise TransitionDefaultMinimumObjectSize.ALL_STORAGE_CLASSES_128_K.)

Indicates which default minimum object size behavior is applied to the lifecycle configuration.

To customize the minimum object size for any transition you can add a filter that specifies a custom objectSizeGreaterThan or objectSizeLessThan for lifecycleRules property. Custom filters always take precedence over the default transition behavior.

versioned?

Type: boolean (optional, default: false (unless object lock is enabled, then true))

Whether this bucket should have versioning turned on or not.

websiteErrorDocument?

Type: string (optional, default: No error document.)

The name of the error document (e.g. "404.html") for the website. websiteIndexDocument must also be set if this is set.

websiteIndexDocument?

Type: string (optional, default: No index document.)

The name of the index document (e.g. "index.html") for the website. Enables static website hosting for this bucket.

websiteRedirect?

Type: RedirectTarget (optional, default: No redirection.)

Specifies 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".

websiteRoutingRules?

Type: RoutingRule[] (optional, default: No redirection rules.)

Rules that define when a redirect is applied and the redirect behavior.