Bucket.Builder

java.lang.Object
- software.amazon.awscdk.services.s3.Bucket.Builder

Enclosing class:: Bucket

public static final class Bucket.Builder
extends java.lang.Object

A fluent builder for Bucket.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Bucket.Builder`	`accessControl(BucketAccessControl accessControl)` Specifies a canned ACL that grants predefined permissions to the bucket.
`Bucket.Builder`	`autoDeleteObjects(java.lang.Boolean autoDeleteObjects)` Whether all objects should be automatically deleted when the bucket is removed from the stack or when the stack is deleted.
`Bucket.Builder`	`blockPublicAccess(BlockPublicAccess blockPublicAccess)` The block public access configuration of this bucket.
`Bucket.Builder`	`bucketKeyEnabled(java.lang.Boolean bucketKeyEnabled)` Specifies whether Amazon S3 should use an S3 Bucket Key with server-side encryption using KMS (SSE-KMS) for new objects in the bucket.
`Bucket.Builder`	`bucketName(java.lang.String bucketName)` Physical name of this bucket.
`Bucket`	`build()`
`Bucket.Builder`	`cors(java.util.List<? extends CorsRule> cors)` The CORS configuration of this bucket.
`static Bucket.Builder`	`create(software.constructs.Construct scope, java.lang.String id)`
`Bucket.Builder`	`encryption(BucketEncryption encryption)` The kind of server-side encryption to apply to this bucket.
`Bucket.Builder`	`encryptionKey(IKey encryptionKey)` External KMS key to use for bucket encryption.
`Bucket.Builder`	`enforceSsl(java.lang.Boolean enforceSsl)` Enforces SSL for requests.
`Bucket.Builder`	`eventBridgeEnabled(java.lang.Boolean eventBridgeEnabled)` Whether this bucket should send notifications to Amazon EventBridge or not.
`Bucket.Builder`	`intelligentTieringConfigurations(java.util.List<? extends IntelligentTieringConfiguration> intelligentTieringConfigurations)` Inteligent Tiering Configurations.
`Bucket.Builder`	`inventories(java.util.List<? extends Inventory> inventories)` The inventory configuration of the bucket.
`Bucket.Builder`	`lifecycleRules(java.util.List<? extends LifecycleRule> lifecycleRules)` Rules that define how Amazon S3 manages objects during their lifetime.
`Bucket.Builder`	`metrics(java.util.List<? extends BucketMetrics> metrics)` The metrics configuration of this bucket.
`Bucket.Builder`	`notificationsHandlerRole(IRole notificationsHandlerRole)` The role to be used by the notifications handler.
`Bucket.Builder`	`objectOwnership(ObjectOwnership objectOwnership)` The objectOwnership of the bucket.
`Bucket.Builder`	`publicReadAccess(java.lang.Boolean publicReadAccess)` Grants public read access to all objects in the bucket.
`Bucket.Builder`	`removalPolicy(RemovalPolicy removalPolicy)` Policy to apply when the bucket is removed from this stack.
`Bucket.Builder`	`serverAccessLogsBucket(IBucket serverAccessLogsBucket)` Destination bucket for the server access logs.
`Bucket.Builder`	`serverAccessLogsPrefix(java.lang.String serverAccessLogsPrefix)` Optional log file prefix to use for the bucket's access logs.
`Bucket.Builder`	`transferAcceleration(java.lang.Boolean transferAcceleration)` Whether this bucket should have transfer acceleration turned on or not.
`Bucket.Builder`	`versioned(java.lang.Boolean versioned)` Whether this bucket should have versioning turned on or not.
`Bucket.Builder`	`websiteErrorDocument(java.lang.String websiteErrorDocument)` The name of the error document (e.g.
`Bucket.Builder`	`websiteIndexDocument(java.lang.String websiteIndexDocument)` The name of the index document (e.g.
`Bucket.Builder`	`websiteRedirect(RedirectTarget websiteRedirect)` Specifies the redirect behavior of all requests to a website endpoint of a bucket.
`Bucket.Builder`	`websiteRoutingRules(java.util.List<? extends RoutingRule> websiteRoutingRules)` Rules that define when a redirect is applied and the redirect behavior.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Method Detail
  - create
```
public static Bucket.Builder create(software.constructs.Construct scope,
                                    java.lang.String id)
