# BucketBase

Represents an S3 Bucket.

Buckets can be either defined within this stack:

  new Bucket(this, 'MyBucket', { props });

Or imported from an existing bucket:

  Bucket.import(this, 'MyImportedBucket', { bucketArn: ... });

You can also export a bucket and import it into another stack:

  const ref = myBucket.export();
  Bucket.import(this, 'MyImportedBucket', ref);

Extends: Construct › Resource › BucketBase
Implements: IResource, IEncryptedResource, IBucket, IEnvironmentAware, IBucketRef, IConstruct, IDependable
Superclass of: Bucket

- Source: [`aws-s3/lib/bucket.ts`](https://github.com/aws/aws-cdk/blob/v2.275.0/packages/aws-cdk-lib/aws-s3/lib/bucket.ts#L583)
- Type last changed: v2.242.0 · 10 Mar 2026

## Initializer

```ts
new BucketBase(scope: Construct, id: string, props?: ResourceProps)
```

## Construct Props

- `account`: string — The AWS account ID this resource belongs to.

  **Default:** the resource is in the same account as the stack it belongs to

- `environmentFromArn`: string — ARN to deduce region and account from.

  **Default:** take environment from `account`, `region` parameters, or use Stack environment.

  The ARN is parsed and the account and region are taken from the ARN.
  This should be used for imported resources.

  Cannot be supplied together with either `account` or `region`.

- `physicalName`: string — The value passed in by users to the physical name prop of the resource.

  **Default:** The physical name will be allocated by CloudFormation at deployment time

  - `undefined` implies that a physical name will be allocated by
    CloudFormation during deployment.
  - a concrete value implies a specific physical name
  - `PhysicalName.GENERATE_IF_NEEDED` is a marker that indicates that a physical will only be generated
    by the CDK if it is needed for cross-environment references. Otherwise, it will be allocated by CloudFormation.

- `region`: string — The AWS region this resource belongs to.

  **Default:** the resource is in the same region as the stack it belongs to

## Properties

- `bucketArn`: string — The ARN of the bucket.

- `bucketDomainName`: string — The IPv4 DNS name of the specified bucket.

- `bucketDualStackDomainName`: string — The IPv6 DNS name of the specified bucket.

- `bucketName`: string — The name of the bucket.

- `bucketRef`: [BucketReference](/cdk/api/v2/docs/aws-cdk-lib.interfaces.aws_s3.BucketReference.html) — A reference to a Bucket resource.

- `bucketRegionalDomainName`: string — The regional domain name of the specified bucket.

- `bucketWebsiteDomainName`: string — The Domain name of the static website.

- `bucketWebsiteUrl`: string — The URL of the static website.

- `disallowPublicAccess`: boolean — Whether to disallow public access.

- `encryptionKey`: [IKey](/cdk/api/v2/docs/aws-cdk-lib.aws_kms.IKey.html) — Optional KMS encryption key associated with this bucket.

- `env`: [ResourceEnvironment](/cdk/api/v2/docs/aws-cdk-lib.interfaces.ResourceEnvironment.html) — The environment this resource belongs to.

  For resources that are created and managed in a Stack (those created by
  creating new class instances like `new Role()`, `new Bucket()`, etc.), this
  is always the same as the environment of the stack they belong to.

  For referenced resources (those obtained from referencing methods like
  `Role.fromRoleArn()`, `Bucket.fromBucketName()`, etc.), they might be
  different than the stack they were imported into.

- `grants`: [BucketGrants](/cdk/api/v2/docs/aws-cdk-lib.aws_s3.BucketGrants.html) — Collection of grant methods for a Bucket.

- `isWebsite`: boolean — If this bucket has been configured for static website hosting.

- `node`: [Node](/cdk/api/v2/docs/constructs.Node.html) — The tree node.

- `policy`: [BucketPolicy](/cdk/api/v2/docs/aws-cdk-lib.aws_s3.BucketPolicy.html) — The resource policy associated with this bucket.

  If `autoCreatePolicy` is true, a `BucketPolicy` will be created upon the
  first call to addToResourcePolicy(s).

- `replicationRoleArn`: string — Role used to set up permissions on this bucket for replication.

- `stack`: [Stack](/cdk/api/v2/docs/aws-cdk-lib.Stack.html) — The stack in which this resource is defined.

## Methods

- `addEventNotification(event: EventType, dest: IBucketNotificationDestination, ...filters: NotificationKeyFilter[]): void` — Adds a bucket notification event destination.

  **Parameters**

  - `event` — The event to trigger the notification.
  - `dest` — The notification destination (Lambda, SNS Topic or SQS Queue).
  - `filters` — S3 object key filter rules to determine which objects trigger this event.

  ```ts
     declare const myLambda: lambda.Function;
     const bucket = new s3.Bucket(this, 'MyBucket');
     const filter: s3.NotificationKeyFilter = { prefix: 'home/myusername/*' };
     bucket.addEventNotification(s3.EventType.OBJECT_CREATED, new s3n.LambdaDestination(myLambda), filter);
  ```

- `addObjectCreatedNotification(dest: IBucketNotificationDestination, ...filters: NotificationKeyFilter[]): void` — Subscribes a destination to receive notifications when an object is created in the bucket.

  This is identical to calling
  `onEvent(EventType.OBJECT_CREATED)`.

  **Parameters**

  - `dest` — The notification destination (see onEvent).
  - `filters` — Filters (see onEvent).

- `addObjectRemovedNotification(dest: IBucketNotificationDestination, ...filters: NotificationKeyFilter[]): void` — Subscribes a destination to receive notifications when an object is removed from the bucket.

  This is identical to calling
  `onEvent(EventType.OBJECT_REMOVED)`.

  **Parameters**

  - `dest` — The notification destination (see onEvent).
  - `filters` — Filters (see onEvent).

- `addReplicationPolicy(roleArn: string, accessControlTransition?: boolean, account?: string): void` — Adds resource policy statements to this bucket that permit cross-account replication.

  Call this method on the destination bucket. If the destination bucket is a referenced bucket,
  its policy cannot be modified by CDK and the permissions must be added in the destination
  account.

  To change replica ownership to the destination bucket owner, set `accessControlTransition` to
  true and provide the source bucket owner's account ID.

  **Parameters**

  - `roleArn` — The ARN of the source bucket's replication role.
  - `accessControlTransition` — Whether to change replica ownership to the destination bucket owner.
  - `account` — The source bucket owner's AWS account ID.

- `addToResourcePolicy(permission: PolicyStatement): AddToResourcePolicyResult` — Adds a statement to the resource policy for a principal (i.e. account/role/service) to perform actions on this bucket and/or its contents. Use `bucketArn` and `arnForObjects(keys)` to obtain ARNs for this bucket or objects.

  Note that the policy statement may or may not be added to the policy.
  For example, when an `IBucket` is created from an existing bucket,
  it's not possible to tell whether the bucket already has a policy
  attached, let alone to re-use that policy to add more statements to it.
  So it's safest to do nothing in these cases.

  **Parameters**

  - `permission` — the policy statement to be added to the bucket's policy.

  **Returns:** metadata about the execution of this method. If the policy was not added, the value of `statementAdded` will be `false`. You should always check this value to make sure that the operation was actually carried out. Otherwise, synthesis and deploy will terminate silently, which may be confusing.

- `applyCrossStackReferenceStrength(strength: ReferenceStrength): void` — Override the cross-stack reference strength for this resource.

  When set, any cross-stack reference to this resource will use the specified
  mechanism instead of the global default determined by the
  `@aws-cdk/core:defaultCrossStackReferences` context key. This is useful for
  selectively weakening specific references to avoid the "deadly embrace" problem
  without changing the app-wide default.

  **Parameters**

  - `strength` — - The reference strength to use for this resource.

- `applyRemovalPolicy(policy: RemovalPolicy): void` — Apply the given removal policy to this resource.

  The Removal Policy controls what happens to this resource when it stops
  being managed by CloudFormation, either because you've removed it from the
  CDK application or because you've made a change that requires the resource
  to be replaced.

  The resource can be deleted (`RemovalPolicy.DESTROY`), or left in your AWS
  account for data recovery and cleanup later (`RemovalPolicy.RETAIN`).

- `arnForObjects(keyPattern: string): string` — Returns an ARN that represents all objects within the bucket that match the key pattern specified.

  To represent all keys, specify ``"*"``.

  If you need to specify a keyPattern with multiple components, concatenate them into a single string, e.g.:

    arnForObjects(`home/${team}/${user}/*`)

- `enableEventBridgeNotification(): void` — Enables event bridge notification, causing all events below to be sent to EventBridge:.

  - Object Deleted (DeleteObject)
  - Object Deleted (Lifecycle expiration)
  - Object Restore Initiated
  - Object Restore Completed
  - Object Restore Expired
  - Object Storage Class Changed
  - Object Access Tier Changed
  - Object ACL Updated
  - Object Tags Added
  - Object Tags Deleted

- `grantDelete(identity: IGrantable, objectsKeyPattern?: any): Grant` — Grants s3:DeleteObject* permission to an IAM principal for objects in this bucket.

  The use of this method is discouraged. Please use `grants.delete()` instead.

  [disable-awslint:no-grants]

  **Parameters**

  - `identity` — The principal.
  - `objectsKeyPattern` — Restrict the permission to a certain key pattern (default '*').

- `grantOnKey(grantee: IGrantable, ...actions: string[]): GrantOnKeyResult` — Gives permissions to a grantable entity to perform actions on the encryption key.

- `grantPublicAccess(keyPrefix?: string, ...allowedActions: string[]): Grant` — Allows unrestricted access to objects from this bucket.

  IMPORTANT: This permission allows anyone to perform actions on S3 objects
  in this bucket, which is useful for when you configure your bucket as a
  website and want everyone to be able to read objects in the bucket without
  needing to authenticate.

  Without arguments, this method will grant read ("s3:GetObject") access to
  all objects ("*") in the bucket.

  The method returns the `iam.Grant` object, which can then be modified
  as needed. For example, you can add a condition that will restrict access only
  to an IPv4 range like this:

      const grant = bucket.grantPublicAccess();
      grant.resourceStatement!.addCondition(‘IpAddress’, { “aws:SourceIp”: “54.240.143.0/24” });

  Note that if this `IBucket` refers to an existing bucket, possibly not
  managed by CloudFormation, this method will have no effect, since it's
  impossible to modify the policy of an existing bucket.

  The use of this method is discouraged. Please use `grants.publicAccess()` instead.

  [disable-awslint:no-grants]

  **Parameters**

  - `keyPrefix` — the prefix of S3 object keys (e.g. `home/*`). Default is "*".
  - `allowedActions` — the set of S3 actions to allow.

- `grantPut(identity: IGrantable, objectsKeyPattern?: any): Grant` — Grants s3:PutObject* and s3:Abort* permissions for this bucket to an IAM principal.

  If encryption is used, permission to use the key to encrypt the contents
  of written files will also be granted to the same principal.

  The use of this method is discouraged. Please use `grants.put()` instead.

  [disable-awslint:no-grants]

  **Parameters**

  - `identity` — The principal.
  - `objectsKeyPattern` — Restrict the permission to a certain key pattern (default '*').

- `grantPutAcl(identity: IGrantable, objectsKeyPattern?: string): Grant` — The use of this method is discouraged. Please use `grants.putAcl()` instead.

  [disable-awslint:no-grants]

- `grantRead(identity: IGrantable, objectsKeyPattern?: any): Grant` — Grant read permissions for this bucket and its contents to an IAM principal (Role/Group/User).

  If encryption is used, permission to use the key to decrypt the contents
  of the bucket will also be granted to the same principal.

  The use of this method is discouraged. Please use `grants.read()` instead.

  [disable-awslint:no-grants]

  **Parameters**

  - `identity` — The principal.
  - `objectsKeyPattern` — Restrict the permission to a certain key pattern (default '*').

- `grantReadWrite(identity: IGrantable, objectsKeyPattern?: any): Grant` — The use of this method is discouraged. Please use `grants.readWrite()` instead.

  [disable-awslint:no-grants]

- `grantReplicationPermission(identity: IGrantable, props: GrantReplicationPermissionProps): Grant` — Grant replication permission to a principal. This method allows the principal to perform replication operations on this bucket.

  Note that when calling this function for source or destination buckets that support KMS encryption,
  you need to specify the KMS key for encryption and the KMS key for decryption, respectively.

  The use of this method is discouraged. Please use `grants.replicationPermission()` instead.

  [disable-awslint:no-grants]

  **Parameters**

  - `identity` — The principal to grant replication permission to.
  - `props` — The properties of the replication source and destination buckets.

- `grantWrite(identity: IGrantable, objectsKeyPattern?: any, allowedActionPatterns?: string[]): Grant` — The use of this method is discouraged. Please use `grants.write()` instead.

  [disable-awslint:no-grants]

- `isConstruct(x: any): boolean` (static) — Checks if `x` is a construct.

  Use this method instead of `instanceof` to properly detect `Construct`
  instances, even when the construct library is symlinked.

  Explanation: in JavaScript, multiple copies of the `constructs` library on
  disk are seen as independent, completely different libraries. As a
  consequence, the class `Construct` in each copy of the `constructs` library
  is seen as a different class, and an instance of one class will not test as
  `instanceof` the other class. `npm install` will not create installations
  like this, but users may manually symlink construct libraries together or
  use a monorepo tool: in those cases, multiple copies of the `constructs`
  library can be accidentally installed, and `instanceof` will behave
  unpredictably. It is safest to avoid using `instanceof`, and using
  this type-testing method instead.

  **Parameters**

  - `x` — Any object.

  **Returns:** true if `x` is an object created from a class which extends `Construct`.

- `isOwnedResource(construct: IConstruct): boolean` (static) — Returns true if the construct was created by CDK, and false otherwise.

- `isResource(construct: IConstruct): boolean` (static) — Check whether the given construct is a Resource.

- `onCloudTrailEvent(id: string, options?: OnCloudTrailBucketEventOptions): Rule` — Define a CloudWatch event that triggers when something happens to this repository.

  Requires that there exists at least one CloudTrail Trail in your account
  that captures the event. This method will not create the Trail.

  **Parameters**

  - `id` — The id of the rule.
  - `options` — Options for adding the rule.

- `onCloudTrailPutObject(id: string, options?: OnCloudTrailBucketEventOptions): Rule` — Defines an AWS CloudWatch event that triggers when an object is uploaded to the specified paths (keys) in this bucket using the PutObject API call.

  Note that some tools like `aws s3 cp` will automatically use either
  PutObject or the multipart upload API depending on the file size,
  so using `onCloudTrailWriteObject` may be preferable.

  Requires that there exists at least one CloudTrail Trail in your account
  that captures the event. This method will not create the Trail.

  **Parameters**

  - `id` — The id of the rule.
  - `options` — Options for adding the rule.

- `onCloudTrailWriteObject(id: string, options?: OnCloudTrailBucketEventOptions): Rule` — Defines an AWS CloudWatch event that triggers when an object at the specified paths (keys) in this bucket are written to.

  This includes
  the events PutObject, CopyObject, and CompleteMultipartUpload.

  Note that some tools like `aws s3 cp` will automatically use either
  PutObject or the multipart upload API depending on the file size,
  so using this method may be preferable to `onCloudTrailPutObject`.

  Requires that there exists at least one CloudTrail Trail in your account
  that captures the event. This method will not create the Trail.

  **Parameters**

  - `id` — The id of the rule.
  - `options` — Options for adding the rule.

- `s3UrlForObject(key?: string): string` — The S3 URL of an S3 object. For example:.

  - `s3://onlybucket`
  - `s3://bucket/key`

  **Parameters**

  - `key` — The S3 key of the object.

  **Returns:** an ObjectS3Url token

- `toString(): string` — Returns a string representation of this construct.

- `transferAccelerationUrlForObject(key?: string, options?: TransferAccelerationUrlOptions): string` — The https Transfer Acceleration URL of an S3 object.

  Specify `dualStack: true` at the options
  for dual-stack endpoint (connect to the bucket over IPv6). For example:

  - `https://bucket.s3-accelerate.amazonaws.com`
  - `https://bucket.s3-accelerate.amazonaws.com/key`

  **Parameters**

  - `key` — The S3 key of the object.
  - `options` — Options for generating URL.

  **Returns:** an TransferAccelerationUrl token

- `urlForObject(key?: string): string` — The https URL of an S3 object. Specify `regional: false` at the options for non-regional URLs. For example:.

  - `https://s3.us-west-1.amazonaws.com/onlybucket`
  - `https://s3.us-west-1.amazonaws.com/bucket/key`
  - `https://s3---cn-north-1.amazonaws.com.rproxy.govskope.ca.cn/china-bucket/mykey`

  **Parameters**

  - `key` — The S3 key of the object.

  **Returns:** an ObjectS3Url token

- `virtualHostedUrlForObject(key?: string, options?: VirtualHostedStyleUrlOptions): string` — The virtual hosted-style URL of an S3 object. Specify `regional: false` at the options for non-regional URL. For example:.

  - `https://only-bucket.s3.us-west-1.amazonaws.com`
  - `https://bucket.s3.us-west-1.amazonaws.com/key`
  - `https://bucket.s3.amazonaws.com/key`
  - `https://china-bucket---s3---cn-north-1.amazonaws.com.rproxy.govskope.ca.cn/mykey`

  **Parameters**

  - `key` — The S3 key of the object.
  - `options` — Options for generating URL.

  **Returns:** an ObjectS3Url token

- `with(...mixins: IMixin[]): IConstruct` — Applies one or more mixins to this construct.

  Mixins are applied in order. The list of constructs is captured at the
  start of the call, so constructs added by a mixin will not be visited.
  Use multiple `with()` calls if subsequent mixins should apply to added
  constructs.