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 |
For more information about AWS CloudHSM, see AWS CloudHSM and the AWS CloudHSM User Guide .
Synopsis
- 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
- module Network.AWS.CloudHSMv2.DescribeClusters
- module Network.AWS.CloudHSMv2.InitializeCluster
- module Network.AWS.CloudHSMv2.CreateHSM
- module Network.AWS.CloudHSMv2.DescribeBackups
- module Network.AWS.CloudHSMv2.DeleteCluster
- module Network.AWS.CloudHSMv2.CreateCluster
- module Network.AWS.CloudHSMv2.DeleteHSM
- module Network.AWS.CloudHSMv2.TagResource
- module Network.AWS.CloudHSMv2.ListTags
- module Network.AWS.CloudHSMv2.UntagResource
- 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
Error matchers are designed for use with the functions provided by
Control.Exception.Lens.
This allows catching (and rethrowing) service specific errors returned
by CloudHSMv2
.
CloudHSMInternalFailureException
_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
_CloudHSMServiceException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The request was rejected because an error occurred.
CloudHSMInvalidRequestException
_CloudHSMInvalidRequestException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The request was rejected because it is not a valid request.
CloudHSMAccessDeniedException
_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
_CloudHSMResourceNotFoundException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The request was rejected because it refers to a resource that cannot be found.
Waiters
Waiters poll by repeatedly sending a request until some remote success condition
configured by the Wait
specification is fulfilled. The Wait
specification
determines how many attempts should be made, in addition to delay and retry strategies.
Operations
Some AWS operations return results that are incomplete and require subsequent
requests in order to obtain the entire result set. The process of sending
subsequent requests to continue where a previous request left off is called
pagination. For example, the ListObjects
operation of Amazon S3 returns up to
1000 objects at a time, and you must send subsequent requests with the
appropriate Marker in order to retrieve the next page of results.
Operations that have an AWSPager
instance can transparently perform subsequent
requests, correctly setting Markers and other request facets to iterate through
the entire result set of a truncated API operation. Operations which support
this have an additional note in the documentation.
Many operations have the ability to filter results on the server side. See the individual operation parameters for details.
DescribeClusters (Paginated)
InitializeCluster
CreateHSM
DescribeBackups (Paginated)
DeleteCluster
CreateCluster
DeleteHSM
TagResource
ListTags (Paginated)
UntagResource
Types
BackupPolicy
data BackupPolicy Source #
Instances
BackupState
data BackupState Source #
Instances
ClusterState
data ClusterState Source #
Active | |
CreateInProgress | |
Degraded | |
DeleteInProgress | |
Deleted | |
InitializeInProgress | |
Initialized | |
Uninitialized | |
UpdateInProgress |
Instances
HSMState
Instances
Backup
Contains information about a backup of an AWS CloudHSM cluster.
See: backup
smart constructor.
Instances
Eq Backup Source # | |
Data Backup Source # | |
Defined in Network.AWS.CloudHSMv2.Types.Product gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> Backup -> c Backup # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c Backup # toConstr :: Backup -> Constr # dataTypeOf :: Backup -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c Backup) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c Backup) # gmapT :: (forall b. Data b => b -> b) -> Backup -> Backup # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> Backup -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> Backup -> r # gmapQ :: (forall d. Data d => d -> u) -> Backup -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> Backup -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> Backup -> m Backup # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> Backup -> m Backup # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> Backup -> m Backup # | |
Read Backup Source # | |
Show Backup Source # | |
Generic Backup Source # | |
Hashable Backup Source # | |
Defined in Network.AWS.CloudHSMv2.Types.Product | |
FromJSON Backup Source # | |
NFData Backup Source # | |
Defined in Network.AWS.CloudHSMv2.Types.Product | |
type Rep Backup Source # | |
Defined in Network.AWS.CloudHSMv2.Types.Product type Rep Backup = D1 (MetaData "Backup" "Network.AWS.CloudHSMv2.Types.Product" "amazonka-cloudhsmv2-1.6.1-HDPIS5infpK5ykPazFhIIc" False) (C1 (MetaCons "Backup'" PrefixI True) ((S1 (MetaSel (Just "_bClusterId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: S1 (MetaSel (Just "_bCreateTimestamp") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe POSIX))) :*: (S1 (MetaSel (Just "_bBackupState") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe BackupState)) :*: S1 (MetaSel (Just "_bBackupId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text)))) |
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.
Instances
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.
Instances
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.
Instances
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.
Instances
Eq Tag Source # | |
Data Tag Source # | |
Defined in Network.AWS.CloudHSMv2.Types.Product gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> Tag -> c Tag # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c Tag # dataTypeOf :: Tag -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c Tag) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c Tag) # gmapT :: (forall b. Data b => b -> b) -> Tag -> Tag # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> Tag -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> Tag -> r # gmapQ :: (forall d. Data d => d -> u) -> Tag -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> Tag -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> Tag -> m Tag # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> Tag -> m Tag # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> Tag -> m Tag # | |
Read Tag Source # | |
Show Tag Source # | |
Generic Tag Source # | |
Hashable Tag Source # | |
Defined in Network.AWS.CloudHSMv2.Types.Product | |
ToJSON Tag Source # | |
Defined in Network.AWS.CloudHSMv2.Types.Product | |
FromJSON Tag Source # | |
NFData Tag Source # | |
Defined in Network.AWS.CloudHSMv2.Types.Product | |
type Rep Tag Source # | |
Defined in Network.AWS.CloudHSMv2.Types.Product type Rep Tag = D1 (MetaData "Tag" "Network.AWS.CloudHSMv2.Types.Product" "amazonka-cloudhsmv2-1.6.1-HDPIS5infpK5ykPazFhIIc" False) (C1 (MetaCons "Tag'" PrefixI True) (S1 (MetaSel (Just "_tagKey") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text) :*: S1 (MetaSel (Just "_tagValue") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text))) |