```
    Parameters:
    
    scope - This parameter is required.
    
    id - This parameter is required.
    
    Returns:
    
    a new instance of Bucket.Builder.
  - accessControl
```
public Bucket.Builder accessControl(BucketAccessControl accessControl)
```
    Specifies a canned ACL that grants predefined permissions to the bucket.
    Default: BucketAccessControl.PRIVATE
    
    Parameters:
    
    accessControl - Specifies a canned ACL that grants predefined permissions to the bucket. This parameter is required.
    
    Returns:
    
    this
  - autoDeleteObjects
```
public Bucket.Builder autoDeleteObjects(java.lang.Boolean autoDeleteObjects)
```
    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.
    Default: false
    
    Parameters:
    
    autoDeleteObjects - Whether all objects should be automatically deleted when the bucket is removed from the stack or when the stack is deleted. This parameter is required.
    
    Returns:
    
    this
  - blockPublicAccess
```
public Bucket.Builder blockPublicAccess(BlockPublicAccess blockPublicAccess)
```
    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
    
    Parameters:
    
    blockPublicAccess - The block public access configuration of this bucket. This parameter is required.
    
    Returns:
    
    this
    
    See Also:
    
    https://docs.aws.amazon.com/AmazonS3/latest/dev/access-control-block-public-access.html
  - bucketKeyEnabled
```
public Bucket.Builder bucketKeyEnabled(java.lang.Boolean bucketKeyEnabled)
```
    Specifies whether Amazon S3 should use an S3 Bucket Key with server-side encryption using KMS (SSE-KMS) for new objects in the bucket.
    Only relevant, when Encryption is set to {@link BucketEncryption.KMS}
    Default: - false
    
    Parameters:
    
    bucketKeyEnabled - Specifies whether Amazon S3 should use an S3 Bucket Key with server-side encryption using KMS (SSE-KMS) for new objects in the bucket. This parameter is required.
    
    Returns:
    
    this
  - bucketName
```
public Bucket.Builder bucketName(java.lang.String bucketName)
```
    Physical name of this bucket.
    Default: - Assigned by CloudFormation (recommended).
    
    Parameters:
    
    bucketName - Physical name of this bucket. This parameter is required.
    
    Returns:
    
    this
  - cors
```
public Bucket.Builder cors(java.util.List<? extends CorsRule> cors)
```
    The CORS configuration of this bucket.
    Default: - No CORS configuration.
    
    Parameters:
    
    cors - The CORS configuration of this bucket. This parameter is required.
    
    Returns:
    
    this
    
    See Also:
    
    https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-cors.html
  - encryption
```
public Bucket.Builder encryption(BucketEncryption encryption)
```
    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.
    
    Parameters:
    
    encryption - The kind of server-side encryption to apply to this bucket. This parameter is required.
    
    Returns:
    
    this
  - encryptionKey
```
public Bucket.Builder encryptionKey(IKey encryptionKey)
```
    External KMS key to use for bucket encryption.
    The 'encryption' property must be either not specified or set to "Kms". An error will be emitted if encryption is set to "Unencrypted" or "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.
    
    Parameters:
    
    encryptionKey - External KMS key to use for bucket encryption. This parameter is required.
    
    Returns:
    
    this
  - enforceSsl
```
public Bucket.Builder enforceSsl(java.lang.Boolean enforceSsl)
```
    Enforces SSL for requests.
    S3.5 of the AWS Foundational Security Best Practices Regarding S3.
    Default: false
    
    Parameters:
    
    enforceSsl - Enforces SSL for requests. This parameter is required.
    
    Returns:
    
    this
    
    See Also:
    
    https://docs.aws.amazon.com/config/latest/developerguide/s3-bucket-ssl-requests-only.html
  - eventBridgeEnabled
```
public Bucket.Builder eventBridgeEnabled(java.lang.Boolean eventBridgeEnabled)
```
    Whether this bucket should send notifications to Amazon EventBridge or not.
    Default: false
    
    Parameters:
    
    eventBridgeEnabled - Whether this bucket should send notifications to Amazon EventBridge or not. This parameter is required.
    
    Returns:
    
    this
  - intelligentTieringConfigurations
```
public Bucket.Builder intelligentTieringConfigurations(java.util.List<? extends IntelligentTieringConfiguration> intelligentTieringConfigurations)
```
    Inteligent Tiering Configurations.
    Default: No Intelligent Tiiering Configurations.
    
    Parameters:
    
    intelligentTieringConfigurations - Inteligent Tiering Configurations. This parameter is required.
    
    Returns:
    
    this
    
    See Also:
    
    https://docs.aws.amazon.com/AmazonS3/latest/userguide/intelligent-tiering.html
  - inventories
```
public Bucket.Builder inventories(java.util.List<? extends Inventory> inventories)
```
    The inventory configuration of the bucket.
    Default: - No inventory configuration
    
    Parameters:
    
    inventories - The inventory configuration of the bucket. This parameter is required.
    
    Returns:
    
    this
    
    See Also:
    
    https://docs.aws.amazon.com/AmazonS3/latest/dev/storage-inventory.html
  - lifecycleRules
```
public Bucket.Builder lifecycleRules(java.util.List<? extends LifecycleRule> lifecycleRules)
```
    Rules that define how Amazon S3 manages objects during their lifetime.
    Default: - No lifecycle rules.
    
    Parameters:
    
    lifecycleRules - Rules that define how Amazon S3 manages objects during their lifetime. This parameter is required.
    
    Returns:
    
    this
  - metrics
```
public Bucket.Builder metrics(java.util.List<? extends BucketMetrics> metrics)
```
    The metrics configuration of this bucket.
    Default: - No metrics configuration.
    
    Parameters:
    
    metrics - The metrics configuration of this bucket. This parameter is required.
    
    Returns:
    
    this
    
    See Also:
    
    https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-metricsconfiguration.html
  - notificationsHandlerRole
```
public Bucket.Builder notificationsHandlerRole(IRole notificationsHandlerRole)
```
    The role to be used by the notifications handler.
    Default: - a new role will be created.
    
    Parameters:
    
    notificationsHandlerRole - The role to be used by the notifications handler. This parameter is required.
    
    Returns:
    
    this
  - objectOwnership
```
public Bucket.Builder objectOwnership(ObjectOwnership objectOwnership)
```
    The objectOwnership of the bucket.
    Default: - No ObjectOwnership configuration, uploading account will own the object.
    
    Parameters:
    
    objectOwnership - The objectOwnership of the bucket. This parameter is required.
    
    Returns:
    
    this
    
    See Also:
    
    https://docs.aws.amazon.com/AmazonS3/latest/dev/about-object-ownership.html
  - publicReadAccess
```
public Bucket.Builder publicReadAccess(java.lang.Boolean publicReadAccess)
```
    Grants public read access to all objects in the bucket.
    Similar to calling bucket.grantPublicAccess()
    Default: false
    
    Parameters:
    
    publicReadAccess - Grants public read access to all objects in the bucket. This parameter is required.
    
    Returns:
    
    this
  - removalPolicy
```
public Bucket.Builder removalPolicy(RemovalPolicy removalPolicy)
```
    Policy to apply when the bucket is removed from this stack.
    Default: - The bucket will be orphaned.
    
    Parameters:
    
    removalPolicy - Policy to apply when the bucket is removed from this stack. This parameter is required.
    
    Returns:
    
    this
  - serverAccessLogsBucket
```
public Bucket.Builder serverAccessLogsBucket(IBucket serverAccessLogsBucket)
```
    Destination bucket for the server access logs.
    Default: - If "serverAccessLogsPrefix" undefined - access logs disabled, otherwise - log to current bucket.
    
    Parameters:
    
    serverAccessLogsBucket - Destination bucket for the server access logs. This parameter is required.
    
    Returns:
    
    this
  - serverAccessLogsPrefix
```
public Bucket.Builder serverAccessLogsPrefix(java.lang.String serverAccessLogsPrefix)
```
    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
    
    Parameters:
    
    serverAccessLogsPrefix - Optional log file prefix to use for the bucket's access logs. This parameter is required.
    
    Returns:
    
    this
  - transferAcceleration
```
public Bucket.Builder transferAcceleration(java.lang.Boolean transferAcceleration)
```
    Whether this bucket should have transfer acceleration turned on or not.
    Default: false
    
    Parameters:
    
    transferAcceleration - Whether this bucket should have transfer acceleration turned on or not. This parameter is required.
    
    Returns:
    
    this
  - versioned
```
public Bucket.Builder versioned(java.lang.Boolean versioned)
```
    Whether this bucket should have versioning turned on or not.
    Default: false
    
    Parameters:
    
    versioned - Whether this bucket should have versioning turned on or not. This parameter is required.
    
    Returns:
    
    this
  - websiteErrorDocument
```
public Bucket.Builder websiteErrorDocument(java.lang.String websiteErrorDocument)
```
    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.
    
    Parameters:
    
    websiteErrorDocument - The name of the error document (e.g. "404.html") for the website. `websiteIndexDocument` must also be set if this is set. This parameter is required.
    
    Returns:
    
    this
  - websiteIndexDocument
```
public Bucket.Builder websiteIndexDocument(java.lang.String websiteIndexDocument)
```
    The name of the index document (e.g. "index.html") for the website. Enables static website hosting for this bucket.
    Default: - No index document.
    
    Parameters:
    
    websiteIndexDocument - The name of the index document (e.g. "index.html") for the website. Enables static website hosting for this bucket. This parameter is required.
    
    Returns:
    
    this
  - websiteRedirect
```
public Bucket.Builder websiteRedirect(RedirectTarget websiteRedirect)
```
    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.
    
    Parameters:
    
    websiteRedirect - Specifies the redirect behavior of all requests to a website endpoint of a bucket. This parameter is required.
    
    Returns:
    
    this
  - websiteRoutingRules
```
public Bucket.Builder websiteRoutingRules(java.util.List<? extends RoutingRule> websiteRoutingRules)
```
    Rules that define when a redirect is applied and the redirect behavior.
    Default: - No redirection rules.
    
    Parameters:
    
    websiteRoutingRules - Rules that define when a redirect is applied and the redirect behavior. This parameter is required.
    
    Returns:
    
    this
  - build
```
public Bucket build()
```

Class Bucket.Builder

Method Summary

Methods inherited from class java.lang.Object

Method Detail

create

accessControl

autoDeleteObjects

blockPublicAccess

bucketKeyEnabled

bucketName

cors

encryption

encryptionKey

enforceSsl

eventBridgeEnabled

intelligentTieringConfigurations

inventories

lifecycleRules

metrics

notificationsHandlerRole

objectOwnership

publicReadAccess

removalPolicy

serverAccessLogsBucket

serverAccessLogsPrefix

transferAcceleration

versioned

websiteErrorDocument

websiteIndexDocument

websiteRedirect

websiteRoutingRules

build