com.amazonaws.services.cloudfront.model.LoggingConfig Maven / Gradle / Ivy
/*
* Copyright 2016-2021 Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with
* the License. A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
* CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions
* and limitations under the License.
*/
package com.amazonaws.services.cloudfront.model;
import java.io.Serializable;
import javax.annotation.Generated;
/**
*
* A complex type that controls whether access logs are written for the distribution.
*
*
* @see AWS API
* Documentation
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class LoggingConfig implements Serializable, Cloneable {
/**
*
* 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.
*
*/
private Boolean enabled;
/**
*
* 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.
*
*/
private Boolean includeCookies;
/**
*
* The Amazon S3 bucket to store the access logs in, for example, myawslogbucket.s3.amazonaws.com.
*
*/
private String bucket;
/**
*
* 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.
*
*/
private String prefix;
/**
* Default constructor for LoggingConfig object. Callers should use the setter or fluent setter (with...) methods to
* initialize the object after creating it.
*/
public LoggingConfig() {
}
/**
* Constructs a new LoggingConfig object. Callers should use the setter or fluent setter (with...) methods to
* initialize any additional object members.
*
* @param bucket
* The Amazon S3 bucket to store the access logs in, for example,
* myawslogbucket.s3.amazonaws.com.
* @param 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.
*/
public LoggingConfig(String bucket, String prefix) {
setBucket(bucket);
setPrefix(prefix);
}
/**
*
* 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.
*
*
* @param 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.
*/
public void setEnabled(Boolean enabled) {
this.enabled = 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.
*
*
* @return 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.
*/
public Boolean getEnabled() {
return this.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.
*
*
* @param 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.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public LoggingConfig withEnabled(Boolean enabled) {
setEnabled(enabled);
return this;
}
/**
*
* 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.
*
*
* @return 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.
*/
public Boolean isEnabled() {
return this.enabled;
}
/**
*
* 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.
*
*
* @param 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.
*/
public void setIncludeCookies(Boolean includeCookies) {
this.includeCookies = 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.
*
*
* @return 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.
*/
public Boolean getIncludeCookies() {
return this.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.
*
*
* @param 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.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public LoggingConfig withIncludeCookies(Boolean includeCookies) {
setIncludeCookies(includeCookies);
return this;
}
/**
*
* 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.
*
*
* @return 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.
*/
public Boolean isIncludeCookies() {
return this.includeCookies;
}
/**
*
* The Amazon S3 bucket to store the access logs in, for example, myawslogbucket.s3.amazonaws.com.
*
*
* @param bucket
* The Amazon S3 bucket to store the access logs in, for example,
* myawslogbucket.s3.amazonaws.com.
*/
public void setBucket(String bucket) {
this.bucket = bucket;
}
/**
*
* The Amazon S3 bucket to store the access logs in, for example, myawslogbucket.s3.amazonaws.com.
*
*
* @return The Amazon S3 bucket to store the access logs in, for example,
* myawslogbucket.s3.amazonaws.com.
*/
public String getBucket() {
return this.bucket;
}
/**
*
* The Amazon S3 bucket to store the access logs in, for example, myawslogbucket.s3.amazonaws.com.
*
*
* @param bucket
* The Amazon S3 bucket to store the access logs in, for example,
* myawslogbucket.s3.amazonaws.com.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public LoggingConfig withBucket(String bucket) {
setBucket(bucket);
return this;
}
/**
*
* 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.
*
*
* @param 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.
*/
public void setPrefix(String prefix) {
this.prefix = 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.
*
*
* @return 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.
*/
public String getPrefix() {
return this.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.
*
*
* @param 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.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public LoggingConfig withPrefix(String prefix) {
setPrefix(prefix);
return this;
}
/**
* 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.
*
* @return A string representation of this object.
*
* @see java.lang.Object#toString()
*/
@Override
public String toString() {
StringBuilder sb = new StringBuilder();
sb.append("{");
if (getEnabled() != null)
sb.append("Enabled: ").append(getEnabled()).append(",");
if (getIncludeCookies() != null)
sb.append("IncludeCookies: ").append(getIncludeCookies()).append(",");
if (getBucket() != null)
sb.append("Bucket: ").append(getBucket()).append(",");
if (getPrefix() != null)
sb.append("Prefix: ").append(getPrefix());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof LoggingConfig == false)
return false;
LoggingConfig other = (LoggingConfig) obj;
if (other.getEnabled() == null ^ this.getEnabled() == null)
return false;
if (other.getEnabled() != null && other.getEnabled().equals(this.getEnabled()) == false)
return false;
if (other.getIncludeCookies() == null ^ this.getIncludeCookies() == null)
return false;
if (other.getIncludeCookies() != null && other.getIncludeCookies().equals(this.getIncludeCookies()) == false)
return false;
if (other.getBucket() == null ^ this.getBucket() == null)
return false;
if (other.getBucket() != null && other.getBucket().equals(this.getBucket()) == false)
return false;
if (other.getPrefix() == null ^ this.getPrefix() == null)
return false;
if (other.getPrefix() != null && other.getPrefix().equals(this.getPrefix()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getEnabled() == null) ? 0 : getEnabled().hashCode());
hashCode = prime * hashCode + ((getIncludeCookies() == null) ? 0 : getIncludeCookies().hashCode());
hashCode = prime * hashCode + ((getBucket() == null) ? 0 : getBucket().hashCode());
hashCode = prime * hashCode + ((getPrefix() == null) ? 0 : getPrefix().hashCode());
return hashCode;
}
@Override
public LoggingConfig clone() {
try {
return (LoggingConfig) super.clone();
} catch (CloneNotSupportedException e) {
throw new IllegalStateException("Got a CloneNotSupportedException from Object.clone() " + "even though we're Cloneable!", e);
}
}
}