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.29.0 (build 41df200)",
           date="2021-06-02T09:55:36.286Z")
 @Stability(value=Experimental)
public interface BucketProps
extends software.amazon.jsii.JsiiSerializable

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

Modifier and Type	Method and Description
static BucketProps.Builder	builder()
default BucketAccessControl	getAccessControl() (experimental) Specifies a canned ACL that grants predefined permissions to the bucket.
default Boolean	getAutoDeleteObjects() (experimental) Whether all objects should be automatically deleted when the bucket is removed from the stack or when the stack is deleted.
default BlockPublicAccess	getBlockPublicAccess() (experimental) The block public access configuration of this bucket.
default Boolean	getBucketKeyEnabled() (experimental) 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() (experimental) Physical name of this bucket.
default List<CorsRule>	getCors() (experimental) The CORS configuration of this bucket.
default BucketEncryption	getEncryption() (experimental) The kind of server-side encryption to apply to this bucket.
default IKey	getEncryptionKey() (experimental) External KMS key to use for bucket encryption.
default Boolean	getEnforceSSL() (experimental) Enforces SSL for requests.
default List<Inventory>	getInventories() (experimental) The inventory configuration of the bucket.
default List<LifecycleRule>	getLifecycleRules() (experimental) Rules that define how Amazon S3 manages objects during their lifetime.
default List<BucketMetrics>	getMetrics() (experimental) The metrics configuration of this bucket.
default ObjectOwnership	getObjectOwnership() (experimental) The objectOwnership of the bucket.
default Boolean	getPublicReadAccess() (experimental) Grants public read access to all objects in the bucket.
default RemovalPolicy	getRemovalPolicy() (experimental) Policy to apply when the bucket is removed from this stack.
default IBucket	getServerAccessLogsBucket() (experimental) Destination bucket for the server access logs.
default String	getServerAccessLogsPrefix() (experimental) Optional log file prefix to use for the bucket's access logs.
default Boolean	getVersioned() (experimental) Whether this bucket should have versioning turned on or not.
default String	getWebsiteErrorDocument() (experimental) The name of the error document (e.g.
default String	getWebsiteIndexDocument() (experimental) The name of the index document (e.g.
default RedirectTarget	getWebsiteRedirect() (experimental) Specifies the redirect behavior of all requests to a website endpoint of a bucket.
default List<RoutingRule>	getWebsiteRoutingRules() (experimental) 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=Experimental)
 @Nullable
default BucketAccessControl getAccessControl()

(experimental) Specifies a canned ACL that grants predefined permissions to the bucket.

Default: BucketAccessControl.PRIVATE

getAutoDeleteObjects

@Stability(value=Experimental)
 @Nullable
default Boolean getAutoDeleteObjects()

(experimental) 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.

Default: false

getBlockPublicAccess

@Stability(value=Experimental)
 @Nullable
default BlockPublicAccess getBlockPublicAccess()

(experimental) 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=Experimental)
 @Nullable
default Boolean getBucketKeyEnabled()

(experimental) 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=Experimental)
 @Nullable
default String getBucketName()

(experimental) Physical name of this bucket.

Default: - Assigned by CloudFormation (recommended).

getCors

@Stability(value=Experimental)
 @Nullable
default List<CorsRule> getCors()

(experimental) 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=Experimental)
 @Nullable
default BucketEncryption getEncryption()

(experimental) 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=Experimental)
 @Nullable
default IKey getEncryptionKey()

(experimental) 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=Experimental)
 @Nullable
default Boolean getEnforceSSL()

(experimental) 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

getInventories

@Stability(value=Experimental)
 @Nullable
default List<Inventory> getInventories()

(experimental) 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=Experimental)
 @Nullable
default List<LifecycleRule> getLifecycleRules()

(experimental) Rules that define how Amazon S3 manages objects during their lifetime.

Default: - No lifecycle rules.

getMetrics

@Stability(value=Experimental)
 @Nullable
default List<BucketMetrics> getMetrics()

(experimental) 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

getObjectOwnership

@Stability(value=Experimental)
 @Nullable
default ObjectOwnership getObjectOwnership()

(experimental) 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=Experimental)
 @Nullable
default Boolean getPublicReadAccess()

(experimental) Grants public read access to all objects in the bucket.

Similar to calling bucket.grantPublicAccess()

Default: false

getRemovalPolicy

@Stability(value=Experimental)
 @Nullable
default RemovalPolicy getRemovalPolicy()

(experimental) Policy to apply when the bucket is removed from this stack.

Default: - The bucket will be orphaned.

getServerAccessLogsBucket

@Stability(value=Experimental)
 @Nullable
default IBucket getServerAccessLogsBucket()

(experimental) Destination bucket for the server access logs.

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

getServerAccessLogsPrefix

@Stability(value=Experimental)
 @Nullable
default String getServerAccessLogsPrefix()

(experimental) 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

getVersioned

@Stability(value=Experimental)
 @Nullable
default Boolean getVersioned()

(experimental) Whether this bucket should have versioning turned on or not.

Default: false

getWebsiteErrorDocument

@Stability(value=Experimental)
 @Nullable
default String getWebsiteErrorDocument()

(experimental) 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=Experimental)
 @Nullable
default String getWebsiteIndexDocument()

(experimental) 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=Experimental)
 @Nullable
default RedirectTarget getWebsiteRedirect()

(experimental) 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=Experimental)
 @Nullable
default List<RoutingRule> getWebsiteRoutingRules()

(experimental) Rules that define when a redirect is applied and the redirect behavior.

Default: - No redirection rules.

builder

@Stability(value=Experimental)
static BucketProps.Builder builder()

Returns:

a BucketProps.Builder of BucketProps