Package software.amazon.awssdk.services.cloudfront.model

Class LoggingConfig

java.lang.Object

software.amazon.awssdk.services.cloudfront.model.LoggingConfig

All Implemented Interfaces:

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

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

A complex type that controls whether access logs are written for the distribution.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	LoggingConfig.Builder

Method Summary

Modifier and Type	Method	Description
String	bucket()	The Amazon S3 bucket to store the access logs in, for example, myawslogbucket.s3.amazonaws.com.
static LoggingConfig.Builder	builder()
Boolean	enabled()	Specifies whether you want CloudFront to save access logs to an Amazon S3 bucket.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
Boolean	includeCookies()	Specifies whether you want CloudFront to include cookies in access logs, specify true for IncludeCookies.
String	prefix()	An optional string that you want CloudFront to prefix to the access log filenames for this distribution, for example, myprefix/.
List<SdkField<?>>	sdkFields()
static Class<? extends LoggingConfig.Builder>	serializableBuilderClass()
LoggingConfig.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()

Specifies whether you want CloudFront to save access logs to an Amazon S3 bucket. If you don't want to enable logging when you create a distribution or if you want to disable logging for an existing distribution, specify false for Enabled, and specify empty Bucket and Prefix elements. If you specify false for Enabled but you specify values for Bucket, prefix, and IncludeCookies, the values are automatically deleted.

Returns:

Specifies whether you want CloudFront to save access logs to an Amazon S3 bucket. If you don't want to enable logging when you create a distribution or if you want to disable logging for an existing distribution, specify false for Enabled, and specify empty Bucket and Prefix elements. If you specify false for Enabled but you specify values for Bucket, prefix, and IncludeCookies, the values are automatically deleted.

includeCookies

public final Boolean includeCookies()

Specifies whether you want CloudFront to include cookies in access logs, specify true for IncludeCookies. If you choose to include cookies in logs, CloudFront logs all cookies regardless of how you configure the cache behaviors for this distribution. If you don't want to include cookies when you create a distribution or if you want to disable include cookies for an existing distribution, specify false for IncludeCookies.

Returns:

Specifies whether you want CloudFront to include cookies in access logs, specify true for IncludeCookies. If you choose to include cookies in logs, CloudFront logs all cookies regardless of how you configure the cache behaviors for this distribution. If you don't want to include cookies when you create a distribution or if you want to disable include cookies for an existing distribution, specify false for IncludeCookies.

bucket

public final String bucket()

The Amazon S3 bucket to store the access logs in, for example, myawslogbucket.s3.amazonaws.com.

Returns:

The Amazon S3 bucket to store the access logs in, for example, myawslogbucket.s3.amazonaws.com.

prefix

public final String prefix()

An optional string that you want CloudFront to prefix to the access log filenames for this distribution, for example, myprefix/. If you want to enable logging, but you don't want to specify a prefix, you still must include an empty Prefix element in the Logging element.

Returns:

An optional string that you want CloudFront to prefix to the access log filenames for this distribution, for example, myprefix/. If you want to enable logging, but you don't want to specify a prefix, you still must include an empty Prefix element in the Logging element.

toBuilder

public LoggingConfig.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<LoggingConfig.Builder,LoggingConfig>

builder

public static LoggingConfig.Builder builder()

serializableBuilderClass

public static Class<? extends LoggingConfig.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