Class: Aws::APIGateway::Types::MutualTlsAuthentication

Inherits:

Struct

• Object
• Struct
• Aws::APIGateway::Types::MutualTlsAuthentication

Includes:

Structure

Defined in:

lib/aws-sdk-apigateway/types.rb

Overview

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.

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #truststore_uri ⇒ String

  An Amazon S3 URL that specifies the truststore for mutual TLS authentication, for example ‘s3://bucket-name/key-name`.

• #truststore_version ⇒ String

  The version of the S3 object that contains your truststore.

• #truststore_warnings ⇒ Array<String>

  A list of warnings that API Gateway returns while processing 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)

# File 'lib/aws-sdk-apigateway/types.rb', line 3831

class MutualTlsAuthentication < Struct.new(
  :truststore_uri,
  :truststore_version,
  :truststore_warnings)
  SENSITIVE = []
  include Aws::Structure
end

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

Returns:

• (String)

# File 'lib/aws-sdk-apigateway/types.rb', line 3831

class MutualTlsAuthentication < Struct.new(
  :truststore_uri,
  :truststore_version,
  :truststore_warnings)
  SENSITIVE = []
  include Aws::Structure
end

#truststore_warnings ⇒ Array<String>

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:

• (Array<String>)

# File 'lib/aws-sdk-apigateway/types.rb', line 3831

class MutualTlsAuthentication < Struct.new(
  :truststore_uri,
  :truststore_version,
  :truststore_warnings)
  SENSITIVE = []
  include Aws::Structure
end