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:

  • Method Details

    • 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()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<MutualTlsAuthenticationInput.Builder,MutualTlsAuthenticationInput>
      Returns:
      a builder for type T

    • 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)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.