libZSservicesZSamazonka-kmsZSamazonka-kms
Copyright(c) 2013-2021 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone

Amazonka.KMS.UpdateCustomKeyStore

Description

Changes the properties of a custom key store. Use the CustomKeyStoreId parameter to identify the custom key store you want to edit. Use the remaining parameters to change the properties of the custom key store.

You can only update a custom key store that is disconnected. To disconnect the custom key store, use DisconnectCustomKeyStore. To reconnect the custom key store after the update completes, use ConnectCustomKeyStore. To find the connection state of a custom key store, use the DescribeCustomKeyStores operation.

The CustomKeyStoreId parameter is required in all commands. Use the other parameters of UpdateCustomKeyStore to edit your key store settings.

  • Use the NewCustomKeyStoreName parameter to change the friendly name of the custom key store to the value that you specify.
  • Use the KeyStorePassword parameter tell KMS the current password of the kmsuser crypto user (CU) in the associated CloudHSM cluster. You can use this parameter to fix connection failures that occur when KMS cannot log into the associated cluster because the kmsuser password has changed. This value does not change the password in the CloudHSM cluster.
  • Use the CloudHsmClusterId parameter to associate the custom key store with a different, but related, CloudHSM cluster. You can use this parameter to repair a custom key store if its CloudHSM cluster becomes corrupted or is deleted, or when you need to create or restore a cluster from a backup.

If the operation succeeds, it returns a JSON object with no properties.

This operation is part of the Custom Key Store feature feature in KMS, which combines the convenience and extensive integration of KMS with the isolation and control of a single-tenant key store.

Cross-account use: No. You cannot perform this operation on a custom key store in a different Amazon Web Services account.

Required permissions: kms:UpdateCustomKeyStore (IAM policy)

Related operations:

  • ConnectCustomKeyStore
  • CreateCustomKeyStore
  • DeleteCustomKeyStore
  • DescribeCustomKeyStores
  • DisconnectCustomKeyStore
Synopsis

Creating a Request

data UpdateCustomKeyStore Source #

See: newUpdateCustomKeyStore smart constructor.

Constructors

UpdateCustomKeyStore' 

Fields

  • keyStorePassword :: Maybe (Sensitive Text)

    Enter the current password of the kmsuser crypto user (CU) in the CloudHSM cluster that is associated with the custom key store.

    This parameter tells KMS the current password of the kmsuser crypto user (CU). It does not set or change the password of any users in the CloudHSM cluster.

  • cloudHsmClusterId :: Maybe Text

    Associates the custom key store with a related CloudHSM cluster.

    Enter the cluster ID of the cluster that you used to create the custom key store or a cluster that shares a backup history and has the same cluster certificate as the original cluster. You cannot use this parameter to associate a custom key store with an unrelated cluster. In addition, the replacement cluster must fulfill the requirements for a cluster associated with a custom key store. To view the cluster certificate of a cluster, use the DescribeClusters operation.

  • newCustomKeyStoreName' :: Maybe Text

    Changes the friendly name of the custom key store to the value that you specify. The custom key store name must be unique in the Amazon Web Services account.

  • customKeyStoreId :: Text

    Identifies the custom key store that you want to update. Enter the ID of the custom key store. To find the ID of a custom key store, use the DescribeCustomKeyStores operation.

Instances

Instances details
Eq UpdateCustomKeyStore Source # 
Instance details

Defined in Amazonka.KMS.UpdateCustomKeyStore

Methods

(==) :: UpdateCustomKeyStore -> UpdateCustomKeyStore -> Bool #

(/=) :: UpdateCustomKeyStore -> UpdateCustomKeyStore -> Bool #

Show UpdateCustomKeyStore Source # 
Instance details

Defined in Amazonka.KMS.UpdateCustomKeyStore

Methods

showsPrec :: Int -> UpdateCustomKeyStore -> ShowS #

show :: UpdateCustomKeyStore -> String #

showList :: [UpdateCustomKeyStore] -> ShowS #

Generic UpdateCustomKeyStore Source # 
Instance details

Defined in Amazonka.KMS.UpdateCustomKeyStore

Associated Types

type Rep UpdateCustomKeyStore :: Type -> Type #

Methods

from :: UpdateCustomKeyStore -> Rep UpdateCustomKeyStore x #

to :: Rep UpdateCustomKeyStore x -> UpdateCustomKeyStore #

NFData UpdateCustomKeyStore Source # 
Instance details

