software.amazon.awssdk.services.apigateway.model.MutualTlsAuthenticationInput Maven / Gradle / Ivy
Show all versions of apigateway 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.apigateway.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;
/**
*
* The mutual TLS authentication configuration for a custom domain name. If specified, API Gateway performs two-way
* authentication between the client and the server. Clients must present a trusted certificate to access your API.
*
*/
@Generated("software.amazon.awssdk:codegen")
public final class MutualTlsAuthenticationInput implements SdkPojo, Serializable,
ToCopyableBuilder {
private static final SdkField TRUSTSTORE_URI_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("truststoreUri").getter(getter(MutualTlsAuthenticationInput::truststoreUri))
.setter(setter(Builder::truststoreUri))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("truststoreUri").build()).build();
private static final SdkField TRUSTSTORE_VERSION_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("truststoreVersion").getter(getter(MutualTlsAuthenticationInput::truststoreVersion))
.setter(setter(Builder::truststoreVersion))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("truststoreVersion").build()).build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(TRUSTSTORE_URI_FIELD,
TRUSTSTORE_VERSION_FIELD));
private static final long serialVersionUID = 1L;
private final String truststoreUri;
private final String truststoreVersion;
private MutualTlsAuthenticationInput(BuilderImpl builder) {
this.truststoreUri = builder.truststoreUri;
this.truststoreVersion = builder.truststoreVersion;
}
/**
*
* An Amazon S3 URL that specifies the truststore for mutual TLS authentication, for example
* s3://bucket-name/key-name
. The truststore can contain certificates from public or private
* certificate authorities. To update the truststore, upload a new version to S3, and then update your custom domain
* name to use the new version. To update the truststore, you must have permissions to access the S3 object.
*
*
* @return An Amazon S3 URL that specifies the truststore for mutual TLS authentication, for example
* s3://bucket-name/key-name
. The truststore can contain certificates from public or private
* certificate authorities. To update the truststore, upload a new version to S3, and then update your
* custom domain name to use the new version. To update the truststore, you must have permissions to access
* the S3 object.
*/
public final String truststoreUri() {
return truststoreUri;
}
/**
*
* The version of the S3 object that contains your truststore. To specify a version, you must have versioning
* enabled for the S3 bucket
*
*
* @return The version of the S3 object that contains your truststore. To specify a version, you must have
* versioning enabled for the S3 bucket
*/
public final String truststoreVersion() {
return truststoreVersion;
}
@Override
public Builder toBuilder() {
return new BuilderImpl(this);
}
public static Builder builder() {
return new BuilderImpl();
}
public static Class extends Builder> serializableBuilderClass() {
return BuilderImpl.class;
}
@Override
public final int hashCode() {
int hashCode = 1;
hashCode = 31 * hashCode + Objects.hashCode(truststoreUri());
hashCode = 31 * hashCode + Objects.hashCode(truststoreVersion());
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 MutualTlsAuthenticationInput)) {
return false;
}
MutualTlsAuthenticationInput other = (MutualTlsAuthenticationInput) obj;
return Objects.equals(truststoreUri(), other.truststoreUri())
&& Objects.equals(truststoreVersion(), other.truststoreVersion());
}
/**
* 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("MutualTlsAuthenticationInput").add("TruststoreUri", truststoreUri())
.add("TruststoreVersion", truststoreVersion()).build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "truststoreUri":
return Optional.ofNullable(clazz.cast(truststoreUri()));
case "truststoreVersion":
return Optional.ofNullable(clazz.cast(truststoreVersion()));
default:
return Optional.empty();
}
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
private static Function