@datafire/amazonaws_cloudhsm
v5.0.0
Published
DataFire integration for Amazon CloudHSM
Downloads
3
Readme
@datafire/amazonaws_cloudhsm
Client library for Amazon CloudHSM
Installation and Usage
npm install --save @datafire/amazonaws_cloudhsm
let amazonaws_cloudhsm = require('@datafire/amazonaws_cloudhsm').create({
accessKeyId: "",
secretAccessKey: "",
region: ""
});
amazonaws_cloudhsm.AddTagsToResource({
"ResourceArn": "",
"TagList": []
}).then(data => {
console.log(data);
});
Description
AWS CloudHSM Service 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.
Actions
AddTagsToResource
amazonaws_cloudhsm.AddTagsToResource({
"ResourceArn": "",
"TagList": []
}, context)
Input
Output
- output AddTagsToResourceResponse
CreateHapg
amazonaws_cloudhsm.CreateHapg({
"Label": ""
}, context)
Input
- input
object
- Label required Label
Output
- output CreateHapgResponse
CreateHsm
amazonaws_cloudhsm.CreateHsm({
"SubnetId": "",
"SshKey": "",
"IamRoleArn": "",
"SubscriptionType": ""
}, context)
Input
- input
object
- ClientToken ClientToken
- EniIp IpAddress
- ExternalId ExternalId
- IamRoleArn required IamRoleArn
- SshKey required SshKey
- SubnetId required SubnetId
- SubscriptionType required SubscriptionType
- SyslogIp IpAddress
Output
- output CreateHsmResponse
CreateLunaClient
amazonaws_cloudhsm.CreateLunaClient({
"Certificate": ""
}, context)
Input
- input
object
- Certificate required Certificate
- Label ClientLabel
Output
- output CreateLunaClientResponse
DeleteHapg
amazonaws_cloudhsm.DeleteHapg({
"HapgArn": ""
}, context)
Input
- input
object
- HapgArn required HapgArn
Output
- output DeleteHapgResponse
DeleteHsm
amazonaws_cloudhsm.DeleteHsm({
"HsmArn": ""
}, context)
Input
- input
object
- HsmArn required HsmArn
Output
- output DeleteHsmResponse
DeleteLunaClient
amazonaws_cloudhsm.DeleteLunaClient({
"ClientArn": ""
}, context)
Input
- input
object
- ClientArn required ClientArn
Output
- output DeleteLunaClientResponse
DescribeHapg
amazonaws_cloudhsm.DescribeHapg({
"HapgArn": ""
}, context)
Input
- input
object
- HapgArn required HapgArn
Output
- output DescribeHapgResponse
DescribeHsm
amazonaws_cloudhsm.DescribeHsm({}, context)
Input
- input
object
- HsmArn HsmArn
- HsmSerialNumber HsmSerialNumber
Output
- output DescribeHsmResponse
DescribeLunaClient
amazonaws_cloudhsm.DescribeLunaClient({}, context)
Input
- input
object
- CertificateFingerprint CertificateFingerprint
- ClientArn ClientArn
Output
- output DescribeLunaClientResponse
GetConfig
amazonaws_cloudhsm.GetConfig({
"ClientArn": "",
"ClientVersion": "",
"HapgList": []
}, context)
Input
- input
object
- ClientArn required ClientArn
- ClientVersion required ClientVersion
- HapgList required HapgList
Output
- output GetConfigResponse
ListAvailableZones
amazonaws_cloudhsm.ListAvailableZones({}, context)
Input
- input
object
Output
- output ListAvailableZonesResponse
ListHapgs
amazonaws_cloudhsm.ListHapgs({}, context)
Input
- input
object
- NextToken PaginationToken
Output
- output ListHapgsResponse
ListHsms
amazonaws_cloudhsm.ListHsms({}, context)
Input
- input
object
- NextToken PaginationToken
Output
- output ListHsmsResponse
ListLunaClients
amazonaws_cloudhsm.ListLunaClients({}, context)
Input
- input
object
- NextToken PaginationToken
Output
- output ListLunaClientsResponse
ListTagsForResource
amazonaws_cloudhsm.ListTagsForResource({
"ResourceArn": ""
}, context)
Input
- input
object
- ResourceArn required String
Output
- output ListTagsForResourceResponse
ModifyHapg
amazonaws_cloudhsm.ModifyHapg({
"HapgArn": ""
}, context)
Input
- input
object
- HapgArn required HapgArn
- Label Label
- PartitionSerialList PartitionSerialList
Output
- output ModifyHapgResponse
ModifyHsm
amazonaws_cloudhsm.ModifyHsm({
"HsmArn": ""
}, context)
Input
- input
object
- EniIp IpAddress
- ExternalId ExternalId
- HsmArn required HsmArn
- IamRoleArn IamRoleArn
- SubnetId SubnetId
- SyslogIp IpAddress
Output
- output ModifyHsmResponse
ModifyLunaClient
amazonaws_cloudhsm.ModifyLunaClient({
"ClientArn": "",
"Certificate": ""
}, context)
Input
- input
object
- Certificate required Certificate
- ClientArn required ClientArn
Output
- output ModifyLunaClientResponse
RemoveTagsFromResource
amazonaws_cloudhsm.RemoveTagsFromResource({
"ResourceArn": "",
"TagKeyList": []
}, context)
Input
- input
object
- ResourceArn required String
- TagKeyList required TagKeyList
Output
Definitions
AZ
- AZ
string
AZList
- AZList
array
- items AZ
AddTagsToResourceRequest
AddTagsToResourceResponse
- AddTagsToResourceResponse
object
- Status required String
Boolean
- Boolean
boolean
Certificate
- Certificate
string
CertificateFingerprint
- CertificateFingerprint
string
ClientArn
- ClientArn
string
ClientLabel
- ClientLabel
string
ClientList
- ClientList
array
- items ClientArn
ClientToken
- ClientToken
string
ClientVersion
- ClientVersion
string
(values: 5.1, 5.3)
CloudHsmInternalException
- CloudHsmInternalException
object
: Indicates that an internal error occurred.
CloudHsmObjectState
- CloudHsmObjectState
string
(values: READY, UPDATING, DEGRADED)
CloudHsmServiceException
- CloudHsmServiceException
object
: Indicates that an exception occurred in the AWS CloudHSM service.
CreateHapgRequest
- CreateHapgRequest
object
: Contains the inputs for the CreateHapgRequest action.- Label required Label
CreateHapgResponse
- CreateHapgResponse
object
: Contains the output of the CreateHAPartitionGroup action.- HapgArn HapgArn
CreateHsmRequest
- CreateHsmRequest
object
: Contains the inputs for the CreateHsm operation.- ClientToken ClientToken
- EniIp IpAddress
- ExternalId ExternalId
- IamRoleArn required IamRoleArn
- SshKey required SshKey
- SubnetId required SubnetId
- SubscriptionType required SubscriptionType
- SyslogIp IpAddress
CreateHsmResponse
- CreateHsmResponse
object
: Contains the output of the CreateHsm operation.- HsmArn HsmArn
CreateLunaClientRequest
- CreateLunaClientRequest
object
: Contains the inputs for the CreateLunaClient action.- Certificate required Certificate
- Label ClientLabel
CreateLunaClientResponse
- CreateLunaClientResponse
object
: Contains the output of the CreateLunaClient action.- ClientArn ClientArn
DeleteHapgRequest
- DeleteHapgRequest
object
: Contains the inputs for the DeleteHapg action.- HapgArn required HapgArn
DeleteHapgResponse
- DeleteHapgResponse
object
: Contains the output of the DeleteHapg action.- Status required String
DeleteHsmRequest
- DeleteHsmRequest
object
: Contains the inputs for the DeleteHsm operation.- HsmArn required HsmArn
DeleteHsmResponse
- DeleteHsmResponse
object
: Contains the output of the DeleteHsm operation.- Status required String
DeleteLunaClientRequest
- DeleteLunaClientRequest
object
- ClientArn required ClientArn
DeleteLunaClientResponse
- DeleteLunaClientResponse
object
- Status required String
DescribeHapgRequest
- DescribeHapgRequest
object
: Contains the inputs for the DescribeHapg action.- HapgArn required HapgArn
DescribeHapgResponse
- DescribeHapgResponse
object
: Contains the output of the DescribeHapg action.- HapgArn HapgArn
- HapgSerial String
- HsmsLastActionFailed HsmList
- HsmsPendingDeletion HsmList
- HsmsPendingRegistration HsmList
- Label Label
- LastModifiedTimestamp Timestamp
- PartitionSerialList PartitionSerialList
- State CloudHsmObjectState
DescribeHsmRequest
- DescribeHsmRequest
object
: Contains the inputs for the DescribeHsm operation.- HsmArn HsmArn
- HsmSerialNumber HsmSerialNumber
DescribeHsmResponse
- DescribeHsmResponse
object
: Contains the output of the DescribeHsm operation.- AvailabilityZone AZ
- EniId EniId
- EniIp IpAddress
- HsmArn HsmArn
- HsmType String
- IamRoleArn IamRoleArn
- Partitions PartitionList
- SerialNumber HsmSerialNumber
- ServerCertLastUpdated Timestamp
- ServerCertUri String
- SoftwareVersion String
- SshKeyLastUpdated Timestamp
- SshPublicKey SshKey
- Status HsmStatus
- StatusDetails String
- SubnetId SubnetId
- SubscriptionEndDate Timestamp
- SubscriptionStartDate Timestamp
- SubscriptionType SubscriptionType
- VendorName String
- VpcId VpcId
DescribeLunaClientRequest
- DescribeLunaClientRequest
object
- CertificateFingerprint CertificateFingerprint
- ClientArn ClientArn
DescribeLunaClientResponse
- DescribeLunaClientResponse
object
- Certificate Certificate
- CertificateFingerprint CertificateFingerprint
- ClientArn ClientArn
- Label Label
- LastModifiedTimestamp Timestamp
EniId
- EniId
string
ExternalId
- ExternalId
string
GetConfigRequest
- GetConfigRequest
object
- ClientArn required ClientArn
- ClientVersion required ClientVersion
- HapgList required HapgList
GetConfigResponse
HapgArn
- HapgArn
string
HapgList
- HapgList
array
- items HapgArn
HsmArn
- HsmArn
string
: An ARN that identifies an HSM.
HsmList
- HsmList
array
: Contains a list of ARNs that identify the HSMs.- items HsmArn
HsmSerialNumber
- HsmSerialNumber
string
HsmStatus
- HsmStatus
string
(values: PENDING, RUNNING, UPDATING, SUSPENDED, TERMINATING, TERMINATED, DEGRADED)
IamRoleArn
- IamRoleArn
string
InvalidRequestException
- InvalidRequestException
object
: Indicates that one or more of the request parameters are not valid.
IpAddress
- IpAddress
string
Label
- Label
string
ListAvailableZonesRequest
- ListAvailableZonesRequest
object
: Contains the inputs for the ListAvailableZones action.
ListAvailableZonesResponse
- ListAvailableZonesResponse
object
- AZList AZList
ListHapgsRequest
- ListHapgsRequest
object
- NextToken PaginationToken
ListHapgsResponse
- ListHapgsResponse
object
- HapgList required HapgList
- NextToken PaginationToken
ListHsmsRequest
- ListHsmsRequest
object
- NextToken PaginationToken
ListHsmsResponse
- ListHsmsResponse
object
: Contains the output of the ListHsms operation.- HsmList HsmList
- NextToken PaginationToken
ListLunaClientsRequest
- ListLunaClientsRequest
object
- NextToken PaginationToken
ListLunaClientsResponse
- ListLunaClientsResponse
object
- ClientList required ClientList
- NextToken PaginationToken
ListTagsForResourceRequest
- ListTagsForResourceRequest
object
- ResourceArn required String
ListTagsForResourceResponse
- ListTagsForResourceResponse
object
- TagList required TagList
ModifyHapgRequest
- ModifyHapgRequest
object
- HapgArn required HapgArn
- Label Label
- PartitionSerialList PartitionSerialList
ModifyHapgResponse
- ModifyHapgResponse
object
- HapgArn HapgArn
ModifyHsmRequest
- ModifyHsmRequest
object
: Contains the inputs for the ModifyHsm operation.- EniIp IpAddress
- ExternalId ExternalId
- HsmArn required HsmArn
- IamRoleArn IamRoleArn
- SubnetId SubnetId
- SyslogIp IpAddress
ModifyHsmResponse
- ModifyHsmResponse
object
: Contains the output of the ModifyHsm operation.- HsmArn HsmArn
ModifyLunaClientRequest
- ModifyLunaClientRequest
object
- Certificate required Certificate
- ClientArn required ClientArn
ModifyLunaClientResponse
- ModifyLunaClientResponse
object
- ClientArn ClientArn
PaginationToken
- PaginationToken
string
PartitionArn
- PartitionArn
string
PartitionList
- PartitionList
array
- items PartitionArn
PartitionSerial
- PartitionSerial
string
PartitionSerialList
- PartitionSerialList
array
- items PartitionSerial
RemoveTagsFromResourceRequest
- RemoveTagsFromResourceRequest
object
- ResourceArn required String
- TagKeyList required TagKeyList
RemoveTagsFromResourceResponse
- RemoveTagsFromResourceResponse
object
- Status required String
SshKey
- SshKey
string
String
- String
string
SubnetId
- SubnetId
string
SubscriptionType
- SubscriptionType
string
(values: PRODUCTION): Specifies the type of subscription for the HSM. PRODUCTION - The HSM is being used in a production environment. TRIAL - The HSM is being used in a product trial.
Tag
- Tag
object
: A key-value pair that identifies or specifies metadata about an AWS CloudHSM resource.
TagKey
- TagKey
string
TagKeyList
- TagKeyList
array
- items TagKey
TagList
- TagList
array
- items Tag
TagValue
- TagValue
string
Timestamp
- Timestamp
string
VpcId
- VpcId
string