Interface CfnBucketProps

All Superinterfaces:
All Known Implementing Classes:

@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)", date="2023-06-19T16:30:37.616Z") @Stability(Stable) public interface CfnBucketProps extends
Properties for defining a CfnBucket.


 CfnBucket rawBucket = CfnBucket.Builder.create(this, "Bucket").build();
 // -or-
 CfnBucket rawBucketAlt = (CfnBucket)myBucket.getNode().getDefaultChild();
 // then
 rawBucket.getCfnOptions().getCondition() = CfnCondition.Builder.create(this, "EnableBucket").build();
 rawBucket.getCfnOptions().getMetadata() = Map.of(
         "metadataKey", "MetadataValue");
  • Method Details

    • getAccelerateConfiguration

      @Stability(Stable) @Nullable default Object getAccelerateConfiguration()
      Configures the transfer acceleration state for an Amazon S3 bucket.

      For more information, see Amazon S3 Transfer Acceleration in the Amazon S3 User Guide .

    • getAccessControl

      @Stability(Stable) @Nullable default String getAccessControl()
      A canned access control list (ACL) that grants predefined permissions to the bucket.

      For more information about canned ACLs, see Canned ACL in the Amazon S3 User Guide .

      Be aware that the syntax for this property differs from the information provided in the Amazon S3 User Guide . The AccessControl property is case-sensitive and must be one of the following values: Private, PublicRead, PublicReadWrite, AuthenticatedRead, LogDeliveryWrite, BucketOwnerRead, BucketOwnerFullControl, or AwsExecRead.

    • getAnalyticsConfigurations

      @Stability(Stable) @Nullable default Object getAnalyticsConfigurations()
      Specifies the configuration and any analyses for the analytics filter of an Amazon S3 bucket.
    • getBucketEncryption

      @Stability(Stable) @Nullable default Object getBucketEncryption()
      Specifies default encryption for a bucket using server-side encryption with Amazon S3-managed keys (SSE-S3) or AWS KMS-managed keys (SSE-KMS) bucket.

      For information about the Amazon S3 default encryption feature, see Amazon S3 Default Encryption for S3 Buckets in the Amazon S3 User Guide .

    • getBucketName

      @Stability(Stable) @Nullable default String getBucketName()
      A name for the bucket.

      If you don't specify a name, AWS CloudFormation generates a unique ID and uses that ID for the bucket name. The bucket name must contain only lowercase letters, numbers, periods (.), and dashes (-) and must follow Amazon S3 bucket restrictions and limitations . For more information, see Rules for naming Amazon S3 buckets in the Amazon S3 User Guide .

      If you specify a name, you can't perform updates that require replacement of this resource. You can perform updates that require no or some interruption. If you need to replace the resource, specify a new name.

    • getCorsConfiguration

      @Stability(Stable) @Nullable default Object getCorsConfiguration()
      Describes the cross-origin access configuration for objects in an Amazon S3 bucket.

      For more information, see Enabling Cross-Origin Resource Sharing in the Amazon S3 User Guide .

    • getIntelligentTieringConfigurations

      @Stability(Stable) @Nullable default Object getIntelligentTieringConfigurations()
      Defines how Amazon S3 handles Intelligent-Tiering storage.
    • getInventoryConfigurations

      @Stability(Stable) @Nullable default Object getInventoryConfigurations()
      Specifies the inventory configuration for an Amazon S3 bucket.

      For more information, see GET Bucket inventory in the Amazon S3 API Reference .

    • getLifecycleConfiguration

      @Stability(Stable) @Nullable default Object getLifecycleConfiguration()
      Specifies the lifecycle configuration for objects in an Amazon S3 bucket.

      For more information, see Object Lifecycle Management in the Amazon S3 User Guide .

    • getLoggingConfiguration

      @Stability(Stable) @Nullable default Object getLoggingConfiguration()
      Settings that define where logs are stored.
    • getMetricsConfigurations

      @Stability(Stable) @Nullable default Object getMetricsConfigurations()
      Specifies a metrics configuration for the CloudWatch request metrics (specified by the metrics configuration ID) from an Amazon S3 bucket.

      If you're updating an existing metrics configuration, note that this is a full replacement of the existing metrics configuration. If you don't include the elements you want to keep, they are erased. For more information, see PutBucketMetricsConfiguration .

    • getNotificationConfiguration

      @Stability(Stable) @Nullable default Object getNotificationConfiguration()
      Configuration that defines how Amazon S3 handles bucket notifications.
    • getObjectLockConfiguration

      @Stability(Stable) @Nullable default Object getObjectLockConfiguration()
      Places an Object Lock configuration on the specified bucket.

      The rule specified in the Object Lock configuration will be applied by default to every new object placed in the specified bucket. For more information, see Locking Objects .

      • The DefaultRetention settings require both a mode and a period.
      • The DefaultRetention period can be either Days or Years but you must select one. You cannot specify Days and Years at the same time.
      • You can only enable Object Lock for new buckets. If you want to turn on Object Lock for an existing bucket, contact AWS Support.

    • getObjectLockEnabled

      @Stability(Stable) @Nullable default Object getObjectLockEnabled()
      Indicates whether this bucket has an Object Lock configuration enabled.

      Enable ObjectLockEnabled when you apply ObjectLockConfiguration to a bucket.

    • getOwnershipControls

      @Stability(Stable) @Nullable default Object getOwnershipControls()
      Configuration that defines how Amazon S3 handles Object Ownership rules.
    • getPublicAccessBlockConfiguration

      @Stability(Stable) @Nullable default Object getPublicAccessBlockConfiguration()
      Configuration that defines how Amazon S3 handles public access.
    • getReplicationConfiguration

      @Stability(Stable) @Nullable default Object getReplicationConfiguration()
      Configuration for replicating objects in an S3 bucket.

      To enable replication, you must also enable versioning by using the VersioningConfiguration property.

      Amazon S3 can store replicated objects in a single destination bucket or multiple destination buckets. The destination bucket or buckets must already exist.

    • getTags

      @Stability(Stable) @Nullable default List<CfnTag> getTags()
      An arbitrary set of tags (key-value pairs) for this S3 bucket.
    • getVersioningConfiguration

      @Stability(Stable) @Nullable default Object getVersioningConfiguration()
      Enables multiple versions of all objects in this bucket.

      You might enable versioning to prevent objects from being deleted or overwritten by mistake or to archive objects so that you can retrieve previous versions of them.

    • getWebsiteConfiguration

      @Stability(Stable) @Nullable default Object getWebsiteConfiguration()
      Information used to configure the bucket as a static website.

      For more information, see Hosting Websites on Amazon S3 .

    • builder

      @Stability(Stable) static CfnBucketProps.Builder builder()
      a CfnBucketProps.Builder of CfnBucketProps