# Bucket

An S3 bucket with associated policy objects.

This bucket does not yet have all features that exposed by the underlying
BucketResource.

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

- CloudFormation: [`AWS::S3::Bucket`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/aws-resource-s3-bucket.html)
- L1 type: [`CfnBucket`](/cdk/api/v2/docs/aws-cdk-lib.aws_s3.CfnBucket.html)
- 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#L2181)
- Type last changed: v2.227.0 · 21 Nov 2025

## Example

```ts
import { RemovalPolicy } from 'aws-cdk-lib';

new s3.Bucket(scope, 'Bucket', {
  blockPublicAccess: s3.BlockPublicAccess.BLOCK_ALL,
  encryption: s3.BucketEncryption.S3_MANAGED,
  enforceSSL: true,
  versioned: true,
  removalPolicy: RemovalPolicy.RETAIN,
});
```

## Initializer

```ts
new Bucket(scope: Construct, id: string, props?: BucketProps)
```

## Construct Props

- `abacStatus`: boolean — Enables Amazon S3 to evaluate the ABAC policy in the request.

  **Default:** The ABAC status is not set

  Set to true to enable ABAC, false to explicitly disable it.

- `accessControl`: [BucketAccessControl](/cdk/api/v2/docs/aws-cdk-lib.aws_s3.BucketAccessControl.html) = BucketAccessControl.PRIVATE — Specifies a canned ACL that grants predefined permissions to the bucket.

- `autoDeleteObjects`: boolean = 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.

- `blockedEncryptionTypes`: [BlockedEncryptionType](/cdk/api/v2/docs/aws-cdk-lib.aws_s3.BlockedEncryptionType.html)[] — Encryption types that should be blocked for this bucket. Use `NONE` to allow all encryption types.

  **Default:** Amazon S3 determines which encryption types to block.

  At least one `BlockedEncryptionType` must be given. If `NONE` is given, it must be
  the only `BlockedEncryptionType` in the list.

- `blockPublicAccess`: [BlockPublicAccess](/cdk/api/v2/docs/aws-cdk-lib.aws_s3.BlockPublicAccess.html) — The block public access configuration of this bucket.

  **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

- `bucketKeyEnabled`: boolean = 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`: string — Physical name of this bucket.

  **Default:** Assigned by CloudFormation (recommended).

  Cannot be used together with `bucketNamePrefix` or `bucketNamespace`.

- `bucketNamePrefix`: string — A prefix for the bucket name in the account-regional namespace.

  **Default:** No prefix.

  Requires `bucketNamespace` to be set to `ACCOUNT_REGIONAL`.
  Cannot be used together with `bucketName`.

  CloudFormation appends `-<accountId>-<region>-an` to form the full name.
  For example, `my-app` becomes `my-app-123456789012-us-east-1-an`.

  Must contain only lowercase letters, numbers, and hyphens.
  Must start and end with a lowercase letter or number.

- `bucketNamespace`: [BucketNamespace](/cdk/api/v2/docs/aws-cdk-lib.aws_s3.BucketNamespace.html) — The namespace for the bucket name.

  **Default:** Global namespace.

  AWS recommends `ACCOUNT_REGIONAL` for improved security, as bucket names
  are scoped to your account and cannot be claimed by other accounts.
  When set to `ACCOUNT_REGIONAL`, `bucketNamePrefix` is required.
  When set to `GLOBAL`, it can be used standalone to explicitly specify the default namespace.

- `cors`: [CorsRule](/cdk/api/v2/docs/aws-cdk-lib.aws_s3.CorsRule.html)[] — The CORS configuration of this bucket.

  **Default:** No CORS configuration.

- `encryption`: [BucketEncryption](/cdk/api/v2/docs/aws-cdk-lib.aws_s3.BucketEncryption.html) — The kind of server-side encryption to apply to this bucket.

  **Default:** `KMS` if `encryptionKey` is specified, or `S3_MANAGED` otherwise.

  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`: [IKey](/cdk/api/v2/docs/aws-cdk-lib.aws_kms.IKey.html) — External KMS key to use for bucket encryption.

  **Default:** If `encryption` is set to `KMS` and this property is undefined, a new KMS key will be created and associated with this bucket.

  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`: boolean = false — Enforces SSL for requests.

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

- `eventBridgeEnabled`: boolean = false — Whether this bucket should send notifications to Amazon EventBridge or not.

- `intelligentTieringConfigurations`: [IntelligentTieringConfiguration](/cdk/api/v2/docs/aws-cdk-lib.aws_s3.IntelligentTieringConfiguration.html)[] — Intelligent Tiering Configurations.

  **Default:** No Intelligent Tiering Configurations.

- `inventories`: [Inventory](/cdk/api/v2/docs/aws-cdk-lib.aws_s3.Inventory.html)[] — The inventory configuration of the bucket.

  **Default:** No inventory configuration

- `lifecycleRules`: [LifecycleRule](/cdk/api/v2/docs/aws-cdk-lib.aws_s3.LifecycleRule.html)[] — Rules that define how Amazon S3 manages objects during their lifetime.

  **Default:** No lifecycle rules.

- `metrics`: [BucketMetrics](/cdk/api/v2/docs/aws-cdk-lib.aws_s3.BucketMetrics.html)[] — The metrics configuration of this bucket.

  **Default:** No metrics configuration.

- `minimumTLSVersion`: number — Enforces minimum TLS version for requests.

  **Default:** No minimum TLS version is enforced.

  Requires `enforceSSL` to be enabled.

- `notificationsHandlerRole`: [IRole](/cdk/api/v2/docs/aws-cdk-lib.aws_iam.IRole.html) — The role to be used by the notifications handler.

  **Default:** a new role will be created.

- `notificationsSkipDestinationValidation`: boolean = false — Skips notification validation of Amazon SQS, Amazon SNS, and Lambda destinations.

- `objectLockDefaultRetention`: [ObjectLockRetention](/cdk/api/v2/docs/aws-cdk-lib.aws_s3.ObjectLockRetention.html) — The default retention mode and rules for S3 Object Lock.

  **Default:** no default retention period

  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`: boolean — Enable object lock on the bucket.

  **Default:** false, unless objectLockDefaultRetention is set (then, true)

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