Defined in Amazonka.KMS.UpdateCustomKeyStore

Methods

rnf :: UpdateCustomKeyStore -> () #

Hashable UpdateCustomKeyStore Source # 
Instance details

Defined in Amazonka.KMS.UpdateCustomKeyStore

Methods

hashWithSalt :: Int -> UpdateCustomKeyStore -> Int #

hash :: UpdateCustomKeyStore -> Int #

ToJSON UpdateCustomKeyStore Source # 
Instance details

Defined in Amazonka.KMS.UpdateCustomKeyStore

Methods

toJSON :: UpdateCustomKeyStore -> Value #

toEncoding :: UpdateCustomKeyStore -> Encoding #

toJSONList :: [UpdateCustomKeyStore] -> Value #

toEncodingList :: [UpdateCustomKeyStore] -> Encoding #

AWSRequest UpdateCustomKeyStore Source # 
Instance details

Defined in Amazonka.KMS.UpdateCustomKeyStore

Associated Types

type AWSResponse UpdateCustomKeyStore #

Methods

request :: UpdateCustomKeyStore -> Request UpdateCustomKeyStore #

response :: MonadResource m => Logger -> Service -> Proxy UpdateCustomKeyStore -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse UpdateCustomKeyStore))) #

ToHeaders UpdateCustomKeyStore Source # 
Instance details

Defined in Amazonka.KMS.UpdateCustomKeyStore

Methods

toHeaders :: UpdateCustomKeyStore -> [Header] #

ToPath UpdateCustomKeyStore Source # 
Instance details

Defined in Amazonka.KMS.UpdateCustomKeyStore

Methods

toPath :: UpdateCustomKeyStore -> ByteString #

ToQuery UpdateCustomKeyStore Source # 
Instance details

Defined in Amazonka.KMS.UpdateCustomKeyStore

Methods

toQuery :: UpdateCustomKeyStore -> QueryString #

type Rep UpdateCustomKeyStore Source # 
Instance details

Defined in Amazonka.KMS.UpdateCustomKeyStore

