Class BucketAccessLogConfig
- All Implemented Interfaces:
Serializable
,SdkPojo
,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:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionbuilder()
final String
The name of the bucket where the access logs are saved.final Boolean
enabled()
A Boolean value that indicates whether bucket access logging is enabled for the bucket.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final int
hashCode()
final String
prefix()
The optional object prefix for the bucket access log.static Class
<? extends BucketAccessLogConfig.Builder> Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
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
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
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 thelogs/
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 thelogs/
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
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 interfaceToCopyableBuilder<BucketAccessLogConfig.Builder,
BucketAccessLogConfig> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode() -
equals
-
equalsBySdkFields
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 anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
-
sdkFields
-