com.amazonaws.services.cloudfront.model.S3OriginConfig Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of aws-java-sdk-cloudfront Show documentation
The AWS Java SDK for Amazon CloudFront module holds the client classes that are used for communicating with Amazon CloudFront Service
There is a newer version: 1.11.69
Show newest version
/*
 * Copyright 2010-2016 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;

/**
 * A complex type that contains information about the Amazon S3 origin. If the
 * origin is a custom origin, use the CustomOriginConfig element instead.
 */
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 end users can
     * only access objects in an Amazon S3 bucket through CloudFront. If you want
     * end users 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. Use the format
     * origin-access-identity/cloudfront/Id where Id is the value that CloudFront
     * returned in the Id element when you created the origin access identity.
     */
    private String originAccessIdentity;

    /**
     * The CloudFront origin access identity to associate with the origin. Use
     * an origin access identity to configure the origin so that end users can
     * only access objects in an Amazon S3 bucket through CloudFront. If you want
     * end users 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. Use the format
     * origin-access-identity/cloudfront/Id where Id is the value that CloudFront
     * returned in the Id element when you created the origin access identity.
     * 
     * @param originAccessIdentity
     *        The CloudFront origin access identity to associate with the
     *        origin. Use an origin access identity to configure the origin so
     *        that end users can only access objects in an Amazon S3 bucket
     *        through CloudFront. If you want end users 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. Use the format
     *        origin-access-identity/cloudfront/Id where Id is the value that
     *        CloudFront returned in the Id element when you created the origin
     *        access identity.
     */

    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 end users can
     * only access objects in an Amazon S3 bucket through CloudFront. If you want
     * end users 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. Use the format
     * origin-access-identity/cloudfront/Id where Id is the value that CloudFront
     * returned in the Id element when you created the origin access identity.
     * 
     * @return The CloudFront origin access identity to associate with the
     *         origin. Use an origin access identity to configure the origin so
     *         that end users can only access objects in an Amazon S3 bucket
     *         through CloudFront. If you want end users 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. Use the format
     *         origin-access-identity/cloudfront/Id where Id is the value that
     *         CloudFront returned in the Id element when you created the origin
     *         access identity.
     */

    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 end users can
     * only access objects in an Amazon S3 bucket through CloudFront. If you want
     * end users 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. Use the format
     * origin-access-identity/cloudfront/Id where Id is the value that CloudFront
     * returned in the Id element when you created the origin access identity.
     * 
     * @param originAccessIdentity
     *        The CloudFront origin access identity to associate with the
     *        origin. Use an origin access identity to configure the origin so
     *        that end users can only access objects in an Amazon S3 bucket
     *        through CloudFront. If you want end users 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. Use the format
     *        origin-access-identity/cloudfront/Id where Id is the value that
     *        CloudFront returned in the Id element when you created the origin
     *        access identity.
     * @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: " + 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);
        }
    }
}