You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

Class: Aws::ApiGatewayV2::Types::MutualTlsAuthenticationInput

Inherits:

Struct

Object
Struct
Aws::ApiGatewayV2::Types::MutualTlsAuthenticationInput

show all

Defined in:: (unknown)

Overview

Note:

When passing MutualTlsAuthenticationInput as input to an Aws::Client method, you can use a vanilla Hash:

{
  truststore_uri: "UriWithLengthBetween1And2048",
  truststore_version: "StringWithLengthBetween1And64",
}

If specified, API Gateway performs two-way authentication between the client and the server. Clients must present a trusted certificate to access your API.

Returned by:

Instance Attribute Summary collapse

#truststore_uri ⇒ String
An Amazon S3 URL that specifies the truststore for mutual TLS authentication, for example, s3://bucket-name.
#truststore_version ⇒ String
The version of the S3 object that contains your truststore.

Instance Attribute Details

#truststore_uri ⇒ `String`

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:

(String) —
An Amazon S3 URL that specifies the truststore for mutual TLS authentication, for example, s3://bucket-name.

#truststore_version ⇒ `String`

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