BucketProps (software.amazon.awscdk:aws-cdk-lib 2.42.1 API)

All Superinterfaces:: software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:: BucketProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:41.736Z")
 @Stability(value=Stable)
public interface BucketProps
extends software.amazon.jsii.JsiiSerializable

Example:

 // Example automatically generated from non-compiling source. May contain errors.
 Bucket sourceBucket = Bucket.Builder.create(this, "MyBucket")
         .versioned(true)
         .build();
 Pipeline pipeline = new Pipeline(this, "MyPipeline");
 Artifact sourceOutput = new Artifact();
 S3SourceAction sourceAction = S3SourceAction.Builder.create()
         .actionName("S3Source")
         .bucket(sourceBucket)
         .bucketKey("path/to/file.zip")
         .output(sourceOutput)
         .build();
 pipeline.addStage(StageOptions.builder()
         .stageName("Source")
         .actions(List.of(sourceAction))
         .build());

Nested Class Summary

Nested Classes
Modifier and Type	Interface and Description
`static class`	`BucketProps.Builder` A builder for `BucketProps`
`static class`	`BucketProps.Jsii$Proxy` An implementation for `BucketProps`

Method Summary

All Methods Static Methods Instance Methods Default Methods
Modifier and Type	Method and Description
`static BucketProps.Builder`	`builder()`
`default BucketAccessControl`	`getAccessControl()` Specifies a canned ACL that grants predefined permissions to the bucket.
`default Boolean`	`getAutoDeleteObjects()` Whether all objects should be automatically deleted when the bucket is removed from the stack or when the stack is deleted.
`default BlockPublicAccess`	`getBlockPublicAccess()` The block public access configuration of this bucket.
`default Boolean`	`getBucketKeyEnabled()` Specifies whether Amazon S3 should use an S3 Bucket Key with server-side encryption using KMS (SSE-KMS) for new objects in the bucket.
`default String`	`getBucketName()` Physical name of this bucket.
`default List<CorsRule>`	`getCors()` The CORS configuration of this bucket.
`default BucketEncryption`	`getEncryption()` The kind of server-side encryption to apply to this bucket.
`default IKey`	`getEncryptionKey()` External KMS key to use for bucket encryption.
`default Boolean`	`getEnforceSSL()` Enforces SSL for requests.
`default Boolean`	`getEventBridgeEnabled()` Whether this bucket should send notifications to Amazon EventBridge or not.
`default List<IntelligentTieringConfiguration>`	`getIntelligentTieringConfigurations()` Inteligent Tiering Configurations.
`default List<Inventory>`	`getInventories()` The inventory configuration of the bucket.
`default List<LifecycleRule>`	`getLifecycleRules()` Rules that define how Amazon S3 manages objects during their lifetime.
`default List<BucketMetrics>`	`getMetrics()` The metrics configuration of this bucket.
`default IRole`	`getNotificationsHandlerRole()` The role to be used by the notifications handler.
`default ObjectOwnership`	`getObjectOwnership()` The objectOwnership of the bucket.
`default Boolean`	`getPublicReadAccess()` Grants public read access to all objects in the bucket.
`default RemovalPolicy`	`getRemovalPolicy()` Policy to apply when the bucket is removed from this stack.
`default IBucket`	`getServerAccessLogsBucket()` Destination bucket for the server access logs.
`default String`	`getServerAccessLogsPrefix()` Optional log file prefix to use for the bucket's access logs.
`default Boolean`	`getTransferAcceleration()` Whether this bucket should have transfer acceleration turned on or not.
`default Boolean`	`getVersioned()` Whether this bucket should have versioning turned on or not.
`default String`	`getWebsiteErrorDocument()` The name of the error document (e.g.
`default String`	`getWebsiteIndexDocument()` The name of the index document (e.g.
`default RedirectTarget`	`getWebsiteRedirect()` Specifies the redirect behavior of all requests to a website endpoint of a bucket.
`default List<RoutingRule>`	`getWebsiteRoutingRules()` Rules that define when a redirect is applied and the redirect behavior.

Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson

- Method Detail
  - getAccessControl
```
@Stability(value=Stable)
 @Nullable
default BucketAccessControl getAccessControl()
```
    Specifies a canned ACL that grants predefined permissions to the bucket.
    Default: BucketAccessControl.PRIVATE
  - getAutoDeleteObjects
```
@Stability(value=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.
    Default: false
  - getBlockPublicAccess
```
@Stability(value=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:
    
    https://docs.aws.amazon.com/AmazonS3/latest/dev/access-control-block-public-access.html
  - getBucketKeyEnabled
```
@Stability(value=Stable)
 @Nullable
default Boolean getBucketKeyEnabled()
```
    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
  - getBucketName
```
@Stability(value=Stable)
 @Nullable
default String getBucketName()
```
    Physical name of this bucket.
    Default: - Assigned by CloudFormation (recommended).
  - getCors
```
@Stability(value=Stable)
 @Nullable
default List<CorsRule> getCors()
```
    The CORS configuration of this bucket.
    Default: - No CORS configuration.
    
    See Also:
    
    https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-cors.html
  - getEncryption
```
@Stability(value=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.
  - getEncryptionKey
```
@Stability(value=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". 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.
  - getEnforceSSL
```
@Stability(value=Stable)
 @Nullable
default Boolean getEnforceSSL()
```
    Enforces SSL for requests.
    S3.5 of the AWS Foundational Security Best Practices Regarding S3.
    Default: false
    
    See Also:
    
    https://docs.aws.amazon.com/config/latest/developerguide/s3-bucket-ssl-requests-only.html
  - getEventBridgeEnabled
```
@Stability(value=Stable)
 @Nullable
default Boolean getEventBridgeEnabled()
```
    Whether this bucket should send notifications to Amazon EventBridge or not.
    Default: false
  - getIntelligentTieringConfigurations
```
@Stability(value=Stable)
 @Nullable
default List<IntelligentTieringConfiguration> getIntelligentTieringConfigurations()
```
    Inteligent Tiering Configurations.
    Default: No Intelligent Tiiering Configurations.
    
    See Also:
    
    https://docs.aws.amazon.com/AmazonS3/latest/userguide/intelligent-tiering.html
  - getInventories
```
@Stability(value=Stable)
 @Nullable
default List<Inventory> getInventories()
```
    The inventory configuration of the bucket.
    Default: - No inventory configuration
    
    See Also:
    
    https://docs.aws.amazon.com/AmazonS3/latest/dev/storage-inventory.html
  - getLifecycleRules
```
@Stability(value=Stable)
 @Nullable
default List<LifecycleRule> getLifecycleRules()
```
    Rules that define how Amazon S3 manages objects during their lifetime.
    Default: - No lifecycle rules.
  - getMetrics
```
@Stability(value=Stable)
 @Nullable
default List<BucketMetrics> getMetrics()
```
    The metrics configuration of this bucket.
    Default: - No metrics configuration.
    
    See Also:
    
    https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-metricsconfiguration.html
  - getNotificationsHandlerRole
```
@Stability(value=Stable)
 @Nullable
default IRole getNotificationsHandlerRole()
```
    The role to be used by the notifications handler.
    Default: - a new role will be created.
  - getObjectOwnership
```
@Stability(value=Stable)
 @Nullable
default ObjectOwnership getObjectOwnership()
```
    The objectOwnership of the bucket.
    Default: - No ObjectOwnership configuration, uploading account will own the object.
    
    See Also:
    
    https://docs.aws.amazon.com/AmazonS3/latest/dev/about-object-ownership.html
  - getPublicReadAccess
```
@Stability(value=Stable)
 @Nullable
default Boolean getPublicReadAccess()
```
    Grants public read access to all objects in the bucket.
    Similar to calling bucket.grantPublicAccess()
    Default: false
  - getRemovalPolicy
```
@Stability(value=Stable)
 @Nullable
default RemovalPolicy getRemovalPolicy()
```
    Policy to apply when the bucket is removed from this stack.
    Default: - The bucket will be orphaned.
  - getServerAccessLogsBucket
```
@Stability(value=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(value=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
  - getTransferAcceleration
```
@Stability(value=Stable)
 @Nullable
default Boolean getTransferAcceleration()
```
    Whether this bucket should have transfer acceleration turned on or not.
    Default: false
  - getVersioned
```
@Stability(value=Stable)
 @Nullable
default Boolean getVersioned()
```
    Whether this bucket should have versioning turned on or not.
    Default: false
  - getWebsiteErrorDocument
```
@Stability(value=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(value=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(value=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(value=Stable)
 @Nullable
default List<RoutingRule> getWebsiteRoutingRules()
```
    Rules that define when a redirect is applied and the redirect behavior.
    Default: - No redirection rules.
  - builder
```
@Stability(value=Stable)
static BucketProps.Builder builder()
```
    Returns:
    
    a BucketProps.Builder of BucketProps

Interface BucketProps

Nested Class Summary

Method Summary

Methods inherited from interface software.amazon.jsii.JsiiSerializable

Method Detail

getAccessControl

getAutoDeleteObjects

getBlockPublicAccess

getBucketKeyEnabled

getBucketName

getCors

getEncryption

getEncryptionKey

getEnforceSSL

getEventBridgeEnabled

getIntelligentTieringConfigurations

getInventories

getLifecycleRules

getMetrics

getNotificationsHandlerRole

getObjectOwnership

getPublicReadAccess

getRemovalPolicy

getServerAccessLogsBucket

getServerAccessLogsPrefix

getTransferAcceleration

getVersioned

getWebsiteErrorDocument

getWebsiteIndexDocument

getWebsiteRedirect

getWebsiteRoutingRules

builder