- `objectOwnership`: [ObjectOwnership](/cdk/api/v2/docs/aws-cdk-lib.aws_s3.ObjectOwnership.html) — The objectOwnership of the bucket.

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

- `publicReadAccess`: boolean = false — Grants public read access to all objects in the bucket.

  Similar to calling `bucket.grantPublicAccess()`

- `removalPolicy`: [RemovalPolicy](/cdk/api/v2/docs/aws-cdk-lib.RemovalPolicy.html) — Policy to apply when the bucket is removed from this stack.

  **Default:** The bucket will be orphaned.

- `replicationRole`: [IRole](/cdk/api/v2/docs/aws-cdk-lib.aws_iam.IRole.html) — The role to be used by the replication.

  **Default:** a new role will be created.

  When setting this property, you must also set `replicationRules`.

- `replicationRules`: [ReplicationRule](/cdk/api/v2/docs/aws-cdk-lib.aws_s3.ReplicationRule.html)[] — A container for one or more replication rules.

  **Default:** No replication

- `serverAccessLogsBucket`: [IBucket](/cdk/api/v2/docs/aws-cdk-lib.aws_s3.IBucket.html) — Destination bucket for the server access logs.

  **Default:** If "serverAccessLogsPrefix" undefined - access logs disabled, otherwise - log to current bucket.

- `serverAccessLogsPrefix`: string — Optional log file prefix to use for the bucket's access logs.

  **Default:** No log file prefix

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

- `targetObjectKeyFormat`: [TargetObjectKeyFormat](/cdk/api/v2/docs/aws-cdk-lib.aws_s3.TargetObjectKeyFormat.html) — Optional key format for log objects.

  **Default:** the default key format is: [DestinationPrefix][YYYY]-[MM]-[DD]-[hh]-[mm]-[ss]-[UniqueString]

- `transferAcceleration`: boolean = false — Whether this bucket should have transfer acceleration turned on or not.

- `transitionDefaultMinimumObjectSize`: [TransitionDefaultMinimumObjectSize](/cdk/api/v2/docs/aws-cdk-lib.aws_s3.TransitionDefaultMinimumObjectSize.html) — Indicates which default minimum object size behavior is applied to the lifecycle configuration.

  **Default:** TransitionDefaultMinimumObjectSize.VARIES_BY_STORAGE_CLASS before September 2024, otherwise TransitionDefaultMinimumObjectSize.ALL_STORAGE_CLASSES_128_K.

  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`: boolean — Whether this bucket should have versioning turned on or not.

  **Default:** false (unless object lock is enabled, then true)

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

  **Default:** No error document.

- `websiteIndexDocument`: string — The name of the index document (e.g. "index.html") for the website. Enables static website hosting for this bucket.

  **Default:** No index document.

- `websiteRedirect`: [RedirectTarget](/cdk/api/v2/docs/aws-cdk-lib.aws_s3.RedirectTarget.html) — Specifies the redirect behavior of all requests to a website endpoint of a bucket.

  **Default:** No redirection.

  If you specify this property, you can't specify "websiteIndexDocument", "websiteErrorDocument" nor , "websiteRoutingRules".

- `websiteRoutingRules`: [RoutingRule](/cdk/api/v2/docs/aws-cdk-lib.aws_s3.RoutingRule.html)[] — Rules that define when a redirect is applied and the redirect behavior.

  **Default:** No redirection rules.

## 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).

- `PROPERTY_INJECTION_ID`: string (static) — Uniquely identifies this class.

- `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

- `addCorsRule(rule: CorsRule): void` — Adds a cross-origin access configuration for objects in an Amazon S3 bucket.

  **Parameters**

  - `rule` — The CORS configuration rule to add.

- `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);
  ```

- `addInventory(inventory: Inventory): void` — Add an inventory configuration.

  **Parameters**

  - `inventory` — configuration to add.

- `addLifecycleRule(rule: LifecycleRule): void` — Add a lifecycle rule to the bucket.

  **Parameters**

  - `rule` — The rule to add.

- `addMetric(metric: BucketMetrics): void` — Adds a metrics configuration for the CloudWatch request metrics from the bucket.

  **Parameters**

  - `metric` — The metric configuration to add.

- `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

- `fromBucketArn(scope: Construct, id: string, bucketArn: string): IBucket` (static)

- `fromBucketAttributes(scope: Construct, id: string, attrs: BucketAttributes): IBucket` (static) — Creates a Bucket construct that represents an external bucket.

  **Parameters**

  - `scope` — The parent creating construct (usually `this`).
  - `id` — The construct's name.
  - `attrs` — A `BucketAttributes` object.

- `fromBucketName(scope: Construct, id: string, bucketName: string): IBucket` (static)

- `fromCfnBucket(cfnBucket: CfnBucket): IBucket` (static) — Create a mutable `IBucket` based on a low-level `CfnBucket`.

- `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

- `validateBucketName(physicalName: string, allowLegacyBucketNaming?: boolean): void` (static) — Thrown an exception if the given bucket name is not valid.

  **Parameters**

  - `physicalName` — name of the bucket.
  - `allowLegacyBucketNaming` — allow legacy bucket naming style, default is false.

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