| 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.CloudHSMv2.Types
Contents
Description
- cloudHSMv2 :: Service
- _CloudHSMInternalFailureException :: AsError a => Getting (First ServiceError) a ServiceError
- _CloudHSMServiceException :: AsError a => Getting (First ServiceError) a ServiceError
- _CloudHSMInvalidRequestException :: AsError a => Getting (First ServiceError) a ServiceError
- _CloudHSMAccessDeniedException :: AsError a => Getting (First ServiceError) a ServiceError
- _CloudHSMResourceNotFoundException :: AsError a => Getting (First ServiceError) a ServiceError
- data BackupPolicy = Default
- data BackupState
- data ClusterState
- data HSMState
- data Backup
- backup :: Text -> Backup
- bClusterId :: Lens' Backup (Maybe Text)
- bCreateTimestamp :: Lens' Backup (Maybe UTCTime)
- bBackupState :: Lens' Backup (Maybe BackupState)
- bBackupId :: Lens' Backup Text
- data Certificates
- certificates :: Certificates
- cManufacturerHardwareCertificate :: Lens' Certificates (Maybe Text)
- cClusterCSR :: Lens' Certificates (Maybe Text)
- cHSMCertificate :: Lens' Certificates (Maybe Text)
- cClusterCertificate :: Lens' Certificates (Maybe Text)
- cAWSHardwareCertificate :: Lens' Certificates (Maybe Text)
- data Cluster
- cluster :: Cluster
- cPreCoPassword :: Lens' Cluster (Maybe Text)
- cStateMessage :: Lens' Cluster (Maybe Text)
- cState :: Lens' Cluster (Maybe ClusterState)
- cSubnetMapping :: Lens' Cluster (HashMap Text Text)
- cHSMs :: Lens' Cluster [HSM]
- cVPCId :: Lens' Cluster (Maybe Text)
- cSourceBackupId :: Lens' Cluster (Maybe Text)
- cCertificates :: Lens' Cluster (Maybe Certificates)
- cSecurityGroup :: Lens' Cluster (Maybe Text)
- cClusterId :: Lens' Cluster (Maybe Text)
- cCreateTimestamp :: Lens' Cluster (Maybe UTCTime)
- cBackupPolicy :: Lens' Cluster (Maybe BackupPolicy)
- cHSMType :: Lens' Cluster (Maybe Text)
- data HSM
- hsm :: Text -> HSM
- hsmStateMessage :: Lens' HSM (Maybe Text)
- hsmState :: Lens' HSM (Maybe HSMState)
- hsmEniId :: Lens' HSM (Maybe Text)
- hsmSubnetId :: Lens' HSM (Maybe Text)
- hsmAvailabilityZone :: Lens' HSM (Maybe Text)
- hsmClusterId :: Lens' HSM (Maybe Text)
- hsmEniIP :: Lens' HSM (Maybe Text)
- hsmHSMId :: Lens' HSM Text
- data Tag
- tag :: Text -> Text -> Tag
- tagKey :: Lens' Tag Text
- tagValue :: Lens' Tag Text
Service Configuration
cloudHSMv2 :: Service Source #
API version 2017-04-28 of the Amazon CloudHSM V2 SDK configuration.
Errors
_CloudHSMInternalFailureException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The request was rejected because of an AWS CloudHSM internal failure. The request can be retried.
_CloudHSMServiceException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The request was rejected because an error occurred.
_CloudHSMInvalidRequestException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The request was rejected because it is not a valid request.
_CloudHSMAccessDeniedException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The request was rejected because the requester does not have permission to perform the requested operation.
_CloudHSMResourceNotFoundException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The request was rejected because it refers to a resource that cannot be found.
BackupPolicy
data BackupPolicy Source #
Constructors
| Default |
Instances
BackupState
data BackupState Source #
Constructors
| BSCreateInProgress | |
| BSDeleted | |
| BSReady |
Instances
ClusterState
data ClusterState Source #
Constructors
| Active | |
| CreateInProgress | |
| Degraded | |
| DeleteInProgress | |
| Deleted | |
| InitializeInProgress | |
| Initialized | |
| Uninitialized | |
| UpdateInProgress |
Instances
HSMState
Constructors
| HSActive | |
| HSCreateInProgress | |
| HSDegraded | |
| HSDeleteInProgress | |
| HSDeleted |
Instances
Backup
Contains information about a backup of an AWS CloudHSM cluster.
See: backup smart constructor.
Creates a value of Backup with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
bClusterId- The identifier (ID) of the cluster that was backed up.bCreateTimestamp- The date and time when the backup was created.bBackupState- The state of the backup.bBackupId- The identifier (ID) of the backup.
bClusterId :: Lens' Backup (Maybe Text) Source #
The identifier (ID) of the cluster that was backed up.
bCreateTimestamp :: Lens' Backup (Maybe UTCTime) Source #
The date and time when the backup was created.
bBackupState :: Lens' Backup (Maybe BackupState) Source #
The state of the backup.
Certificates
data Certificates Source #
Contains one or more certificates or a certificate signing request (CSR).
See: certificates smart constructor.
certificates :: Certificates Source #
Creates a value of Certificates with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
cManufacturerHardwareCertificate- The HSM hardware certificate issued (signed) by the hardware manufacturer.cClusterCSR- The cluster's certificate signing request (CSR). The CSR exists only when the cluster's state isUNINITIALIZED.cHSMCertificate- The HSM certificate issued (signed) by the HSM hardware.cClusterCertificate- The cluster certificate issued (signed) by the issuing certificate authority (CA) of the cluster's owner.cAWSHardwareCertificate- The HSM hardware certificate issued (signed) by AWS CloudHSM.
cManufacturerHardwareCertificate :: Lens' Certificates (Maybe Text) Source #
The HSM hardware certificate issued (signed) by the hardware manufacturer.
cClusterCSR :: Lens' Certificates (Maybe Text) Source #
The cluster's certificate signing request (CSR). The CSR exists only when the cluster's state is UNINITIALIZED .
cHSMCertificate :: Lens' Certificates (Maybe Text) Source #
The HSM certificate issued (signed) by the HSM hardware.
cClusterCertificate :: Lens' Certificates (Maybe Text) Source #
The cluster certificate issued (signed) by the issuing certificate authority (CA) of the cluster's owner.
cAWSHardwareCertificate :: Lens' Certificates (Maybe Text) Source #
The HSM hardware certificate issued (signed) by AWS CloudHSM.
Cluster
Contains information about an AWS CloudHSM cluster.
See: cluster smart constructor.
Creates a value of Cluster with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
cPreCoPassword- The default password for the cluster's Pre-Crypto Officer (PRECO) user.cStateMessage- A description of the cluster's state.cState- The cluster's state.cSubnetMapping- A map of the cluster's subnets and their corresponding Availability Zones.cHSMs- Contains information about the HSMs in the cluster.cVPCId- The identifier (ID) of the virtual private cloud (VPC) that contains the cluster.cSourceBackupId- The identifier (ID) of the backup used to create the cluster. This value exists only when the cluster was created from a backup.cCertificates- Contains one or more certificates or a certificate signing request (CSR).cSecurityGroup- The identifier (ID) of the cluster's security group.cClusterId- The cluster's identifier (ID).cCreateTimestamp- The date and time when the cluster was created.cBackupPolicy- The cluster's backup policy.cHSMType- The type of HSM that the cluster contains.
cPreCoPassword :: Lens' Cluster (Maybe Text) Source #
The default password for the cluster's Pre-Crypto Officer (PRECO) user.
cSubnetMapping :: Lens' Cluster (HashMap Text Text) Source #
A map of the cluster's subnets and their corresponding Availability Zones.
cVPCId :: Lens' Cluster (Maybe Text) Source #
The identifier (ID) of the virtual private cloud (VPC) that contains the cluster.
cSourceBackupId :: Lens' Cluster (Maybe Text) Source #
The identifier (ID) of the backup used to create the cluster. This value exists only when the cluster was created from a backup.
cCertificates :: Lens' Cluster (Maybe Certificates) Source #
Contains one or more certificates or a certificate signing request (CSR).
cSecurityGroup :: Lens' Cluster (Maybe Text) Source #
The identifier (ID) of the cluster's security group.
cCreateTimestamp :: Lens' Cluster (Maybe UTCTime) Source #
The date and time when the cluster was created.
cBackupPolicy :: Lens' Cluster (Maybe BackupPolicy) Source #
The cluster's backup policy.
HSM
Contains information about a hardware security module (HSM) in an AWS CloudHSM cluster.
See: hsm smart constructor.
Creates a value of HSM with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
hsmStateMessage- A description of the HSM's state.hsmState- The HSM's state.hsmEniId- The identifier (ID) of the HSM's elastic network interface (ENI).hsmSubnetId- The subnet that contains the HSM's elastic network interface (ENI).hsmAvailabilityZone- The Availability Zone that contains the HSM.hsmClusterId- The identifier (ID) of the cluster that contains the HSM.hsmEniIP- The IP address of the HSM's elastic network interface (ENI).hsmHSMId- The HSM's identifier (ID).
hsmEniId :: Lens' HSM (Maybe Text) Source #
The identifier (ID) of the HSM's elastic network interface (ENI).
hsmSubnetId :: Lens' HSM (Maybe Text) Source #
The subnet that contains the HSM's elastic network interface (ENI).
hsmClusterId :: Lens' HSM (Maybe Text) Source #
The identifier (ID) of the cluster that contains the HSM.
hsmEniIP :: Lens' HSM (Maybe Text) Source #
The IP address of the HSM's elastic network interface (ENI).
Tag
Contains a tag. A tag is a key-value pair.
See: tag smart constructor.