Package software.amazon.awssdk.services.apigateway.model

Class MutualTlsAuthenticationInput

java.lang.Object

software.amazon.awssdk.services.apigateway.model.MutualTlsAuthenticationInput

All Implemented Interfaces:

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

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

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	Description
static interface	MutualTlsAuthenticationInput.Builder

Method Summary

Modifier and Type	Method	Description
static MutualTlsAuthenticationInput.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends MutualTlsAuthenticationInput.Builder>	serializableBuilderClass()
MutualTlsAuthenticationInput.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.

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

toBuilder

public MutualTlsAuthenticationInput.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<MutualTlsAuthenticationInput.Builder,MutualTlsAuthenticationInput>

builder

public static MutualTlsAuthenticationInput.Builder builder()

serializableBuilderClass

public static Class<? extends MutualTlsAuthenticationInput.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

sdkFieldNameToField

public final Map<String,SdkField<?>> sdkFieldNameToField()

Specified by:

sdkFieldNameToField in interface SdkPojo