/*
* Copyright 2012-2017 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;
/**
* <p>
* A complex type that contains information about the Amazon S3 origin. If the origin is a custom origin, use the
* <code>CustomOriginConfig</code> element instead.
* </p>
*
* @see <a href="http://docs.aws.amazon.com/goto/WebAPI/cloudfront-2017-03-25/S3OriginConfig" target="_top">AWS API
* Documentation</a>
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class S3OriginConfig implements Serializable, Cloneable {
/**
* <p>
* The CloudFront origin access identity to associate with the origin. Use an origin access identity to configure
* the origin so that viewers can <i>only</i> access objects in an Amazon S3 bucket through CloudFront. The format
* of the value is:
* </p>
* <p>
* origin-access-identity/CloudFront/<i>ID-of-origin-access-identity</i>
* </p>
* <p>
* where <code> <i>ID-of-origin-access-identity</i> </code> is the value that CloudFront returned in the
* <code>ID</code> element when you created the origin access identity.
* </p>
* <p>
* If you want viewers to be able to access objects using either the CloudFront URL or the Amazon S3 URL, specify an
* empty <code>OriginAccessIdentity</code> element.
* </p>
* <p>
* To delete the origin access identity from an existing distribution, update the distribution configuration and
* include an empty <code>OriginAccessIdentity</code> element.
* </p>
* <p>
* To replace the origin access identity, update the distribution configuration and specify the new origin access
* identity.
* </p>
* <p>
* For more information about the origin access identity, see <a
* href="http://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/PrivateContent.html">Serving Private
* Content through CloudFront</a> in the <i>Amazon CloudFront Developer Guide</i>.
* </p>
*/
private String originAccessIdentity;
/**
* <p>
* The CloudFront origin access identity to associate with the origin. Use an origin access identity to configure
* the origin so that viewers can <i>only</i> access objects in an Amazon S3 bucket through CloudFront. The format
* of the value is:
* </p>
* <p>
* origin-access-identity/CloudFront/<i>ID-of-origin-access-identity</i>
* </p>
* <p>
* where <code> <i>ID-of-origin-access-identity</i> </code> is the value that CloudFront returned in the
* <code>ID</code> element when you created the origin access identity.
* </p>
* <p>
* If you want viewers to be able to access objects using either the CloudFront URL or the Amazon S3 URL, specify an
* empty <code>OriginAccessIdentity</code> element.
* </p>
* <p>
* To delete the origin access identity from an existing distribution, update the distribution configuration and
* include an empty <code>OriginAccessIdentity</code> element.
* </p>
* <p>
* To replace the origin access identity, update the distribution configuration and specify the new origin access
* identity.
* </p>
* <p>
* For more information about the origin access identity, see <a
* href="http://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/PrivateContent.html">Serving Private
* Content through CloudFront</a> in the <i>Amazon CloudFront Developer Guide</i>.
* </p>
*
* @param originAccessIdentity
* The CloudFront origin access identity to associate with the origin. Use an origin access identity to
* configure the origin so that viewers can <i>only</i> access objects in an Amazon S3 bucket through
* CloudFront. The format of the value is:</p>
* <p>
* origin-access-identity/CloudFront/<i>ID-of-origin-access-identity</i>
* </p>
* <p>
* where <code> <i>ID-of-origin-access-identity</i> </code> is the value that CloudFront returned in the
* <code>ID</code> element when you created the origin access identity.
* </p>
* <p>
* If you want viewers to be able to access objects using either the CloudFront URL or the Amazon S3 URL,
* specify an empty <code>OriginAccessIdentity</code> element.
* </p>
* <p>
* To delete the origin access identity from an existing distribution, update the distribution configuration
* and include an empty <code>OriginAccessIdentity</code> element.
* </p>
* <p>
* To replace the origin access identity, update the distribution configuration and specify the new origin
* access identity.
* </p>
* <p>
* For more information about the origin access identity, see <a
* href="http://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/PrivateContent.html">Serving
* Private Content through CloudFront</a> in the <i>Amazon CloudFront Developer Guide</i>.
*/
public void setOriginAccessIdentity(String originAccessIdentity) {
this.originAccessIdentity = originAccessIdentity;
}
/**
* <p>
* The CloudFront origin access identity to associate with the origin. Use an origin access identity to configure
* the origin so that viewers can <i>only</i> access objects in an Amazon S3 bucket through CloudFront. The format
* of the value is:
* </p>
* <p>
* origin-access-identity/CloudFront/<i>ID-of-origin-access-identity</i>
* </p>
* <p>
* where <code> <i>ID-of-origin-access-identity</i> </code> is the value that CloudFront returned in the
* <code>ID</code> element when you created the origin access identity.
* </p>
* <p>
* If you want viewers to be able to access objects using either the CloudFront URL or the Amazon S3 URL, specify an
* empty <code>OriginAccessIdentity</code> element.
* </p>
* <p>
* To delete the origin access identity from an existing distribution, update the distribution configuration and
* include an empty <code>OriginAccessIdentity</code> element.
* </p>
* <p>
* To replace the origin access identity, update the distribution configuration and specify the new origin access
* identity.
* </p>
* <p>
* For more information about the origin access identity, see <a
* href="http://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/PrivateContent.html">Serving Private
* Content through CloudFront</a> in the <i>Amazon CloudFront Developer Guide</i>.
* </p>
*
* @return The CloudFront origin access identity to associate with the origin. Use an origin access identity to
* configure the origin so that viewers can <i>only</i> access objects in an Amazon S3 bucket through
* CloudFront. The format of the value is:</p>
* <p>
* origin-access-identity/CloudFront/<i>ID-of-origin-access-identity</i>
* </p>
* <p>
* where <code> <i>ID-of-origin-access-identity</i> </code> is the value that CloudFront returned in the
* <code>ID</code> element when you created the origin access identity.
* </p>
* <p>
* If you want viewers to be able to access objects using either the CloudFront URL or the Amazon S3 URL,
* specify an empty <code>OriginAccessIdentity</code> element.
* </p>
* <p>
* To delete the origin access identity from an existing distribution, update the distribution configuration
* and include an empty <code>OriginAccessIdentity</code> element.
* </p>
* <p>
* To replace the origin access identity, update the distribution configuration and specify the new origin
* access identity.
* </p>
* <p>
* For more information about the origin access identity, see <a
* href="http://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/PrivateContent.html">Serving
* Private Content through CloudFront</a> in the <i>Amazon CloudFront Developer Guide</i>.
*/
public String getOriginAccessIdentity() {
return this.originAccessIdentity;
}
/**
* <p>
* The CloudFront origin access identity to associate with the origin. Use an origin access identity to configure
* the origin so that viewers can <i>only</i> access objects in an Amazon S3 bucket through CloudFront. The format
* of the value is:
* </p>
* <p>
* origin-access-identity/CloudFront/<i>ID-of-origin-access-identity</i>
* </p>
* <p>
* where <code> <i>ID-of-origin-access-identity</i> </code> is the value that CloudFront returned in the
* <code>ID</code> element when you created the origin access identity.
* </p>
* <p>
* If you want viewers to be able to access objects using either the CloudFront URL or the Amazon S3 URL, specify an
* empty <code>OriginAccessIdentity</code> element.
* </p>
* <p>
* To delete the origin access identity from an existing distribution, update the distribution configuration and
* include an empty <code>OriginAccessIdentity</code> element.
* </p>
* <p>
* To replace the origin access identity, update the distribution configuration and specify the new origin access
* identity.
* </p>
* <p>
* For more information about the origin access identity, see <a
* href="http://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/PrivateContent.html">Serving Private
* Content through CloudFront</a> in the <i>Amazon CloudFront Developer Guide</i>.
* </p>
*
* @param originAccessIdentity
* The CloudFront origin access identity to associate with the origin. Use an origin access identity to
* configure the origin so that viewers can <i>only</i> access objects in an Amazon S3 bucket through
* CloudFront. The format of the value is:</p>
* <p>
* origin-access-identity/CloudFront/<i>ID-of-origin-access-identity</i>
* </p>
* <p>
* where <code> <i>ID-of-origin-access-identity</i> </code> is the value that CloudFront returned in the
* <code>ID</code> element when you created the origin access identity.
* </p>
* <p>
* If you want viewers to be able to access objects using either the CloudFront URL or the Amazon S3 URL,
* specify an empty <code>OriginAccessIdentity</code> element.
* </p>
* <p>
* To delete the origin access identity from an existing distribution, update the distribution configuration
* and include an empty <code>OriginAccessIdentity</code> element.
* </p>
* <p>
* To replace the origin access identity, update the distribution configuration and specify the new origin
* access identity.
* </p>
* <p>
* For more information about the origin access identity, see <a
* href="http://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/PrivateContent.html">Serving
* Private Content through CloudFront</a> in the <i>Amazon CloudFront Developer Guide</i>.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public S3OriginConfig withOriginAccessIdentity(String originAccessIdentity) {
setOriginAccessIdentity(originAccessIdentity);
return this;
}
/**
* Returns a string representation of this object; useful for testing and debugging.
*
* @return A string representation of this object.
*
* @see java.lang.Object#toString()
*/
@Override
public String toString() {
StringBuilder sb = new StringBuilder();
sb.append("{");
if (getOriginAccessIdentity() != null)
sb.append("OriginAccessIdentity: ").append(getOriginAccessIdentity());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof S3OriginConfig == false)
return false;
S3OriginConfig other = (S3OriginConfig) obj;
if (other.getOriginAccessIdentity() == null ^ this.getOriginAccessIdentity() == null)
return false;
if (other.getOriginAccessIdentity() != null && other.getOriginAccessIdentity().equals(this.getOriginAccessIdentity()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getOriginAccessIdentity() == null) ? 0 : getOriginAccessIdentity().hashCode());
return hashCode;
}
@Override
public S3OriginConfig clone() {
try {
return (S3OriginConfig) super.clone();
} catch (CloneNotSupportedException e) {
throw new IllegalStateException("Got a CloneNotSupportedException from Object.clone() " + "even though we're Cloneable!", e);
}
}
}