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

Interface LoggingConfig.Builder

All Superinterfaces:

CopyableBuilder<LoggingConfig.Builder,LoggingConfig>, SdkBuilder<LoggingConfig.Builder,LoggingConfig>

Enclosing class:

LoggingConfig

public static interface LoggingConfig.Builder
extends CopyableBuilder<LoggingConfig.Builder,LoggingConfig>

Method Summary

Modifier and Type	Method	Description
LoggingConfig.Builder	bucket(String bucket)	The Amazon S3 bucket to store the access logs in, for example, myawslogbucket.s3.amazonaws.com.
LoggingConfig.Builder	enabled(Boolean enabled)	Specifies whether you want CloudFront to save access logs to an Amazon S3 bucket.
LoggingConfig.Builder	includeCookies(Boolean includeCookies)	Specifies whether you want CloudFront to include cookies in access logs, specify true for IncludeCookies.
LoggingConfig.Builder	prefix(String prefix)	An optional string that you want CloudFront to prefix to the access log filenames for this distribution, for example, myprefix/.

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

copy

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

apply, build

Method Detail

enabled

LoggingConfig.Builder enabled(Boolean enabled)

Specifies whether you want CloudFront to save access logs to an Amazon S3 bucket. If you do not 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.

Parameters:

enabled - Specifies whether you want CloudFront to save access logs to an Amazon S3 bucket. If you do not 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:

Returns a reference to this object so that method calls can be chained together.

includeCookies

LoggingConfig.Builder includeCookies(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 do not 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.

Parameters:

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 do not 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:

Returns a reference to this object so that method calls can be chained together.

bucket

LoggingConfig.Builder bucket(String bucket)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

prefix

LoggingConfig.Builder prefix(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 do not want to specify a prefix, you still must include an empty Prefix element in the Logging element.

Parameters:

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 do not want to specify a prefix, you still must include an empty Prefix element in the Logging element.

Returns:

Returns a reference to this object so that method calls can be chained together.