Package software.amazon.awscdk.services.s3

Interface BucketProps

All Superinterfaces:
software.amazon.jsii.JsiiSerializable
All Known Implementing Classes:
BucketProps.Jsii$Proxy
@Generated(value="jsii-pacmak/1.104.0 (build e79254c)", date="2024-11-22T02:24:08.810Z") @Stability(Stable) public interface BucketProps extends software.amazon.jsii.JsiiSerializable
Example: 

 import software.amazon.awscdk.services.kms.*;
 Key myKmsKey = new Key(this, "myKMSKey");
 Bucket myBucket = Bucket.Builder.create(this, "mySSEKMSEncryptedBucket")
         .encryption(BucketEncryption.KMS)
         .encryptionKey(myKmsKey)
         .objectOwnership(ObjectOwnership.BUCKET_OWNER_ENFORCED)
         .build();
 Distribution.Builder.create(this, "myDist")
         .defaultBehavior(BehaviorOptions.builder()
                 .origin(S3BucketOrigin.withOriginAccessControl(myBucket))
                 .build())
         .build();

  • Method Details

    • getAccessControl

      @Stability(Stable) @Nullable default BucketAccessControl getAccessControl()
      Specifies a canned ACL that grants predefined permissions to the bucket.

      Default: BucketAccessControl.PRIVATE

    • getAutoDeleteObjects

      @Stability(Stable) @Nullable default Boolean getAutoDeleteObjects()
      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.

      Default: false

    • getBlockPublicAccess

      @Stability(Stable) @Nullable default BlockPublicAccess getBlockPublicAccess()
      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

      See Also:

    • getBucketKeyEnabled

      @Stability(Stable) @Nullable default Boolean getBucketKeyEnabled()
      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.

      Default: - false

    • getBucketName

      @Stability(Stable) @Nullable default String getBucketName()
      Physical name of this bucket.

      Default: - Assigned by CloudFormation (recommended).

    • getCors

      @Stability(Stable) @Nullable default List<CorsRule> getCors()
      The CORS configuration of this bucket.

      Default: - No CORS configuration.

      See Also:

    • getEncryption

      @Stability(Stable) @Nullable default BucketEncryption getEncryption()
      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.

      Default: - `KMS` if `encryptionKey` is specified, or `UNENCRYPTED` otherwise. But if `UNENCRYPTED` is specified, the bucket will be encrypted as `S3_MANAGED` automatically.

    • getEncryptionKey

      @Stability(Stable) @Nullable default IKey getEncryptionKey()
      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.

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

    • getEnforceSSL

      @Stability(Stable) @Nullable default Boolean getEnforceSSL()
      Enforces SSL for requests.

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

      Default: false

      See Also:

    • getEventBridgeEnabled

      @Stability(Stable) @Nullable default Boolean getEventBridgeEnabled()
      Whether this bucket should send notifications to Amazon EventBridge or not.

      Default: false

    • getIntelligentTieringConfigurations

      @Stability(Stable) @Nullable default List<IntelligentTieringConfiguration> getIntelligentTieringConfigurations()
      Inteligent Tiering Configurations.

      Default: No Intelligent Tiiering Configurations.

      See Also:

    • getInventories

      @Stability(Stable) @Nullable default List<Inventory> getInventories()
      The inventory configuration of the bucket.

      Default: - No inventory configuration

      See Also:

    • getLifecycleRules

      @Stability(Stable) @Nullable default List<LifecycleRule> getLifecycleRules()
      Rules that define how Amazon S3 manages objects during their lifetime.

      Default: - No lifecycle rules.

    • getMetrics

      @Stability(Stable) @Nullable default List<BucketMetrics> getMetrics()
      The metrics configuration of this bucket.

      Default: - No metrics configuration.

      See Also:

    • getMinimumTLSVersion

      @Stability(Stable) @Nullable default Number getMinimumTLSVersion()
      Enforces minimum TLS version for requests.

      Requires enforceSSL to be enabled.

      Default: No minimum TLS version is enforced.

      See Also:

    • getNotificationsHandlerRole

      @Stability(Stable) @Nullable default IRole getNotificationsHandlerRole()
      The role to be used by the notifications handler.

      Default: - a new role will be created.

    • getNotificationsSkipDestinationValidation

      @Stability(Stable) @Nullable default Boolean getNotificationsSkipDestinationValidation()
      Skips notification validation of Amazon SQS, Amazon SNS, and Lambda destinations.

      Default: false

    • getObjectLockDefaultRetention

      @Stability(Stable) @Nullable default ObjectLockRetention getObjectLockDefaultRetention()
      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.

      Default: no default retention period

      See Also:

    • getObjectLockEnabled

      @Stability(Stable) @Nullable default Boolean getObjectLockEnabled()
      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.

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

      See Also:

    • getObjectOwnership

      @Stability(Stable) @Nullable default ObjectOwnership getObjectOwnership()
      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.

      See Also:

    • getPublicReadAccess

      @Stability(Stable) @Nullable default Boolean getPublicReadAccess()
      Grants public read access to all objects in the bucket.

      Similar to calling bucket.grantPublicAccess()

      Default: false

    • getRemovalPolicy

      @Stability(Stable) @Nullable default RemovalPolicy getRemovalPolicy()
      Policy to apply when the bucket is removed from this stack.

      Default: - The bucket will be orphaned.

    • getServerAccessLogsBucket

      @Stability(Stable) @Nullable default IBucket getServerAccessLogsBucket()
      Destination bucket for the server access logs.

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

    • getServerAccessLogsPrefix

      @Stability(Stable) @Nullable default String getServerAccessLogsPrefix()
      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.

      Default: - No log file prefix

    • getTargetObjectKeyFormat

      @Stability(Stable) @Nullable default TargetObjectKeyFormat getTargetObjectKeyFormat()
      Optional key format for log objects.

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

    • getTransferAcceleration

      @Stability(Stable) @Nullable default Boolean getTransferAcceleration()
      Whether this bucket should have transfer acceleration turned on or not.

      Default: false

    • getTransitionDefaultMinimumObjectSize

      @Stability(Stable) @Nullable default TransitionDefaultMinimumObjectSize getTransitionDefaultMinimumObjectSize()
      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.

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

    • getVersioned

      @Stability(Stable) @Nullable default Boolean getVersioned()
      Whether this bucket should have versioning turned on or not.

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

    • getWebsiteErrorDocument

      @Stability(Stable) @Nullable default String getWebsiteErrorDocument()
      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.

    • getWebsiteIndexDocument

      @Stability(Stable) @Nullable default String getWebsiteIndexDocument()
      The name of the index document (e.g. "index.html") for the website. Enables static website hosting for this bucket.

      Default: - No index document.

    • getWebsiteRedirect

      @Stability(Stable) @Nullable default RedirectTarget getWebsiteRedirect()
      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".

      Default: - No redirection.

    • getWebsiteRoutingRules

      @Stability(Stable) @Nullable default List<RoutingRule> getWebsiteRoutingRules()
      Rules that define when a redirect is applied and the redirect behavior.

      Default: - No redirection rules.

    • builder

      @Stability(Stable) static BucketProps.Builder builder()
      Returns:
      a BucketProps.Builder of BucketProps