type Rep UpdateCustomKeyStore = D1 ('MetaData "UpdateCustomKeyStore" "Amazonka.KMS.UpdateCustomKeyStore" "libZSservicesZSamazonka-kmsZSamazonka-kms" 'False) (C1 ('MetaCons "UpdateCustomKeyStore'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "keyStorePassword") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (Sensitive Text))) :*: S1 ('MetaSel ('Just "cloudHsmClusterId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "newCustomKeyStoreName'") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "customKeyStoreId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))
type AWSResponse UpdateCustomKeyStore Source # 
Instance details

Defined in Amazonka.KMS.UpdateCustomKeyStore

type AWSResponse UpdateCustomKeyStore = UpdateCustomKeyStoreResponse

newUpdateCustomKeyStore Source #

Arguments

:: Text

$sel:customKeyStoreId:UpdateCustomKeyStore'

-> UpdateCustomKeyStore 

Create a value of UpdateCustomKeyStore 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:keyStorePassword:UpdateCustomKeyStore', updateCustomKeyStore_keyStorePassword - Enter the current password of the kmsuser crypto user (CU) in the CloudHSM cluster that is associated with the custom key store.

This parameter tells KMS the current password of the kmsuser crypto user (CU). It does not set or change the password of any users in the CloudHSM cluster.

$sel:cloudHsmClusterId:UpdateCustomKeyStore', updateCustomKeyStore_cloudHsmClusterId - Associates the custom key store with a related CloudHSM cluster.

Enter the cluster ID of the cluster that you used to create the custom key store or a cluster that shares a backup history and has the same cluster certificate as the original cluster. You cannot use this parameter to associate a custom key store with an unrelated cluster. In addition, the replacement cluster must fulfill the requirements for a cluster associated with a custom key store. To view the cluster certificate of a cluster, use the DescribeClusters operation.

$sel:newCustomKeyStoreName':UpdateCustomKeyStore', updateCustomKeyStore_newCustomKeyStoreName - Changes the friendly name of the custom key store to the value that you specify. The custom key store name must be unique in the Amazon Web Services account.

$sel:customKeyStoreId:UpdateCustomKeyStore', updateCustomKeyStore_customKeyStoreId - Identifies the custom key store that you want to update. Enter the ID of the custom key store. To find the ID of a custom key store, use the DescribeCustomKeyStores operation.

Request Lenses

updateCustomKeyStore_keyStorePassword :: Lens' UpdateCustomKeyStore (Maybe Text) Source #

Enter the current password of the kmsuser crypto user (CU) in the CloudHSM cluster that is associated with the custom key store.

This parameter tells KMS the current password of the kmsuser crypto user (CU). It does not set or change the password of any users in the CloudHSM cluster.

updateCustomKeyStore_cloudHsmClusterId :: Lens' UpdateCustomKeyStore (Maybe Text) Source #

Associates the custom key store with a related CloudHSM cluster.

Enter the cluster ID of the cluster that you used to create the custom key store or a cluster that shares a backup history and has the same cluster certificate as the original cluster. You cannot use this parameter to associate a custom key store with an unrelated cluster. In addition, the replacement cluster must fulfill the requirements for a cluster associated with a custom key store. To view the cluster certificate of a cluster, use the DescribeClusters operation.

updateCustomKeyStore_newCustomKeyStoreName :: Lens' UpdateCustomKeyStore (Maybe Text) Source #

Changes the friendly name of the custom key store to the value that you specify. The custom key store name must be unique in the Amazon Web Services account.

updateCustomKeyStore_customKeyStoreId :: Lens' UpdateCustomKeyStore Text Source #

Identifies the custom key store that you want to update. Enter the ID of the custom key store. To find the ID of a custom key store, use the DescribeCustomKeyStores operation.

Destructuring the Response

data UpdateCustomKeyStoreResponse Source #

See: newUpdateCustomKeyStoreResponse smart constructor.

Constructors

UpdateCustomKeyStoreResponse' 

Fields

Instances

Instances details
Eq UpdateCustomKeyStoreResponse Source # 
Instance details

Defined in Amazonka.KMS.UpdateCustomKeyStore

Methods

(==) :: UpdateCustomKeyStoreResponse -> UpdateCustomKeyStoreResponse -> Bool #

(/=) :: UpdateCustomKeyStoreResponse -> UpdateCustomKeyStoreResponse -> Bool #

Read UpdateCustomKeyStoreResponse Source # 
Instance details

Defined in Amazonka.KMS.UpdateCustomKeyStore

Methods

readsPrec :: Int -> ReadS UpdateCustomKeyStoreResponse #

readList :: ReadS [UpdateCustomKeyStoreResponse] #

readPrec :: ReadPrec UpdateCustomKeyStoreResponse #

readListPrec :: ReadPrec [UpdateCustomKeyStoreResponse] #

Show UpdateCustomKeyStoreResponse Source # 
Instance details

Defined in Amazonka.KMS.UpdateCustomKeyStore

Methods

showsPrec :: Int -> UpdateCustomKeyStoreResponse -> ShowS #

show :: UpdateCustomKeyStoreResponse -> String #

showList :: [UpdateCustomKeyStoreResponse] -> ShowS #

Generic UpdateCustomKeyStoreResponse Source # 
Instance details

Defined in Amazonka.KMS.UpdateCustomKeyStore

Associated Types

type Rep UpdateCustomKeyStoreResponse :: Type -> Type #

Methods

from :: UpdateCustomKeyStoreResponse -> Rep UpdateCustomKeyStoreResponse x #

to :: Rep UpdateCustomKeyStoreResponse x -> UpdateCustomKeyStoreResponse #

NFData UpdateCustomKeyStoreResponse Source # 
Instance details

Defined in Amazonka.KMS.UpdateCustomKeyStore

Methods

rnf :: UpdateCustomKeyStoreResponse -> () #

type Rep UpdateCustomKeyStoreResponse Source # 
Instance details

Defined in Amazonka.KMS.UpdateCustomKeyStore

type Rep UpdateCustomKeyStoreResponse = D1 ('MetaData "UpdateCustomKeyStoreResponse" "Amazonka.KMS.UpdateCustomKeyStore" "libZSservicesZSamazonka-kmsZSamazonka-kms" 'False) (C1 ('MetaCons "UpdateCustomKeyStoreResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newUpdateCustomKeyStoreResponse Source #

Arguments

:: Int

$sel:httpStatus:UpdateCustomKeyStoreResponse'

-> UpdateCustomKeyStoreResponse 

Create a value of UpdateCustomKeyStoreResponse 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:httpStatus:UpdateCustomKeyStoreResponse', updateCustomKeyStoreResponse_httpStatus - The response's http status code.

Response Lenses

updateCustomKeyStoreResponse_httpStatus :: Lens' UpdateCustomKeyStoreResponse Int Source #

The response's http status code.