Amazonka.APIGateway.Types.MutualTlsAuthenticationInput

Documentation

data MutualTlsAuthenticationInput

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.

See: newMutualTlsAuthenticationInput smart constructor.

Constructors

MutualTlsAuthenticationInput'

Fields

• 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

ToJSON MutualTlsAuthenticationInput

Defined in Amazonka.APIGateway.Types.MutualTlsAuthenticationInput

Methods

toJSON :: MutualTlsAuthenticationInput -> Value

toEncoding :: MutualTlsAuthenticationInput -> Encoding

toJSONList :: [MutualTlsAuthenticationInput] -> Value

toEncodingList :: [MutualTlsAuthenticationInput] -> Encoding

Generic MutualTlsAuthenticationInput

Defined in Amazonka.APIGateway.Types.MutualTlsAuthenticationInput

Associated Types

type Rep MutualTlsAuthenticationInput :: Type -> Type

Methods

from :: MutualTlsAuthenticationInput -> Rep MutualTlsAuthenticationInput x

to :: Rep MutualTlsAuthenticationInput x -> MutualTlsAuthenticationInput

Read MutualTlsAuthenticationInput

Defined in Amazonka.APIGateway.Types.MutualTlsAuthenticationInput

Methods

readsPrec :: Int -> ReadS MutualTlsAuthenticationInput

readList :: ReadS [MutualTlsAuthenticationInput]

readPrec :: ReadPrec MutualTlsAuthenticationInput

readListPrec :: ReadPrec [MutualTlsAuthenticationInput]

Show MutualTlsAuthenticationInput

Defined in Amazonka.APIGateway.Types.MutualTlsAuthenticationInput

Methods

showsPrec :: Int -> MutualTlsAuthenticationInput -> ShowS

show :: MutualTlsAuthenticationInput -> String

showList :: [MutualTlsAuthenticationInput] -> ShowS

NFData MutualTlsAuthenticationInput

Defined in Amazonka.APIGateway.Types.MutualTlsAuthenticationInput

Methods

rnf :: MutualTlsAuthenticationInput -> ()

Eq MutualTlsAuthenticationInput

Defined in Amazonka.APIGateway.Types.MutualTlsAuthenticationInput

Methods

(==) :: MutualTlsAuthenticationInput -> MutualTlsAuthenticationInput -> Bool

(/=) :: MutualTlsAuthenticationInput -> MutualTlsAuthenticationInput -> Bool

Hashable MutualTlsAuthenticationInput

Defined in Amazonka.APIGateway.Types.MutualTlsAuthenticationInput

Methods

hashWithSalt :: Int -> MutualTlsAuthenticationInput -> Int

hash :: MutualTlsAuthenticationInput -> Int

type Rep MutualTlsAuthenticationInput

Defined in Amazonka.APIGateway.Types.MutualTlsAuthenticationInput

type Rep MutualTlsAuthenticationInput = D1 ('MetaData "MutualTlsAuthenticationInput" "Amazonka.APIGateway.Types.MutualTlsAuthenticationInput" "amazonka-apigateway-2.0-zw0Lbt4rUGxZBjJ4Rpfi" 'False) (C1 ('MetaCons "MutualTlsAuthenticationInput'" 'PrefixI 'True) (S1 ('MetaSel ('Just "truststoreUri") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "truststoreVersion") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))

newMutualTlsAuthenticationInput :: MutualTlsAuthenticationInput

Create a value of MutualTlsAuthenticationInput 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:truststoreUri:MutualTlsAuthenticationInput', mutualTlsAuthenticationInput_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:MutualTlsAuthenticationInput', mutualTlsAuthenticationInput_truststoreVersion - The version of the S3 object that contains your truststore. To specify a version, you must have versioning enabled for the S3 bucket

mutualTlsAuthenticationInput_truststoreUri :: Lens' MutualTlsAuthenticationInput (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.

mutualTlsAuthenticationInput_truststoreVersion :: Lens' MutualTlsAuthenticationInput (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