| 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
Contents
- Service Configuration
- Errors
- AlgorithmSpec
- ConnectionErrorCodeType
- ConnectionStateType
- CustomKeyStoreType
- CustomerMasterKeySpec
- DataKeyPairSpec
- DataKeySpec
- EncryptionAlgorithmSpec
- ExpirationModelType
- GrantOperation
- KeyManagerType
- KeySpec
- KeyState
- KeyUsageType
- MacAlgorithmSpec
- MessageType
- MultiRegionKeyType
- OriginType
- SigningAlgorithmSpec
- WrappingKeySpec
- XksProxyConnectivityType
- AliasListEntry
- CustomKeyStoresListEntry
- GrantConstraints
- GrantListEntry
- KeyListEntry
- KeyMetadata
- ListGrantsResponse
- MultiRegionConfiguration
- MultiRegionKey
- Tag
- XksKeyConfigurationType
- XksProxyAuthenticationCredentialType
- XksProxyConfigurationType
Description
Synopsis
- defaultService :: Service
- _AlreadyExistsException :: AsError a => Fold a ServiceError
- _CloudHsmClusterInUseException :: AsError a => Fold a ServiceError
- _CloudHsmClusterInvalidConfigurationException :: AsError a => Fold a ServiceError
- _CloudHsmClusterNotActiveException :: AsError a => Fold a ServiceError
- _CloudHsmClusterNotFoundException :: AsError a => Fold a ServiceError
- _CloudHsmClusterNotRelatedException :: AsError a => Fold a ServiceError
- _CustomKeyStoreHasCMKsException :: AsError a => Fold a ServiceError
- _CustomKeyStoreInvalidStateException :: AsError a => Fold a ServiceError
- _CustomKeyStoreNameInUseException :: AsError a => Fold a ServiceError
- _CustomKeyStoreNotFoundException :: AsError a => Fold a ServiceError
- _DependencyTimeoutException :: AsError a => Fold a ServiceError
- _DisabledException :: AsError a => Fold a ServiceError
- _ExpiredImportTokenException :: AsError a => Fold a ServiceError
- _IncorrectKeyException :: AsError a => Fold a ServiceError
- _IncorrectKeyMaterialException :: AsError a => Fold a ServiceError
- _IncorrectTrustAnchorException :: AsError a => Fold a ServiceError
- _InvalidAliasNameException :: AsError a => Fold a ServiceError
- _InvalidArnException :: AsError a => Fold a ServiceError
- _InvalidCiphertextException :: AsError a => Fold a ServiceError
- _InvalidGrantIdException :: AsError a => Fold a ServiceError
- _InvalidGrantTokenException :: AsError a => Fold a ServiceError
- _InvalidImportTokenException :: AsError a => Fold a ServiceError
- _InvalidKeyUsageException :: AsError a => Fold a ServiceError
- _InvalidMarkerException :: AsError a => Fold a ServiceError
- _KMSInternalException :: AsError a => Fold a ServiceError
- _KMSInvalidMacException :: AsError a => Fold a ServiceError
- _KMSInvalidSignatureException :: AsError a => Fold a ServiceError
- _KMSInvalidStateException :: AsError a => Fold a ServiceError
- _KeyUnavailableException :: AsError a => Fold a ServiceError
- _LimitExceededException :: AsError a => Fold a ServiceError
- _MalformedPolicyDocumentException :: AsError a => Fold a ServiceError
- _NotFoundException :: AsError a => Fold a ServiceError
- _TagException :: AsError a => Fold a ServiceError
- _UnsupportedOperationException :: AsError a => Fold a ServiceError
- _XksKeyAlreadyInUseException :: AsError a => Fold a ServiceError
- _XksKeyInvalidConfigurationException :: AsError a => Fold a ServiceError
- _XksKeyNotFoundException :: AsError a => Fold a ServiceError
- _XksProxyIncorrectAuthenticationCredentialException :: AsError a => Fold a ServiceError
- _XksProxyInvalidConfigurationException :: AsError a => Fold a ServiceError
- _XksProxyInvalidResponseException :: AsError a => Fold a ServiceError
- _XksProxyUriEndpointInUseException :: AsError a => Fold a ServiceError
- _XksProxyUriInUseException :: AsError a => Fold a ServiceError
- _XksProxyUriUnreachableException :: AsError a => Fold a ServiceError
- _XksProxyVpcEndpointServiceInUseException :: AsError a => Fold a ServiceError
- _XksProxyVpcEndpointServiceInvalidConfigurationException :: AsError a => Fold a ServiceError
- _XksProxyVpcEndpointServiceNotFoundException :: AsError a => Fold a ServiceError
- newtype AlgorithmSpec where
- AlgorithmSpec' { }
- pattern AlgorithmSpec_RSAES_OAEP_SHA_1 :: AlgorithmSpec
- pattern AlgorithmSpec_RSAES_OAEP_SHA_256 :: AlgorithmSpec
- pattern AlgorithmSpec_RSAES_PKCS1_V1_5 :: AlgorithmSpec
- newtype ConnectionErrorCodeType where
- ConnectionErrorCodeType' { }
- pattern ConnectionErrorCodeType_CLUSTER_NOT_FOUND :: ConnectionErrorCodeType
- pattern ConnectionErrorCodeType_INSUFFICIENT_CLOUDHSM_HSMS :: ConnectionErrorCodeType
- pattern ConnectionErrorCodeType_INSUFFICIENT_FREE_ADDRESSES_IN_SUBNET :: ConnectionErrorCodeType
- pattern ConnectionErrorCodeType_INTERNAL_ERROR :: ConnectionErrorCodeType
- pattern ConnectionErrorCodeType_INVALID_CREDENTIALS :: ConnectionErrorCodeType
- pattern ConnectionErrorCodeType_NETWORK_ERRORS :: ConnectionErrorCodeType
- pattern ConnectionErrorCodeType_SUBNET_NOT_FOUND :: ConnectionErrorCodeType
- pattern ConnectionErrorCodeType_USER_LOCKED_OUT :: ConnectionErrorCodeType
- pattern ConnectionErrorCodeType_USER_LOGGED_IN :: ConnectionErrorCodeType
- pattern ConnectionErrorCodeType_USER_NOT_FOUND :: ConnectionErrorCodeType
- pattern ConnectionErrorCodeType_XKS_PROXY_ACCESS_DENIED :: ConnectionErrorCodeType
- pattern ConnectionErrorCodeType_XKS_PROXY_INVALID_CONFIGURATION :: ConnectionErrorCodeType
- pattern ConnectionErrorCodeType_XKS_PROXY_INVALID_RESPONSE :: ConnectionErrorCodeType
- pattern ConnectionErrorCodeType_XKS_PROXY_INVALID_TLS_CONFIGURATION :: ConnectionErrorCodeType
- pattern ConnectionErrorCodeType_XKS_PROXY_NOT_REACHABLE :: ConnectionErrorCodeType
- pattern ConnectionErrorCodeType_XKS_PROXY_TIMED_OUT :: ConnectionErrorCodeType
- pattern ConnectionErrorCodeType_XKS_VPC_ENDPOINT_SERVICE_INVALID_CONFIGURATION :: ConnectionErrorCodeType
- pattern ConnectionErrorCodeType_XKS_VPC_ENDPOINT_SERVICE_NOT_FOUND :: ConnectionErrorCodeType
- newtype ConnectionStateType where
- ConnectionStateType' { }
- pattern ConnectionStateType_CONNECTED :: ConnectionStateType
- pattern ConnectionStateType_CONNECTING :: ConnectionStateType
- pattern ConnectionStateType_DISCONNECTED :: ConnectionStateType
- pattern ConnectionStateType_DISCONNECTING :: ConnectionStateType
- pattern ConnectionStateType_FAILED :: ConnectionStateType
- newtype CustomKeyStoreType where
- newtype CustomerMasterKeySpec where
- CustomerMasterKeySpec' { }
- pattern CustomerMasterKeySpec_ECC_NIST_P256 :: CustomerMasterKeySpec
- pattern CustomerMasterKeySpec_ECC_NIST_P384 :: CustomerMasterKeySpec
- pattern CustomerMasterKeySpec_ECC_NIST_P521 :: CustomerMasterKeySpec
- pattern CustomerMasterKeySpec_ECC_SECG_P256K1 :: CustomerMasterKeySpec
- pattern CustomerMasterKeySpec_HMAC_224 :: CustomerMasterKeySpec
- pattern CustomerMasterKeySpec_HMAC_256 :: CustomerMasterKeySpec
- pattern CustomerMasterKeySpec_HMAC_384 :: CustomerMasterKeySpec
- pattern CustomerMasterKeySpec_HMAC_512 :: CustomerMasterKeySpec
- pattern CustomerMasterKeySpec_RSA_2048 :: CustomerMasterKeySpec
- pattern CustomerMasterKeySpec_RSA_3072 :: CustomerMasterKeySpec
- pattern CustomerMasterKeySpec_RSA_4096 :: CustomerMasterKeySpec
- pattern CustomerMasterKeySpec_SM2 :: CustomerMasterKeySpec
- pattern CustomerMasterKeySpec_SYMMETRIC_DEFAULT :: CustomerMasterKeySpec
- newtype DataKeyPairSpec where
- DataKeyPairSpec' { }
- pattern DataKeyPairSpec_ECC_NIST_P256 :: DataKeyPairSpec
- pattern DataKeyPairSpec_ECC_NIST_P384 :: DataKeyPairSpec
- pattern DataKeyPairSpec_ECC_NIST_P521 :: DataKeyPairSpec
- pattern DataKeyPairSpec_ECC_SECG_P256K1 :: DataKeyPairSpec
- pattern DataKeyPairSpec_RSA_2048 :: DataKeyPairSpec
- pattern DataKeyPairSpec_RSA_3072 :: DataKeyPairSpec
- pattern DataKeyPairSpec_RSA_4096 :: DataKeyPairSpec
- pattern DataKeyPairSpec_SM2 :: DataKeyPairSpec
- newtype DataKeySpec where
- DataKeySpec' { }
- pattern DataKeySpec_AES_128 :: DataKeySpec
- pattern DataKeySpec_AES_256 :: DataKeySpec
- newtype EncryptionAlgorithmSpec where
- EncryptionAlgorithmSpec' { }
- pattern EncryptionAlgorithmSpec_RSAES_OAEP_SHA_1 :: EncryptionAlgorithmSpec
- pattern EncryptionAlgorithmSpec_RSAES_OAEP_SHA_256 :: EncryptionAlgorithmSpec
- pattern EncryptionAlgorithmSpec_SM2PKE :: EncryptionAlgorithmSpec
- pattern EncryptionAlgorithmSpec_SYMMETRIC_DEFAULT :: EncryptionAlgorithmSpec
- newtype ExpirationModelType where
- newtype GrantOperation where
- GrantOperation' { }
- pattern GrantOperation_CreateGrant :: GrantOperation
- pattern GrantOperation_Decrypt :: GrantOperation
- pattern GrantOperation_DescribeKey :: GrantOperation
- pattern GrantOperation_Encrypt :: GrantOperation
- pattern GrantOperation_GenerateDataKey :: GrantOperation
- pattern GrantOperation_GenerateDataKeyPair :: GrantOperation
- pattern GrantOperation_GenerateDataKeyPairWithoutPlaintext :: GrantOperation
- pattern GrantOperation_GenerateDataKeyWithoutPlaintext :: GrantOperation
- pattern GrantOperation_GenerateMac :: GrantOperation
- pattern GrantOperation_GetPublicKey :: GrantOperation
- pattern GrantOperation_ReEncryptFrom :: GrantOperation
- pattern GrantOperation_ReEncryptTo :: GrantOperation
- pattern GrantOperation_RetireGrant :: GrantOperation
- pattern GrantOperation_Sign :: GrantOperation
- pattern GrantOperation_Verify :: GrantOperation
- pattern GrantOperation_VerifyMac :: GrantOperation
- newtype KeyManagerType where
- KeyManagerType' { }
- pattern KeyManagerType_AWS :: KeyManagerType
- pattern KeyManagerType_CUSTOMER :: KeyManagerType
- newtype KeySpec where
- KeySpec' {
- fromKeySpec :: Text
- pattern KeySpec_ECC_NIST_P256 :: KeySpec
- pattern KeySpec_ECC_NIST_P384 :: KeySpec
- pattern KeySpec_ECC_NIST_P521 :: KeySpec
- pattern KeySpec_ECC_SECG_P256K1 :: KeySpec
- pattern KeySpec_HMAC_224 :: KeySpec
- pattern KeySpec_HMAC_256 :: KeySpec
- pattern KeySpec_HMAC_384 :: KeySpec
- pattern KeySpec_HMAC_512 :: KeySpec
- pattern KeySpec_RSA_2048 :: KeySpec
- pattern KeySpec_RSA_3072 :: KeySpec
- pattern KeySpec_RSA_4096 :: KeySpec
- pattern KeySpec_SM2 :: KeySpec
- pattern KeySpec_SYMMETRIC_DEFAULT :: KeySpec
- KeySpec' {
- newtype KeyState where
- KeyState' {
- fromKeyState :: Text
- pattern KeyState_Creating :: KeyState
- pattern KeyState_Disabled :: KeyState
- pattern KeyState_Enabled :: KeyState
- pattern KeyState_PendingDeletion :: KeyState
- pattern KeyState_PendingImport :: KeyState
- pattern KeyState_PendingReplicaDeletion :: KeyState
- pattern KeyState_Unavailable :: KeyState
- pattern KeyState_Updating :: KeyState
- KeyState' {
- newtype KeyUsageType where
- KeyUsageType' { }
- pattern KeyUsageType_ENCRYPT_DECRYPT :: KeyUsageType
- pattern KeyUsageType_GENERATE_VERIFY_MAC :: KeyUsageType
- pattern KeyUsageType_SIGN_VERIFY :: KeyUsageType
- newtype MacAlgorithmSpec where
- MacAlgorithmSpec' { }
- pattern MacAlgorithmSpec_HMAC_SHA_224 :: MacAlgorithmSpec
- pattern MacAlgorithmSpec_HMAC_SHA_256 :: MacAlgorithmSpec
- pattern MacAlgorithmSpec_HMAC_SHA_384 :: MacAlgorithmSpec
- pattern MacAlgorithmSpec_HMAC_SHA_512 :: MacAlgorithmSpec
- newtype MessageType where
- MessageType' { }
- pattern MessageType_DIGEST :: MessageType
- pattern MessageType_RAW :: MessageType
- newtype MultiRegionKeyType where
- newtype OriginType where
- OriginType' { }
- pattern OriginType_AWS_CLOUDHSM :: OriginType
- pattern OriginType_AWS_KMS :: OriginType
- pattern OriginType_EXTERNAL :: OriginType
- pattern OriginType_EXTERNAL_KEY_STORE :: OriginType
- newtype SigningAlgorithmSpec where
- SigningAlgorithmSpec' { }
- pattern SigningAlgorithmSpec_ECDSA_SHA_256 :: SigningAlgorithmSpec
- pattern SigningAlgorithmSpec_ECDSA_SHA_384 :: SigningAlgorithmSpec
- pattern SigningAlgorithmSpec_ECDSA_SHA_512 :: SigningAlgorithmSpec
- pattern SigningAlgorithmSpec_RSASSA_PKCS1_V1_5_SHA_256 :: SigningAlgorithmSpec
- pattern SigningAlgorithmSpec_RSASSA_PKCS1_V1_5_SHA_384 :: SigningAlgorithmSpec
- pattern SigningAlgorithmSpec_RSASSA_PKCS1_V1_5_SHA_512 :: SigningAlgorithmSpec
- pattern SigningAlgorithmSpec_RSASSA_PSS_SHA_256 :: SigningAlgorithmSpec
- pattern SigningAlgorithmSpec_RSASSA_PSS_SHA_384 :: SigningAlgorithmSpec
- pattern SigningAlgorithmSpec_RSASSA_PSS_SHA_512 :: SigningAlgorithmSpec
- pattern SigningAlgorithmSpec_SM2DSA :: SigningAlgorithmSpec
- newtype WrappingKeySpec where
- WrappingKeySpec' { }
- pattern WrappingKeySpec_RSA_2048 :: WrappingKeySpec
- newtype XksProxyConnectivityType where
- data AliasListEntry = AliasListEntry' {}
- newAliasListEntry :: AliasListEntry
- aliasListEntry_aliasArn :: Lens' AliasListEntry (Maybe Text)
- aliasListEntry_aliasName :: Lens' AliasListEntry (Maybe Text)
- aliasListEntry_creationDate :: Lens' AliasListEntry (Maybe UTCTime)
- aliasListEntry_lastUpdatedDate :: Lens' AliasListEntry (Maybe UTCTime)
- aliasListEntry_targetKeyId :: Lens' AliasListEntry (Maybe Text)
- data CustomKeyStoresListEntry = CustomKeyStoresListEntry' {
- cloudHsmClusterId :: Maybe Text
- connectionErrorCode :: Maybe ConnectionErrorCodeType
- connectionState :: Maybe ConnectionStateType
- creationDate :: Maybe POSIX
- customKeyStoreId :: Maybe Text
- customKeyStoreName :: Maybe Text
- customKeyStoreType :: Maybe CustomKeyStoreType
- trustAnchorCertificate :: Maybe Text
- xksProxyConfiguration :: Maybe XksProxyConfigurationType
- newCustomKeyStoresListEntry :: CustomKeyStoresListEntry
- customKeyStoresListEntry_cloudHsmClusterId :: Lens' CustomKeyStoresListEntry (Maybe Text)
- customKeyStoresListEntry_connectionErrorCode :: Lens' CustomKeyStoresListEntry (Maybe ConnectionErrorCodeType)
- customKeyStoresListEntry_connectionState :: Lens' CustomKeyStoresListEntry (Maybe ConnectionStateType)
- customKeyStoresListEntry_creationDate :: Lens' CustomKeyStoresListEntry (Maybe UTCTime)
- customKeyStoresListEntry_customKeyStoreId :: Lens' CustomKeyStoresListEntry (Maybe Text)
- customKeyStoresListEntry_customKeyStoreName :: Lens' CustomKeyStoresListEntry (Maybe Text)
- customKeyStoresListEntry_customKeyStoreType :: Lens' CustomKeyStoresListEntry (Maybe CustomKeyStoreType)
- customKeyStoresListEntry_trustAnchorCertificate :: Lens' CustomKeyStoresListEntry (Maybe Text)
- customKeyStoresListEntry_xksProxyConfiguration :: Lens' CustomKeyStoresListEntry (Maybe XksProxyConfigurationType)
- data GrantConstraints = GrantConstraints' {}
- newGrantConstraints :: GrantConstraints
- grantConstraints_encryptionContextEquals :: Lens' GrantConstraints (Maybe (HashMap Text Text))
- grantConstraints_encryptionContextSubset :: Lens' GrantConstraints (Maybe (HashMap Text Text))
- data GrantListEntry = GrantListEntry' {}
- newGrantListEntry :: GrantListEntry
- grantListEntry_constraints :: Lens' GrantListEntry (Maybe GrantConstraints)
- grantListEntry_creationDate :: Lens' GrantListEntry (Maybe UTCTime)
- grantListEntry_grantId :: Lens' GrantListEntry (Maybe Text)
- grantListEntry_granteePrincipal :: Lens' GrantListEntry (Maybe Text)
- grantListEntry_issuingAccount :: Lens' GrantListEntry (Maybe Text)
- grantListEntry_keyId :: Lens' GrantListEntry (Maybe Text)
- grantListEntry_name :: Lens' GrantListEntry (Maybe Text)
- grantListEntry_operations :: Lens' GrantListEntry (Maybe [GrantOperation])
- grantListEntry_retiringPrincipal :: Lens' GrantListEntry (Maybe Text)
- data KeyListEntry = KeyListEntry' {}
- newKeyListEntry :: KeyListEntry
- keyListEntry_keyArn :: Lens' KeyListEntry (Maybe Text)
- keyListEntry_keyId :: Lens' KeyListEntry (Maybe Text)
- data KeyMetadata = KeyMetadata' {
- aWSAccountId :: Maybe Text
- arn :: Maybe Text
- cloudHsmClusterId :: Maybe Text
- creationDate :: Maybe POSIX
- customKeyStoreId :: Maybe Text
- customerMasterKeySpec :: Maybe CustomerMasterKeySpec
- deletionDate :: Maybe POSIX
- description :: Maybe Text
- enabled :: Maybe Bool
- encryptionAlgorithms :: Maybe [EncryptionAlgorithmSpec]
- expirationModel :: Maybe ExpirationModelType
- keyManager :: Maybe KeyManagerType
- keySpec :: Maybe KeySpec
- keyState :: Maybe KeyState
- keyUsage :: Maybe KeyUsageType
- macAlgorithms :: Maybe [MacAlgorithmSpec]
- multiRegion :: Maybe Bool
- multiRegionConfiguration :: Maybe MultiRegionConfiguration
- origin :: Maybe OriginType
- pendingDeletionWindowInDays :: Maybe Natural
- signingAlgorithms :: Maybe [SigningAlgorithmSpec]
- validTo :: Maybe POSIX
- xksKeyConfiguration :: Maybe XksKeyConfigurationType
- keyId :: Text
- newKeyMetadata :: Text -> KeyMetadata
- keyMetadata_aWSAccountId :: Lens' KeyMetadata (Maybe Text)
- keyMetadata_arn :: Lens' KeyMetadata (Maybe Text)
- keyMetadata_cloudHsmClusterId :: Lens' KeyMetadata (Maybe Text)
- keyMetadata_creationDate :: Lens' KeyMetadata (Maybe UTCTime)
- keyMetadata_customKeyStoreId :: Lens' KeyMetadata (Maybe Text)
- keyMetadata_customerMasterKeySpec :: Lens' KeyMetadata (Maybe CustomerMasterKeySpec)
- keyMetadata_deletionDate :: Lens' KeyMetadata (Maybe UTCTime)
- keyMetadata_description :: Lens' KeyMetadata (Maybe Text)
- keyMetadata_enabled :: Lens' KeyMetadata (Maybe Bool)
- keyMetadata_encryptionAlgorithms :: Lens' KeyMetadata (Maybe [EncryptionAlgorithmSpec])
- keyMetadata_expirationModel :: Lens' KeyMetadata (Maybe ExpirationModelType)
- keyMetadata_keyManager :: Lens' KeyMetadata (Maybe KeyManagerType)
- keyMetadata_keySpec :: Lens' KeyMetadata (Maybe KeySpec)
- keyMetadata_keyState :: Lens' KeyMetadata (Maybe KeyState)
- keyMetadata_keyUsage :: Lens' KeyMetadata (Maybe KeyUsageType)
- keyMetadata_macAlgorithms :: Lens' KeyMetadata (Maybe [MacAlgorithmSpec])
- keyMetadata_multiRegion :: Lens' KeyMetadata (Maybe Bool)
- keyMetadata_multiRegionConfiguration :: Lens' KeyMetadata (Maybe MultiRegionConfiguration)
- keyMetadata_origin :: Lens' KeyMetadata (Maybe OriginType)
- keyMetadata_pendingDeletionWindowInDays :: Lens' KeyMetadata (Maybe Natural)
- keyMetadata_signingAlgorithms :: Lens' KeyMetadata (Maybe [SigningAlgorithmSpec])
- keyMetadata_validTo :: Lens' KeyMetadata (Maybe UTCTime)
- keyMetadata_xksKeyConfiguration :: Lens' KeyMetadata (Maybe XksKeyConfigurationType)
- keyMetadata_keyId :: Lens' KeyMetadata Text
- data ListGrantsResponse = ListGrantsResponse' {
- grants :: Maybe [GrantListEntry]
- nextMarker :: Maybe Text
- truncated :: Maybe Bool
- newListGrantsResponse :: ListGrantsResponse
- listGrantsResponse_grants :: Lens' ListGrantsResponse (Maybe [GrantListEntry])
- listGrantsResponse_nextMarker :: Lens' ListGrantsResponse (Maybe Text)
- listGrantsResponse_truncated :: Lens' ListGrantsResponse (Maybe Bool)
- data MultiRegionConfiguration = MultiRegionConfiguration' {}
- newMultiRegionConfiguration :: MultiRegionConfiguration
- multiRegionConfiguration_multiRegionKeyType :: Lens' MultiRegionConfiguration (Maybe MultiRegionKeyType)
- multiRegionConfiguration_primaryKey :: Lens' MultiRegionConfiguration (Maybe MultiRegionKey)
- multiRegionConfiguration_replicaKeys :: Lens' MultiRegionConfiguration (Maybe [MultiRegionKey])
- data MultiRegionKey = MultiRegionKey' {}
- newMultiRegionKey :: MultiRegionKey
- multiRegionKey_arn :: Lens' MultiRegionKey (Maybe Text)
- multiRegionKey_region :: Lens' MultiRegionKey (Maybe Text)
- data Tag = Tag' {}
- newTag :: Text -> Text -> Tag
- tag_tagKey :: Lens' Tag Text
- tag_tagValue :: Lens' Tag Text
- data XksKeyConfigurationType = XksKeyConfigurationType' {}
- newXksKeyConfigurationType :: XksKeyConfigurationType
- xksKeyConfigurationType_id :: Lens' XksKeyConfigurationType (Maybe Text)
- data XksProxyAuthenticationCredentialType = XksProxyAuthenticationCredentialType' {}
- newXksProxyAuthenticationCredentialType :: Text -> Text -> XksProxyAuthenticationCredentialType
- xksProxyAuthenticationCredentialType_accessKeyId :: Lens' XksProxyAuthenticationCredentialType Text
- xksProxyAuthenticationCredentialType_rawSecretAccessKey :: Lens' XksProxyAuthenticationCredentialType Text
- data XksProxyConfigurationType = XksProxyConfigurationType' {}
- newXksProxyConfigurationType :: XksProxyConfigurationType
- xksProxyConfigurationType_accessKeyId :: Lens' XksProxyConfigurationType (Maybe Text)
- xksProxyConfigurationType_connectivity :: Lens' XksProxyConfigurationType (Maybe XksProxyConnectivityType)
- xksProxyConfigurationType_uriEndpoint :: Lens' XksProxyConfigurationType (Maybe Text)
- xksProxyConfigurationType_uriPath :: Lens' XksProxyConfigurationType (Maybe Text)
- xksProxyConfigurationType_vpcEndpointServiceName :: Lens' XksProxyConfigurationType (Maybe Text)
Service Configuration
defaultService :: Service Source #
API version 2014-11-01 of the Amazon Key Management Service SDK configuration.
Errors
_AlreadyExistsException :: AsError a => Fold a ServiceError Source #
The request was rejected because it attempted to create a resource that already exists.
_CloudHsmClusterInUseException :: AsError a => Fold a ServiceError Source #
The request was rejected because the specified CloudHSM cluster is already associated with an CloudHSM key store in the account, or it shares a backup history with an CloudHSM key store in the account. Each CloudHSM key store in the account must be associated with a different CloudHSM cluster.
CloudHSM clusters that share a backup history have the same cluster certificate. To view the cluster certificate of an CloudHSM cluster, use the DescribeClusters operation.
_CloudHsmClusterInvalidConfigurationException :: AsError a => Fold a ServiceError Source #
The request was rejected because the associated CloudHSM cluster did not meet the configuration requirements for an CloudHSM key store.
- The CloudHSM cluster must be configured with private subnets in at least two different Availability Zones in the Region.
- The security group for the cluster (cloudhsm-cluster-<cluster-id>-sg) must include inbound rules and outbound rules that allow TCP traffic on ports 2223-2225. The Source in the inbound rules and the Destination in the outbound rules must match the security group ID. These rules are set by default when you create the CloudHSM cluster. Do not delete or change them. To get information about a particular security group, use the DescribeSecurityGroups operation.
The CloudHSM cluster must contain at least as many HSMs as the operation requires. To add HSMs, use the CloudHSM CreateHsm operation.
For the CreateCustomKeyStore, UpdateCustomKeyStore, and CreateKey operations, the CloudHSM cluster must have at least two active HSMs, each in a different Availability Zone. For the ConnectCustomKeyStore operation, the CloudHSM must contain at least one active HSM.
For information about the requirements for an CloudHSM cluster that is associated with an CloudHSM key store, see Assemble the Prerequisites in the Key Management Service Developer Guide. For information about creating a private subnet for an CloudHSM cluster, see Create a Private Subnet in the CloudHSM User Guide. For information about cluster security groups, see Configure a Default Security Group in the /CloudHSM User Guide/ .
_CloudHsmClusterNotActiveException :: AsError a => Fold a ServiceError Source #
The request was rejected because the CloudHSM cluster associated with the CloudHSM key store is not active. Initialize and activate the cluster and try the command again. For detailed instructions, see Getting Started in the CloudHSM User Guide.
_CloudHsmClusterNotFoundException :: AsError a => Fold a ServiceError Source #
The request was rejected because KMS cannot find the CloudHSM cluster with the specified cluster ID. Retry the request with a different cluster ID.
_CloudHsmClusterNotRelatedException :: AsError a => Fold a ServiceError Source #
The request was rejected because the specified CloudHSM cluster has a different cluster certificate than the original cluster. You cannot use the operation to specify an unrelated cluster for an CloudHSM key store.
Specify an CloudHSM cluster that shares a backup history with the original cluster. This includes clusters that were created from a backup of the current cluster, and clusters that were created from the same backup that produced the current cluster.
CloudHSM clusters that share a backup history have the same cluster certificate. To view the cluster certificate of an CloudHSM cluster, use the DescribeClusters operation.
_CustomKeyStoreHasCMKsException :: AsError a => Fold a ServiceError Source #
The request was rejected because the custom key store contains KMS keys. After verifying that you do not need to use the KMS keys, use the ScheduleKeyDeletion operation to delete the KMS keys. After they are deleted, you can delete the custom key store.
_CustomKeyStoreInvalidStateException :: AsError a => Fold a ServiceError Source #
The request was rejected because of the ConnectionState of the custom
key store. To get the ConnectionState of a custom key store, use the
DescribeCustomKeyStores operation.
This exception is thrown under the following conditions:
- You requested the ConnectCustomKeyStore operation on a custom key
store with a
ConnectionStateofDISCONNECTINGorFAILED. This operation is valid for all otherConnectionStatevalues. To reconnect a custom key store in aFAILEDstate, disconnect it (DisconnectCustomKeyStore), then connect it (ConnectCustomKeyStore). - You requested the CreateKey operation in a custom key store that is
not connected. This operations is valid only when the custom key
store
ConnectionStateisCONNECTED. - You requested the DisconnectCustomKeyStore operation on a custom key
store with a
ConnectionStateofDISCONNECTINGorDISCONNECTED. This operation is valid for all otherConnectionStatevalues. - You requested the UpdateCustomKeyStore or DeleteCustomKeyStore
operation on a custom key store that is not disconnected. This
operation is valid only when the custom key store
ConnectionStateisDISCONNECTED. - You requested the GenerateRandom operation in an CloudHSM key store
that is not connected. This operation is valid only when the
CloudHSM key store
ConnectionStateisCONNECTED.
_CustomKeyStoreNameInUseException :: AsError a => Fold a ServiceError Source #
The request was rejected because the specified custom key store name is already assigned to another custom key store in the account. Try again with a custom key store name that is unique in the account.
_CustomKeyStoreNotFoundException :: AsError a => Fold a ServiceError Source #
The request was rejected because KMS cannot find a custom key store with the specified key store name or ID.
_DependencyTimeoutException :: AsError a => Fold a ServiceError Source #
The system timed out while trying to fulfill the request. You can retry the request.
_DisabledException :: AsError a => Fold a ServiceError Source #
The request was rejected because the specified KMS key is not enabled.
_ExpiredImportTokenException :: AsError a => Fold a ServiceError Source #
The request was rejected because the specified import token is expired. Use GetParametersForImport to get a new import token and public key, use the new public key to encrypt the key material, and then try the request again.
_IncorrectKeyException :: AsError a => Fold a ServiceError Source #
The request was rejected because the specified KMS key cannot decrypt
the data. The KeyId in a Decrypt request and the SourceKeyId in a
ReEncrypt request must identify the same KMS key that was used to
encrypt the ciphertext.
_IncorrectKeyMaterialException :: AsError a => Fold a ServiceError Source #
The request was rejected because the key material in the request is, expired, invalid, or is not the same key material that was previously imported into this KMS key.
_IncorrectTrustAnchorException :: AsError a => Fold a ServiceError Source #
The request was rejected because the trust anchor certificate in the request to create an CloudHSM key store is not the trust anchor certificate for the specified CloudHSM cluster.
When you
initialize the CloudHSM cluster,
you create the trust anchor certificate and save it in the
customerCA.crt file.
_InvalidAliasNameException :: AsError a => Fold a ServiceError Source #
The request was rejected because the specified alias name is not valid.
_InvalidArnException :: AsError a => Fold a ServiceError Source #
The request was rejected because a specified ARN, or an ARN in a key policy, is not valid.
_InvalidCiphertextException :: AsError a => Fold a ServiceError Source #
From the Decrypt or ReEncrypt operation, the request was rejected because the specified ciphertext, or additional authenticated data incorporated into the ciphertext, such as the encryption context, is corrupted, missing, or otherwise invalid.
From the ImportKeyMaterial operation, the request was rejected because KMS could not decrypt the encrypted (wrapped) key material.
_InvalidGrantIdException :: AsError a => Fold a ServiceError Source #
The request was rejected because the specified GrantId is not valid.
_InvalidGrantTokenException :: AsError a => Fold a ServiceError Source #
The request was rejected because the specified grant token is not valid.
_InvalidImportTokenException :: AsError a => Fold a ServiceError Source #
The request was rejected because the provided import token is invalid or is associated with a different KMS key.
_InvalidKeyUsageException :: AsError a => Fold a ServiceError Source #
The request was rejected for one of the following reasons:
- The
KeyUsagevalue of the KMS key is incompatible with the API operation. - The encryption algorithm or signing algorithm specified for the
operation is incompatible with the type of key material in the KMS
key
(KeySpec).
For encrypting, decrypting, re-encrypting, and generating data keys, the
KeyUsage must be ENCRYPT_DECRYPT. For signing and verifying
messages, the KeyUsage must be SIGN_VERIFY. For generating and
verifying message authentication codes (MACs), the KeyUsage must be
GENERATE_VERIFY_MAC. To find the KeyUsage of a KMS key, use the
DescribeKey operation.
To find the encryption or signing algorithms supported for a particular KMS key, use the DescribeKey operation.
_InvalidMarkerException :: AsError a => Fold a ServiceError Source #
The request was rejected because the marker that specifies where pagination should next begin is not valid.
_KMSInternalException :: AsError a => Fold a ServiceError Source #
The request was rejected because an internal exception occurred. The request can be retried.
_KMSInvalidMacException :: AsError a => Fold a ServiceError Source #
The request was rejected because the HMAC verification failed. HMAC verification fails when the HMAC computed by using the specified message, HMAC KMS key, and MAC algorithm does not match the HMAC specified in the request.
_KMSInvalidSignatureException :: AsError a => Fold a ServiceError Source #
The request was rejected because the signature verification failed. Signature verification fails when it cannot confirm that signature was produced by signing the specified message with the specified KMS key and signing algorithm.
_KMSInvalidStateException :: AsError a => Fold a ServiceError Source #
The request was rejected because the state of the specified resource is not valid for this request.
This exceptions means one of the following:
The key state of the KMS key is not compatible with the operation.
To find the key state, use the DescribeKey operation. For more information about which key states are compatible with each KMS operation, see Key states of KMS keys in the /Key Management Service Developer Guide/ .
- For cryptographic operations on KMS keys in custom key stores, this exception represents a general failure with many possible causes. To identify the cause, see the error message that accompanies the exception.
_KeyUnavailableException :: AsError a => Fold a ServiceError Source #
The request was rejected because the specified KMS key was not available. You can retry the request.
_LimitExceededException :: AsError a => Fold a ServiceError Source #
The request was rejected because a quota was exceeded. For more information, see Quotas in the Key Management Service Developer Guide.
_MalformedPolicyDocumentException :: AsError a => Fold a ServiceError Source #
The request was rejected because the specified policy is not syntactically or semantically correct.
_NotFoundException :: AsError a => Fold a ServiceError Source #
The request was rejected because the specified entity or resource could not be found.
_TagException :: AsError a => Fold a ServiceError Source #
The request was rejected because one or more tags are not valid.
_UnsupportedOperationException :: AsError a => Fold a ServiceError Source #
The request was rejected because a specified parameter is not supported or a specified resource is not valid for this operation.
_XksKeyAlreadyInUseException :: AsError a => Fold a ServiceError Source #
The request was rejected because the (XksKeyId) is already associated
with a KMS key in this external key store. Each KMS key in an external
key store must be associated with a different external key.
_XksKeyInvalidConfigurationException :: AsError a => Fold a ServiceError Source #
The request was rejected because the external key specified by the
XksKeyId parameter did not meet the configuration requirements for an
external key store.
The external key must be an AES-256 symmetric key that is enabled and performs encryption and decryption.
_XksKeyNotFoundException :: AsError a => Fold a ServiceError Source #
The request was rejected because the external key store proxy could not
find the external key. This exception is thrown when the value of the
XksKeyId parameter doesn't identify a key in the external key manager
associated with the external key proxy.
Verify that the XksKeyId represents an existing key in the external
key manager. Use the key identifier that the external key store proxy
uses to identify the key. For details, see the documentation provided
with your external key store proxy or key manager.
_XksProxyIncorrectAuthenticationCredentialException :: AsError a => Fold a ServiceError Source #
The request was rejected because the proxy credentials failed to authenticate to the specified external key store proxy. The specified external key store proxy rejected a status request from KMS due to invalid credentials. This can indicate an error in the credentials or in the identification of the external key store proxy.
_XksProxyInvalidConfigurationException :: AsError a => Fold a ServiceError Source #
The request was rejected because the Amazon VPC endpoint service configuration does not fulfill the requirements for an external key store proxy. For details, see the exception message.
_XksProxyInvalidResponseException :: AsError a => Fold a ServiceError Source #
KMS cannot interpret the response it received from the external key store proxy. The problem might be a poorly constructed response, but it could also be a transient network issue. If you see this error repeatedly, report it to the proxy vendor.
_XksProxyUriEndpointInUseException :: AsError a => Fold a ServiceError Source #
The request was rejected because the concatenation of the
XksProxyUriEndpoint is already associated with an external key store
in the Amazon Web Services account and Region. Each external key store
in an account and Region must use a unique external key store proxy
address.
_XksProxyUriInUseException :: AsError a => Fold a ServiceError Source #
The request was rejected because the concatenation of the
XksProxyUriEndpoint and XksProxyUriPath is already associated with
an external key store in the Amazon Web Services account and Region.
Each external key store in an account and Region must use a unique
external key store proxy API address.
_XksProxyUriUnreachableException :: AsError a => Fold a ServiceError Source #
KMS was unable to reach the specified XksProxyUriPath. The path must
be reachable before you create the external key store or update its
settings.
This exception is also thrown when the external key store proxy response
to a GetHealthStatus request indicates that all external key manager
instances are unavailable.
_XksProxyVpcEndpointServiceInUseException :: AsError a => Fold a ServiceError Source #
The request was rejected because the specified Amazon VPC endpoint service is already associated with an external key store in the Amazon Web Services account and Region. Each external key store in an Amazon Web Services account and Region must use a different Amazon VPC endpoint service.
_XksProxyVpcEndpointServiceInvalidConfigurationException :: AsError a => Fold a ServiceError Source #
The request was rejected because the Amazon VPC endpoint service configuration does not fulfill the requirements for an external key store proxy. For details, see the exception message and review the requirements for Amazon VPC endpoint service connectivity for an external key store.
_XksProxyVpcEndpointServiceNotFoundException :: AsError a => Fold a ServiceError Source #
The request was rejected because KMS could not find the specified VPC
endpoint service. Use DescribeCustomKeyStores to verify the VPC endpoint
service name for the external key store. Also, confirm that the
Allow principals list for the VPC endpoint service includes the KMS
service principal for the Region, such as
cks.kms.us-east-1.amazonaws.com.
AlgorithmSpec
newtype AlgorithmSpec Source #
Constructors
| AlgorithmSpec' | |
Fields | |
Bundled Patterns
| pattern AlgorithmSpec_RSAES_OAEP_SHA_1 :: AlgorithmSpec | |
| pattern AlgorithmSpec_RSAES_OAEP_SHA_256 :: AlgorithmSpec | |
| pattern AlgorithmSpec_RSAES_PKCS1_V1_5 :: AlgorithmSpec |
Instances
ConnectionErrorCodeType
newtype ConnectionErrorCodeType Source #
Constructors
| ConnectionErrorCodeType' | |
Fields | |
Bundled Patterns
Instances
ConnectionStateType
newtype ConnectionStateType Source #
Constructors
| ConnectionStateType' | |
Fields | |
Bundled Patterns
| pattern ConnectionStateType_CONNECTED :: ConnectionStateType | |
| pattern ConnectionStateType_CONNECTING :: ConnectionStateType | |
| pattern ConnectionStateType_DISCONNECTED :: ConnectionStateType | |
| pattern ConnectionStateType_DISCONNECTING :: ConnectionStateType | |
| pattern ConnectionStateType_FAILED :: ConnectionStateType |
Instances
CustomKeyStoreType
newtype CustomKeyStoreType Source #
Constructors
| CustomKeyStoreType' | |
Fields | |
Bundled Patterns
| pattern CustomKeyStoreType_AWS_CLOUDHSM :: CustomKeyStoreType | |
| pattern CustomKeyStoreType_EXTERNAL_KEY_STORE :: CustomKeyStoreType |
Instances
CustomerMasterKeySpec
newtype CustomerMasterKeySpec Source #
Constructors
| CustomerMasterKeySpec' | |
Fields | |
Bundled Patterns
Instances
DataKeyPairSpec
newtype DataKeyPairSpec Source #
Constructors
| DataKeyPairSpec' | |
Fields | |
Bundled Patterns
| pattern DataKeyPairSpec_ECC_NIST_P256 :: DataKeyPairSpec | |
| pattern DataKeyPairSpec_ECC_NIST_P384 :: DataKeyPairSpec | |
| pattern DataKeyPairSpec_ECC_NIST_P521 :: DataKeyPairSpec | |
| pattern DataKeyPairSpec_ECC_SECG_P256K1 :: DataKeyPairSpec | |
| pattern DataKeyPairSpec_RSA_2048 :: DataKeyPairSpec | |
| pattern DataKeyPairSpec_RSA_3072 :: DataKeyPairSpec | |
| pattern DataKeyPairSpec_RSA_4096 :: DataKeyPairSpec | |
| pattern DataKeyPairSpec_SM2 :: DataKeyPairSpec |
Instances
DataKeySpec
newtype DataKeySpec Source #
Constructors
| DataKeySpec' | |
Fields | |
Bundled Patterns
| pattern DataKeySpec_AES_128 :: DataKeySpec | |
| pattern DataKeySpec_AES_256 :: DataKeySpec |
Instances
EncryptionAlgorithmSpec
newtype EncryptionAlgorithmSpec Source #
Constructors
| EncryptionAlgorithmSpec' | |
Fields | |
Bundled Patterns
Instances
ExpirationModelType
newtype ExpirationModelType Source #
Constructors
| ExpirationModelType' | |
Fields | |
Bundled Patterns
| pattern ExpirationModelType_KEY_MATERIAL_DOES_NOT_EXPIRE :: ExpirationModelType | |
| pattern ExpirationModelType_KEY_MATERIAL_EXPIRES :: ExpirationModelType |
Instances
GrantOperation
newtype GrantOperation Source #
Constructors
| GrantOperation' | |
Fields | |
Bundled Patterns
| pattern GrantOperation_CreateGrant :: GrantOperation | |
| pattern GrantOperation_Decrypt :: GrantOperation | |
| pattern GrantOperation_DescribeKey :: GrantOperation | |
| pattern GrantOperation_Encrypt :: GrantOperation | |
| pattern GrantOperation_GenerateDataKey :: GrantOperation | |
| pattern GrantOperation_GenerateDataKeyPair :: GrantOperation | |
| pattern GrantOperation_GenerateDataKeyPairWithoutPlaintext :: GrantOperation | |
| pattern GrantOperation_GenerateDataKeyWithoutPlaintext :: GrantOperation | |
| pattern GrantOperation_GenerateMac :: GrantOperation | |
| pattern GrantOperation_GetPublicKey :: GrantOperation | |
| pattern GrantOperation_ReEncryptFrom :: GrantOperation | |
| pattern GrantOperation_ReEncryptTo :: GrantOperation | |
| pattern GrantOperation_RetireGrant :: GrantOperation | |
| pattern GrantOperation_Sign :: GrantOperation | |
| pattern GrantOperation_Verify :: GrantOperation | |
| pattern GrantOperation_VerifyMac :: GrantOperation |
Instances
KeyManagerType
newtype KeyManagerType Source #
Constructors
| KeyManagerType' | |
Fields | |
Bundled Patterns
| pattern KeyManagerType_AWS :: KeyManagerType | |
| pattern KeyManagerType_CUSTOMER :: KeyManagerType |
Instances
KeySpec
Constructors
| KeySpec' | |
Fields
| |
Bundled Patterns
| pattern KeySpec_ECC_NIST_P256 :: KeySpec | |
| pattern KeySpec_ECC_NIST_P384 :: KeySpec | |
| pattern KeySpec_ECC_NIST_P521 :: KeySpec | |
| pattern KeySpec_ECC_SECG_P256K1 :: KeySpec | |
| pattern KeySpec_HMAC_224 :: KeySpec | |
| pattern KeySpec_HMAC_256 :: KeySpec | |
| pattern KeySpec_HMAC_384 :: KeySpec | |
| pattern KeySpec_HMAC_512 :: KeySpec | |
| pattern KeySpec_RSA_2048 :: KeySpec | |
| pattern KeySpec_RSA_3072 :: KeySpec | |
| pattern KeySpec_RSA_4096 :: KeySpec | |
| pattern KeySpec_SM2 :: KeySpec | |
| pattern KeySpec_SYMMETRIC_DEFAULT :: KeySpec |
Instances
KeyState
Constructors
| KeyState' | |
Fields
| |
Bundled Patterns
| pattern KeyState_Creating :: KeyState | |
| pattern KeyState_Disabled :: KeyState | |
| pattern KeyState_Enabled :: KeyState | |
| pattern KeyState_PendingDeletion :: KeyState | |
| pattern KeyState_PendingImport :: KeyState | |
| pattern KeyState_PendingReplicaDeletion :: KeyState | |
| pattern KeyState_Unavailable :: KeyState | |
| pattern KeyState_Updating :: KeyState |
Instances
KeyUsageType
newtype KeyUsageType Source #
Constructors
| KeyUsageType' | |
Fields | |
Bundled Patterns
| pattern KeyUsageType_ENCRYPT_DECRYPT :: KeyUsageType | |
| pattern KeyUsageType_GENERATE_VERIFY_MAC :: KeyUsageType | |
| pattern KeyUsageType_SIGN_VERIFY :: KeyUsageType |
Instances
MacAlgorithmSpec
newtype MacAlgorithmSpec Source #
Constructors
| MacAlgorithmSpec' | |
Fields | |
Bundled Patterns
| pattern MacAlgorithmSpec_HMAC_SHA_224 :: MacAlgorithmSpec | |
| pattern MacAlgorithmSpec_HMAC_SHA_256 :: MacAlgorithmSpec | |
| pattern MacAlgorithmSpec_HMAC_SHA_384 :: MacAlgorithmSpec | |
| pattern MacAlgorithmSpec_HMAC_SHA_512 :: MacAlgorithmSpec |
Instances
MessageType
newtype MessageType Source #
Constructors
| MessageType' | |
Fields | |
Bundled Patterns
| pattern MessageType_DIGEST :: MessageType | |
| pattern MessageType_RAW :: MessageType |
Instances
MultiRegionKeyType
newtype MultiRegionKeyType Source #
Constructors
| MultiRegionKeyType' | |
Fields | |
Bundled Patterns
| pattern MultiRegionKeyType_PRIMARY :: MultiRegionKeyType | |
| pattern MultiRegionKeyType_REPLICA :: MultiRegionKeyType |
Instances
OriginType
newtype OriginType Source #
Constructors
| OriginType' | |
Fields | |
Bundled Patterns
| pattern OriginType_AWS_CLOUDHSM :: OriginType | |
| pattern OriginType_AWS_KMS :: OriginType | |
| pattern OriginType_EXTERNAL :: OriginType | |
| pattern OriginType_EXTERNAL_KEY_STORE :: OriginType |
Instances
SigningAlgorithmSpec
newtype SigningAlgorithmSpec Source #
Constructors
| SigningAlgorithmSpec' | |
Fields | |
Bundled Patterns
Instances
WrappingKeySpec
newtype WrappingKeySpec Source #
Constructors
| WrappingKeySpec' | |
Fields | |
Bundled Patterns
| pattern WrappingKeySpec_RSA_2048 :: WrappingKeySpec |
Instances
XksProxyConnectivityType
newtype XksProxyConnectivityType Source #
Constructors
| XksProxyConnectivityType' | |
Fields | |
Bundled Patterns
| pattern XksProxyConnectivityType_PUBLIC_ENDPOINT :: XksProxyConnectivityType | |
| pattern XksProxyConnectivityType_VPC_ENDPOINT_SERVICE :: XksProxyConnectivityType |
Instances
AliasListEntry
data AliasListEntry Source #
Contains information about an alias.
See: newAliasListEntry smart constructor.
Constructors
| AliasListEntry' | |
Fields
| |
Instances
newAliasListEntry :: AliasListEntry Source #
Create a value of AliasListEntry 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:aliasArn:AliasListEntry', aliasListEntry_aliasArn - String that contains the key ARN.
$sel:aliasName:AliasListEntry', aliasListEntry_aliasName - String that contains the alias. This value begins with alias/.
$sel:creationDate:AliasListEntry', aliasListEntry_creationDate - Date and time that the alias was most recently created in the account
and Region. Formatted as Unix time.
$sel:lastUpdatedDate:AliasListEntry', aliasListEntry_lastUpdatedDate - Date and time that the alias was most recently associated with a KMS key
in the account and Region. Formatted as Unix time.
$sel:targetKeyId:AliasListEntry', aliasListEntry_targetKeyId - String that contains the key identifier of the KMS key associated with
the alias.
aliasListEntry_aliasArn :: Lens' AliasListEntry (Maybe Text) Source #
String that contains the key ARN.
aliasListEntry_aliasName :: Lens' AliasListEntry (Maybe Text) Source #
String that contains the alias. This value begins with alias/.
aliasListEntry_creationDate :: Lens' AliasListEntry (Maybe UTCTime) Source #
Date and time that the alias was most recently created in the account and Region. Formatted as Unix time.
aliasListEntry_lastUpdatedDate :: Lens' AliasListEntry (Maybe UTCTime) Source #
Date and time that the alias was most recently associated with a KMS key in the account and Region. Formatted as Unix time.
aliasListEntry_targetKeyId :: Lens' AliasListEntry (Maybe Text) Source #
String that contains the key identifier of the KMS key associated with the alias.
CustomKeyStoresListEntry
data CustomKeyStoresListEntry Source #
Contains information about each custom key store in the custom key store list.
See: newCustomKeyStoresListEntry smart constructor.
Constructors
| CustomKeyStoresListEntry' | |
Fields
| |
Instances
newCustomKeyStoresListEntry :: CustomKeyStoresListEntry Source #
Create a value of CustomKeyStoresListEntry 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:cloudHsmClusterId:CustomKeyStoresListEntry', customKeyStoresListEntry_cloudHsmClusterId - A unique identifier for the CloudHSM cluster that is associated with an
CloudHSM key store. This field appears only when the
CustomKeyStoreType is AWS_CLOUDHSM.
$sel:connectionErrorCode:CustomKeyStoresListEntry', customKeyStoresListEntry_connectionErrorCode - Describes the connection error. This field appears in the response only
when the ConnectionState is FAILED.
Many failures can be resolved by updating the properties of the custom key store. To update a custom key store, disconnect it (DisconnectCustomKeyStore), correct the errors (UpdateCustomKeyStore), and try to connect again (ConnectCustomKeyStore). For additional help resolving these errors, see How to Fix a Connection Failure in Key Management Service Developer Guide.
All custom key stores:
INTERNAL_ERROR— KMS could not complete the request due to an internal error. Retry the request. ForConnectCustomKeyStorerequests, disconnect the custom key store before trying to connect again.NETWORK_ERRORS— Network errors are preventing KMS from connecting the custom key store to its backing key store.
CloudHSM key stores:
CLUSTER_NOT_FOUND— KMS cannot find the CloudHSM cluster with the specified cluster ID.INSUFFICIENT_CLOUDHSM_HSMS— The associated CloudHSM cluster does not contain any active HSMs. To connect a custom key store to its CloudHSM cluster, the cluster must contain at least one active HSM.INSUFFICIENT_FREE_ADDRESSES_IN_SUBNET— At least one private subnet associated with the CloudHSM cluster doesn't have any available IP addresses. A CloudHSM key store connection requires one free IP address in each of the associated private subnets, although two are preferable. For details, see How to Fix a Connection Failure in the Key Management Service Developer Guide.INVALID_CREDENTIALS— TheKeyStorePasswordfor the custom key store doesn't match the current password of thekmsusercrypto user in the CloudHSM cluster. Before you can connect your custom key store to its CloudHSM cluster, you must change thekmsuseraccount password and update theKeyStorePasswordvalue for the custom key store.SUBNET_NOT_FOUND— A subnet in the CloudHSM cluster configuration was deleted. If KMS cannot find all of the subnets in the cluster configuration, attempts to connect the custom key store to the CloudHSM cluster fail. To fix this error, create a cluster from a recent backup and associate it with your custom key store. (This process creates a new cluster configuration with a VPC and private subnets.) For details, see How to Fix a Connection Failure in the Key Management Service Developer Guide.USER_LOCKED_OUT— ThekmsuserCU account is locked out of the associated CloudHSM cluster due to too many failed password attempts. Before you can connect your custom key store to its CloudHSM cluster, you must change thekmsuseraccount password and update the key store password value for the custom key store.USER_LOGGED_IN— ThekmsuserCU account is logged into the associated CloudHSM cluster. This prevents KMS from rotating thekmsuseraccount password and logging into the cluster. Before you can connect your custom key store to its CloudHSM cluster, you must log thekmsuserCU out of the cluster. If you changed thekmsuserpassword to log into the cluster, you must also and update the key store password value for the custom key store. For help, see How to Log Out and Reconnect in the Key Management Service Developer Guide.USER_NOT_FOUND— KMS cannot find akmsuserCU account in the associated CloudHSM cluster. Before you can connect your custom key store to its CloudHSM cluster, you must create akmsuserCU account in the cluster, and then update the key store password value for the custom key store.
External key stores:
INVALID_CREDENTIALS— One or both of theXksProxyAuthenticationCredentialvalues is not valid on the specified external key store proxy.XKS_PROXY_ACCESS_DENIED— KMS requests are denied access to the external key store proxy. If the external key store proxy has authorization rules, verify that they permit KMS to communicate with the proxy on your behalf.XKS_PROXY_INVALID_CONFIGURATION— A configuration error is preventing the external key store from connecting to its proxy. Verify the value of theXksProxyUriPath.XKS_PROXY_INVALID_RESPONSE— KMS cannot interpret the response from the external key store proxy. If you see this connection error code repeatedly, notify your external key store proxy vendor.XKS_PROXY_INVALID_TLS_CONFIGURATION— KMS cannot connect to the external key store proxy because the TLS configuration is invalid. Verify that the XKS proxy supports TLS 1.2 or 1.3. Also, verify that the TLS certificate is not expired, and that it matches the hostname in theXksProxyUriEndpointvalue, and that it is signed by a certificate authority included in the Trusted Certificate Authorities list.XKS_PROXY_NOT_REACHABLE— KMS can't communicate with your external key store proxy. Verify that theXksProxyUriEndpointandXksProxyUriPathare correct. Use the tools for your external key store proxy to verify that the proxy is active and available on its network. Also, verify that your external key manager instances are operating properly. Connection attempts fail with this connection error code if the proxy reports that all external key manager instances are unavailable.XKS_PROXY_TIMED_OUT— KMS can connect to the external key store proxy, but the proxy does not respond to KMS in the time allotted. If you see this connection error code repeatedly, notify your external key store proxy vendor.XKS_VPC_ENDPOINT_SERVICE_INVALID_CONFIGURATION— The Amazon VPC endpoint service configuration doesn't conform to the requirements for an KMS external key store.- The VPC endpoint service must be an endpoint service for interface endpoints in the caller's Amazon Web Services account.
- It must have a network load balancer (NLB) connected to at least two subnets, each in a different Availability Zone.
- The
Allow principalslist must include the KMS service principal for the Region,cks.kms.<region>.amazonaws.com, such ascks.kms.us-east-1.amazonaws.com. - It must not require acceptance of connection requests.
- It must have a private DNS name. The private DNS name for an
external key store with
VPC_ENDPOINT_SERVICEconnectivity must be unique in its Amazon Web Services Region. - The domain of the private DNS name must have a
verification status
of
verified. - The TLS certificate specifies the private DNS hostname at which the endpoint is reachable.
XKS_VPC_ENDPOINT_SERVICE_NOT_FOUND— KMS can't find the VPC endpoint service that it uses to communicate with the external key store proxy. Verify that theXksProxyVpcEndpointServiceNameis correct and the KMS service principal has service consumer permissions on the Amazon VPC endpoint service.
$sel:connectionState:CustomKeyStoresListEntry', customKeyStoresListEntry_connectionState - Indicates whether the custom key store is connected to its backing key
store. For an CloudHSM key store, the ConnectionState indicates
whether it is connected to its CloudHSM cluster. For an external key
store, the ConnectionState indicates whether it is connected to the
external key store proxy that communicates with your external key
manager.
You can create and use KMS keys in your custom key stores only when its
ConnectionState is CONNECTED.
The ConnectionState value is DISCONNECTED only if the key store has
never been connected or you use the DisconnectCustomKeyStore operation
to disconnect it. If the value is CONNECTED but you are having trouble
using the custom key store, make sure that the backing key store is
reachable and active. For an CloudHSM key store, verify that its
associated CloudHSM cluster is active and contains at least one active
HSM. For an external key store, verify that the external key store proxy
and external key manager are connected and enabled.
A value of FAILED indicates that an attempt to connect was
unsuccessful. The ConnectionErrorCode field in the response indicates
the cause of the failure. For help resolving a connection failure, see
Troubleshooting a custom key store
in the Key Management Service Developer Guide.
$sel:creationDate:CustomKeyStoresListEntry', customKeyStoresListEntry_creationDate - The date and time when the custom key store was created.
$sel:customKeyStoreId:CustomKeyStoresListEntry', customKeyStoresListEntry_customKeyStoreId - A unique identifier for the custom key store.
$sel:customKeyStoreName:CustomKeyStoresListEntry', customKeyStoresListEntry_customKeyStoreName - The user-specified friendly name for the custom key store.
$sel:customKeyStoreType:CustomKeyStoresListEntry', customKeyStoresListEntry_customKeyStoreType - Indicates the type of the custom key store. AWS_CLOUDHSM indicates a
custom key store backed by an CloudHSM cluster. EXTERNAL_KEY_STORE
indicates a custom key store backed by an external key store proxy and
external key manager outside of Amazon Web Services.
$sel:trustAnchorCertificate:CustomKeyStoresListEntry', customKeyStoresListEntry_trustAnchorCertificate - The trust anchor certificate of the CloudHSM cluster associated with an
CloudHSM key store. When you
initialize the cluster,
you create this certificate and save it in the customerCA.crt file.
This field appears only when the CustomKeyStoreType is AWS_CLOUDHSM.
$sel:xksProxyConfiguration:CustomKeyStoresListEntry', customKeyStoresListEntry_xksProxyConfiguration - Configuration settings for the external key store proxy (XKS proxy). The
external key store proxy translates KMS requests into a format that your
external key manager can understand. The proxy configuration includes
connection information that KMS requires.
This field appears only when the CustomKeyStoreType is
EXTERNAL_KEY_STORE.
customKeyStoresListEntry_cloudHsmClusterId :: Lens' CustomKeyStoresListEntry (Maybe Text) Source #
A unique identifier for the CloudHSM cluster that is associated with an
CloudHSM key store. This field appears only when the
CustomKeyStoreType is AWS_CLOUDHSM.
customKeyStoresListEntry_connectionErrorCode :: Lens' CustomKeyStoresListEntry (Maybe ConnectionErrorCodeType) Source #
Describes the connection error. This field appears in the response only
when the ConnectionState is FAILED.
Many failures can be resolved by updating the properties of the custom key store. To update a custom key store, disconnect it (DisconnectCustomKeyStore), correct the errors (UpdateCustomKeyStore), and try to connect again (ConnectCustomKeyStore). For additional help resolving these errors, see How to Fix a Connection Failure in Key Management Service Developer Guide.
All custom key stores:
INTERNAL_ERROR— KMS could not complete the request due to an internal error. Retry the request. ForConnectCustomKeyStorerequests, disconnect the custom key store before trying to connect again.NETWORK_ERRORS— Network errors are preventing KMS from connecting the custom key store to its backing key store.
CloudHSM key stores:
CLUSTER_NOT_FOUND— KMS cannot find the CloudHSM cluster with the specified cluster ID.INSUFFICIENT_CLOUDHSM_HSMS— The associated CloudHSM cluster does not contain any active HSMs. To connect a custom key store to its CloudHSM cluster, the cluster must contain at least one active HSM.INSUFFICIENT_FREE_ADDRESSES_IN_SUBNET— At least one private subnet associated with the CloudHSM cluster doesn't have any available IP addresses. A CloudHSM key store connection requires one free IP address in each of the associated private subnets, although two are preferable. For details, see How to Fix a Connection Failure in the Key Management Service Developer Guide.INVALID_CREDENTIALS— TheKeyStorePasswordfor the custom key store doesn't match the current password of thekmsusercrypto user in the CloudHSM cluster. Before you can connect your custom key store to its CloudHSM cluster, you must change thekmsuseraccount password and update theKeyStorePasswordvalue for the custom key store.SUBNET_NOT_FOUND— A subnet in the CloudHSM cluster configuration was deleted. If KMS cannot find all of the subnets in the cluster configuration, attempts to connect the custom key store to the CloudHSM cluster fail. To fix this error, create a cluster from a recent backup and associate it with your custom key store. (This process creates a new cluster configuration with a VPC and private subnets.) For details, see How to Fix a Connection Failure in the Key Management Service Developer Guide.USER_LOCKED_OUT— ThekmsuserCU account is locked out of the associated CloudHSM cluster due to too many failed password attempts. Before you can connect your custom key store to its CloudHSM cluster, you must change thekmsuseraccount password and update the key store password value for the custom key store.USER_LOGGED_IN— ThekmsuserCU account is logged into the associated CloudHSM cluster. This prevents KMS from rotating thekmsuseraccount password and logging into the cluster. Before you can connect your custom key store to its CloudHSM cluster, you must log thekmsuserCU out of the cluster. If you changed thekmsuserpassword to log into the cluster, you must also and update the key store password value for the custom key store. For help, see How to Log Out and Reconnect in the Key Management Service Developer Guide.USER_NOT_FOUND— KMS cannot find akmsuserCU account in the associated CloudHSM cluster. Before you can connect your custom key store to its CloudHSM cluster, you must create akmsuserCU account in the cluster, and then update the key store password value for the custom key store.
External key stores:
INVALID_CREDENTIALS— One or both of theXksProxyAuthenticationCredentialvalues is not valid on the specified external key store proxy.XKS_PROXY_ACCESS_DENIED— KMS requests are denied access to the external key store proxy. If the external key store proxy has authorization rules, verify that they permit KMS to communicate with the proxy on your behalf.XKS_PROXY_INVALID_CONFIGURATION— A configuration error is preventing the external key store from connecting to its proxy. Verify the value of theXksProxyUriPath.XKS_PROXY_INVALID_RESPONSE— KMS cannot interpret the response from the external key store proxy. If you see this connection error code repeatedly, notify your external key store proxy vendor.XKS_PROXY_INVALID_TLS_CONFIGURATION— KMS cannot connect to the external key store proxy because the TLS configuration is invalid. Verify that the XKS proxy supports TLS 1.2 or 1.3. Also, verify that the TLS certificate is not expired, and that it matches the hostname in theXksProxyUriEndpointvalue, and that it is signed by a certificate authority included in the Trusted Certificate Authorities list.XKS_PROXY_NOT_REACHABLE— KMS can't communicate with your external key store proxy. Verify that theXksProxyUriEndpointandXksProxyUriPathare correct. Use the tools for your external key store proxy to verify that the proxy is active and available on its network. Also, verify that your external key manager instances are operating properly. Connection attempts fail with this connection error code if the proxy reports that all external key manager instances are unavailable.XKS_PROXY_TIMED_OUT— KMS can connect to the external key store proxy, but the proxy does not respond to KMS in the time allotted. If you see this connection error code repeatedly, notify your external key store proxy vendor.XKS_VPC_ENDPOINT_SERVICE_INVALID_CONFIGURATION— The Amazon VPC endpoint service configuration doesn't conform to the requirements for an KMS external key store.- The VPC endpoint service must be an endpoint service for interface endpoints in the caller's Amazon Web Services account.
- It must have a network load balancer (NLB) connected to at least two subnets, each in a different Availability Zone.
- The
Allow principalslist must include the KMS service principal for the Region,cks.kms.<region>.amazonaws.com, such ascks.kms.us-east-1.amazonaws.com. - It must not require acceptance of connection requests.
- It must have a private DNS name. The private DNS name for an
external key store with
VPC_ENDPOINT_SERVICEconnectivity must be unique in its Amazon Web Services Region. - The domain of the private DNS name must have a
verification status
of
verified. - The TLS certificate specifies the private DNS hostname at which the endpoint is reachable.
XKS_VPC_ENDPOINT_SERVICE_NOT_FOUND— KMS can't find the VPC endpoint service that it uses to communicate with the external key store proxy. Verify that theXksProxyVpcEndpointServiceNameis correct and the KMS service principal has service consumer permissions on the Amazon VPC endpoint service.
customKeyStoresListEntry_connectionState :: Lens' CustomKeyStoresListEntry (Maybe ConnectionStateType) Source #
Indicates whether the custom key store is connected to its backing key
store. For an CloudHSM key store, the ConnectionState indicates
whether it is connected to its CloudHSM cluster. For an external key
store, the ConnectionState indicates whether it is connected to the
external key store proxy that communicates with your external key
manager.
You can create and use KMS keys in your custom key stores only when its
ConnectionState is CONNECTED.
The ConnectionState value is DISCONNECTED only if the key store has
never been connected or you use the DisconnectCustomKeyStore operation
to disconnect it. If the value is CONNECTED but you are having trouble
using the custom key store, make sure that the backing key store is
reachable and active. For an CloudHSM key store, verify that its
associated CloudHSM cluster is active and contains at least one active
HSM. For an external key store, verify that the external key store proxy
and external key manager are connected and enabled.
A value of FAILED indicates that an attempt to connect was
unsuccessful. The ConnectionErrorCode field in the response indicates
the cause of the failure. For help resolving a connection failure, see
Troubleshooting a custom key store
in the Key Management Service Developer Guide.
customKeyStoresListEntry_creationDate :: Lens' CustomKeyStoresListEntry (Maybe UTCTime) Source #
The date and time when the custom key store was created.
customKeyStoresListEntry_customKeyStoreId :: Lens' CustomKeyStoresListEntry (Maybe Text) Source #
A unique identifier for the custom key store.
customKeyStoresListEntry_customKeyStoreName :: Lens' CustomKeyStoresListEntry (Maybe Text) Source #
The user-specified friendly name for the custom key store.
customKeyStoresListEntry_customKeyStoreType :: Lens' CustomKeyStoresListEntry (Maybe CustomKeyStoreType) Source #
Indicates the type of the custom key store. AWS_CLOUDHSM indicates a
custom key store backed by an CloudHSM cluster. EXTERNAL_KEY_STORE
indicates a custom key store backed by an external key store proxy and
external key manager outside of Amazon Web Services.
customKeyStoresListEntry_trustAnchorCertificate :: Lens' CustomKeyStoresListEntry (Maybe Text) Source #
The trust anchor certificate of the CloudHSM cluster associated with an
CloudHSM key store. When you
initialize the cluster,
you create this certificate and save it in the customerCA.crt file.
This field appears only when the CustomKeyStoreType is AWS_CLOUDHSM.
customKeyStoresListEntry_xksProxyConfiguration :: Lens' CustomKeyStoresListEntry (Maybe XksProxyConfigurationType) Source #
Configuration settings for the external key store proxy (XKS proxy). The external key store proxy translates KMS requests into a format that your external key manager can understand. The proxy configuration includes connection information that KMS requires.
This field appears only when the CustomKeyStoreType is
EXTERNAL_KEY_STORE.
GrantConstraints
data GrantConstraints Source #
Use this structure to allow cryptographic operations in the grant only when the operation request includes the specified encryption context.
KMS applies the grant constraints only to cryptographic operations that support an encryption context, that is, all cryptographic operations with a symmetric KMS key. Grant constraints are not applied to operations that do not support an encryption context, such as cryptographic operations with asymmetric KMS keys and management operations, such as DescribeKey or RetireGrant.
In a cryptographic operation, the encryption context in the decryption operation must be an exact, case-sensitive match for the keys and values in the encryption context of the encryption operation. Only the order of the pairs can vary.
However, in a grant constraint, the key in each key-value pair is not case sensitive, but the value is case sensitive.
To avoid confusion, do not use multiple encryption context pairs that
differ only by case. To require a fully case-sensitive encryption
context, use the kms:EncryptionContext: and
kms:EncryptionContextKeys conditions in an IAM or key policy. For
details, see
kms:EncryptionContext:
in the /Key Management Service Developer Guide/ .
See: newGrantConstraints smart constructor.
Constructors
| GrantConstraints' | |
Fields
| |
Instances
newGrantConstraints :: GrantConstraints Source #
Create a value of GrantConstraints 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:encryptionContextEquals:GrantConstraints', grantConstraints_encryptionContextEquals - A list of key-value pairs that must match the encryption context in the
cryptographic operation
request. The grant allows the operation only when the encryption context
in the request is the same as the encryption context specified in this
constraint.
$sel:encryptionContextSubset:GrantConstraints', grantConstraints_encryptionContextSubset - A list of key-value pairs that must be included in the encryption
context of the
cryptographic operation
request. The grant allows the cryptographic operation only when the
encryption context in the request includes the key-value pairs specified
in this constraint, although it can include additional key-value pairs.
grantConstraints_encryptionContextEquals :: Lens' GrantConstraints (Maybe (HashMap Text Text)) Source #
A list of key-value pairs that must match the encryption context in the cryptographic operation request. The grant allows the operation only when the encryption context in the request is the same as the encryption context specified in this constraint.
grantConstraints_encryptionContextSubset :: Lens' GrantConstraints (Maybe (HashMap Text Text)) Source #
A list of key-value pairs that must be included in the encryption context of the cryptographic operation request. The grant allows the cryptographic operation only when the encryption context in the request includes the key-value pairs specified in this constraint, although it can include additional key-value pairs.
GrantListEntry
data GrantListEntry Source #
Contains information about a grant.
See: newGrantListEntry smart constructor.
Constructors
| GrantListEntry' | |
Fields
| |
Instances
newGrantListEntry :: GrantListEntry Source #
Create a value of GrantListEntry 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:constraints:GrantListEntry', grantListEntry_constraints - A list of key-value pairs that must be present in the encryption context
of certain subsequent operations that the grant allows.
$sel:creationDate:GrantListEntry', grantListEntry_creationDate - The date and time when the grant was created.
$sel:grantId:GrantListEntry', grantListEntry_grantId - The unique identifier for the grant.
$sel:granteePrincipal:GrantListEntry', grantListEntry_granteePrincipal - The identity that gets the permissions in the grant.
The GranteePrincipal field in the ListGrants response usually
contains the user or role designated as the grantee principal in the
grant. However, when the grantee principal in the grant is an Amazon Web
Services service, the GranteePrincipal field contains the
service principal,
which might represent several different grantee principals.
$sel:issuingAccount:GrantListEntry', grantListEntry_issuingAccount - The Amazon Web Services account under which the grant was issued.
$sel:keyId:GrantListEntry', grantListEntry_keyId - The unique identifier for the KMS key to which the grant applies.
$sel:name:GrantListEntry', grantListEntry_name - The friendly name that identifies the grant. If a name was provided in
the CreateGrant request, that name is returned. Otherwise this value is
null.
$sel:operations:GrantListEntry', grantListEntry_operations - The list of operations permitted by the grant.
$sel:retiringPrincipal:GrantListEntry', grantListEntry_retiringPrincipal - The principal that can retire the grant.
grantListEntry_constraints :: Lens' GrantListEntry (Maybe GrantConstraints) Source #
A list of key-value pairs that must be present in the encryption context of certain subsequent operations that the grant allows.
grantListEntry_creationDate :: Lens' GrantListEntry (Maybe UTCTime) Source #
The date and time when the grant was created.
grantListEntry_grantId :: Lens' GrantListEntry (Maybe Text) Source #
The unique identifier for the grant.
grantListEntry_granteePrincipal :: Lens' GrantListEntry (Maybe Text) Source #
The identity that gets the permissions in the grant.
The GranteePrincipal field in the ListGrants response usually
contains the user or role designated as the grantee principal in the
grant. However, when the grantee principal in the grant is an Amazon Web
Services service, the GranteePrincipal field contains the
service principal,
which might represent several different grantee principals.
grantListEntry_issuingAccount :: Lens' GrantListEntry (Maybe Text) Source #
The Amazon Web Services account under which the grant was issued.
grantListEntry_keyId :: Lens' GrantListEntry (Maybe Text) Source #
The unique identifier for the KMS key to which the grant applies.
grantListEntry_name :: Lens' GrantListEntry (Maybe Text) Source #
The friendly name that identifies the grant. If a name was provided in the CreateGrant request, that name is returned. Otherwise this value is null.
grantListEntry_operations :: Lens' GrantListEntry (Maybe [GrantOperation]) Source #
The list of operations permitted by the grant.
grantListEntry_retiringPrincipal :: Lens' GrantListEntry (Maybe Text) Source #
The principal that can retire the grant.
KeyListEntry
data KeyListEntry Source #
Contains information about each entry in the key list.
See: newKeyListEntry smart constructor.
Constructors
| KeyListEntry' | |
Instances
newKeyListEntry :: KeyListEntry Source #
Create a value of KeyListEntry 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:keyArn:KeyListEntry', keyListEntry_keyArn - ARN of the key.
$sel:keyId:KeyListEntry', keyListEntry_keyId - Unique identifier of the key.
keyListEntry_keyArn :: Lens' KeyListEntry (Maybe Text) Source #
ARN of the key.
keyListEntry_keyId :: Lens' KeyListEntry (Maybe Text) Source #
Unique identifier of the key.
KeyMetadata
data KeyMetadata Source #
Contains metadata about a KMS key.
This data type is used as a response element for the CreateKey, DescribeKey, and ReplicateKey operations.
See: newKeyMetadata smart constructor.
Constructors
| KeyMetadata' | |
Fields
| |
Instances
Arguments
| :: Text | |
| -> KeyMetadata |
Create a value of KeyMetadata 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:aWSAccountId:KeyMetadata', keyMetadata_aWSAccountId - The twelve-digit account ID of the Amazon Web Services account that owns
the KMS key.
$sel:arn:KeyMetadata', keyMetadata_arn - The Amazon Resource Name (ARN) of the KMS key. For examples, see
Key Management Service (KMS)
in the Example ARNs section of the /Amazon Web Services General
Reference/.
$sel:cloudHsmClusterId:KeyMetadata', keyMetadata_cloudHsmClusterId - The cluster ID of the CloudHSM cluster that contains the key material
for the KMS key. When you create a KMS key in an CloudHSM
custom key store,
KMS creates the key material for the KMS key in the associated CloudHSM
cluster. This field is present only when the KMS key is created in an
CloudHSM key store.
$sel:creationDate:KeyMetadata', keyMetadata_creationDate - The date and time when the KMS key was created.
$sel:customKeyStoreId:KeyMetadata', keyMetadata_customKeyStoreId - A unique identifier for the
custom key store
that contains the KMS key. This field is present only when the KMS key
is created in a custom key store.
$sel:customerMasterKeySpec:KeyMetadata', keyMetadata_customerMasterKeySpec - Instead, use the KeySpec field.
The KeySpec and CustomerMasterKeySpec fields have the same value. We
recommend that you use the KeySpec field in your code. However, to
avoid breaking changes, KMS supports both fields.
$sel:deletionDate:KeyMetadata', keyMetadata_deletionDate - The date and time after which KMS deletes this KMS key. This value is
present only when the KMS key is scheduled for deletion, that is, when
its KeyState is PendingDeletion.
When the primary key in a multi-Region key is scheduled for deletion but
still has replica keys, its key state is PendingReplicaDeletion and
the length of its waiting period is displayed in the
PendingDeletionWindowInDays field.
$sel:description:KeyMetadata', keyMetadata_description - The description of the KMS key.
$sel:enabled:KeyMetadata', keyMetadata_enabled - Specifies whether the KMS key is enabled. When KeyState is Enabled
this value is true, otherwise it is false.
$sel:encryptionAlgorithms:KeyMetadata', keyMetadata_encryptionAlgorithms - The encryption algorithms that the KMS key supports. You cannot use the
KMS key with other encryption algorithms within KMS.
This value is present only when the KeyUsage of the KMS key is
ENCRYPT_DECRYPT.
$sel:expirationModel:KeyMetadata', keyMetadata_expirationModel - Specifies whether the KMS key's key material expires. This value is
present only when Origin is EXTERNAL, otherwise this value is
omitted.
$sel:keyManager:KeyMetadata', keyMetadata_keyManager - The manager of the KMS key. KMS keys in your Amazon Web Services account
are either customer managed or Amazon Web Services managed. For more
information about the difference, see
KMS keys
in the Key Management Service Developer Guide.
$sel:keySpec:KeyMetadata', keyMetadata_keySpec - Describes the type of key material in the KMS key.
$sel:keyState:KeyMetadata', keyMetadata_keyState - The current status of the KMS key.
For more information about how key state affects the use of a KMS key, see Key states of KMS keys in the Key Management Service Developer Guide.
$sel:keyUsage:KeyMetadata', keyMetadata_keyUsage - The
cryptographic operations
for which you can use the KMS key.
$sel:macAlgorithms:KeyMetadata', keyMetadata_macAlgorithms - The message authentication code (MAC) algorithm that the HMAC KMS key
supports.
This value is present only when the KeyUsage of the KMS key is
GENERATE_VERIFY_MAC.
$sel:multiRegion:KeyMetadata', keyMetadata_multiRegion - Indicates whether the KMS key is a multi-Region (True) or regional
(False) key. This value is True for multi-Region primary and replica
keys and False for regional KMS keys.
For more information about multi-Region keys, see Multi-Region keys in KMS in the Key Management Service Developer Guide.
$sel:multiRegionConfiguration:KeyMetadata', keyMetadata_multiRegionConfiguration - Lists the primary and replica keys in same multi-Region key. This field
is present only when the value of the MultiRegion field is True.
For more information about any listed KMS key, use the DescribeKey operation.
MultiRegionKeyTypeindicates whether the KMS key is aPRIMARYorREPLICAkey.PrimaryKeydisplays the key ARN and Region of the primary key. This field displays the current KMS key if it is the primary key.ReplicaKeysdisplays the key ARNs and Regions of all replica keys. This field includes the current KMS key if it is a replica key.
$sel:origin:KeyMetadata', keyMetadata_origin - The source of the key material for the KMS key. When this value is
AWS_KMS, KMS created the key material. When this value is EXTERNAL,
the key material was imported or the KMS key doesn't have any key
material. When this value is AWS_CLOUDHSM, the key material was
created in the CloudHSM cluster associated with a custom key store.
$sel:pendingDeletionWindowInDays:KeyMetadata', keyMetadata_pendingDeletionWindowInDays - The waiting period before the primary key in a multi-Region key is
deleted. This waiting period begins when the last of its replica keys is
deleted. This value is present only when the KeyState of the KMS key
is PendingReplicaDeletion. That indicates that the KMS key is the
primary key in a multi-Region key, it is scheduled for deletion, and it
still has existing replica keys.
When a single-Region KMS key or a multi-Region replica key is scheduled
for deletion, its deletion date is displayed in the DeletionDate
field. However, when the primary key in a multi-Region key is scheduled
for deletion, its waiting period doesn't begin until all of its replica
keys are deleted. This value displays that waiting period. When the last
replica key in the multi-Region key is deleted, the KeyState of the
scheduled primary key changes from PendingReplicaDeletion to
PendingDeletion and the deletion date appears in the DeletionDate
field.
$sel:signingAlgorithms:KeyMetadata', keyMetadata_signingAlgorithms - The signing algorithms that the KMS key supports. You cannot use the KMS
key with other signing algorithms within KMS.
This field appears only when the KeyUsage of the KMS key is
SIGN_VERIFY.
$sel:validTo:KeyMetadata', keyMetadata_validTo - The time at which the imported key material expires. When the key
material expires, KMS deletes the key material and the KMS key becomes
unusable. This value is present only for KMS keys whose Origin is
EXTERNAL and whose ExpirationModel is KEY_MATERIAL_EXPIRES,
otherwise this value is omitted.
$sel:xksKeyConfiguration:KeyMetadata', keyMetadata_xksKeyConfiguration - Information about the external key that is associated with a KMS key in
an external key store.
For more information, see External key in the Key Management Service Developer Guide.
$sel:keyId:KeyMetadata', keyMetadata_keyId - The globally unique identifier for the KMS key.
keyMetadata_aWSAccountId :: Lens' KeyMetadata (Maybe Text) Source #
The twelve-digit account ID of the Amazon Web Services account that owns the KMS key.
keyMetadata_arn :: Lens' KeyMetadata (Maybe Text) Source #
The Amazon Resource Name (ARN) of the KMS key. For examples, see Key Management Service (KMS) in the Example ARNs section of the /Amazon Web Services General Reference/.
keyMetadata_cloudHsmClusterId :: Lens' KeyMetadata (Maybe Text) Source #
The cluster ID of the CloudHSM cluster that contains the key material for the KMS key. When you create a KMS key in an CloudHSM custom key store, KMS creates the key material for the KMS key in the associated CloudHSM cluster. This field is present only when the KMS key is created in an CloudHSM key store.
keyMetadata_creationDate :: Lens' KeyMetadata (Maybe UTCTime) Source #
The date and time when the KMS key was created.
keyMetadata_customKeyStoreId :: Lens' KeyMetadata (Maybe Text) Source #
A unique identifier for the custom key store that contains the KMS key. This field is present only when the KMS key is created in a custom key store.
keyMetadata_customerMasterKeySpec :: Lens' KeyMetadata (Maybe CustomerMasterKeySpec) Source #
Instead, use the KeySpec field.
The KeySpec and CustomerMasterKeySpec fields have the same value. We
recommend that you use the KeySpec field in your code. However, to
avoid breaking changes, KMS supports both fields.
keyMetadata_deletionDate :: Lens' KeyMetadata (Maybe UTCTime) Source #
The date and time after which KMS deletes this KMS key. This value is
present only when the KMS key is scheduled for deletion, that is, when
its KeyState is PendingDeletion.
When the primary key in a multi-Region key is scheduled for deletion but
still has replica keys, its key state is PendingReplicaDeletion and
the length of its waiting period is displayed in the
PendingDeletionWindowInDays field.
keyMetadata_description :: Lens' KeyMetadata (Maybe Text) Source #
The description of the KMS key.
keyMetadata_enabled :: Lens' KeyMetadata (Maybe Bool) Source #
Specifies whether the KMS key is enabled. When KeyState is Enabled
this value is true, otherwise it is false.
keyMetadata_encryptionAlgorithms :: Lens' KeyMetadata (Maybe [EncryptionAlgorithmSpec]) Source #
The encryption algorithms that the KMS key supports. You cannot use the KMS key with other encryption algorithms within KMS.
This value is present only when the KeyUsage of the KMS key is
ENCRYPT_DECRYPT.
keyMetadata_expirationModel :: Lens' KeyMetadata (Maybe ExpirationModelType) Source #
Specifies whether the KMS key's key material expires. This value is
present only when Origin is EXTERNAL, otherwise this value is
omitted.
keyMetadata_keyManager :: Lens' KeyMetadata (Maybe KeyManagerType) Source #
The manager of the KMS key. KMS keys in your Amazon Web Services account are either customer managed or Amazon Web Services managed. For more information about the difference, see KMS keys in the Key Management Service Developer Guide.
keyMetadata_keySpec :: Lens' KeyMetadata (Maybe KeySpec) Source #
Describes the type of key material in the KMS key.
keyMetadata_keyState :: Lens' KeyMetadata (Maybe KeyState) Source #
The current status of the KMS key.
For more information about how key state affects the use of a KMS key, see Key states of KMS keys in the Key Management Service Developer Guide.
keyMetadata_keyUsage :: Lens' KeyMetadata (Maybe KeyUsageType) Source #
The cryptographic operations for which you can use the KMS key.
keyMetadata_macAlgorithms :: Lens' KeyMetadata (Maybe [MacAlgorithmSpec]) Source #
The message authentication code (MAC) algorithm that the HMAC KMS key supports.
This value is present only when the KeyUsage of the KMS key is
GENERATE_VERIFY_MAC.
keyMetadata_multiRegion :: Lens' KeyMetadata (Maybe Bool) Source #
Indicates whether the KMS key is a multi-Region (True) or regional
(False) key. This value is True for multi-Region primary and replica
keys and False for regional KMS keys.
For more information about multi-Region keys, see Multi-Region keys in KMS in the Key Management Service Developer Guide.
keyMetadata_multiRegionConfiguration :: Lens' KeyMetadata (Maybe MultiRegionConfiguration) Source #
Lists the primary and replica keys in same multi-Region key. This field
is present only when the value of the MultiRegion field is True.
For more information about any listed KMS key, use the DescribeKey operation.
MultiRegionKeyTypeindicates whether the KMS key is aPRIMARYorREPLICAkey.PrimaryKeydisplays the key ARN and Region of the primary key. This field displays the current KMS key if it is the primary key.ReplicaKeysdisplays the key ARNs and Regions of all replica keys. This field includes the current KMS key if it is a replica key.
keyMetadata_origin :: Lens' KeyMetadata (Maybe OriginType) Source #
The source of the key material for the KMS key. When this value is
AWS_KMS, KMS created the key material. When this value is EXTERNAL,
the key material was imported or the KMS key doesn't have any key
material. When this value is AWS_CLOUDHSM, the key material was
created in the CloudHSM cluster associated with a custom key store.
keyMetadata_pendingDeletionWindowInDays :: Lens' KeyMetadata (Maybe Natural) Source #
The waiting period before the primary key in a multi-Region key is
deleted. This waiting period begins when the last of its replica keys is
deleted. This value is present only when the KeyState of the KMS key
is PendingReplicaDeletion. That indicates that the KMS key is the
primary key in a multi-Region key, it is scheduled for deletion, and it
still has existing replica keys.
When a single-Region KMS key or a multi-Region replica key is scheduled
for deletion, its deletion date is displayed in the DeletionDate
field. However, when the primary key in a multi-Region key is scheduled
for deletion, its waiting period doesn't begin until all of its replica
keys are deleted. This value displays that waiting period. When the last
replica key in the multi-Region key is deleted, the KeyState of the
scheduled primary key changes from PendingReplicaDeletion to
PendingDeletion and the deletion date appears in the DeletionDate
field.
keyMetadata_signingAlgorithms :: Lens' KeyMetadata (Maybe [SigningAlgorithmSpec]) Source #
The signing algorithms that the KMS key supports. You cannot use the KMS key with other signing algorithms within KMS.
This field appears only when the KeyUsage of the KMS key is
SIGN_VERIFY.
keyMetadata_validTo :: Lens' KeyMetadata (Maybe UTCTime) Source #
The time at which the imported key material expires. When the key
material expires, KMS deletes the key material and the KMS key becomes
unusable. This value is present only for KMS keys whose Origin is
EXTERNAL and whose ExpirationModel is KEY_MATERIAL_EXPIRES,
otherwise this value is omitted.
keyMetadata_xksKeyConfiguration :: Lens' KeyMetadata (Maybe XksKeyConfigurationType) Source #
Information about the external key that is associated with a KMS key in an external key store.
For more information, see External key in the Key Management Service Developer Guide.
keyMetadata_keyId :: Lens' KeyMetadata Text Source #
The globally unique identifier for the KMS key.
ListGrantsResponse
data ListGrantsResponse Source #
See: newListGrantsResponse smart constructor.
Constructors
| ListGrantsResponse' | |
Fields
| |
Instances
newListGrantsResponse :: ListGrantsResponse Source #
Create a value of ListGrantsResponse 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:grants:ListGrantsResponse', listGrantsResponse_grants - A list of grants.
$sel:nextMarker:ListGrantsResponse', listGrantsResponse_nextMarker - When Truncated is true, this element is present and contains the value
to use for the Marker parameter in a subsequent request.
$sel:truncated:ListGrantsResponse', listGrantsResponse_truncated - A flag that indicates whether there are more items in the list. When
this value is true, the list in this response is truncated. To get more
items, pass the value of the NextMarker element in thisresponse to the
Marker parameter in a subsequent request.
listGrantsResponse_grants :: Lens' ListGrantsResponse (Maybe [GrantListEntry]) Source #
A list of grants.
listGrantsResponse_nextMarker :: Lens' ListGrantsResponse (Maybe Text) Source #
When Truncated is true, this element is present and contains the value
to use for the Marker parameter in a subsequent request.
listGrantsResponse_truncated :: Lens' ListGrantsResponse (Maybe Bool) Source #
A flag that indicates whether there are more items in the list. When
this value is true, the list in this response is truncated. To get more
items, pass the value of the NextMarker element in thisresponse to the
Marker parameter in a subsequent request.
MultiRegionConfiguration
data MultiRegionConfiguration Source #
Describes the configuration of this multi-Region key. This field appears only when the KMS key is a primary or replica of a multi-Region key.
For more information about any listed KMS key, use the DescribeKey operation.
See: newMultiRegionConfiguration smart constructor.
Constructors
| MultiRegionConfiguration' | |
Fields
| |
Instances
newMultiRegionConfiguration :: MultiRegionConfiguration Source #
Create a value of MultiRegionConfiguration 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:multiRegionKeyType:MultiRegionConfiguration', multiRegionConfiguration_multiRegionKeyType - Indicates whether the KMS key is a PRIMARY or REPLICA key.
$sel:primaryKey:MultiRegionConfiguration', multiRegionConfiguration_primaryKey - Displays the key ARN and Region of the primary key. This field includes
the current KMS key if it is the primary key.
$sel:replicaKeys:MultiRegionConfiguration', multiRegionConfiguration_replicaKeys - displays the key ARNs and Regions of all replica keys. This field
includes the current KMS key if it is a replica key.
multiRegionConfiguration_multiRegionKeyType :: Lens' MultiRegionConfiguration (Maybe MultiRegionKeyType) Source #
Indicates whether the KMS key is a PRIMARY or REPLICA key.
multiRegionConfiguration_primaryKey :: Lens' MultiRegionConfiguration (Maybe MultiRegionKey) Source #
Displays the key ARN and Region of the primary key. This field includes the current KMS key if it is the primary key.
multiRegionConfiguration_replicaKeys :: Lens' MultiRegionConfiguration (Maybe [MultiRegionKey]) Source #
displays the key ARNs and Regions of all replica keys. This field includes the current KMS key if it is a replica key.
MultiRegionKey
data MultiRegionKey Source #
Describes the primary or replica key in a multi-Region key.
See: newMultiRegionKey smart constructor.
Constructors
| MultiRegionKey' | |
Instances
newMultiRegionKey :: MultiRegionKey Source #
Create a value of MultiRegionKey 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:arn:MultiRegionKey', multiRegionKey_arn - Displays the key ARN of a primary or replica key of a multi-Region key.
$sel:region:MultiRegionKey', multiRegionKey_region - Displays the Amazon Web Services Region of a primary or replica key in a
multi-Region key.
multiRegionKey_arn :: Lens' MultiRegionKey (Maybe Text) Source #
Displays the key ARN of a primary or replica key of a multi-Region key.
multiRegionKey_region :: Lens' MultiRegionKey (Maybe Text) Source #
Displays the Amazon Web Services Region of a primary or replica key in a multi-Region key.
Tag
A key-value pair. A tag consists of a tag key and a tag value. Tag keys and tag values are both required, but tag values can be empty (null) strings.
For information about the rules that apply to tag keys and tag values, see User-Defined Tag Restrictions in the Amazon Web Services Billing and Cost Management User Guide.
See: newTag smart constructor.
Instances
| FromJSON Tag Source # | |
| ToJSON Tag Source # | |
Defined in Amazonka.KMS.Types.Tag | |
| Generic Tag Source # | |
| Read Tag Source # | |
| Show Tag Source # | |
| NFData Tag Source # | |
Defined in Amazonka.KMS.Types.Tag | |
| Eq Tag Source # | |
| Hashable Tag Source # | |
Defined in Amazonka.KMS.Types.Tag | |
| type Rep Tag Source # | |
Defined in Amazonka.KMS.Types.Tag type Rep Tag = D1 ('MetaData "Tag" "Amazonka.KMS.Types.Tag" "amazonka-kms-2.0-6YhT3Ymbf9Z5PoaGoz7tbG" 'False) (C1 ('MetaCons "Tag'" 'PrefixI 'True) (S1 ('MetaSel ('Just "tagKey") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "tagValue") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))) | |
Create a value of Tag 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:tagKey:Tag', tag_tagKey - The key of the tag.
$sel:tagValue:Tag', tag_tagValue - The value of the tag.
XksKeyConfigurationType
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' | |
Instances
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.
XksProxyAuthenticationCredentialType
data XksProxyAuthenticationCredentialType Source #
KMS uses the authentication credential to sign requests that it sends to the external key store proxy (XKS proxy) on your behalf. You establish these credentials on your external key store proxy and report them to KMS.
The XksProxyAuthenticationCredential includes two required elements.
See: newXksProxyAuthenticationCredentialType smart constructor.
Constructors
| XksProxyAuthenticationCredentialType' | |
Fields
| |
Instances
newXksProxyAuthenticationCredentialType Source #
Arguments
| :: Text | |
| -> Text |
|
| -> XksProxyAuthenticationCredentialType |
Create a value of XksProxyAuthenticationCredentialType 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:XksProxyAuthenticationCredentialType', xksProxyAuthenticationCredentialType_accessKeyId - A unique identifier for the raw secret access key.
$sel:rawSecretAccessKey:XksProxyAuthenticationCredentialType', xksProxyAuthenticationCredentialType_rawSecretAccessKey - A secret string of 43-64 characters. Valid characters are a-z, A-Z, 0-9,
/, +, and =.
xksProxyAuthenticationCredentialType_accessKeyId :: Lens' XksProxyAuthenticationCredentialType Text Source #
A unique identifier for the raw secret access key.
xksProxyAuthenticationCredentialType_rawSecretAccessKey :: Lens' XksProxyAuthenticationCredentialType Text Source #
A secret string of 43-64 characters. Valid characters are a-z, A-Z, 0-9, /, +, and =.
XksProxyConfigurationType
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
| |
Instances
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.