software.amazon.awssdk.services.apigateway.model

Class MutualTlsAuthentication

java.lang.Object

software.amazon.awssdk.services.apigateway.model.MutualTlsAuthentication

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<MutualTlsAuthentication.Builder,MutualTlsAuthentication>

@Generated(value="software.amazon.awssdk:codegen")
public final class MutualTlsAuthentication
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<MutualTlsAuthentication.Builder,MutualTlsAuthentication>

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.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	MutualTlsAuthentication.Builder

Method Summary

Modifier and Type	Method and Description
static MutualTlsAuthentication.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasTruststoreWarnings() For responses, this returns true if the service returned a value for the TruststoreWarnings property.
List<SdkField<?>>	sdkFields()
static Class<? extends MutualTlsAuthentication.Builder>	serializableBuilderClass()
MutualTlsAuthentication.Builder	toBuilder()
String	toString() Returns a string representation of this object.
String	truststoreUri() An Amazon S3 URL that specifies the truststore for mutual TLS authentication, for example s3://bucket-name/key-name.
String	truststoreVersion() The version of the S3 object that contains your truststore.
List<String>	truststoreWarnings() A list of warnings that API Gateway returns while processing your truststore.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

truststoreUri

public final String truststoreUri()

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.

Returns:

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.

truststoreVersion

public final String truststoreVersion()

The version of the S3 object that contains your truststore. To specify a version, you must have versioning enabled for the S3 bucket.

Returns:

The version of the S3 object that contains your truststore. To specify a version, you must have versioning enabled for the S3 bucket.

hasTruststoreWarnings

public final boolean hasTruststoreWarnings()

For responses, this returns true if the service returned a value for the TruststoreWarnings property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

truststoreWarnings

public final List<String> truststoreWarnings()

A list of warnings that API Gateway returns while processing your truststore. Invalid certificates produce warnings. Mutual TLS is still enabled, but some clients might not be able to access your API. To resolve warnings, upload a new truststore to S3, and then update you domain name to use the new version.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasTruststoreWarnings() method.

Returns:

A list of warnings that API Gateway returns while processing your truststore. Invalid certificates produce warnings. Mutual TLS is still enabled, but some clients might not be able to access your API. To resolve warnings, upload a new truststore to S3, and then update you domain name to use the new version.

toBuilder

public MutualTlsAuthentication.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<MutualTlsAuthentication.Builder,MutualTlsAuthentication>

builder

public static MutualTlsAuthentication.Builder builder()

serializableBuilderClass

public static Class<? extends MutualTlsAuthentication.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final String toString()

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.

Overrides:

toString in class Object

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo