Class LoggingConfig
java.lang.Object
com.amazonaws.services.cloudfront.model.LoggingConfig
- All Implemented Interfaces:
Serializable
,Cloneable
A complex type that controls whether access logs are written for the
distribution.
- See Also:
-
Constructor Summary
ConstructorsConstructorDescriptionDefault constructor for LoggingConfig object.LoggingConfig
(String bucket, String prefix) Constructs a new LoggingConfig object. -
Method Summary
Modifier and TypeMethodDescriptionclone()
boolean
The Amazon S3 bucket to store the access logs in, for example, myawslogbucket.s3.amazonaws.com.Specifies whether you want CloudFront to save access logs to an Amazon S3 bucket.Specifies whether you want CloudFront to include cookies in access logs, specify true for IncludeCookies.An optional string that you want CloudFront to prefix to the access log filenames for this distribution, for example, myprefix/.int
hashCode()
Specifies whether you want CloudFront to save access logs to an Amazon S3 bucket.Specifies whether you want CloudFront to include cookies in access logs, specify true for IncludeCookies.void
The Amazon S3 bucket to store the access logs in, for example, myawslogbucket.s3.amazonaws.com.void
setEnabled
(Boolean enabled) Specifies whether you want CloudFront to save access logs to an Amazon S3 bucket.void
setIncludeCookies
(Boolean includeCookies) Specifies whether you want CloudFront to include cookies in access logs, specify true for IncludeCookies.void
An optional string that you want CloudFront to prefix to the access log filenames for this distribution, for example, myprefix/.toString()
Returns a string representation of this object; useful for testing and debugging.withBucket
(String bucket) The Amazon S3 bucket to store the access logs in, for example, myawslogbucket.s3.amazonaws.com.withEnabled
(Boolean enabled) Specifies whether you want CloudFront to save access logs to an Amazon S3 bucket.withIncludeCookies
(Boolean includeCookies) Specifies whether you want CloudFront to include cookies in access logs, specify true for IncludeCookies.withPrefix
(String prefix) An optional string that you want CloudFront to prefix to the access log filenames for this distribution, for example, myprefix/.
-
Constructor Details
-
LoggingConfig
public LoggingConfig()Default constructor for LoggingConfig object. Callers should use the setter or fluent setter (with...) methods to initialize the object after creating it. -
LoggingConfig
Constructs a new LoggingConfig object. Callers should use the setter or fluent setter (with...) methods to initialize any additional object members.- Parameters:
bucket
- The Amazon S3 bucket to store the access logs in, for example, myawslogbucket.s3.amazonaws.com.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.
-
-
Method Details
-
setEnabled
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.
-
getEnabled
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:
- 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.
-
withEnabled
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.
-
isEnabled
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:
- 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.
-
setIncludeCookies
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.
-
getIncludeCookies
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:
- 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.
-
withIncludeCookies
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.
-
isIncludeCookies
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:
- 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.
-
setBucket
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.
-
getBucket
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.
-
withBucket
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.
-
setPrefix
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.
-
getPrefix
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:
- 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.
-
withPrefix
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.
-
toString
Returns a string representation of this object; useful for testing and debugging. -
equals
-
hashCode
public int hashCode() -
clone
-