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.XksKeyConfigurationType

Description

Synopsis

data XksKeyConfigurationType = XksKeyConfigurationType' {
- id :: Maybe Text
}
newXksKeyConfigurationType :: XksKeyConfigurationType
xksKeyConfigurationType_id :: Lens' XksKeyConfigurationType (Maybe Text)

Documentation

data XksKeyConfigurationType Source #

Information about the external key that is associated with a KMS key in an external key store.

This element appears in a CreateKey or DescribeKey response only for a KMS key in an external key store.

The external key is a symmetric encryption key that is hosted by an external key manager outside of Amazon Web Services. When you use the KMS key in an external key store in a cryptographic operation, the cryptographic operation is performed in the external key manager using the specified external key. For more information, see External key in the Key Management Service Developer Guide.

See: newXksKeyConfigurationType smart constructor.

Constructors

XksKeyConfigurationType'
Fields id :: Maybe Text The ID of the external key in its external key manager. This is the ID that the external key store proxy uses to identify the external key.

Instances

Instances details

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

newXksKeyConfigurationType :: XksKeyConfigurationType Source #

Create a value of XksKeyConfigurationType 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:id:XksKeyConfigurationType', xksKeyConfigurationType_id - The ID of the external key in its external key manager. This is the ID that the external key store proxy uses to identify the external key.

xksKeyConfigurationType_id :: Lens' XksKeyConfigurationType (Maybe Text) Source #

The ID of the external key in its external key manager. This is the ID that the external key store proxy uses to identify the external key.