software.amazon.awssdk.services.cloudfront.model.S3Origin Maven / Gradle / Ivy
Show all versions of cloudfront Show documentation
/*
* Copyright 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 software.amazon.awssdk.services.cloudfront.model;
import java.io.Serializable;
import java.util.Arrays;
import java.util.Collections;
import java.util.List;
import java.util.Objects;
import java.util.Optional;
import java.util.function.BiConsumer;
import java.util.function.Function;
import software.amazon.awssdk.annotations.Generated;
import software.amazon.awssdk.core.SdkField;
import software.amazon.awssdk.core.SdkPojo;
import software.amazon.awssdk.core.protocol.MarshallLocation;
import software.amazon.awssdk.core.protocol.MarshallingType;
import software.amazon.awssdk.core.traits.LocationTrait;
import software.amazon.awssdk.utils.ToString;
import software.amazon.awssdk.utils.builder.CopyableBuilder;
import software.amazon.awssdk.utils.builder.ToCopyableBuilder;
/**
*
* A complex type that contains information about the Amazon S3 bucket from which you want CloudFront to get your media
* files for distribution.
*
*/
@Generated("software.amazon.awssdk:codegen")
public final class S3Origin implements SdkPojo, Serializable, ToCopyableBuilder {
private static final SdkField DOMAIN_NAME_FIELD = SdkField
. builder(MarshallingType.STRING)
.memberName("DomainName")
.getter(getter(S3Origin::domainName))
.setter(setter(Builder::domainName))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("DomainName")
.unmarshallLocationName("DomainName").build()).build();
private static final SdkField ORIGIN_ACCESS_IDENTITY_FIELD = SdkField
. builder(MarshallingType.STRING)
.memberName("OriginAccessIdentity")
.getter(getter(S3Origin::originAccessIdentity))
.setter(setter(Builder::originAccessIdentity))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("OriginAccessIdentity")
.unmarshallLocationName("OriginAccessIdentity").build()).build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(DOMAIN_NAME_FIELD,
ORIGIN_ACCESS_IDENTITY_FIELD));
private static final long serialVersionUID = 1L;
private final String domainName;
private final String originAccessIdentity;
private S3Origin(BuilderImpl builder) {
this.domainName = builder.domainName;
this.originAccessIdentity = builder.originAccessIdentity;
}
/**
*
* The DNS name of the Amazon S3 origin.
*
*
* @return The DNS name of the Amazon S3 origin.
*/
public final String domainName() {
return domainName;
}
/**
*
* The CloudFront origin access identity to associate with the distribution. Use an origin access identity to
* configure the distribution 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.
*
*
* For more information, see Using an Origin Access Identity to Restrict Access to Your Amazon S3 Content in the Amazon CloudFront
* Developer Guide.
*
*
* @return The CloudFront origin access identity to associate with the distribution. Use an origin access identity
* to configure the distribution 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.
*
*
* For more information, see Using an Origin Access Identity to Restrict Access to Your Amazon S3 Content in the Amazon
* CloudFront Developer Guide.
*/
public final String originAccessIdentity() {
return originAccessIdentity;
}
@Override
public Builder toBuilder() {
return new BuilderImpl(this);
}
public static Builder builder() {
return new BuilderImpl();
}
public static Class serializableBuilderClass() {
return BuilderImpl.class;
}
@Override
public final int hashCode() {
int hashCode = 1;
hashCode = 31 * hashCode + Objects.hashCode(domainName());
hashCode = 31 * hashCode + Objects.hashCode(originAccessIdentity());
return hashCode;
}
@Override
public final boolean equals(Object obj) {
return equalsBySdkFields(obj);
}
@Override
public final boolean equalsBySdkFields(Object obj) {
if (this == obj) {
return true;
}
if (obj == null) {
return false;
}
if (!(obj instanceof S3Origin)) {
return false;
}
S3Origin other = (S3Origin) obj;
return Objects.equals(domainName(), other.domainName())
&& Objects.equals(originAccessIdentity(), other.originAccessIdentity());
}
/**
* 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.
*/
@Override
public final String toString() {
return ToString.builder("S3Origin").add("DomainName", domainName()).add("OriginAccessIdentity", originAccessIdentity())
.build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "DomainName":
return Optional.ofNullable(clazz.cast(domainName()));
case "OriginAccessIdentity":
return Optional.ofNullable(clazz.cast(originAccessIdentity()));
default:
return Optional.empty();
}
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
private static Function getter(Function g) {
return obj -> g.apply((S3Origin) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends SdkPojo, CopyableBuilder {
/**
*
* The DNS name of the Amazon S3 origin.
*
*
* @param domainName
* The DNS name of the Amazon S3 origin.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder domainName(String domainName);
/**
*
* The CloudFront origin access identity to associate with the distribution. Use an origin access identity to
* configure the distribution 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.
*
*
* For more information, see Using an Origin Access Identity to Restrict Access to Your Amazon S3 Content in the Amazon
* CloudFront Developer Guide.
*
*
* @param originAccessIdentity
* The CloudFront origin access identity to associate with the distribution. Use an origin access
* identity to configure the distribution 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.
*
*
* For more information, see Using an Origin Access Identity to Restrict Access to Your Amazon S3 Content in the Amazon
* CloudFront Developer Guide.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder originAccessIdentity(String originAccessIdentity);
}
static final class BuilderImpl implements Builder {
private String domainName;
private String originAccessIdentity;
private BuilderImpl() {
}
private BuilderImpl(S3Origin model) {
domainName(model.domainName);
originAccessIdentity(model.originAccessIdentity);
}
public final String getDomainName() {
return domainName;
}
public final void setDomainName(String domainName) {
this.domainName = domainName;
}
@Override
public final Builder domainName(String domainName) {
this.domainName = domainName;
return this;
}
public final String getOriginAccessIdentity() {
return originAccessIdentity;
}
public final void setOriginAccessIdentity(String originAccessIdentity) {
this.originAccessIdentity = originAccessIdentity;
}
@Override
public final Builder originAccessIdentity(String originAccessIdentity) {
this.originAccessIdentity = originAccessIdentity;
return this;
}
@Override
public S3Origin build() {
return new S3Origin(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
}
}