@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

• input object
  • HsmType required HsmType
  • SourceBackupId BackupId
  • SubnetIds required SubnetIds

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

• input object
  • ClusterId required ClusterId
  • EniId EniId
  • EniIp IpAddress
  • HsmId HsmId

Output

• output DeleteHsmResponse

DescribeBackups

amazonaws_cloudhsmv2.DescribeBackups({}, context)

Input

• input object
  • MaxResults string
  • NextToken string
  • Filters Filters
  • MaxResults MaxSize
  • NextToken NextToken

Output

• output DescribeBackupsResponse

DescribeClusters

amazonaws_cloudhsmv2.DescribeClusters({}, context)

Input

• input object
  • MaxResults string
  • NextToken string
  • Filters Filters
  • MaxResults MaxSize
  • NextToken NextToken

Output

• output DescribeClustersResponse

InitializeCluster

amazonaws_cloudhsmv2.InitializeCluster({
  "ClusterId": "",
  "SignedCert": "",
  "TrustAnchor": ""
}, context)

Input

• input object
  • ClusterId required ClusterId
  • SignedCert required Cert
  • TrustAnchor required Cert

Output

• output InitializeClusterResponse

ListTags

amazonaws_cloudhsmv2.ListTags({
  "ResourceId": ""
}, context)

Input

• input object
  • MaxResults string
  • NextToken string
  • MaxResults MaxSize
  • NextToken NextToken
  • ResourceId required ClusterId

Output

• output ListTagsResponse

TagResource

amazonaws_cloudhsmv2.TagResource({
  "ResourceId": "",
  "TagList": []
}, context)

Input

• input object
  • ResourceId required ClusterId
  • TagList required TagList

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).
  • AwsHardwareCertificate Cert
  • ClusterCertificate Cert
  • ClusterCsr Cert
  • HsmCertificate Cert
  • ManufacturerHardwareCertificate Cert

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
  • HsmType required HsmType
  • SourceBackupId BackupId
  • SubnetIds required SubnetIds

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

• DeleteHsmRequest object
  • ClusterId required ClusterId
  • EniId EniId
  • EniIp IpAddress
  • HsmId HsmId

DeleteHsmResponse

• DeleteHsmResponse object
  • HsmId HsmId

DescribeBackupsRequest

• DescribeBackupsRequest object
  • Filters Filters
  • MaxResults MaxSize
  • NextToken NextToken

DescribeBackupsResponse

• DescribeBackupsResponse object
  • Backups Backups
  • NextToken NextToken

DescribeClustersRequest

• DescribeClustersRequest object
  • Filters Filters
  • MaxResults MaxSize
  • NextToken NextToken

DescribeClustersResponse

• DescribeClustersResponse object
  • Clusters Clusters
  • NextToken NextToken

EniId

• EniId string

ExternalAz

• ExternalAz string

ExternalSubnetMapping

• ExternalSubnetMapping array
  • items object
    • key ExternalAz
    • value SubnetId

Field

• Field string

Filters

• Filters array
  • items object
    • key Field
    • value Strings

Hsm

• Hsm object: Contains information about a hardware security module (HSM) in an AWS CloudHSM cluster.
  • AvailabilityZone ExternalAz
  • ClusterId ClusterId
  • EniId EniId
  • EniIp IpAddress
  • HsmId required HsmId
  • State HsmState
  • StateMessage String
  • SubnetId SubnetId

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
  • ClusterId required ClusterId
  • SignedCert required Cert
  • TrustAnchor required Cert

InitializeClusterResponse

• InitializeClusterResponse object
  • State ClusterState
  • StateMessage StateMessage

IpAddress

• IpAddress string

ListTagsRequest

• ListTagsRequest object
  • MaxResults MaxSize
  • NextToken NextToken
  • ResourceId required ClusterId

ListTagsResponse

• ListTagsResponse object
  • NextToken NextToken
  • TagList required TagList

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

• Tag object: Contains a tag. A tag is a key-value pair.
  • Key required TagKey
  • Value required TagValue

TagKey

• TagKey string

TagKeyList

• TagKeyList array
  • items TagKey

TagList

• TagList array
  • items Tag

TagResourceRequest

• TagResourceRequest object
  • ResourceId required ClusterId
  • TagList required TagList

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