@datafire/amazonaws_cloudhsmv2
v5.0.0
Published
DataFire integration for AWS CloudHSM V2
Downloads
6
Readme
@datafire/amazonaws_cloudhsmv2
Client library for AWS CloudHSM V2
Installation and Usage
npm install --save @datafire/amazonaws_cloudhsmv2
let amazonaws_cloudhsmv2 = require('@datafire/amazonaws_cloudhsmv2').create({
accessKeyId: "",
secretAccessKey: "",
region: ""
});
amazonaws_cloudhsmv2.CreateCluster({
"SubnetIds": [],
"HsmType": ""
}).then(data => {
console.log(data);
});
Description
For more information about AWS CloudHSM, see AWS CloudHSM and the AWS CloudHSM User Guide.
Actions
CreateCluster
amazonaws_cloudhsmv2.CreateCluster({
"SubnetIds": [],
"HsmType": ""
}, context)
Input
Output
- output CreateClusterResponse
CreateHsm
amazonaws_cloudhsmv2.CreateHsm({
"ClusterId": "",
"AvailabilityZone": ""
}, context)
Input
- input
object
- AvailabilityZone required ExternalAz
- ClusterId required ClusterId
- IpAddress IpAddress
Output
- output CreateHsmResponse
DeleteCluster
amazonaws_cloudhsmv2.DeleteCluster({
"ClusterId": ""
}, context)
Input
- input
object
- ClusterId required ClusterId
Output
- output DeleteClusterResponse
DeleteHsm
amazonaws_cloudhsmv2.DeleteHsm({
"ClusterId": ""
}, context)
Input
Output
- output DeleteHsmResponse
DescribeBackups
amazonaws_cloudhsmv2.DescribeBackups({}, context)
Input
Output
- output DescribeBackupsResponse
DescribeClusters
amazonaws_cloudhsmv2.DescribeClusters({}, context)
Input
Output
- output DescribeClustersResponse
InitializeCluster
amazonaws_cloudhsmv2.InitializeCluster({
"ClusterId": "",
"SignedCert": "",
"TrustAnchor": ""
}, context)
Input
Output
- output InitializeClusterResponse
ListTags
amazonaws_cloudhsmv2.ListTags({
"ResourceId": ""
}, context)
Input
- input
object
Output
- output ListTagsResponse
TagResource
amazonaws_cloudhsmv2.TagResource({
"ResourceId": "",
"TagList": []
}, context)
Input
Output
- output TagResourceResponse
UntagResource
amazonaws_cloudhsmv2.UntagResource({
"ResourceId": "",
"TagKeyList": []
}, context)
Input
- input
object
- ResourceId required ClusterId
- TagKeyList required TagKeyList
Output
- output UntagResourceResponse
Definitions
Backup
- Backup
object
: Contains information about a backup of an AWS CloudHSM cluster.- BackupId required BackupId
- BackupState BackupState
- ClusterId ClusterId
- CreateTimestamp Timestamp
BackupId
- BackupId
string
BackupPolicy
- BackupPolicy
string
(values: DEFAULT)
BackupState
- BackupState
string
(values: CREATE_IN_PROGRESS, READY, DELETED)
Backups
- Backups
array
- items Backup
Cert
- Cert
string
Certificates
- Certificates
object
: Contains one or more certificates or a certificate signing request (CSR).
CloudHsmAccessDeniedException
- CloudHsmAccessDeniedException
object
: The request was rejected because the requester does not have permission to perform the requested operation.- Message errorMessage
CloudHsmInternalFailureException
- CloudHsmInternalFailureException
object
: The request was rejected because of an AWS CloudHSM internal failure. The request can be retried.- Message errorMessage
CloudHsmInvalidRequestException
- CloudHsmInvalidRequestException
object
: The request was rejected because it is not a valid request.- Message errorMessage
CloudHsmResourceNotFoundException
- CloudHsmResourceNotFoundException
object
: The request was rejected because it refers to a resource that cannot be found.- Message errorMessage
CloudHsmServiceException
- CloudHsmServiceException
object
: The request was rejected because an error occurred.- Message errorMessage
Cluster
- Cluster
object
: Contains information about an AWS CloudHSM cluster.- BackupPolicy BackupPolicy
- Certificates Certificates
- ClusterId ClusterId
- CreateTimestamp Timestamp
- HsmType HsmType
- Hsms Hsms
- PreCoPassword PreCoPassword
- SecurityGroup SecurityGroup
- SourceBackupId BackupId
- State ClusterState
- StateMessage StateMessage
- SubnetMapping ExternalSubnetMapping
- VpcId VpcId
ClusterId
- ClusterId
string
ClusterState
- ClusterState
string
(values: CREATE_IN_PROGRESS, UNINITIALIZED, INITIALIZE_IN_PROGRESS, INITIALIZED, ACTIVE, UPDATE_IN_PROGRESS, DELETE_IN_PROGRESS, DELETED, DEGRADED)
Clusters
- Clusters
array
- items Cluster
CreateClusterRequest
- CreateClusterRequest
object
CreateClusterResponse
- CreateClusterResponse
object
- Cluster Cluster
CreateHsmRequest
- CreateHsmRequest
object
- AvailabilityZone required ExternalAz
- ClusterId required ClusterId
- IpAddress IpAddress
CreateHsmResponse
- CreateHsmResponse
object
- Hsm Hsm
DeleteClusterRequest
- DeleteClusterRequest
object
- ClusterId required ClusterId
DeleteClusterResponse
- DeleteClusterResponse
object
- Cluster Cluster
DeleteHsmRequest
DeleteHsmResponse
- DeleteHsmResponse
object
- HsmId HsmId
DescribeBackupsRequest
DescribeBackupsResponse
DescribeClustersRequest
DescribeClustersResponse
EniId
- EniId
string
ExternalAz
- ExternalAz
string
ExternalSubnetMapping
- ExternalSubnetMapping
array
- items
object
- key ExternalAz
- value SubnetId
- items
Field
- Field
string
Filters
Hsm
- Hsm
object
: Contains information about a hardware security module (HSM) in an AWS CloudHSM cluster.
HsmId
- HsmId
string
HsmState
- HsmState
string
(values: CREATE_IN_PROGRESS, ACTIVE, DEGRADED, DELETE_IN_PROGRESS, DELETED)
HsmType
- HsmType
string
Hsms
- Hsms
array
- items Hsm
InitializeClusterRequest
- InitializeClusterRequest
object
InitializeClusterResponse
- InitializeClusterResponse
object
- State ClusterState
- StateMessage StateMessage
IpAddress
- IpAddress
string
ListTagsRequest
ListTagsResponse
MaxSize
- MaxSize
integer
NextToken
- NextToken
string
PreCoPassword
- PreCoPassword
string
SecurityGroup
- SecurityGroup
string
StateMessage
- StateMessage
string
String
- String
string
Strings
- Strings
array
- items String
SubnetId
- SubnetId
string
SubnetIds
- SubnetIds
array
- items SubnetId
Tag
TagKey
- TagKey
string
TagKeyList
- TagKeyList
array
- items TagKey
TagList
- TagList
array
- items Tag
TagResourceRequest
TagResourceResponse
- TagResourceResponse
object
TagValue
- TagValue
string
Timestamp
- Timestamp
string
UntagResourceRequest
- UntagResourceRequest
object
- ResourceId required ClusterId
- TagKeyList required TagKeyList
UntagResourceResponse
- UntagResourceResponse
object
VpcId
- VpcId
string
errorMessage
- errorMessage
string