Package software.amazon.awscdk.services.s3

Class BucketProps.Jsii$Proxy

java.lang.Object

software.amazon.jsii.JsiiObject

software.amazon.awscdk.services.s3.BucketProps.Jsii$Proxy

All Implemented Interfaces:

BucketProps, software.amazon.jsii.JsiiSerializable

Enclosing interface:

BucketProps

@Stability(Stable)
@Internal
public static final class BucketProps.Jsii$Proxy
extends software.amazon.jsii.JsiiObject
implements BucketProps

An implementation for BucketProps

Nested Class Summary

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.amazon.awscdk.services.s3.BucketProps

BucketProps.Builder, BucketProps.Jsii$Proxy

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	Jsii$Proxy(BucketProps.Builder builder)	Constructor that initializes the object based on literal property values passed by the BucketProps.Builder.
protected	Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef)	Constructor that initializes the object based on values retrieved from the JsiiObject.

Method Summary

Modifier and Type	Method	Description
com.fasterxml.jackson.databind.JsonNode	$jsii$toJson()
final boolean	equals(Object o)
final BucketAccessControl	getAccessControl()	Specifies a canned ACL that grants predefined permissions to the bucket.
final Boolean	getAutoDeleteObjects()	Whether all objects should be automatically deleted when the bucket is removed from the stack or when the stack is deleted.
final BlockPublicAccess	getBlockPublicAccess()	The block public access configuration of this bucket.
final Boolean	getBucketKeyEnabled()	Whether Amazon S3 should use its own intermediary key to generate data keys.
final String	getBucketName()	Physical name of this bucket.
final List<CorsRule>	getCors()	The CORS configuration of this bucket.
final BucketEncryption	getEncryption()	The kind of server-side encryption to apply to this bucket.
final IKey	getEncryptionKey()	External KMS key to use for bucket encryption.
final Boolean	getEnforceSSL()	Enforces SSL for requests.
final Boolean	getEventBridgeEnabled()	Whether this bucket should send notifications to Amazon EventBridge or not.
final List<IntelligentTieringConfiguration>	getIntelligentTieringConfigurations()	Intelligent Tiering Configurations.
final List<Inventory>	getInventories()	The inventory configuration of the bucket.
final List<LifecycleRule>	getLifecycleRules()	Rules that define how Amazon S3 manages objects during their lifetime.
final List<BucketMetrics>	getMetrics()	The metrics configuration of this bucket.
final Number	getMinimumTLSVersion()	Enforces minimum TLS version for requests.
final IRole	getNotificationsHandlerRole()	The role to be used by the notifications handler.
final Boolean	getNotificationsSkipDestinationValidation()	Skips notification validation of Amazon SQS, Amazon SNS, and Lambda destinations.
final ObjectLockRetention	getObjectLockDefaultRetention()	The default retention mode and rules for S3 Object Lock.
final Boolean	getObjectLockEnabled()	Enable object lock on the bucket.
final ObjectOwnership	getObjectOwnership()	The objectOwnership of the bucket.
final Boolean	getPublicReadAccess()	Grants public read access to all objects in the bucket.
final RemovalPolicy	getRemovalPolicy()	Policy to apply when the bucket is removed from this stack.
final IRole	getReplicationRole()	The role to be used by the replication.
final List<ReplicationRule>	getReplicationRules()	A container for one or more replication rules.
final IBucket	getServerAccessLogsBucket()	Destination bucket for the server access logs.
final String	getServerAccessLogsPrefix()	Optional log file prefix to use for the bucket's access logs.
final TargetObjectKeyFormat	getTargetObjectKeyFormat()	Optional key format for log objects.
final Boolean	getTransferAcceleration()	Whether this bucket should have transfer acceleration turned on or not.
final TransitionDefaultMinimumObjectSize	getTransitionDefaultMinimumObjectSize()	Indicates which default minimum object size behavior is applied to the lifecycle configuration.
final Boolean	getVersioned()	Whether this bucket should have versioning turned on or not.
final String	getWebsiteErrorDocument()	The name of the error document (e.g.
final String	getWebsiteIndexDocument()	The name of the index document (e.g.
final RedirectTarget	getWebsiteRedirect()	Specifies the redirect behavior of all requests to a website endpoint of a bucket.
final List<RoutingRule>	getWebsiteRoutingRules()	Rules that define when a redirect is applied and the redirect behavior.
final int	hashCode()

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Details

Jsii$Proxy

protected Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef)

Constructor that initializes the object based on values retrieved from the JsiiObject.

Parameters:

objRef - Reference to the JSII managed object.

Jsii$Proxy

protected Jsii$Proxy(BucketProps.Builder builder)

Constructor that initializes the object based on literal property values passed by the BucketProps.Builder.

Method Details

getAccessControl

public final BucketAccessControl getAccessControl()

Description copied from interface: BucketProps

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

Default: BucketAccessControl.PRIVATE

Specified by:

getAccessControl in interface BucketProps

getAutoDeleteObjects

public final Boolean getAutoDeleteObjects()

Description copied from interface: BucketProps

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

Specified by:

getAutoDeleteObjects in interface BucketProps

getBlockPublicAccess

public final BlockPublicAccess getBlockPublicAccess()

Description copied from interface: BucketProps

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

Specified by:

getBlockPublicAccess in interface BucketProps

See Also:

• https://docs.aws.amazon.com/AmazonS3/latest/dev/access-control-block-public-access.html

getBucketKeyEnabled

public final Boolean getBucketKeyEnabled()

Description copied from interface: BucketProps

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

Specified by:

getBucketKeyEnabled in interface BucketProps

getBucketName

public final String getBucketName()

Description copied from interface: BucketProps

Physical name of this bucket.

Default: - Assigned by CloudFormation (recommended).

Specified by:

getBucketName in interface BucketProps

getCors

public final List<CorsRule> getCors()

Description copied from interface: BucketProps

The CORS configuration of this bucket.

Default: - No CORS configuration.

Specified by:

getCors in interface BucketProps

See Also:

• https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-cors.html

getEncryption

public final BucketEncryption getEncryption()

Description copied from interface: BucketProps

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 `S3_MANAGED` otherwise.

Specified by:

getEncryption in interface BucketProps

getEncryptionKey

public final IKey getEncryptionKey()

Description copied from interface: BucketProps

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.

Specified by:

getEncryptionKey in interface BucketProps

getEnforceSSL

public final Boolean getEnforceSSL()

Description copied from interface: BucketProps

Enforces SSL for requests.

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

Default: false

Specified by:

getEnforceSSL in interface BucketProps

See Also:

• https://docs.aws.amazon.com/config/latest/developerguide/s3-bucket-ssl-requests-only.html

getEventBridgeEnabled

public final Boolean getEventBridgeEnabled()

Description copied from interface: BucketProps

Whether this bucket should send notifications to Amazon EventBridge or not.

Default: false

Specified by:

getEventBridgeEnabled in interface BucketProps

getIntelligentTieringConfigurations

public final List<IntelligentTieringConfiguration> getIntelligentTieringConfigurations()

Description copied from interface: BucketProps

Intelligent Tiering Configurations.

Default: No Intelligent Tiiering Configurations.

Specified by:

getIntelligentTieringConfigurations in interface BucketProps

See Also:

• https://docs.aws.amazon.com/AmazonS3/latest/userguide/intelligent-tiering.html

getInventories

public final List<Inventory> getInventories()

Description copied from interface: BucketProps

The inventory configuration of the bucket.

Default: - No inventory configuration

Specified by:

getInventories in interface BucketProps

See Also:

• https://docs.aws.amazon.com/AmazonS3/latest/dev/storage-inventory.html

getLifecycleRules

public final List<LifecycleRule> getLifecycleRules()

Description copied from interface: BucketProps

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

Default: - No lifecycle rules.

Specified by:

getLifecycleRules in interface BucketProps

getMetrics

public final List<BucketMetrics> getMetrics()

Description copied from interface: BucketProps

The metrics configuration of this bucket.

Default: - No metrics configuration.

Specified by:

getMetrics in interface BucketProps

See Also:

• https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-metricsconfiguration.html

getMinimumTLSVersion

public final Number getMinimumTLSVersion()

Description copied from interface: BucketProps

Enforces minimum TLS version for requests.

Requires enforceSSL to be enabled.

Default: No minimum TLS version is enforced.

Specified by:

getMinimumTLSVersion in interface BucketProps

See Also:

• https://docs.aws.amazon.com/AmazonS3/latest/userguide/amazon-s3-policy-keys.html#example-object-tls-version

getNotificationsHandlerRole

public final IRole getNotificationsHandlerRole()

Description copied from interface: BucketProps

The role to be used by the notifications handler.

Default: - a new role will be created.

Specified by:

getNotificationsHandlerRole in interface BucketProps

getNotificationsSkipDestinationValidation

public final Boolean getNotificationsSkipDestinationValidation()

Description copied from interface: BucketProps

Skips notification validation of Amazon SQS, Amazon SNS, and Lambda destinations.

Default: false

Specified by:

getNotificationsSkipDestinationValidation in interface BucketProps

getObjectLockDefaultRetention

public final ObjectLockRetention getObjectLockDefaultRetention()

Description copied from interface: BucketProps

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

Specified by:

getObjectLockDefaultRetention in interface BucketProps

See Also:

• https://docs.aws.amazon.com/AmazonS3/latest/userguide/object-lock-overview.html#object-lock-bucket-config-enable

getObjectLockEnabled

public final Boolean getObjectLockEnabled()

Description copied from interface: BucketProps

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)

