Class: Aws::APIGateway::Types::MutualTlsAuthenticationInput

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb

Overview

Note:

When making an API call, you may pass MutualTlsAuthenticationInput data as a hash:

{
  truststore_uri: "String",
  truststore_version: "String",
}

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

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#truststore_uriString

An Amazon S3 resource ARN 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)


5500
5501
5502
5503
5504
5505
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 5500

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

#truststore_versionString

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)


5500
5501
5502
5503
5504
5505
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 5500

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