Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.KMS.Types.XksProxyConfigurationType

Description

Documentation

data XksProxyConfigurationType Source #

Detailed information about the external key store proxy (XKS proxy). Your external key store proxy translates KMS requests into a format that your external key manager can understand. These fields appear in a DescribeCustomKeyStores response only when the CustomKeyStoreType is EXTERNAL_KEY_STORE.

See: newXksProxyConfigurationType smart constructor.

Constructors

XksProxyConfigurationType'

Fields

accessKeyId :: Maybe (Sensitive Text)
The part of the external key store proxy authentication credential that uniquely identifies the secret access key.
connectivity :: Maybe XksProxyConnectivityType
Indicates whether the external key store proxy uses a public endpoint or an Amazon VPC endpoint service to communicate with KMS.
uriEndpoint :: Maybe Text
The URI endpoint for the external key store proxy.
If the external key store proxy has a public endpoint, it is displayed here.
If the external key store proxy uses an Amazon VPC endpoint service name, this field displays the private DNS name associated with the VPC endpoint service.
uriPath :: Maybe Text
The path to the external key store proxy APIs.
vpcEndpointServiceName :: Maybe Text
The Amazon VPC endpoint service used to communicate with the external key store proxy. This field appears only when the external key store proxy uses an Amazon VPC endpoint service to communicate with KMS.

Instances

Instances details

FromJSON XksProxyConfigurationType Source #
Instance details Defined in Amazonka.KMS.Types.XksProxyConfigurationType Methods parseJSON :: Value -> Parser XksProxyConfigurationType # parseJSONList :: Value -> Parser [XksProxyConfigurationType] #
Generic XksProxyConfigurationType Source #
Instance details Defined in Amazonka.KMS.Types.XksProxyConfigurationType Associated Types type Rep XksProxyConfigurationType :: Type -> Type # Methods from :: XksProxyConfigurationType -> Rep XksProxyConfigurationType x # to :: Rep XksProxyConfigurationType x -> XksProxyConfigurationType #
Show XksProxyConfigurationType Source #
Instance details Defined in Amazonka.KMS.Types.XksProxyConfigurationType Methods showsPrec :: Int -> XksProxyConfigurationType -> ShowS # show :: XksProxyConfigurationType -> String # showList :: [XksProxyConfigurationType] -> ShowS #
NFData XksProxyConfigurationType Source #
Instance details Defined in Amazonka.KMS.Types.XksProxyConfigurationType Methods rnf :: XksProxyConfigurationType -> () #
Eq XksProxyConfigurationType Source #
Instance details Defined in Amazonka.KMS.Types.XksProxyConfigurationType Methods (==) :: XksProxyConfigurationType -> XksProxyConfigurationType -> Bool # (/=) :: XksProxyConfigurationType -> XksProxyConfigurationType -> Bool #
Hashable XksProxyConfigurationType Source #
Instance details Defined in Amazonka.KMS.Types.XksProxyConfigurationType Methods hashWithSalt :: Int -> XksProxyConfigurationType -> Int # hash :: XksProxyConfigurationType -> Int #
type Rep XksProxyConfigurationType Source #
Instance details Defined in Amazonka.KMS.Types.XksProxyConfigurationType type Rep XksProxyConfigurationType = D1 ('MetaData "XksProxyConfigurationType" "Amazonka.KMS.Types.XksProxyConfigurationType" "amazonka-kms-2.0-6YhT3Ymbf9Z5PoaGoz7tbG" 'False) (C1 ('MetaCons "XksProxyConfigurationType'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "accessKeyId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (Sensitive Text))) :: S1 ('MetaSel ('Just "connectivity") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe XksProxyConnectivityType))) :: (S1 ('MetaSel ('Just "uriEndpoint") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "uriPath") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "vpcEndpointServiceName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))))

newXksProxyConfigurationType :: XksProxyConfigurationType Source #

Create a value of XksProxyConfigurationType 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:accessKeyId:XksProxyConfigurationType', xksProxyConfigurationType_accessKeyId - The part of the external key store proxy authentication credential that uniquely identifies the secret access key.

$sel:connectivity:XksProxyConfigurationType', xksProxyConfigurationType_connectivity - Indicates whether the external key store proxy uses a public endpoint or an Amazon VPC endpoint service to communicate with KMS.

$sel:uriEndpoint:XksProxyConfigurationType', xksProxyConfigurationType_uriEndpoint - The URI endpoint for the external key store proxy.

If the external key store proxy has a public endpoint, it is displayed here.

If the external key store proxy uses an Amazon VPC endpoint service name, this field displays the private DNS name associated with the VPC endpoint service.

$sel:uriPath:XksProxyConfigurationType', xksProxyConfigurationType_uriPath - The path to the external key store proxy APIs.

$sel:vpcEndpointServiceName:XksProxyConfigurationType', xksProxyConfigurationType_vpcEndpointServiceName - The Amazon VPC endpoint service used to communicate with the external key store proxy. This field appears only when the external key store proxy uses an Amazon VPC endpoint service to communicate with KMS.

xksProxyConfigurationType_accessKeyId :: Lens' XksProxyConfigurationType (Maybe Text) Source #

The part of the external key store proxy authentication credential that uniquely identifies the secret access key.

xksProxyConfigurationType_connectivity :: Lens' XksProxyConfigurationType (Maybe XksProxyConnectivityType) Source #

Indicates whether the external key store proxy uses a public endpoint or an Amazon VPC endpoint service to communicate with KMS.

xksProxyConfigurationType_uriEndpoint :: Lens' XksProxyConfigurationType (Maybe Text) Source #

The URI endpoint for the external key store proxy.

If the external key store proxy has a public endpoint, it is displayed here.

If the external key store proxy uses an Amazon VPC endpoint service name, this field displays the private DNS name associated with the VPC endpoint service.

xksProxyConfigurationType_uriPath :: Lens' XksProxyConfigurationType (Maybe Text) Source #

The path to the external key store proxy APIs.

xksProxyConfigurationType_vpcEndpointServiceName :: Lens' XksProxyConfigurationType (Maybe Text) Source #

The Amazon VPC endpoint service used to communicate with the external key store proxy. This field appears only when the external key store proxy uses an Amazon VPC endpoint service to communicate with KMS.