Name	Name	Last commit message	Last commit date
parent directory ..
README.md	README.md
index.js	index.js
openapi.json	openapi.json
package.json	package.json

@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: ""
});

.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": null,
  "TagList": null
}, context)

Input

input object
- ResourceArn required
- TagList required
  - items Tag

Output

output AddTagsToResourceResponse

CreateHapg

amazonaws_cloudhsm.CreateHapg({
  "Label": null
}, context)

Input

input object
- Label required

Output

output CreateHapgResponse

CreateHsm

amazonaws_cloudhsm.CreateHsm({
  "SubnetId": null,
  "SshKey": null,
  "IamRoleArn": null,
  "SubscriptionType": ""
}, context)

Input

input object
- ClientToken
- EniIp
- ExternalId
- IamRoleArn required
- SshKey required
- SubnetId required
- SubscriptionType required SubscriptionType
- SyslogIp

Output

output CreateHsmResponse

CreateLunaClient

amazonaws_cloudhsm.CreateLunaClient({
  "Certificate": null
}, context)

Input

input object
- Certificate required
- Label

Output

output CreateLunaClientResponse

DeleteHapg

amazonaws_cloudhsm.DeleteHapg({
  "HapgArn": null
}, context)

Input

input object
- HapgArn required

Output

output DeleteHapgResponse

DeleteHsm

amazonaws_cloudhsm.DeleteHsm({
  "HsmArn": null
}, context)

Input

input object
- HsmArn required

Output

output DeleteHsmResponse

DeleteLunaClient

amazonaws_cloudhsm.DeleteLunaClient({
  "ClientArn": null
}, context)

Input

input object
- ClientArn required

Output

output DeleteLunaClientResponse

DescribeHapg

amazonaws_cloudhsm.DescribeHapg({
  "HapgArn": null
}, context)

Input

input object
- HapgArn required

Output

output DescribeHapgResponse

DescribeHsm

amazonaws_cloudhsm.DescribeHsm({}, context)

Input

input object
- HsmArn
- HsmSerialNumber

Output

output DescribeHsmResponse

DescribeLunaClient

amazonaws_cloudhsm.DescribeLunaClient({}, context)

Input

input object
- CertificateFingerprint
- ClientArn

Output

output DescribeLunaClientResponse

GetConfig

amazonaws_cloudhsm.GetConfig({
  "ClientArn": null,
  "ClientVersion": null,
  "HapgList": null
}, context)

Input

input object
- ClientArn required
- ClientVersion required
- HapgList required
  - items HapgArn

Output

output GetConfigResponse

ListAvailableZones

amazonaws_cloudhsm.ListAvailableZones({}, context)

Input

input object

Output

output ListAvailableZonesResponse

ListHapgs

amazonaws_cloudhsm.ListHapgs({}, context)

Input

input object
- NextToken

Output

output ListHapgsResponse

ListHsms

amazonaws_cloudhsm.ListHsms({}, context)

Input

input object
- NextToken

Output

output ListHsmsResponse

ListLunaClients

amazonaws_cloudhsm.ListLunaClients({}, context)

Input

input object
- NextToken

Output

output ListLunaClientsResponse

ListTagsForResource

amazonaws_cloudhsm.ListTagsForResource({
  "ResourceArn": null
}, context)

Input

input object
- ResourceArn required

Output

output ListTagsForResourceResponse

ModifyHapg

amazonaws_cloudhsm.ModifyHapg({
  "HapgArn": null
}, context)

Input

input object
- HapgArn required
- Label
- PartitionSerialList
  - items PartitionSerial

Output

output ModifyHapgResponse

ModifyHsm

amazonaws_cloudhsm.ModifyHsm({
  "HsmArn": null
}, context)

Input

input object
- EniIp
- ExternalId
- HsmArn required
- IamRoleArn
- SubnetId
- SyslogIp

Output

output ModifyHsmResponse

ModifyLunaClient

amazonaws_cloudhsm.ModifyLunaClient({
  "ClientArn": null,
  "Certificate": null
}, context)

Input

input object
- Certificate required
- ClientArn required

Output

output ModifyLunaClientResponse

RemoveTagsFromResource

amazonaws_cloudhsm.RemoveTagsFromResource({
  "ResourceArn": null,
  "TagKeyList": null
}, context)

Input

input object
- ResourceArn required
- TagKeyList required
  - items TagKey

Output

output RemoveTagsFromResourceResponse

Definitions

AZ

AZ string

AZList

AZList array
- items AZ

AddTagsToResourceRequest

AddTagsToResourceRequest object
- ResourceArn required
- TagList required
  - items Tag

AddTagsToResourceResponse

AddTagsToResourceResponse object
- Status required

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.
- message
- retryable

CreateHapgRequest

CreateHapgRequest object: Contains the inputs for the CreateHapgRequest action.
- Label required

CreateHapgResponse

CreateHapgResponse object: Contains the output of the CreateHAPartitionGroup action.
- HapgArn

CreateHsmRequest

CreateHsmRequest object: Contains the inputs for the CreateHsm operation.
- ClientToken
- EniIp
- ExternalId
- IamRoleArn required
- SshKey required
- SubnetId required
- SubscriptionType required SubscriptionType
- SyslogIp

CreateHsmResponse

CreateHsmResponse object: Contains the output of the CreateHsm operation.
- HsmArn

CreateLunaClientRequest

CreateLunaClientRequest object: Contains the inputs for the CreateLunaClient action.
- Certificate required
- Label

CreateLunaClientResponse