Specified by:

getObjectLockEnabled in interface BucketProps

See Also:

• https://docs.aws.amazon.com/AmazonS3/latest/userguide/object-lock-overview.html#object-lock-bucket-config-enable

getObjectOwnership

public final ObjectOwnership getObjectOwnership()

Description copied from interface: BucketProps

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.

Specified by:

getObjectOwnership in interface BucketProps

See Also:

• https://docs.aws.amazon.com/AmazonS3/latest/dev/about-object-ownership.html

getPublicReadAccess

public final Boolean getPublicReadAccess()

Description copied from interface: BucketProps

Grants public read access to all objects in the bucket.

Similar to calling bucket.grantPublicAccess()

Default: false

Specified by:

getPublicReadAccess in interface BucketProps

getRemovalPolicy

public final RemovalPolicy getRemovalPolicy()

Description copied from interface: BucketProps

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

Default: - The bucket will be orphaned.

Specified by:

getRemovalPolicy in interface BucketProps

getReplicationRole

public final IRole getReplicationRole()

Description copied from interface: BucketProps

The role to be used by the replication.

When setting this property, you must also set replicationRules.

Default: - a new role will be created.

Specified by:

getReplicationRole in interface BucketProps

getReplicationRules

public final List<ReplicationRule> getReplicationRules()

