amazonka-cloudhsmv2-2.0: Amazon CloudHSM V2 SDK.
Copyright(c) 2013-2023 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellSafe-Inferred
LanguageHaskell2010

Amazonka.CloudHSMV2.DeleteHsm

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

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.

  • eniIp :: Maybe Text

    The IP address 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.

  • clusterId :: Text

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

Instances

Instances details
ToJSON DeleteHsm Source # 
Instance details

Defined in Amazonka.CloudHSMV2.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

ToQuery DeleteHsm Source # 
Instance details

Defined in Amazonka.CloudHSMV2.DeleteHsm

AWSRequest DeleteHsm Source # 
Instance details

Defined in Amazonka.CloudHSMV2.DeleteHsm

Associated Types

type AWSResponse DeleteHsm #

Generic DeleteHsm Source # 
Instance details

Defined in Amazonka.CloudHSMV2.DeleteHsm

Associated Types

type Rep DeleteHsm :: Type -> Type #

Read DeleteHsm Source # 
Instance details

Defined in Amazonka.CloudHSMV2.DeleteHsm

Show DeleteHsm Source # 
Instance details

Defined in Amazonka.CloudHSMV2.DeleteHsm

NFData DeleteHsm Source # 
Instance details

Defined in Amazonka.CloudHSMV2.DeleteHsm

Methods

rnf :: DeleteHsm -> () #

Eq DeleteHsm Source # 
Instance details

Defined in Amazonka.CloudHSMV2.DeleteHsm

Hashable DeleteHsm Source # 
Instance details

Defined in Amazonka.CloudHSMV2.DeleteHsm

type AWSResponse DeleteHsm Source # 
Instance details

Defined in Amazonka.CloudHSMV2.DeleteHsm

type Rep DeleteHsm Source # 
Instance details

Defined in Amazonka.CloudHSMV2.DeleteHsm

type Rep DeleteHsm = D1 ('MetaData "DeleteHsm" "Amazonka.CloudHSMV2.DeleteHsm" "amazonka-cloudhsmv2-2.0-JPONnjzt63Q1wP3HCntyXZ" 'False) (C1 ('MetaCons "DeleteHsm'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "eniId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "eniIp") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "hsmId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "clusterId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))

newDeleteHsm Source #

Arguments

:: Text

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:

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

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

DeleteHsm, deleteHsm_hsmId - The identifier (ID) of the HSM that you are deleting.

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_eniIp :: Lens' DeleteHsm (Maybe Text) Source #

The IP address 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_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

Instances

Instances details
Generic DeleteHsmResponse Source # 
Instance details

Defined in Amazonka.CloudHSMV2.DeleteHsm

Associated Types

type Rep DeleteHsmResponse :: Type -> Type #

Read DeleteHsmResponse Source # 
Instance details

Defined in Amazonka.CloudHSMV2.DeleteHsm

Show DeleteHsmResponse Source # 
Instance details

Defined in Amazonka.CloudHSMV2.DeleteHsm

NFData DeleteHsmResponse Source # 
Instance details

Defined in Amazonka.CloudHSMV2.DeleteHsm

Methods

rnf :: DeleteHsmResponse -> () #

Eq DeleteHsmResponse Source # 
Instance details

Defined in Amazonka.CloudHSMV2.DeleteHsm

type Rep DeleteHsmResponse Source # 
Instance details

Defined in Amazonka.CloudHSMV2.DeleteHsm

type Rep DeleteHsmResponse = D1 ('MetaData "DeleteHsmResponse" "Amazonka.CloudHSMV2.DeleteHsm" "amazonka-cloudhsmv2-2.0-JPONnjzt63Q1wP3HCntyXZ" '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 #

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:

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.