CreateLunaClientResponse object: Contains the output of the CreateLunaClient action.
- ClientArn

DeleteHapgRequest

DeleteHapgRequest object: Contains the inputs for the DeleteHapg action.
- HapgArn required

DeleteHapgResponse

DeleteHapgResponse object: Contains the output of the DeleteHapg action.
- Status required

DeleteHsmRequest

DeleteHsmRequest object: Contains the inputs for the DeleteHsm operation.
- HsmArn required

DeleteHsmResponse

DeleteHsmResponse object: Contains the output of the DeleteHsm operation.
- Status required

DeleteLunaClientRequest

DeleteLunaClientRequest object
- ClientArn required

DeleteLunaClientResponse

DeleteLunaClientResponse object
- Status required

DescribeHapgRequest

DescribeHapgRequest object: Contains the inputs for the DescribeHapg action.
- HapgArn required

DescribeHapgResponse

DescribeHapgResponse object: Contains the output of the DescribeHapg action.
- HapgArn
- HapgSerial
- HsmsLastActionFailed
  - items HsmArn
- HsmsPendingDeletion
  - items HsmArn
- HsmsPendingRegistration
  - items HsmArn
- Label
- LastModifiedTimestamp
- PartitionSerialList
  - items PartitionSerial
- State

DescribeHsmRequest

DescribeHsmRequest object: Contains the inputs for the DescribeHsm operation.
- HsmArn
- HsmSerialNumber

DescribeHsmResponse

DescribeHsmResponse object: Contains the output of the DescribeHsm operation.
- AvailabilityZone
- EniId
- EniIp
- HsmArn
- HsmType
- IamRoleArn
- Partitions
  - items PartitionArn
- SerialNumber
- ServerCertLastUpdated
- ServerCertUri
- SoftwareVersion
- SshKeyLastUpdated
- SshPublicKey
- Status
- StatusDetails
- SubnetId
- SubscriptionEndDate
- SubscriptionStartDate
- SubscriptionType SubscriptionType
- VendorName
- VpcId

DescribeLunaClientRequest

DescribeLunaClientRequest object
- CertificateFingerprint
- ClientArn

DescribeLunaClientResponse

DescribeLunaClientResponse object
- Certificate
- CertificateFingerprint
- ClientArn
- Label
- LastModifiedTimestamp

EniId

EniId string

ExternalId

ExternalId string

GetConfigRequest

GetConfigRequest object
- ClientArn required
- ClientVersion required
- HapgList required
  - items HapgArn

GetConfigResponse

GetConfigResponse object
- ConfigCred
- ConfigFile
- ConfigType

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
  - items AZ

ListHapgsRequest

ListHapgsRequest object
- NextToken

ListHapgsResponse

ListHapgsResponse object
- HapgList required
  - items HapgArn
- NextToken

ListHsmsRequest

ListHsmsRequest object
- NextToken

ListHsmsResponse

ListHsmsResponse object: Contains the output of the ListHsms operation.
- HsmList
  - items HsmArn
- NextToken

ListLunaClientsRequest

ListLunaClientsRequest object
- NextToken

ListLunaClientsResponse

ListLunaClientsResponse object
- ClientList required
  - items ClientArn
- NextToken

ListTagsForResourceRequest

ListTagsForResourceRequest object
- ResourceArn required

ListTagsForResourceResponse

ListTagsForResourceResponse object
- TagList required
  - items Tag

ModifyHapgRequest

ModifyHapgRequest object
- HapgArn required
- Label
- PartitionSerialList
  - items PartitionSerial

ModifyHapgResponse

ModifyHapgResponse object
- HapgArn

ModifyHsmRequest

ModifyHsmRequest object: Contains the inputs for the ModifyHsm operation.
- EniIp
- ExternalId
- HsmArn required
- IamRoleArn
- SubnetId
- SyslogIp

ModifyHsmResponse

ModifyHsmResponse object: Contains the output of the ModifyHsm operation.
- HsmArn

ModifyLunaClientRequest

ModifyLunaClientRequest object
- Certificate required
- ClientArn required

ModifyLunaClientResponse

ModifyLunaClientResponse object
- 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
- TagKeyList required
  - items TagKey

RemoveTagsFromResourceResponse

RemoveTagsFromResourceResponse object
- Status required

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.

TagKey

TagKey string

TagKeyList

TagKeyList array
- items TagKey

TagList

TagList array
- items Tag

TagValue

TagValue string

Timestamp

Timestamp string

VpcId

VpcId string

Files

amazonaws_cloudhsm

Directory actions

More options

Directory actions

More options

Latest commit

History

amazonaws_cloudhsm

Folders and files

parent directory

README.md

@datafire/amazonaws_cloudhsm

Installation and Usage

Description

Actions

AddTagsToResource

Input

Output

CreateHapg

Input

Output

CreateHsm

Input

Output

CreateLunaClient

Input

Output

DeleteHapg

Input

Output

DeleteHsm

Input

Output

DeleteLunaClient

Input

Output

DescribeHapg

Input

Output

DescribeHsm

Input

Output

DescribeLunaClient

Input

Output

GetConfig

Input

Output

ListAvailableZones

Input

Output

ListHapgs

Input

Output

ListHsms

Input

Output

ListLunaClients

Input

Output

ListTagsForResource

Input

Output

ModifyHapg

Input

Output

ModifyHsm

Input

Output

ModifyLunaClient

Input

Output

RemoveTagsFromResource

Input

Output

Definitions

AZ

AZList

AddTagsToResourceRequest