com.amazonaws.services.cloudfront.model.S3OriginConfig Maven / Gradle / Ivy
Show all versions of aws-java-sdk-cloudfront Show documentation
/*
* 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 contains information about the Amazon S3 origin. If the origin is a custom origin or an S3 bucket
* that is configured as a website endpoint, use the CustomOriginConfig element instead.
*
*
* @see AWS API
* Documentation
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class S3OriginConfig implements Serializable, Cloneable {
/**
*
* The CloudFront origin access identity to associate with the origin. Use an origin access identity to configure
* the origin so that viewers can only access objects in an Amazon S3 bucket through CloudFront. The format
* of the value is:
*
*
* origin-access-identity/cloudfront/ID-of-origin-access-identity
*
*
* where ID-of-origin-access-identity is the value that CloudFront returned in the
* ID element when you created the origin access identity.
*
*
* If you want viewers to be able to access objects using either the CloudFront URL or the Amazon S3 URL, specify an
* empty OriginAccessIdentity element.
*
*
* To delete the origin access identity from an existing distribution, update the distribution configuration and
* include an empty OriginAccessIdentity element.
*
*
* To replace the origin access identity, update the distribution configuration and specify the new origin access
* identity.
*
*
* For more information about the origin access identity, see Serving Private
* Content through CloudFront in the Amazon CloudFront Developer Guide.
*
*/
private String originAccessIdentity;
/**
*
* The CloudFront origin access identity to associate with the origin. Use an origin access identity to configure
* the origin so that viewers can only access objects in an Amazon S3 bucket through CloudFront. The format
* of the value is:
*
*
* origin-access-identity/cloudfront/ID-of-origin-access-identity
*
*
* where ID-of-origin-access-identity is the value that CloudFront returned in the
* ID element when you created the origin access identity.
*
*
* If you want viewers to be able to access objects using either the CloudFront URL or the Amazon S3 URL, specify an
* empty OriginAccessIdentity element.
*
*
* To delete the origin access identity from an existing distribution, update the distribution configuration and
* include an empty OriginAccessIdentity element.
*
*
* To replace the origin access identity, update the distribution configuration and specify the new origin access
* identity.
*
*
* For more information about the origin access identity, see Serving Private
* Content through CloudFront in the Amazon CloudFront Developer Guide.
*
*
* @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 only access objects in an Amazon S3 bucket through
* CloudFront. The format of the value is:
*
* origin-access-identity/cloudfront/ID-of-origin-access-identity
*
*
* where ID-of-origin-access-identity is the value that CloudFront returned in the
* ID element when you created the origin access identity.
*
*
* If you want viewers to be able to access objects using either the CloudFront URL or the Amazon S3 URL,
* specify an empty OriginAccessIdentity element.
*
*
* To delete the origin access identity from an existing distribution, update the distribution configuration
* and include an empty OriginAccessIdentity element.
*
*
* To replace the origin access identity, update the distribution configuration and specify the new origin
* access identity.
*
*
* For more information about the origin access identity, see Serving
* Private Content through CloudFront in the Amazon CloudFront Developer Guide.
*/
public void setOriginAccessIdentity(String originAccessIdentity) {
this.originAccessIdentity = originAccessIdentity;
}
/**
*
* The CloudFront origin access identity to associate with the origin. Use an origin access identity to configure
* the origin so that viewers can only access objects in an Amazon S3 bucket through CloudFront. The format
* of the value is:
*
*
* origin-access-identity/cloudfront/ID-of-origin-access-identity
*
*
* where ID-of-origin-access-identity is the value that CloudFront returned in the
* ID element when you created the origin access identity.
*
*
* If you want viewers to be able to access objects using either the CloudFront URL or the Amazon S3 URL, specify an
* empty OriginAccessIdentity element.
*
*
* To delete the origin access identity from an existing distribution, update the distribution configuration and
* include an empty OriginAccessIdentity element.
*
*
* To replace the origin access identity, update the distribution configuration and specify the new origin access
* identity.
*
*
* For more information about the origin access identity, see Serving Private
* Content through CloudFront in the Amazon CloudFront Developer Guide.
*
*
* @return The CloudFront origin access identity to associate with the origin. Use an origin access identity to
* configure the origin so that viewers can only access objects in an Amazon S3 bucket through
* CloudFront. The format of the value is:
*
* origin-access-identity/cloudfront/ID-of-origin-access-identity
*
*
* where ID-of-origin-access-identity is the value that CloudFront returned in the
* ID element when you created the origin access identity.
*
*
* If you want viewers to be able to access objects using either the CloudFront URL or the Amazon S3 URL,
* specify an empty OriginAccessIdentity element.
*
*
* To delete the origin access identity from an existing distribution, update the distribution configuration
* and include an empty OriginAccessIdentity element.
*
*
* To replace the origin access identity, update the distribution configuration and specify the new origin
* access identity.
*
*
* For more information about the origin access identity, see Serving
* Private Content through CloudFront in the Amazon CloudFront Developer Guide.
*/
public String getOriginAccessIdentity() {
return this.originAccessIdentity;
}
/**
*
* The CloudFront origin access identity to associate with the origin. Use an origin access identity to configure
* the origin so that viewers can only access objects in an Amazon S3 bucket through CloudFront. The format
* of the value is:
*
*
* origin-access-identity/cloudfront/ID-of-origin-access-identity
*
*
* where ID-of-origin-access-identity is the value that CloudFront returned in the
* ID element when you created the origin access identity.
*
*
* If you want viewers to be able to access objects using either the CloudFront URL or the Amazon S3 URL, specify an
* empty OriginAccessIdentity element.
*
*
* To delete the origin access identity from an existing distribution, update the distribution configuration and
* include an empty OriginAccessIdentity element.
*
*
* To replace the origin access identity, update the distribution configuration and specify the new origin access
* identity.
*
*
* For more information about the origin access identity, see Serving Private
* Content through CloudFront in the Amazon CloudFront Developer Guide.
*
*
* @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 only access objects in an Amazon S3 bucket through
* CloudFront. The format of the value is:
*
* origin-access-identity/cloudfront/ID-of-origin-access-identity
*
*
* where ID-of-origin-access-identity is the value that CloudFront returned in the
* ID element when you created the origin access identity.
*
*
* If you want viewers to be able to access objects using either the CloudFront URL or the Amazon S3 URL,
* specify an empty OriginAccessIdentity element.
*
*
* To delete the origin access identity from an existing distribution, update the distribution configuration
* and include an empty OriginAccessIdentity element.
*
*
* To replace the origin access identity, update the distribution configuration and specify the new origin
* access identity.
*
*
* For more information about the origin access identity, see Serving
* Private Content through CloudFront in the Amazon CloudFront Developer Guide.
* @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. 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 (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);
}
}
}