com.amazonaws.services.apigateway.model

Class MutualTlsAuthenticationInput

java.lang.Object

com.amazonaws.services.apigateway.model.MutualTlsAuthenticationInput

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class MutualTlsAuthenticationInput
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
MutualTlsAuthenticationInput()

Method Summary

Modifier and Type	Method and Description
MutualTlsAuthenticationInput	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.
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.
String	toString() Returns a string representation of this object.
MutualTlsAuthenticationInput	withTruststoreUri(String truststoreUri) An Amazon S3 URL that specifies the truststore for mutual TLS authentication, for example s3://bucket-name/key-name.
MutualTlsAuthenticationInput	withTruststoreVersion(String truststoreVersion) The version of the S3 object that contains your truststore.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

MutualTlsAuthenticationInput

public MutualTlsAuthenticationInput()

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 MutualTlsAuthenticationInput 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 MutualTlsAuthenticationInput 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.

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 MutualTlsAuthenticationInput 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.