Description copied from interface: BucketProps

A container for one or more replication rules.

Default: - No replication

Specified by:

getReplicationRules in interface BucketProps

getServerAccessLogsBucket

public final IBucket getServerAccessLogsBucket()

Description copied from interface: BucketProps

Destination bucket for the server access logs.

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

Specified by:

getServerAccessLogsBucket in interface BucketProps

getServerAccessLogsPrefix

public final String getServerAccessLogsPrefix()

Description copied from interface: BucketProps

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

Specified by:

getServerAccessLogsPrefix in interface BucketProps

getTargetObjectKeyFormat

public final TargetObjectKeyFormat getTargetObjectKeyFormat()

Description copied from interface: BucketProps

Optional key format for log objects.

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

Specified by:

getTargetObjectKeyFormat in interface BucketProps

getTransferAcceleration

public final Boolean getTransferAcceleration()

Description copied from interface: BucketProps

Whether this bucket should have transfer acceleration turned on or not.

Default: false

Specified by:

getTransferAcceleration in interface BucketProps

getTransitionDefaultMinimumObjectSize

public final TransitionDefaultMinimumObjectSize getTransitionDefaultMinimumObjectSize()

Description copied from interface: BucketProps

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.

Specified by:

getTransitionDefaultMinimumObjectSize in interface BucketProps

getVersioned

public final Boolean getVersioned()

Description copied from interface: BucketProps

Whether this bucket should have versioning turned on or not.

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

Specified by:

getVersioned in interface BucketProps

getWebsiteErrorDocument

public final String getWebsiteErrorDocument()

Description copied from interface: BucketProps

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.

Specified by:

getWebsiteErrorDocument in interface BucketProps

getWebsiteIndexDocument

public final String getWebsiteIndexDocument()

Description copied from interface: BucketProps

The name of the index document (e.g. "index.html") for the website. Enables static website hosting for this bucket.

Default: - No index document.

Specified by:

getWebsiteIndexDocument in interface BucketProps

getWebsiteRedirect

public final RedirectTarget getWebsiteRedirect()

Description copied from interface: BucketProps

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.

Specified by:

getWebsiteRedirect in interface BucketProps

getWebsiteRoutingRules

public final List<RoutingRule> getWebsiteRoutingRules()

Description copied from interface: BucketProps

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

Default: - No redirection rules.

Specified by:

getWebsiteRoutingRules in interface BucketProps

$jsii$toJson

@Internal
public com.fasterxml.jackson.databind.JsonNode $jsii$toJson()

Specified by:

$jsii$toJson in interface software.amazon.jsii.JsiiSerializable

equals

public final boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public final int hashCode()

Overrides:

hashCode in class Object