Copyright | (c) 2013-2018 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 |
Language | Haskell2010 |
Network.AWS.CloudHSM.DescribeHSM
Description
This is documentation for AWS CloudHSM Classic . For more information, see AWS CloudHSM Classic FAQs , the AWS CloudHSM Classic User Guide , and the AWS CloudHSM Classic API Reference .
For information about the current version of AWS CloudHSM , see AWS CloudHSM , the AWS CloudHSM User Guide , and the AWS CloudHSM API Reference .
Retrieves information about an HSM. You can identify the HSM by its ARN or its serial number.
Synopsis
- describeHSM :: DescribeHSM
- data DescribeHSM
- dhsmHSMSerialNumber :: Lens' DescribeHSM (Maybe Text)
- dhsmHSMARN :: Lens' DescribeHSM (Maybe Text)
- describeHSMResponse :: Int -> DescribeHSMResponse
- data DescribeHSMResponse
- desrsStatus :: Lens' DescribeHSMResponse (Maybe HSMStatus)
- desrsIAMRoleARN :: Lens' DescribeHSMResponse (Maybe Text)
- desrsEniId :: Lens' DescribeHSMResponse (Maybe Text)
- desrsVPCId :: Lens' DescribeHSMResponse (Maybe Text)
- desrsSSHKeyLastUpdated :: Lens' DescribeHSMResponse (Maybe Text)
- desrsSubscriptionEndDate :: Lens' DescribeHSMResponse (Maybe Text)
- desrsServerCertURI :: Lens' DescribeHSMResponse (Maybe Text)
- desrsSubscriptionType :: Lens' DescribeHSMResponse (Maybe SubscriptionType)
- desrsSSHPublicKey :: Lens' DescribeHSMResponse (Maybe Text)
- desrsSubnetId :: Lens' DescribeHSMResponse (Maybe Text)
- desrsStatusDetails :: Lens' DescribeHSMResponse (Maybe Text)
- desrsPartitions :: Lens' DescribeHSMResponse [Text]
- desrsSubscriptionStartDate :: Lens' DescribeHSMResponse (Maybe Text)
- desrsAvailabilityZone :: Lens' DescribeHSMResponse (Maybe Text)
- desrsServerCertLastUpdated :: Lens' DescribeHSMResponse (Maybe Text)
- desrsSoftwareVersion :: Lens' DescribeHSMResponse (Maybe Text)
- desrsVendorName :: Lens' DescribeHSMResponse (Maybe Text)
- desrsSerialNumber :: Lens' DescribeHSMResponse (Maybe Text)
- desrsHSMARN :: Lens' DescribeHSMResponse (Maybe Text)
- desrsEniIP :: Lens' DescribeHSMResponse (Maybe Text)
- desrsHSMType :: Lens' DescribeHSMResponse (Maybe Text)
- desrsResponseStatus :: Lens' DescribeHSMResponse Int
Creating a Request
describeHSM :: DescribeHSM Source #
Creates a value of DescribeHSM
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
dhsmHSMSerialNumber
- The serial number of the HSM. Either theHsmArn
or theHsmSerialNumber
parameter must be specified.dhsmHSMARN
- The ARN of the HSM. Either theHsmArn
or theSerialNumber
parameter must be specified.
data DescribeHSM Source #
Contains the inputs for the DescribeHsm
operation.
See: describeHSM
smart constructor.
Instances
Request Lenses
dhsmHSMSerialNumber :: Lens' DescribeHSM (Maybe Text) Source #
The serial number of the HSM. Either the HsmArn
or the HsmSerialNumber
parameter must be specified.
dhsmHSMARN :: Lens' DescribeHSM (Maybe Text) Source #
The ARN of the HSM. Either the HsmArn
or the SerialNumber
parameter must be specified.
Destructuring the Response
Arguments
:: Int | |
-> DescribeHSMResponse |
Creates a value of DescribeHSMResponse
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
desrsStatus
- The status of the HSM.desrsIAMRoleARN
- The ARN of the IAM role assigned to the HSM.desrsEniId
- The identifier of the elastic network interface (ENI) attached to the HSM.desrsVPCId
- The identifier of the VPC that the HSM is in.desrsSSHKeyLastUpdated
- The date and time that the SSH key was last updated.desrsSubscriptionEndDate
- The subscription end date.desrsServerCertURI
- The URI of the certificate server.desrsSubscriptionType
- Undocumented member.desrsSSHPublicKey
- The public SSH key.desrsSubnetId
- The identifier of the subnet that the HSM is in.desrsStatusDetails
- Contains additional information about the status of the HSM.desrsPartitions
- The list of partitions on the HSM.desrsSubscriptionStartDate
- The subscription start date.desrsAvailabilityZone
- The Availability Zone that the HSM is in.desrsServerCertLastUpdated
- The date and time that the server certificate was last updated.desrsSoftwareVersion
- The HSM software version.desrsVendorName
- The name of the HSM vendor.desrsSerialNumber
- The serial number of the HSM.desrsHSMARN
- The ARN of the HSM.desrsEniIP
- The IP address assigned to the HSM's ENI.desrsHSMType
- The HSM model type.desrsResponseStatus
- -- | The response status code.
data DescribeHSMResponse Source #
Contains the output of the DescribeHsm
operation.
See: describeHSMResponse
smart constructor.
Instances
Response Lenses
desrsStatus :: Lens' DescribeHSMResponse (Maybe HSMStatus) Source #
The status of the HSM.
desrsIAMRoleARN :: Lens' DescribeHSMResponse (Maybe Text) Source #
The ARN of the IAM role assigned to the HSM.
desrsEniId :: Lens' DescribeHSMResponse (Maybe Text) Source #
The identifier of the elastic network interface (ENI) attached to the HSM.
desrsVPCId :: Lens' DescribeHSMResponse (Maybe Text) Source #
The identifier of the VPC that the HSM is in.
desrsSSHKeyLastUpdated :: Lens' DescribeHSMResponse (Maybe Text) Source #
The date and time that the SSH key was last updated.
desrsSubscriptionEndDate :: Lens' DescribeHSMResponse (Maybe Text) Source #
The subscription end date.
desrsServerCertURI :: Lens' DescribeHSMResponse (Maybe Text) Source #
The URI of the certificate server.
desrsSubscriptionType :: Lens' DescribeHSMResponse (Maybe SubscriptionType) Source #
Undocumented member.
desrsSSHPublicKey :: Lens' DescribeHSMResponse (Maybe Text) Source #
The public SSH key.
desrsSubnetId :: Lens' DescribeHSMResponse (Maybe Text) Source #
The identifier of the subnet that the HSM is in.
desrsStatusDetails :: Lens' DescribeHSMResponse (Maybe Text) Source #
Contains additional information about the status of the HSM.
desrsPartitions :: Lens' DescribeHSMResponse [Text] Source #
The list of partitions on the HSM.
desrsSubscriptionStartDate :: Lens' DescribeHSMResponse (Maybe Text) Source #
The subscription start date.
desrsAvailabilityZone :: Lens' DescribeHSMResponse (Maybe Text) Source #
The Availability Zone that the HSM is in.
desrsServerCertLastUpdated :: Lens' DescribeHSMResponse (Maybe Text) Source #
The date and time that the server certificate was last updated.
desrsSoftwareVersion :: Lens' DescribeHSMResponse (Maybe Text) Source #
The HSM software version.
desrsVendorName :: Lens' DescribeHSMResponse (Maybe Text) Source #
The name of the HSM vendor.
desrsSerialNumber :: Lens' DescribeHSMResponse (Maybe Text) Source #
The serial number of the HSM.
desrsHSMARN :: Lens' DescribeHSMResponse (Maybe Text) Source #
The ARN of the HSM.
desrsEniIP :: Lens' DescribeHSMResponse (Maybe Text) Source #
The IP address assigned to the HSM's ENI.
desrsHSMType :: Lens' DescribeHSMResponse (Maybe Text) Source #
The HSM model type.
desrsResponseStatus :: Lens' DescribeHSMResponse Int Source #
- - | The response status code.