Copyright	(c) 2013-2021 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None

Amazonka.APIGateway.Types.MutualTlsAuthentication

Description

Documentation

data MutualTlsAuthentication Source #

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.

See: newMutualTlsAuthentication smart constructor.

Constructors

MutualTlsAuthentication'

Fields

truststoreWarnings :: Maybe [Text]
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.
truststoreUri :: Maybe Text
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.
truststoreVersion :: Maybe Text
The version of the S3 object that contains your truststore. To specify a version, you must have versioning enabled for the S3 bucket.

Instances

Instances details

Eq MutualTlsAuthentication Source #
Instance details Defined in Amazonka.APIGateway.Types.MutualTlsAuthentication Methods (==) :: MutualTlsAuthentication -> MutualTlsAuthentication -> Bool # (/=) :: MutualTlsAuthentication -> MutualTlsAuthentication -> Bool #
Read MutualTlsAuthentication Source #
Instance details Defined in Amazonka.APIGateway.Types.MutualTlsAuthentication Methods readsPrec :: Int -> ReadS MutualTlsAuthentication # readList :: ReadS [MutualTlsAuthentication] # readPrec :: ReadPrec MutualTlsAuthentication # readListPrec :: ReadPrec [MutualTlsAuthentication] #
Show MutualTlsAuthentication Source #
Instance details Defined in Amazonka.APIGateway.Types.MutualTlsAuthentication Methods showsPrec :: Int -> MutualTlsAuthentication -> ShowS # show :: MutualTlsAuthentication -> String # showList :: [MutualTlsAuthentication] -> ShowS #
Generic MutualTlsAuthentication Source #
Instance details Defined in Amazonka.APIGateway.Types.MutualTlsAuthentication Associated Types type Rep MutualTlsAuthentication :: Type -> Type # Methods from :: MutualTlsAuthentication -> Rep MutualTlsAuthentication x # to :: Rep MutualTlsAuthentication x -> MutualTlsAuthentication #
NFData MutualTlsAuthentication Source #
Instance details Defined in Amazonka.APIGateway.Types.MutualTlsAuthentication Methods rnf :: MutualTlsAuthentication -> () #
Hashable MutualTlsAuthentication Source #
Instance details Defined in Amazonka.APIGateway.Types.MutualTlsAuthentication Methods hashWithSalt :: Int -> MutualTlsAuthentication -> Int # hash :: MutualTlsAuthentication -> Int #
FromJSON MutualTlsAuthentication Source #
Instance details Defined in Amazonka.APIGateway.Types.MutualTlsAuthentication Methods parseJSON :: Value -> Parser MutualTlsAuthentication # parseJSONList :: Value -> Parser [MutualTlsAuthentication] #
type Rep MutualTlsAuthentication Source #
Instance details Defined in Amazonka.APIGateway.Types.MutualTlsAuthentication type Rep MutualTlsAuthentication = D1 ('MetaData "MutualTlsAuthentication" "Amazonka.APIGateway.Types.MutualTlsAuthentication" "libZSservicesZSamazonka-apigatewayZSamazonka-apigateway" 'False) (C1 ('MetaCons "MutualTlsAuthentication'" 'PrefixI 'True) (S1 ('MetaSel ('Just "truststoreWarnings") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :: (S1 ('MetaSel ('Just "truststoreUri") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "truststoreVersion") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))))

newMutualTlsAuthentication :: MutualTlsAuthentication Source #

Create a value of MutualTlsAuthentication with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:truststoreWarnings:MutualTlsAuthentication', mutualTlsAuthentication_truststoreWarnings - 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.

$sel:truststoreUri:MutualTlsAuthentication', mutualTlsAuthentication_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.

$sel:truststoreVersion:MutualTlsAuthentication', mutualTlsAuthentication_truststoreVersion - The version of the S3 object that contains your truststore. To specify a version, you must have versioning enabled for the S3 bucket.

mutualTlsAuthentication_truststoreWarnings :: Lens' MutualTlsAuthentication (Maybe [Text]) Source #

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.

mutualTlsAuthentication_truststoreUri :: Lens' MutualTlsAuthentication (Maybe Text) Source #

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.

mutualTlsAuthentication_truststoreVersion :: Lens' MutualTlsAuthentication (Maybe Text) Source #

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