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 |
Synopsis
- defaultService :: 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
- _CloudHsmTagException :: AsError a => Getting (First ServiceError) a ServiceError
- newtype BackupPolicy where
- BackupPolicy' { }
- pattern BackupPolicy_DEFAULT :: BackupPolicy
- newtype BackupRetentionType where
- newtype BackupState where
- BackupState' { }
- pattern BackupState_CREATE_IN_PROGRESS :: BackupState
- pattern BackupState_DELETED :: BackupState
- pattern BackupState_PENDING_DELETION :: BackupState
- pattern BackupState_READY :: BackupState
- newtype ClusterState where
- ClusterState' { }
- pattern ClusterState_ACTIVE :: ClusterState
- pattern ClusterState_CREATE_IN_PROGRESS :: ClusterState
- pattern ClusterState_DEGRADED :: ClusterState
- pattern ClusterState_DELETED :: ClusterState
- pattern ClusterState_DELETE_IN_PROGRESS :: ClusterState
- pattern ClusterState_INITIALIZED :: ClusterState
- pattern ClusterState_INITIALIZE_IN_PROGRESS :: ClusterState
- pattern ClusterState_UNINITIALIZED :: ClusterState
- pattern ClusterState_UPDATE_IN_PROGRESS :: ClusterState
- newtype HsmState where
- HsmState' {
- fromHsmState :: Text
- pattern HsmState_ACTIVE :: HsmState
- pattern HsmState_CREATE_IN_PROGRESS :: HsmState
- pattern HsmState_DEGRADED :: HsmState
- pattern HsmState_DELETED :: HsmState
- pattern HsmState_DELETE_IN_PROGRESS :: HsmState
- HsmState' {
- data Backup = Backup' {}
- newBackup :: Text -> Backup
- backup_deleteTimestamp :: Lens' Backup (Maybe UTCTime)
- backup_sourceCluster :: Lens' Backup (Maybe Text)
- backup_neverExpires :: Lens' Backup (Maybe Bool)
- backup_sourceRegion :: Lens' Backup (Maybe Text)
- backup_tagList :: Lens' Backup (Maybe [Tag])
- backup_sourceBackup :: Lens' Backup (Maybe Text)
- backup_clusterId :: Lens' Backup (Maybe Text)
- backup_createTimestamp :: Lens' Backup (Maybe UTCTime)
- backup_copyTimestamp :: Lens' Backup (Maybe UTCTime)
- backup_backupState :: Lens' Backup (Maybe BackupState)
- backup_backupId :: Lens' Backup Text
- data BackupRetentionPolicy = BackupRetentionPolicy' {}
- newBackupRetentionPolicy :: BackupRetentionPolicy
- backupRetentionPolicy_value :: Lens' BackupRetentionPolicy (Maybe Text)
- backupRetentionPolicy_type :: Lens' BackupRetentionPolicy (Maybe BackupRetentionType)
- data Certificates = Certificates' {}
- newCertificates :: Certificates
- certificates_manufacturerHardwareCertificate :: Lens' Certificates (Maybe Text)
- certificates_clusterCsr :: Lens' Certificates (Maybe Text)
- certificates_hsmCertificate :: Lens' Certificates (Maybe Text)
- certificates_clusterCertificate :: Lens' Certificates (Maybe Text)
- certificates_awsHardwareCertificate :: Lens' Certificates (Maybe Text)
- data Cluster = Cluster' {
- preCoPassword :: Maybe Text
- stateMessage :: Maybe Text
- state :: Maybe ClusterState
- subnetMapping :: Maybe (HashMap Text Text)
- backupRetentionPolicy :: Maybe BackupRetentionPolicy
- hsms :: Maybe [Hsm]
- vpcId :: Maybe Text
- tagList :: Maybe [Tag]
- sourceBackupId :: Maybe Text
- certificates :: Maybe Certificates
- securityGroup :: Maybe Text
- clusterId :: Maybe Text
- createTimestamp :: Maybe POSIX
- backupPolicy :: Maybe BackupPolicy
- hsmType :: Maybe Text
- newCluster :: Cluster
- cluster_preCoPassword :: Lens' Cluster (Maybe Text)
- cluster_stateMessage :: Lens' Cluster (Maybe Text)
- cluster_state :: Lens' Cluster (Maybe ClusterState)
- cluster_subnetMapping :: Lens' Cluster (Maybe (HashMap Text Text))
- cluster_backupRetentionPolicy :: Lens' Cluster (Maybe BackupRetentionPolicy)
- cluster_hsms :: Lens' Cluster (Maybe [Hsm])
- cluster_vpcId :: Lens' Cluster (Maybe Text)
- cluster_tagList :: Lens' Cluster (Maybe [Tag])
- cluster_sourceBackupId :: Lens' Cluster (Maybe Text)
- cluster_certificates :: Lens' Cluster (Maybe Certificates)
- cluster_securityGroup :: Lens' Cluster (Maybe Text)
- cluster_clusterId :: Lens' Cluster (Maybe Text)
- cluster_createTimestamp :: Lens' Cluster (Maybe UTCTime)
- cluster_backupPolicy :: Lens' Cluster (Maybe BackupPolicy)
- cluster_hsmType :: Lens' Cluster (Maybe Text)
- data DestinationBackup = DestinationBackup' {}
- newDestinationBackup :: DestinationBackup
- destinationBackup_sourceCluster :: Lens' DestinationBackup (Maybe Text)
- destinationBackup_sourceRegion :: Lens' DestinationBackup (Maybe Text)
- destinationBackup_sourceBackup :: Lens' DestinationBackup (Maybe Text)
- destinationBackup_createTimestamp :: Lens' DestinationBackup (Maybe UTCTime)
- data Hsm = Hsm' {}
- newHsm :: Text -> Hsm
- hsm_stateMessage :: Lens' Hsm (Maybe Text)
- hsm_state :: Lens' Hsm (Maybe HsmState)
- hsm_eniId :: Lens' Hsm (Maybe Text)
- hsm_subnetId :: Lens' Hsm (Maybe Text)
- hsm_availabilityZone :: Lens' Hsm (Maybe Text)
- hsm_clusterId :: Lens' Hsm (Maybe Text)
- hsm_eniIp :: Lens' Hsm (Maybe Text)
- hsm_hsmId :: Lens' Hsm Text
- data Tag = Tag' {}
- newTag :: Text -> Text -> Tag
- tag_key :: Lens' Tag Text
- tag_value :: Lens' Tag Text
Service Configuration
defaultService :: 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.
_CloudHsmTagException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The request was rejected because of a tagging failure. Verify the tag conditions in all applicable policies, and then retry the request.
BackupPolicy
newtype BackupPolicy Source #
pattern BackupPolicy_DEFAULT :: BackupPolicy |
Instances
BackupRetentionType
newtype BackupRetentionType Source #
pattern BackupRetentionType_DAYS :: BackupRetentionType |
Instances
BackupState
newtype BackupState Source #
pattern BackupState_CREATE_IN_PROGRESS :: BackupState | |
pattern BackupState_DELETED :: BackupState | |
pattern BackupState_PENDING_DELETION :: BackupState | |
pattern BackupState_READY :: BackupState |
Instances
ClusterState
newtype ClusterState Source #
pattern ClusterState_ACTIVE :: ClusterState | |
pattern ClusterState_CREATE_IN_PROGRESS :: ClusterState | |
pattern ClusterState_DEGRADED :: ClusterState | |
pattern ClusterState_DELETED :: ClusterState | |
pattern ClusterState_DELETE_IN_PROGRESS :: ClusterState | |
pattern ClusterState_INITIALIZED :: ClusterState | |
pattern ClusterState_INITIALIZE_IN_PROGRESS :: ClusterState | |
pattern ClusterState_UNINITIALIZED :: ClusterState | |
pattern ClusterState_UPDATE_IN_PROGRESS :: ClusterState |
Instances
HsmState
pattern HsmState_ACTIVE :: HsmState | |
pattern HsmState_CREATE_IN_PROGRESS :: HsmState | |
pattern HsmState_DEGRADED :: HsmState | |
pattern HsmState_DELETED :: HsmState | |
pattern HsmState_DELETE_IN_PROGRESS :: HsmState |
Instances
Backup
Contains information about a backup of an AWS CloudHSM cluster. All
backup objects contain the BackupId
, BackupState
, ClusterId
, and
CreateTimestamp
parameters. Backups that were copied into a
destination region additionally contain the CopyTimestamp
,
SourceBackup
, SourceCluster
, and SourceRegion
parameters. A backup
that is pending deletion will include the DeleteTimestamp
parameter.
See: newBackup
smart constructor.
Backup' | |
|
Instances
Create a value of Backup
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:deleteTimestamp:Backup'
, backup_deleteTimestamp
- The date and time when the backup will be permanently deleted.
$sel:sourceCluster:Backup'
, backup_sourceCluster
- The identifier (ID) of the cluster containing the source backup from
which the new backup was copied.
$sel:neverExpires:Backup'
, backup_neverExpires
- Specifies whether the service should exempt a backup from the retention
policy for the cluster. True
exempts a backup from the retention
policy. False
means the service applies the backup retention policy
defined at the cluster.
$sel:sourceRegion:Backup'
, backup_sourceRegion
- The AWS Region that contains the source backup from which the new backup
was copied.
$sel:tagList:Backup'
, backup_tagList
- The list of tags for the backup.
$sel:sourceBackup:Backup'
, backup_sourceBackup
- The identifier (ID) of the source backup from which the new backup was
copied.
$sel:clusterId:Backup'
, backup_clusterId
- The identifier (ID) of the cluster that was backed up.
$sel:createTimestamp:Backup'
, backup_createTimestamp
- The date and time when the backup was created.
$sel:copyTimestamp:Backup'
, backup_copyTimestamp
- The date and time when the backup was copied from a source backup.
$sel:backupState:Backup'
, backup_backupState
- The state of the backup.
$sel:backupId:Backup'
, backup_backupId
- The identifier (ID) of the backup.
backup_deleteTimestamp :: Lens' Backup (Maybe UTCTime) Source #
The date and time when the backup will be permanently deleted.
backup_sourceCluster :: Lens' Backup (Maybe Text) Source #
The identifier (ID) of the cluster containing the source backup from which the new backup was copied.
backup_neverExpires :: Lens' Backup (Maybe Bool) Source #
Specifies whether the service should exempt a backup from the retention
policy for the cluster. True
exempts a backup from the retention
policy. False
means the service applies the backup retention policy
defined at the cluster.
backup_sourceRegion :: Lens' Backup (Maybe Text) Source #
The AWS Region that contains the source backup from which the new backup was copied.
backup_sourceBackup :: Lens' Backup (Maybe Text) Source #
The identifier (ID) of the source backup from which the new backup was copied.
backup_clusterId :: Lens' Backup (Maybe Text) Source #
The identifier (ID) of the cluster that was backed up.
backup_createTimestamp :: Lens' Backup (Maybe UTCTime) Source #
The date and time when the backup was created.
backup_copyTimestamp :: Lens' Backup (Maybe UTCTime) Source #
The date and time when the backup was copied from a source backup.
backup_backupState :: Lens' Backup (Maybe BackupState) Source #
The state of the backup.
BackupRetentionPolicy
data BackupRetentionPolicy Source #
A policy that defines the number of days to retain backups.
See: newBackupRetentionPolicy
smart constructor.
Instances
newBackupRetentionPolicy :: BackupRetentionPolicy Source #
Create a value of BackupRetentionPolicy
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:value:BackupRetentionPolicy'
, backupRetentionPolicy_value
- Use a value between 7 - 379.
$sel:type':BackupRetentionPolicy'
, backupRetentionPolicy_type
- The type of backup retention policy. For the DAYS
type, the value is
the number of days to retain backups.
backupRetentionPolicy_value :: Lens' BackupRetentionPolicy (Maybe Text) Source #
Use a value between 7 - 379.
backupRetentionPolicy_type :: Lens' BackupRetentionPolicy (Maybe BackupRetentionType) Source #
The type of backup retention policy. For the DAYS
type, the value is
the number of days to retain backups.
Certificates
data Certificates Source #
Contains one or more certificates or a certificate signing request (CSR).
See: newCertificates
smart constructor.
Certificates' | |
|
Instances
newCertificates :: Certificates Source #
Create a value of Certificates
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:manufacturerHardwareCertificate:Certificates'
, certificates_manufacturerHardwareCertificate
- The HSM hardware certificate issued (signed) by the hardware
manufacturer.
$sel:clusterCsr:Certificates'
, certificates_clusterCsr
- The cluster's certificate signing request (CSR). The CSR exists only
when the cluster's state is UNINITIALIZED
.
$sel:hsmCertificate:Certificates'
, certificates_hsmCertificate
- The HSM certificate issued (signed) by the HSM hardware.
$sel:clusterCertificate:Certificates'
, certificates_clusterCertificate
- The cluster certificate issued (signed) by the issuing certificate
authority (CA) of the cluster's owner.
$sel:awsHardwareCertificate:Certificates'
, certificates_awsHardwareCertificate
- The HSM hardware certificate issued (signed) by AWS CloudHSM.
certificates_manufacturerHardwareCertificate :: Lens' Certificates (Maybe Text) Source #
The HSM hardware certificate issued (signed) by the hardware manufacturer.
certificates_clusterCsr :: Lens' Certificates (Maybe Text) Source #
The cluster's certificate signing request (CSR). The CSR exists only
when the cluster's state is UNINITIALIZED
.
certificates_hsmCertificate :: Lens' Certificates (Maybe Text) Source #
The HSM certificate issued (signed) by the HSM hardware.
certificates_clusterCertificate :: Lens' Certificates (Maybe Text) Source #
The cluster certificate issued (signed) by the issuing certificate authority (CA) of the cluster's owner.
certificates_awsHardwareCertificate :: Lens' Certificates (Maybe Text) Source #
The HSM hardware certificate issued (signed) by AWS CloudHSM.
Cluster
Contains information about an AWS CloudHSM cluster.
See: newCluster
smart constructor.
Cluster' | |
|
Instances
newCluster :: Cluster Source #
Create a value of Cluster
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:preCoPassword:Cluster'
, cluster_preCoPassword
- The default password for the cluster's Pre-Crypto Officer (PRECO) user.
$sel:stateMessage:Cluster'
, cluster_stateMessage
- A description of the cluster's state.
$sel:state:Cluster'
, cluster_state
- The cluster's state.
$sel:subnetMapping:Cluster'
, cluster_subnetMapping
- A map from availability zone to the cluster’s subnet in that
availability zone.
$sel:backupRetentionPolicy:Cluster'
, cluster_backupRetentionPolicy
- A policy that defines how the service retains backups.
$sel:hsms:Cluster'
, cluster_hsms
- Contains information about the HSMs in the cluster.
$sel:vpcId:Cluster'
, cluster_vpcId
- The identifier (ID) of the virtual private cloud (VPC) that contains the
cluster.
$sel:tagList:Cluster'
, cluster_tagList
- The list of tags for the cluster.
$sel:sourceBackupId:Cluster'
, cluster_sourceBackupId
- The identifier (ID) of the backup used to create the cluster. This value
exists only when the cluster was created from a backup.
$sel:certificates:Cluster'
, cluster_certificates
- Contains one or more certificates or a certificate signing request
(CSR).
$sel:securityGroup:Cluster'
, cluster_securityGroup
- The identifier (ID) of the cluster's security group.
$sel:clusterId:Cluster'
, cluster_clusterId
- The cluster's identifier (ID).
$sel:createTimestamp:Cluster'
, cluster_createTimestamp
- The date and time when the cluster was created.
$sel:backupPolicy:Cluster'
, cluster_backupPolicy
- The cluster's backup policy.
$sel:hsmType:Cluster'
, cluster_hsmType
- The type of HSM that the cluster contains.
cluster_preCoPassword :: Lens' Cluster (Maybe Text) Source #
The default password for the cluster's Pre-Crypto Officer (PRECO) user.
cluster_state :: Lens' Cluster (Maybe ClusterState) Source #
The cluster's state.
cluster_subnetMapping :: Lens' Cluster (Maybe (HashMap Text Text)) Source #
A map from availability zone to the cluster’s subnet in that availability zone.
cluster_backupRetentionPolicy :: Lens' Cluster (Maybe BackupRetentionPolicy) Source #
A policy that defines how the service retains backups.
cluster_hsms :: Lens' Cluster (Maybe [Hsm]) Source #
Contains information about the HSMs in the cluster.
cluster_vpcId :: Lens' Cluster (Maybe Text) Source #
The identifier (ID) of the virtual private cloud (VPC) that contains the cluster.
cluster_sourceBackupId :: 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.
cluster_certificates :: Lens' Cluster (Maybe Certificates) Source #
Contains one or more certificates or a certificate signing request (CSR).
cluster_securityGroup :: Lens' Cluster (Maybe Text) Source #
The identifier (ID) of the cluster's security group.
cluster_createTimestamp :: Lens' Cluster (Maybe UTCTime) Source #
The date and time when the cluster was created.
cluster_backupPolicy :: Lens' Cluster (Maybe BackupPolicy) Source #
The cluster's backup policy.
DestinationBackup
data DestinationBackup Source #
Contains information about the backup that will be copied and created by the CopyBackupToRegion operation.
See: newDestinationBackup
smart constructor.
DestinationBackup' | |
|
Instances
newDestinationBackup :: DestinationBackup Source #
Create a value of DestinationBackup
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:sourceCluster:DestinationBackup'
, destinationBackup_sourceCluster
- The identifier (ID) of the cluster containing the source backup from
which the new backup was copied.
$sel:sourceRegion:DestinationBackup'
, destinationBackup_sourceRegion
- The AWS region that contains the source backup from which the new backup
was copied.
$sel:sourceBackup:DestinationBackup'
, destinationBackup_sourceBackup
- The identifier (ID) of the source backup from which the new backup was
copied.
$sel:createTimestamp:DestinationBackup'
, destinationBackup_createTimestamp
- The date and time when both the source backup was created.
destinationBackup_sourceCluster :: Lens' DestinationBackup (Maybe Text) Source #
The identifier (ID) of the cluster containing the source backup from which the new backup was copied.
destinationBackup_sourceRegion :: Lens' DestinationBackup (Maybe Text) Source #
The AWS region that contains the source backup from which the new backup was copied.
destinationBackup_sourceBackup :: Lens' DestinationBackup (Maybe Text) Source #
The identifier (ID) of the source backup from which the new backup was copied.
destinationBackup_createTimestamp :: Lens' DestinationBackup (Maybe UTCTime) Source #
The date and time when both the source backup was created.
Hsm
Contains information about a hardware security module (HSM) in an AWS CloudHSM cluster.
See: newHsm
smart constructor.
Hsm' | |
|
Instances
Create a value of Hsm
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:stateMessage:Hsm'
, hsm_stateMessage
- A description of the HSM's state.
$sel:state:Hsm'
, hsm_state
- The HSM's state.
$sel:eniId:Hsm'
, hsm_eniId
- The identifier (ID) of the HSM's elastic network interface (ENI).
$sel:subnetId:Hsm'
, hsm_subnetId
- The subnet that contains the HSM's elastic network interface (ENI).
$sel:availabilityZone:Hsm'
, hsm_availabilityZone
- The Availability Zone that contains the HSM.
$sel:clusterId:Hsm'
, hsm_clusterId
- The identifier (ID) of the cluster that contains the HSM.
$sel:eniIp:Hsm'
, hsm_eniIp
- The IP address of the HSM's elastic network interface (ENI).
$sel:hsmId:Hsm'
, hsm_hsmId
- The HSM's identifier (ID).
hsm_eniId :: Lens' Hsm (Maybe Text) Source #
The identifier (ID) of the HSM's elastic network interface (ENI).
hsm_subnetId :: Lens' Hsm (Maybe Text) Source #
The subnet that contains the HSM's elastic network interface (ENI).
hsm_clusterId :: Lens' Hsm (Maybe Text) Source #
The identifier (ID) of the cluster that contains the HSM.
hsm_eniIp :: 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: newTag
smart constructor.
Instances
Eq Tag Source # | |
Read Tag Source # | |
Show Tag Source # | |
Generic Tag Source # | |
NFData Tag Source # | |
Defined in Amazonka.CloudHSMV2.Types.Tag | |
Hashable Tag Source # | |
Defined in Amazonka.CloudHSMV2.Types.Tag | |
ToJSON Tag Source # | |
Defined in Amazonka.CloudHSMV2.Types.Tag | |
FromJSON Tag Source # | |
type Rep Tag Source # | |
Defined in Amazonka.CloudHSMV2.Types.Tag type Rep Tag = D1 ('MetaData "Tag" "Amazonka.CloudHSMV2.Types.Tag" "libZSservicesZSamazonka-cloudhsmv2ZSamazonka-cloudhsmv2" 'False) (C1 ('MetaCons "Tag'" 'PrefixI 'True) (S1 ('MetaSel ('Just "key") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "value") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))) |
Create a value of Tag
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:key:Tag'
, tag_key
- The key of the tag.
$sel:value:Tag'
, tag_value
- The value of the tag.