Copyright	(c) 2013-2021 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None

Amazonka.CloudHSMV2.DeleteHsm

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Deletes the specified HSM. To specify an HSM, you can use its identifier (ID), the IP address of the HSM's elastic network interface (ENI), or the ID of the HSM's ENI. You need to specify only one of these values. To find these values, use DescribeClusters.

Synopsis

data DeleteHsm = DeleteHsm' {
- eniId :: Maybe Text
- hsmId :: Maybe Text
- eniIp :: Maybe Text
- clusterId :: Text
}
newDeleteHsm :: Text -> DeleteHsm
deleteHsm_eniId :: Lens' DeleteHsm (Maybe Text)
deleteHsm_hsmId :: Lens' DeleteHsm (Maybe Text)
deleteHsm_eniIp :: Lens' DeleteHsm (Maybe Text)
deleteHsm_clusterId :: Lens' DeleteHsm Text
data DeleteHsmResponse = DeleteHsmResponse' {
- hsmId :: Maybe Text
- httpStatus :: Int
}
newDeleteHsmResponse :: Int -> DeleteHsmResponse
deleteHsmResponse_hsmId :: Lens' DeleteHsmResponse (Maybe Text)
deleteHsmResponse_httpStatus :: Lens' DeleteHsmResponse Int

Creating a Request

data DeleteHsm Source #

See: newDeleteHsm smart constructor.

Constructors

DeleteHsm'
Fields eniId :: Maybe Text The identifier (ID) of the elastic network interface (ENI) of the HSM that you are deleting. hsmId :: Maybe Text The identifier (ID) of the HSM that you are deleting. eniIp :: Maybe Text The IP address of the elastic network interface (ENI) of the HSM that you are deleting. clusterId :: Text The identifier (ID) of the cluster that contains the HSM that you are deleting.

Instances

Instances details

