MutualTlsAuthentication (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.apigateway.model.MutualTlsAuthentication

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class MutualTlsAuthentication
extends Object
implements Serializable, Cloneable, StructuredPojo
```
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

Constructor Summary

Constructors
Constructor and Description

MutualTlsAuthentication()

Constructors
Constructor and Description
`MutualTlsAuthentication()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`MutualTlsAuthentication`	`clone()`
`boolean`	`equals(Object obj)`
`String`	`getTruststoreUri()` An Amazon S3 URL that specifies the truststore for mutual TLS authentication, for example `s3://bucket-name/key-name`.
`String`	`getTruststoreVersion()` The version of the S3 object that contains your truststore.
`List<String>`	`getTruststoreWarnings()` A list of warnings that API Gateway returns while processing your truststore.
`int`	`hashCode()`
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setTruststoreUri(String truststoreUri)` An Amazon S3 URL that specifies the truststore for mutual TLS authentication, for example `s3://bucket-name/key-name`.
`void`	`setTruststoreVersion(String truststoreVersion)` The version of the S3 object that contains your truststore.
`void`	`setTruststoreWarnings(Collection<String> truststoreWarnings)` A list of warnings that API Gateway returns while processing your truststore.
`String`	`toString()` Returns a string representation of this object.
`MutualTlsAuthentication`	`withTruststoreUri(String truststoreUri)` An Amazon S3 URL that specifies the truststore for mutual TLS authentication, for example `s3://bucket-name/key-name`.
`MutualTlsAuthentication`	`withTruststoreVersion(String truststoreVersion)` The version of the S3 object that contains your truststore.
`MutualTlsAuthentication`	`withTruststoreWarnings(Collection<String> truststoreWarnings)` A list of warnings that API Gateway returns while processing your truststore.
`MutualTlsAuthentication`	`withTruststoreWarnings(String... truststoreWarnings)` A list of warnings that API Gateway returns while processing your truststore.

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - MutualTlsAuthentication
```
public MutualTlsAuthentication()
```
- Method Detail
  - setTruststoreUri
```
public void setTruststoreUri(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.
    
    Parameters:
    
    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.
  - getTruststoreUri
```
public String getTruststoreUri()
```
    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.
  - withTruststoreUri
```
public MutualTlsAuthentication withTruststoreUri(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.
    
    Parameters:
    
    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:
    
    Returns a reference to this object so that method calls can be chained together.
  - setTruststoreVersion
```
public void setTruststoreVersion(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.
    
    Parameters:
    
    truststoreVersion - The version of the S3 object that contains your truststore. To specify a version, you must have versioning enabled for the S3 bucket.
  - getTruststoreVersion
```
public String getTruststoreVersion()
```
    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.
  - withTruststoreVersion
```
public MutualTlsAuthentication withTruststoreVersion(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.
    
    Parameters:
    
    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:
    
    Returns a reference to this object so that method calls can be chained together.
  - getTruststoreWarnings
```
public List<String> getTruststoreWarnings()
```
    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.
    
    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.
  - setTruststoreWarnings
```
public void setTruststoreWarnings(Collection<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.
    
    Parameters:
    
    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.
  - withTruststoreWarnings
```
public MutualTlsAuthentication withTruststoreWarnings(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.
    
    NOTE: This method appends the values to the existing list (if any). Use setTruststoreWarnings(java.util.Collection) or withTruststoreWarnings(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withTruststoreWarnings
```
public MutualTlsAuthentication withTruststoreWarnings(Collection<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.
    
    Parameters:
    
    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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - toString
```
public 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
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public MutualTlsAuthentication clone()
```
    Overrides:
    
    clone in class Object
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Description copied from interface: StructuredPojo
    
    Marshalls this structured data using the given ProtocolMarshaller.
    
    Specified by:
    
    marshall in interface StructuredPojo
    
    Parameters:
    
    protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.

Did this page help you?

Class MutualTlsAuthentication

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

MutualTlsAuthentication

Method Detail

setTruststoreUri

getTruststoreUri

withTruststoreUri

setTruststoreVersion

getTruststoreVersion

withTruststoreVersion

getTruststoreWarnings

setTruststoreWarnings

withTruststoreWarnings

withTruststoreWarnings

toString

equals

hashCode

clone

marshall