BucketLoggingConfiguration (AWS SDK for Java

JavaScript is disabled on your browser.

AWS SDK for Java 1.x API Reference - 1.12.795

We announced the upcoming end-of-support for AWS SDK for Java (v1). We recommend that you migrate to AWS SDK for Java v2. For dates, additional details, and information on how to migrate, please refer to the linked announcement.

All Classes

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method

com.amazonaws.services.s3.model

Class BucketLoggingConfiguration

java.lang.Object
- com.amazonaws.services.s3.model.BucketLoggingConfiguration

All Implemented Interfaces:

Serializable
```
public class BucketLoggingConfiguration
extends Object
implements Serializable 
```
Represents bucket logging configuration used to control bucket-based server access logging in Amazon S3.

For logging to be enabled for a bucket both the destinationBucketName and logfilePrefix must not be null, and the named bucket must exist. When both variables are not null, this object represents an enabled logging configuration (as indicated by isLoggingEnabled()).
If either the targetBucketName or logfilePrefix are null, this object represents a disabled logging configuration (as indicated by isLoggingEnabled()).
Server access logging can be enabled or disabled with AmazonS3Client.setBucketLoggingConfiguration(SetBucketLoggingConfigurationRequest) and the current status of server access logging for a bucket can be retrieved through AmazonS3Client.getBucketLoggingConfiguration(String)

See Also:

AmazonS3.getBucketLoggingConfiguration(String), AmazonS3.setBucketLoggingConfiguration(SetBucketLoggingConfigurationRequest), Serialized Form

Constructor Summary

Constructors
Constructor and Description
`BucketLoggingConfiguration ()` Creates a new bucket logging configuration, which by default is disabled.
`BucketLoggingConfiguration (String destinationBucketName, String logFilePrefix)` Creates a new bucket logging configuration which enables server access logs to be collected and stored in the specified destination bucket with the specified log file prefix.

Method Summary

All Methods
Modifier and Type	Method and Description
`String`	`getDestinationBucketName ()` Returns the destination bucket name for this logging configuration.
`String`	`getLogFilePrefix ()` Returns the optional log file prefix.
`TargetObjectKeyFormat`	`getTargetObjectKeyFormat ()` Returns the `TargetObjectKeyFormat` for this logging configuration.
`boolean`	`isLoggingEnabled ()` Returns true if logging is enabled.
`void`	`setDestinationBucketName (String destinationBucketName)` Sets the destination bucket name for this logging configuration.
`void`	`setLogFilePrefix (String logFilePrefix)` Sets the log file prefix for this bucket logging configuration.
`void`	`setTargetObjectKeyFormat (TargetObjectKeyFormat targetObjectKeyFormat)` Sets the `TargetObjectKeyFormat` for this logging configuration.
`String`	`toString ()`
`BucketLoggingConfiguration`	`withTargetObjectKeyFormat (TargetObjectKeyFormat targetObjectKeyFormat)` Sets the `TargetObjectKeyFormat` for this logging configuration and returns this object for method chaining.

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

- Constructor Detail
  - BucketLoggingConfiguration
```
public BucketLoggingConfiguration()
```
    Creates a new bucket logging configuration, which by default is disabled.
    Passing this new object directly to AmazonS3.setBucketLoggingConfiguration(SetBucketLoggingConfigurationRequest) will turn off bucket logging for the specified bucket.
  - BucketLoggingConfiguration
```
public BucketLoggingConfiguration(String destinationBucketName,
 String logFilePrefix)
```
    Creates a new bucket logging configuration which enables server access logs to be collected and stored in the specified destination bucket with the specified log file prefix.
    
    Parameters:
    
    destinationBucketName - The name of the bucket to which to delivery server access logs from the target bucket. This may be the same bucket for which logging is being configured.
    
    logFilePrefix - The optional prefix to append to server access logs when they are written to the destination bucket.
- Method Detail
  - isLoggingEnabled
```
public boolean isLoggingEnabled()
```
    Returns true if logging is enabled.
    
    Returns:
    
    True if logging is enabled.
  - getLogFilePrefix
```
public String getLogFilePrefix()
```
    Returns the optional log file prefix.
    
    Returns:
    
    The optional log file prefix.
  - setLogFilePrefix
```
public void setLogFilePrefix(String logFilePrefix)
```
    Sets the log file prefix for this bucket logging configuration.
    
    Parameters:
    
    logFilePrefix - The log file prefix for this logging configuration.
  - getDestinationBucketName
```
public String getDestinationBucketName()
```
    Returns the destination bucket name for this logging configuration.
    
    Returns:
    
    The destination bucket name for this logging configuration.
  - setDestinationBucketName
```
public void setDestinationBucketName(String destinationBucketName)
```
    Sets the destination bucket name for this logging configuration.
    
    Parameters:
    
    destinationBucketName - The destination bucket name for this logging configuration.
  - getTargetObjectKeyFormat
```
public TargetObjectKeyFormat getTargetObjectKeyFormat()
```
    Returns the TargetObjectKeyFormat for this logging configuration.
    
    Returns:
    
    The TargetObjectKeyFormat for this logging configuration.
  - setTargetObjectKeyFormat
```
public void setTargetObjectKeyFormat(TargetObjectKeyFormat targetObjectKeyFormat)
```
    Sets the TargetObjectKeyFormat for this logging configuration.
    
    Parameters:
    
    targetObjectKeyFormat - The TargetObjectKeyFormat for this logging configuration.
  - withTargetObjectKeyFormat
```
public BucketLoggingConfiguration withTargetObjectKeyFormat(TargetObjectKeyFormat targetObjectKeyFormat)
```
    Sets the TargetObjectKeyFormat for this logging configuration and returns this object for method chaining.
    
    Parameters:
    
    targetObjectKeyFormat - The TargetObjectKeyFormat for this logging configuration.
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object

Skip navigation links

All Classes

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method

AWS SDK for Java 1.x API Reference - 1.12.795

Class BucketLoggingConfiguration

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

BucketLoggingConfiguration

BucketLoggingConfiguration

Method Detail

isLoggingEnabled

getLogFilePrefix

setLogFilePrefix

getDestinationBucketName

setDestinationBucketName

getTargetObjectKeyFormat

setTargetObjectKeyFormat

withTargetObjectKeyFormat

toString