BucketProps.Jsii$Proxy

java.lang.Object
- software.amazon.jsii.JsiiObject
- - software.amazon.awscdk.services.s3.BucketProps.Jsii$Proxy

All Implemented Interfaces:: BucketProps

Enclosing interface:: BucketProps

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 interface software.amazon.awscdk.services.s3.BucketProps
  BucketProps.Builder, BucketProps.Jsii$Proxy

Constructor Summary

Constructors
Modifier	Constructor and Description
`protected`	`Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef)` Constructor that initializes the object based on values retrieved from the JsiiObject.

Method Summary

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

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

Methods inherited from interface software.amazon.awscdk.services.s3.BucketProps
builder

- Constructor Detail
  - 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.
- Method Detail
  - 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 java.lang.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.
    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 java.lang.Boolean getBucketKeyEnabled()
```
    Description copied from interface: BucketProps
    
    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
    
    Specified by:
    
    getBucketKeyEnabled in interface BucketProps
  - getBucketName
```
public final java.lang.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 java.util.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 `Unencrypted` 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". 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.
    
    Specified by:
    
    getEncryptionKey in interface BucketProps
  - getEnforceSSL
```
public final java.lang.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 java.lang.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 java.util.List<IntelligentTieringConfiguration> getIntelligentTieringConfigurations()
```
    Description copied from interface: BucketProps
    
    Inteligent 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 java.util.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 java.util.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 java.util.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
  - 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
  - getObjectOwnership
```
public final ObjectOwnership getObjectOwnership()
```
    Description copied from interface: BucketProps
    
    The objectOwnership of the bucket.
    Default: - No ObjectOwnership configuration, uploading account will own the object.
    
    Specified by:
    
    getObjectOwnership in interface BucketProps
    
    See Also:
    
    https://docs.aws.amazon.com/AmazonS3/latest/dev/about-object-ownership.html
  - getPublicReadAccess
```
public final java.lang.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
  - 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 java.lang.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
  - getTransferAcceleration
```
public final java.lang.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
  - getVersioned
```
public final java.lang.Boolean getVersioned()
```
    Description copied from interface: BucketProps
    
    Whether this bucket should have versioning turned on or not.
    Default: false
    
    Specified by:
    
    getVersioned in interface BucketProps
  - getWebsiteErrorDocument
```
public final java.lang.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 java.lang.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 java.util.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
```
public com.fasterxml.jackson.databind.JsonNode $jsii$toJson()
```
  - equals
```
public final boolean equals(java.lang.Object o)
```
  - hashCode
```
public final int hashCode()
```

Class BucketProps.Jsii$Proxy

Nested Class Summary

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

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.awscdk.services.s3.BucketProps

Constructor Detail

Jsii$Proxy

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

$jsii$toJson

equals

hashCode