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:

  • Method Details

    • 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()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<BucketAccessLogConfig.Builder,BucketAccessLogConfig>
      Returns:
      a builder for type T

    • 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)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.