Package software.amazon.awssdk.services.lightsail.model

Class BucketAccessLogConfig

java.lang.Object

software.amazon.awssdk.services.lightsail.model.BucketAccessLogConfig

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<BucketAccessLogConfig.Builder,BucketAccessLogConfig>

@Generated("software.amazon.awssdk:codegen")
public final class BucketAccessLogConfig
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<BucketAccessLogConfig.Builder,BucketAccessLogConfig>

Describes the access log configuration for a bucket in the Amazon Lightsail object storage service.

For more information about bucket access logs, see Logging bucket requests using access logging in Amazon Lightsail in the Amazon Lightsail Developer Guide.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	BucketAccessLogConfig.Builder

Method Summary

Modifier and Type	Method	Description
static BucketAccessLogConfig.Builder	builder()
String	destination()	The name of the bucket where the access logs are saved.
Boolean	enabled()	A Boolean value that indicates whether bucket access logging is enabled for the bucket.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	prefix()	The optional object prefix for the bucket access log.
List<SdkField<?>>	sdkFields()
static Class<? extends BucketAccessLogConfig.Builder>	serializableBuilderClass()
BucketAccessLogConfig.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

Methods inherited from class java.lang.Object

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

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

enabled

public final Boolean enabled()

A Boolean value that indicates whether bucket access logging is enabled for the bucket.

Returns:

A Boolean value that indicates whether bucket access logging is enabled for the bucket.

destination

public final String destination()

The name of the bucket where the access logs are saved. The destination can be a Lightsail bucket in the same account, and in the same Amazon Web Services Region as the source bucket.

This parameter is required when enabling the access log for a bucket, and should be omitted when disabling the access log.

Returns:

The name of the bucket where the access logs are saved. The destination can be a Lightsail bucket in the same account, and in the same Amazon Web Services Region as the source bucket.

This parameter is required when enabling the access log for a bucket, and should be omitted when disabling the access log.

prefix

public final String prefix()

The optional object prefix for the bucket access log.

The prefix is an optional addition to the object key that organizes your access log files in the destination bucket. For example, if you specify a logs/ prefix, then each log object will begin with the logs/ prefix in its key (for example, logs/2021-11-01-21-32-16-E568B2907131C0C0).

This parameter can be optionally specified when enabling the access log for a bucket, and should be omitted when disabling the access log.

Returns:

The optional object prefix for the bucket access log.

The prefix is an optional addition to the object key that organizes your access log files in the destination bucket. For example, if you specify a logs/ prefix, then each log object will begin with the logs/ prefix in its key (for example, logs/2021-11-01-21-32-16-E568B2907131C0C0).

This parameter can be optionally specified when enabling the access log for a bucket, and should be omitted when disabling the access log.

toBuilder

public BucketAccessLogConfig.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<BucketAccessLogConfig.Builder,BucketAccessLogConfig>

builder

public static BucketAccessLogConfig.Builder builder()

serializableBuilderClass

public static Class<? extends BucketAccessLogConfig.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo