class Amazonite::ApiGateway::MutualTlsAuthentication

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.

Included Modules

Defined in:

api_gateway/mutual_tls_authentication.cr

Constructors

Instance Method Summary

Constructor Detail

def self.new(pull : JSON::PullParser) #

[View source]
def self.new(truststore_uri : String | Nil = nil, truststore_version : String | Nil = nil, truststore_warnings : Array(String) | Nil = nil) #

[View source]
def self.new(*, __pull_for_json_serializable pull : JSON::PullParser) #

[View source]

Instance Method Detail

def ==(other : self) #
Description copied from class Reference

Returns true if this reference is the same as other. Invokes same?.


def hash(hasher) #
Description copied from class Reference

See Object#hash(hasher)


def truststore_uri : String | Nil #

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.


[View source]
def truststore_uri=(truststore_uri : String | Nil) #

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.


[View source]
def truststore_version : String | Nil #

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


[View source]
def truststore_version=(truststore_version : String | Nil) #

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


[View source]
def truststore_warnings : Array(String) | Nil #

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.


[View source]
def truststore_warnings=(truststore_warnings : Array(String) | Nil) #

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.


[View source]
def validate! : Nil #

[View source]