Eq DeleteHsm Source #
Instance details Defined in Amazonka.CloudHSMV2.DeleteHsm Methods (==) :: DeleteHsm -> DeleteHsm -> Bool # (/=) :: DeleteHsm -> DeleteHsm -> Bool #
Read DeleteHsm Source #
Instance details Defined in Amazonka.CloudHSMV2.DeleteHsm Methods readsPrec :: Int -> ReadS DeleteHsm # readList :: ReadS [DeleteHsm] # readPrec :: ReadPrec DeleteHsm # readListPrec :: ReadPrec [DeleteHsm] #
Show DeleteHsm Source #
Instance details Defined in Amazonka.CloudHSMV2.DeleteHsm Methods showsPrec :: Int -> DeleteHsm -> ShowS # show :: DeleteHsm -> String # showList :: [DeleteHsm] -> ShowS #
Generic DeleteHsm Source #
Instance details Defined in Amazonka.CloudHSMV2.DeleteHsm Associated Types type Rep DeleteHsm :: Type -> Type # Methods from :: DeleteHsm -> Rep DeleteHsm x # to :: Rep DeleteHsm x -> DeleteHsm #
NFData DeleteHsm Source #
Instance details Defined in Amazonka.CloudHSMV2.DeleteHsm Methods rnf :: DeleteHsm -> () #
Hashable DeleteHsm Source #
Instance details Defined in Amazonka.CloudHSMV2.DeleteHsm Methods hashWithSalt :: Int -> DeleteHsm -> Int # hash :: DeleteHsm -> Int #
ToJSON DeleteHsm Source #
Instance details Defined in Amazonka.CloudHSMV2.DeleteHsm Methods toJSON :: DeleteHsm -> Value # toEncoding :: DeleteHsm -> Encoding # toJSONList :: [DeleteHsm] -> Value # toEncodingList :: [DeleteHsm] -> Encoding #
AWSRequest DeleteHsm Source #
Instance details Defined in Amazonka.CloudHSMV2.DeleteHsm Associated Types type AWSResponse DeleteHsm # Methods request :: DeleteHsm -> Request DeleteHsm # response :: MonadResource m => Logger -> Service -> Proxy DeleteHsm -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse DeleteHsm))) #
ToHeaders DeleteHsm Source #
Instance details Defined in Amazonka.CloudHSMV2.DeleteHsm Methods toHeaders :: DeleteHsm -> [Header] #
ToPath DeleteHsm Source #
Instance details Defined in Amazonka.CloudHSMV2.DeleteHsm Methods toPath :: DeleteHsm -> ByteString #
ToQuery DeleteHsm Source #
Instance details Defined in Amazonka.CloudHSMV2.DeleteHsm Methods toQuery :: DeleteHsm -> QueryString #
type Rep DeleteHsm Source #
Instance details Defined in Amazonka.CloudHSMV2.DeleteHsm type Rep DeleteHsm = D1 ('MetaData "DeleteHsm" "Amazonka.CloudHSMV2.DeleteHsm" "libZSservicesZSamazonka-cloudhsmv2ZSamazonka-cloudhsmv2" 'False) (C1 ('MetaCons "DeleteHsm'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "eniId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "hsmId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "eniIp") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "clusterId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))
type AWSResponse DeleteHsm Source #
Instance details Defined in Amazonka.CloudHSMV2.DeleteHsm type AWSResponse DeleteHsm = DeleteHsmResponse

newDeleteHsm Source #

Arguments

:: Text	`$sel:clusterId:DeleteHsm'`
-> DeleteHsm

Create a value of DeleteHsm 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:eniId:DeleteHsm', deleteHsm_eniId - The identifier (ID) of the elastic network interface (ENI) of the HSM that you are deleting.

$sel:hsmId:DeleteHsm', deleteHsm_hsmId - The identifier (ID) of the HSM that you are deleting.

$sel:eniIp:DeleteHsm', deleteHsm_eniIp - The IP address of the elastic network interface (ENI) of the HSM that you are deleting.

$sel:clusterId:DeleteHsm', deleteHsm_clusterId - The identifier (ID) of the cluster that contains the HSM that you are deleting.

Request Lenses

deleteHsm_eniId :: Lens' DeleteHsm (Maybe Text) Source #

The identifier (ID) of the elastic network interface (ENI) of the HSM that you are deleting.

deleteHsm_hsmId :: Lens' DeleteHsm (Maybe Text) Source #

The identifier (ID) of the HSM that you are deleting.

deleteHsm_eniIp :: Lens' DeleteHsm (Maybe Text) Source #

The IP address of the elastic network interface (ENI) of the HSM that you are deleting.

deleteHsm_clusterId :: Lens' DeleteHsm Text Source #

The identifier (ID) of the cluster that contains the HSM that you are deleting.

Destructuring the Response

data DeleteHsmResponse Source #

See: newDeleteHsmResponse smart constructor.

Constructors

DeleteHsmResponse'
Fields hsmId :: Maybe Text The identifier (ID) of the HSM that was deleted. httpStatus :: Int The response's http status code.

Instances

Instances details

Eq DeleteHsmResponse Source #
Instance details Defined in Amazonka.CloudHSMV2.DeleteHsm Methods (==) :: DeleteHsmResponse -> DeleteHsmResponse -> Bool # (/=) :: DeleteHsmResponse -> DeleteHsmResponse -> Bool #
Read DeleteHsmResponse Source #
Instance details Defined in Amazonka.CloudHSMV2.DeleteHsm Methods readsPrec :: Int -> ReadS DeleteHsmResponse # readList :: ReadS [DeleteHsmResponse] # readPrec :: ReadPrec DeleteHsmResponse # readListPrec :: ReadPrec [DeleteHsmResponse] #
Show DeleteHsmResponse Source #
Instance details Defined in Amazonka.CloudHSMV2.DeleteHsm Methods showsPrec :: Int -> DeleteHsmResponse -> ShowS # show :: DeleteHsmResponse -> String # showList :: [DeleteHsmResponse] -> ShowS #
Generic DeleteHsmResponse Source #
Instance details Defined in Amazonka.CloudHSMV2.DeleteHsm Associated Types type Rep DeleteHsmResponse :: Type -> Type # Methods from :: DeleteHsmResponse -> Rep DeleteHsmResponse x # to :: Rep DeleteHsmResponse x -> DeleteHsmResponse #
NFData DeleteHsmResponse Source #
Instance details Defined in Amazonka.CloudHSMV2.DeleteHsm Methods rnf :: DeleteHsmResponse -> () #
type Rep DeleteHsmResponse Source #
Instance details Defined in Amazonka.CloudHSMV2.DeleteHsm type Rep DeleteHsmResponse = D1 ('MetaData "DeleteHsmResponse" "Amazonka.CloudHSMV2.DeleteHsm" "libZSservicesZSamazonka-cloudhsmv2ZSamazonka-cloudhsmv2" 'False) (C1 ('MetaCons "DeleteHsmResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "hsmId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newDeleteHsmResponse Source #

Arguments

:: Int	`$sel:httpStatus:DeleteHsmResponse'`
-> DeleteHsmResponse

Create a value of DeleteHsmResponse 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:hsmId:DeleteHsm', deleteHsmResponse_hsmId - The identifier (ID) of the HSM that was deleted.

$sel:httpStatus:DeleteHsmResponse', deleteHsmResponse_httpStatus - The response's http status code.

Response Lenses

deleteHsmResponse_hsmId :: Lens' DeleteHsmResponse (Maybe Text) Source #

The identifier (ID) of the HSM that was deleted.

deleteHsmResponse_httpStatus :: Lens' DeleteHsmResponse Int Source #

The response's http status code.