AWS SDK for PHP 3.x

Client: Aws\CloudHSMV2\CloudHSMV2Client

Service ID: cloudhsmv2

Version: 2017-04-28

This page describes the parameters and results for the operations of the AWS CloudHSM V2 (2017-04-28), and shows how to use the Aws\CloudHSMV2\CloudHSMV2Client object to call the described operations. This documentation is specific to the 2017-04-28 API version of the service.

Operation Summary

Each of the following operations can be created from a client using $client->getCommand('CommandName'), where "CommandName" is the name of one of the following operations. Note: a command is a value that encapsulates an operation and the parameters used to create an HTTP request.

You can also create and send a command immediately using the magic methods available on a client object: $client->commandName(/* parameters */). You can send the command asynchronously (returning a promise) by appending the word "Async" to the operation name: $client->commandNameAsync(/* parameters */).

CopyBackupToRegion ( array $params = [] )
Copy an AWS CloudHSM cluster backup to a different region.
CreateCluster ( array $params = [] )
Creates a new AWS CloudHSM cluster.
CreateHsm ( array $params = [] )
Creates a new hardware security module (HSM) in the specified AWS CloudHSM cluster.
DeleteBackup ( array $params = [] )
Deletes a specified AWS CloudHSM backup.
DeleteCluster ( array $params = [] )
Deletes the specified AWS CloudHSM cluster.
DeleteHsm ( array $params = [] )
Deletes the specified HSM.
DescribeBackups ( array $params = [] )
Gets information about backups of AWS CloudHSM clusters.
DescribeClusters ( array $params = [] )
Gets information about AWS CloudHSM clusters.
InitializeCluster ( array $params = [] )
Claims an AWS CloudHSM cluster by submitting the cluster certificate issued by your issuing certificate authority (CA) and the CA's root certificate.
ListTags ( array $params = [] )
Gets a list of tags for the specified AWS CloudHSM cluster.
ModifyBackupAttributes ( array $params = [] )
Modifies attributes for AWS CloudHSM backup.
ModifyCluster ( array $params = [] )
Modifies AWS CloudHSM cluster.
RestoreBackup ( array $params = [] )
Restores a specified AWS CloudHSM backup that is in the PENDING_DELETION state.
TagResource ( array $params = [] )
Adds or overwrites one or more tags for the specified AWS CloudHSM cluster.
UntagResource ( array $params = [] )
Removes the specified tag or tags from the specified AWS CloudHSM cluster.

Paginators

Paginators handle automatically iterating over paginated API results. Paginators are associated with specific API operations, and they accept the parameters that the corresponding API operation accepts. You can get a paginator from a client class using getPaginator($paginatorName, $operationParameters). This client supports the following paginators:

DescribeBackups
DescribeClusters
ListTags

Operations

CopyBackupToRegion

$result = $client->copyBackupToRegion([/* ... */]);
$promise = $client->copyBackupToRegionAsync([/* ... */]);

Copy an AWS CloudHSM cluster backup to a different region.

Parameter Syntax

$result = $client->copyBackupToRegion([
    'BackupId' => '<string>', // REQUIRED
    'DestinationRegion' => '<string>', // REQUIRED
    'TagList' => [
        [
            'Key' => '<string>', // REQUIRED
            'Value' => '<string>', // REQUIRED
        ],
        // ...
    ],
]);

Parameter Details

Members

BackupId

Required: Yes
Type: string

The ID of the backup that will be copied to the destination region.

DestinationRegion

Required: Yes
Type: string

The AWS region that will contain your copied CloudHSM cluster backup.

TagList

Type: Array of Tag structures

Tags to apply to the destination backup during creation. If you specify tags, only these tags will be applied to the destination backup. If you do not specify tags, the service copies tags from the source backup to the destination backup.

Result Syntax

[
    'DestinationBackup' => [
        'CreateTimestamp' => <DateTime>,
        'SourceBackup' => '<string>',
        'SourceCluster' => '<string>',
        'SourceRegion' => '<string>',
    ],
]

Result Details

Members

DestinationBackup

Type: DestinationBackup structure

Information on the backup that will be copied to the destination region, including CreateTimestamp, SourceBackup, SourceCluster, and Source Region. CreateTimestamp of the destination backup will be the same as that of the source backup.

You will need to use the sourceBackupID returned in this operation to use the DescribeBackups operation on the backup that will be copied to the destination region.

Errors

CloudHsmAccessDeniedException:
The request was rejected because the requester does not have permission to perform the requested operation.
CloudHsmInternalFailureException:
The request was rejected because of an AWS CloudHSM internal failure. The request can be retried.
CloudHsmInvalidRequestException:
The request was rejected because it is not a valid request.
CloudHsmResourceNotFoundException:
The request was rejected because it refers to a resource that cannot be found.
CloudHsmServiceException:
The request was rejected because an error occurred.
CloudHsmTagException:
The request was rejected because of a tagging failure. Verify the tag conditions in all applicable policies, and then retry the request.

CreateCluster

$result = $client->createCluster([/* ... */]);
$promise = $client->createClusterAsync([/* ... */]);

Creates a new AWS CloudHSM cluster.

Parameter Syntax

$result = $client->createCluster([
    'BackupRetentionPolicy' => [
        'Type' => 'DAYS',
        'Value' => '<string>',
    ],
    'HsmType' => '<string>', // REQUIRED
    'SourceBackupId' => '<string>',
    'SubnetIds' => ['<string>', ...], // REQUIRED
    'TagList' => [
        [
            'Key' => '<string>', // REQUIRED
            'Value' => '<string>', // REQUIRED
        ],
        // ...
    ],
]);

Parameter Details

Members

BackupRetentionPolicy

Type: BackupRetentionPolicy structure

A policy that defines how the service retains backups.

HsmType

Required: Yes
Type: string

The type of HSM to use in the cluster. Currently the only allowed value is hsm1.medium.

SourceBackupId

Type: string

The identifier (ID) of the cluster backup to restore. Use this value to restore the cluster from a backup instead of creating a new cluster. To find the backup ID, use DescribeBackups.

SubnetIds

Required: Yes
Type: Array of strings

The identifiers (IDs) of the subnets where you are creating the cluster. You must specify at least one subnet. If you specify multiple subnets, they must meet the following criteria:

All subnets must be in the same virtual private cloud (VPC).
You can specify only one subnet per Availability Zone.

TagList

Type: Array of Tag structures

Tags to apply to the CloudHSM cluster during creation.

Result Syntax

[
    'Cluster' => [
        'BackupPolicy' => 'DEFAULT',
        'BackupRetentionPolicy' => [
            'Type' => 'DAYS',
            'Value' => '<string>',
        ],
        'Certificates' => [
            'AwsHardwareCertificate' => '<string>',
            'ClusterCertificate' => '<string>',
            'ClusterCsr' => '<string>',
            'HsmCertificate' => '<string>',
            'ManufacturerHardwareCertificate' => '<string>',
        ],
        'ClusterId' => '<string>',
        'CreateTimestamp' => <DateTime>,
        'HsmType' => '<string>',
        'Hsms' => [
            [
                'AvailabilityZone' => '<string>',
                'ClusterId' => '<string>',
                'EniId' => '<string>',
                'EniIp' => '<string>',
                'HsmId' => '<string>',
                'State' => 'CREATE_IN_PROGRESS|ACTIVE|DEGRADED|DELETE_IN_PROGRESS|DELETED',
                'StateMessage' => '<string>',
                'SubnetId' => '<string>',
            ],
            // ...
        ],
        'PreCoPassword' => '<string>',
        'SecurityGroup' => '<string>',
        'SourceBackupId' => '<string>',
        'State' => 'CREATE_IN_PROGRESS|UNINITIALIZED|INITIALIZE_IN_PROGRESS|INITIALIZED|ACTIVE|UPDATE_IN_PROGRESS|DELETE_IN_PROGRESS|DELETED|DEGRADED',
        'StateMessage' => '<string>',
        'SubnetMapping' => ['<string>', ...],
        'TagList' => [
            [
                'Key' => '<string>',
                'Value' => '<string>',
            ],
            // ...
        ],
        'VpcId' => '<string>',
    ],
]

Result Details

Members

Cluster

Type: Cluster structure

Information about the cluster that was created.

Errors

CloudHsmAccessDeniedException:
The request was rejected because the requester does not have permission to perform the requested operation.
CloudHsmInternalFailureException:
The request was rejected because of an AWS CloudHSM internal failure. The request can be retried.
CloudHsmInvalidRequestException:
The request was rejected because it is not a valid request.
CloudHsmResourceNotFoundException:
The request was rejected because it refers to a resource that cannot be found.
CloudHsmServiceException:
The request was rejected because an error occurred.
CloudHsmTagException:
The request was rejected because of a tagging failure. Verify the tag conditions in all applicable policies, and then retry the request.

CreateHsm

$result = $client->createHsm([/* ... */]);
$promise = $client->createHsmAsync([/* ... */]);

Creates a new hardware security module (HSM) in the specified AWS CloudHSM cluster.

Parameter Syntax

$result = $client->createHsm([
    'AvailabilityZone' => '<string>', // REQUIRED
    'ClusterId' => '<string>', // REQUIRED
    'IpAddress' => '<string>',
]);

Parameter Details

Members

AvailabilityZone

Required: Yes
Type: string

The Availability Zone where you are creating the HSM. To find the cluster's Availability Zones, use DescribeClusters.

ClusterId

Required: Yes
Type: string

The identifier (ID) of the HSM's cluster. To find the cluster ID, use DescribeClusters.

IpAddress

Type: string

The HSM's IP address. If you specify an IP address, use an available address from the subnet that maps to the Availability Zone where you are creating the HSM. If you don't specify an IP address, one is chosen for you from that subnet.

Result Syntax

[
    'Hsm' => [
        'AvailabilityZone' => '<string>',
        'ClusterId' => '<string>',
        'EniId' => '<string>',
        'EniIp' => '<string>',
        'HsmId' => '<string>',
        'State' => 'CREATE_IN_PROGRESS|ACTIVE|DEGRADED|DELETE_IN_PROGRESS|DELETED',
        'StateMessage' => '<string>',
        'SubnetId' => '<string>',
    ],
]

Result Details

Members

Hsm

Type: Hsm structure

Information about the HSM that was created.

Errors

CloudHsmInternalFailureException:
The request was rejected because of an AWS CloudHSM internal failure. The request can be retried.
CloudHsmServiceException:
The request was rejected because an error occurred.
CloudHsmInvalidRequestException:
The request was rejected because it is not a valid request.
CloudHsmResourceNotFoundException:
The request was rejected because it refers to a resource that cannot be found.
CloudHsmAccessDeniedException:
The request was rejected because the requester does not have permission to perform the requested operation.

DeleteBackup

$result = $client->deleteBackup([/* ... */]);
$promise = $client->deleteBackupAsync([/* ... */]);

Deletes a specified AWS CloudHSM backup. A backup can be restored up to 7 days after the DeleteBackup request is made. For more information on restoring a backup, see RestoreBackup.

Parameter Syntax

$result = $client->deleteBackup([
    'BackupId' => '<string>', // REQUIRED
]);

Parameter Details

Members

BackupId

Required: Yes
Type: string

The ID of the backup to be deleted. To find the ID of a backup, use the DescribeBackups operation.

Result Syntax

[
    'Backup' => [
        'BackupId' => '<string>',
        'BackupState' => 'CREATE_IN_PROGRESS|READY|DELETED|PENDING_DELETION',
        'ClusterId' => '<string>',
        'CopyTimestamp' => <DateTime>,
        'CreateTimestamp' => <DateTime>,
        'DeleteTimestamp' => <DateTime>,
        'NeverExpires' => true || false,
        'SourceBackup' => '<string>',
        'SourceCluster' => '<string>',
        'SourceRegion' => '<string>',
        'TagList' => [
            [
                'Key' => '<string>',
                'Value' => '<string>',
            ],
            // ...
        ],
    ],
]

Result Details

Members

Backup

Type: Backup structure

Information on the Backup object deleted.

Errors

CloudHsmAccessDeniedException:
The request was rejected because the requester does not have permission to perform the requested operation.
CloudHsmInternalFailureException:
The request was rejected because of an AWS CloudHSM internal failure. The request can be retried.
CloudHsmInvalidRequestException:
The request was rejected because it is not a valid request.
CloudHsmResourceNotFoundException:
The request was rejected because it refers to a resource that cannot be found.
CloudHsmServiceException:
The request was rejected because an error occurred.

DeleteCluster

$result = $client->deleteCluster([/* ... */]);
$promise = $client->deleteClusterAsync([/* ... */]);

Deletes the specified AWS CloudHSM cluster. Before you can delete a cluster, you must delete all HSMs in the cluster. To see if the cluster contains any HSMs, use DescribeClusters. To delete an HSM, use DeleteHsm.

Parameter Syntax

$result = $client->deleteCluster([
    'ClusterId' => '<string>', // REQUIRED
]);

Parameter Details

Members

ClusterId

Required: Yes
Type: string

The identifier (ID) of the cluster that you are deleting. To find the cluster ID, use DescribeClusters.

Result Syntax

[
    'Cluster' => [
        'BackupPolicy' => 'DEFAULT',
        'BackupRetentionPolicy' => [
            'Type' => 'DAYS',
            'Value' => '<string>',
        ],
        'Certificates' => [
            'AwsHardwareCertificate' => '<string>',
            'ClusterCertificate' => '<string>',
            'ClusterCsr' => '<string>',
            'HsmCertificate' => '<string>',
            'ManufacturerHardwareCertificate' => '<string>',
        ],
        'ClusterId' => '<string>',
        'CreateTimestamp' => <DateTime>,
        'HsmType' => '<string>',
        'Hsms' => [
            [
                'AvailabilityZone' => '<string>',
                'ClusterId' => '<string>',
                'EniId' => '<string>',
                'EniIp' => '<string>',
                'HsmId' => '<string>',
                'State' => 'CREATE_IN_PROGRESS|ACTIVE|DEGRADED|DELETE_IN_PROGRESS|DELETED',
                'StateMessage' => '<string>',
                'SubnetId' => '<string>',
            ],
            // ...
        ],
        'PreCoPassword' => '<string>',
        'SecurityGroup' => '<string>',
        'SourceBackupId' => '<string>',
        'State' => 'CREATE_IN_PROGRESS|UNINITIALIZED|INITIALIZE_IN_PROGRESS|INITIALIZED|ACTIVE|UPDATE_IN_PROGRESS|DELETE_IN_PROGRESS|DELETED|DEGRADED',
        'StateMessage' => '<string>',
        'SubnetMapping' => ['<string>', ...],
        'TagList' => [
            [
                'Key' => '<string>',
                'Value' => '<string>',
            ],
            // ...
        ],
        'VpcId' => '<string>',
    ],
]

Result Details

Members

Cluster

Type: Cluster structure

Information about the cluster that was deleted.

Errors

CloudHsmAccessDeniedException:
The request was rejected because the requester does not have permission to perform the requested operation.
CloudHsmInternalFailureException:
The request was rejected because of an AWS CloudHSM internal failure. The request can be retried.
CloudHsmInvalidRequestException:
The request was rejected because it is not a valid request.
CloudHsmResourceNotFoundException:
The request was rejected because it refers to a resource that cannot be found.
CloudHsmServiceException:
The request was rejected because an error occurred.
CloudHsmTagException:
The request was rejected because of a tagging failure. Verify the tag conditions in all applicable policies, and then retry the request.

DeleteHsm

$result = $client->deleteHsm([/* ... */]);
$promise = $client->deleteHsmAsync([/* ... */]);

Deletes the specified HSM. To specify an HSM, you can use its identifier (ID), the IP address of the HSM's elastic network interface (ENI), or the ID of the HSM's ENI. You need to specify only one of these values. To find these values, use DescribeClusters.

Parameter Syntax

$result = $client->deleteHsm([
    'ClusterId' => '<string>', // REQUIRED
    'EniId' => '<string>',
    'EniIp' => '<string>',
    'HsmId' => '<string>',
]);

Parameter Details

Members

ClusterId

Required: Yes
Type: string

The identifier (ID) of the cluster that contains the HSM that you are deleting.

EniId

Type: string

The identifier (ID) of the elastic network interface (ENI) of the HSM that you are deleting.

EniIp

Type: string

The IP address of the elastic network interface (ENI) of the HSM that you are deleting.

HsmId

Type: string

The identifier (ID) of the HSM that you are deleting.

Result Syntax

[
    'HsmId' => '<string>',
]

Result Details

Members

HsmId

Type: string

The identifier (ID) of the HSM that was deleted.

Errors

CloudHsmInternalFailureException:
The request was rejected because of an AWS CloudHSM internal failure. The request can be retried.
CloudHsmServiceException:
The request was rejected because an error occurred.
CloudHsmResourceNotFoundException:
The request was rejected because it refers to a resource that cannot be found.
CloudHsmInvalidRequestException:
The request was rejected because it is not a valid request.
CloudHsmAccessDeniedException:
The request was rejected because the requester does not have permission to perform the requested operation.

DescribeBackups

$result = $client->describeBackups([/* ... */]);
$promise = $client->describeBackupsAsync([/* ... */]);

Gets information about backups of AWS CloudHSM clusters.

This is a paginated operation, which means that each response might contain only a subset of all the backups. When the response contains only a subset of backups, it includes a NextToken value. Use this value in a subsequent DescribeBackups request to get more backups. When you receive a response with no NextToken (or an empty or null value), that means there are no more backups to get.

Parameter Syntax

$result = $client->describeBackups([
    'Filters' => [
        '<Field>' => ['<string>', ...],
        // ...
    ],
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
    'SortAscending' => true || false,
]);

Parameter Details

Members

Filters

Type: Associative array of custom strings keys (Field) to stringss

One or more filters to limit the items returned in the response.

Use the backupIds filter to return only the specified backups. Specify backups by their backup identifier (ID).

Use the sourceBackupIds filter to return only the backups created from a source backup. The sourceBackupID of a source backup is returned by the CopyBackupToRegion operation.

Use the clusterIds filter to return only the backups for the specified clusters. Specify clusters by their cluster identifier (ID).

Use the states filter to return only backups that match the specified state.

Use the neverExpires filter to return backups filtered by the value in the neverExpires parameter. True returns all backups exempt from the backup retention policy. False returns all backups with a backup retention policy defined at the cluster.

MaxResults

Type: int

The maximum number of backups to return in the response. When there are more backups than the number you specify, the response contains a NextToken value.

NextToken

Type: string

The NextToken value that you received in the previous response. Use this value to get more backups.

SortAscending

Type: boolean

Designates whether or not to sort the return backups by ascending chronological order of generation.

Result Syntax

[
    'Backups' => [
        [
            'BackupId' => '<string>',
            'BackupState' => 'CREATE_IN_PROGRESS|READY|DELETED|PENDING_DELETION',
            'ClusterId' => '<string>',
            'CopyTimestamp' => <DateTime>,
            'CreateTimestamp' => <DateTime>,
            'DeleteTimestamp' => <DateTime>,
            'NeverExpires' => true || false,
            'SourceBackup' => '<string>',
            'SourceCluster' => '<string>',
            'SourceRegion' => '<string>',
            'TagList' => [
                [
                    'Key' => '<string>',
                    'Value' => '<string>',
                ],
                // ...
            ],
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Members

Backups

Type: Array of Backup structures

A list of backups.

NextToken

Type: string

An opaque string that indicates that the response contains only a subset of backups. Use this value in a subsequent DescribeBackups request to get more backups.

Errors

CloudHsmAccessDeniedException:
The request was rejected because the requester does not have permission to perform the requested operation.
CloudHsmInternalFailureException:
The request was rejected because of an AWS CloudHSM internal failure. The request can be retried.
CloudHsmInvalidRequestException:
The request was rejected because it is not a valid request.
CloudHsmResourceNotFoundException:
The request was rejected because it refers to a resource that cannot be found.
CloudHsmServiceException:
The request was rejected because an error occurred.
CloudHsmTagException:
The request was rejected because of a tagging failure. Verify the tag conditions in all applicable policies, and then retry the request.

DescribeClusters

$result = $client->describeClusters([/* ... */]);
$promise = $client->describeClustersAsync([/* ... */]);

Gets information about AWS CloudHSM clusters.

This is a paginated operation, which means that each response might contain only a subset of all the clusters. When the response contains only a subset of clusters, it includes a NextToken value. Use this value in a subsequent DescribeClusters request to get more clusters. When you receive a response with no NextToken (or an empty or null value), that means there are no more clusters to get.

Parameter Syntax

$result = $client->describeClusters([
    'Filters' => [
        '<Field>' => ['<string>', ...],
        // ...
    ],
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
]);

Parameter Details

Members

Filters

Type: Associative array of custom strings keys (Field) to stringss

One or more filters to limit the items returned in the response.

Use the clusterIds filter to return only the specified clusters. Specify clusters by their cluster identifier (ID).

Use the vpcIds filter to return only the clusters in the specified virtual private clouds (VPCs). Specify VPCs by their VPC identifier (ID).

Use the states filter to return only clusters that match the specified state.

MaxResults

Type: int

The maximum number of clusters to return in the response. When there are more clusters than the number you specify, the response contains a NextToken value.

NextToken

Type: string

The NextToken value that you received in the previous response. Use this value to get more clusters.

Result Syntax

[
    'Clusters' => [
        [
            'BackupPolicy' => 'DEFAULT',
            'BackupRetentionPolicy' => [
                'Type' => 'DAYS',
                'Value' => '<string>',
            ],
            'Certificates' => [
                'AwsHardwareCertificate' => '<string>',
                'ClusterCertificate' => '<string>',
                'ClusterCsr' => '<string>',
                'HsmCertificate' => '<string>',
                'ManufacturerHardwareCertificate' => '<string>',
            ],
            'ClusterId' => '<string>',
            'CreateTimestamp' => <DateTime>,
            'HsmType' => '<string>',
            'Hsms' => [
                [
                    'AvailabilityZone' => '<string>',
                    'ClusterId' => '<string>',
                    'EniId' => '<string>',
                    'EniIp' => '<string>',
                    'HsmId' => '<string>',
                    'State' => 'CREATE_IN_PROGRESS|ACTIVE|DEGRADED|DELETE_IN_PROGRESS|DELETED',
                    'StateMessage' => '<string>',
                    'SubnetId' => '<string>',
                ],
                // ...
            ],
            'PreCoPassword' => '<string>',
            'SecurityGroup' => '<string>',
            'SourceBackupId' => '<string>',
            'State' => 'CREATE_IN_PROGRESS|UNINITIALIZED|INITIALIZE_IN_PROGRESS|INITIALIZED|ACTIVE|UPDATE_IN_PROGRESS|DELETE_IN_PROGRESS|DELETED|DEGRADED',
            'StateMessage' => '<string>',
            'SubnetMapping' => ['<string>', ...],
            'TagList' => [
                [
                    'Key' => '<string>',
                    'Value' => '<string>',
                ],
                // ...
            ],
            'VpcId' => '<string>',
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Members

Clusters

Type: Array of Cluster structures

A list of clusters.

NextToken

Type: string

An opaque string that indicates that the response contains only a subset of clusters. Use this value in a subsequent DescribeClusters request to get more clusters.

Errors

CloudHsmAccessDeniedException:
The request was rejected because the requester does not have permission to perform the requested operation.
CloudHsmInternalFailureException:
The request was rejected because of an AWS CloudHSM internal failure. The request can be retried.
CloudHsmInvalidRequestException:
The request was rejected because it is not a valid request.
CloudHsmServiceException:
The request was rejected because an error occurred.
CloudHsmTagException:
The request was rejected because of a tagging failure. Verify the tag conditions in all applicable policies, and then retry the request.

InitializeCluster

$result = $client->initializeCluster([/* ... */]);
$promise = $client->initializeClusterAsync([/* ... */]);

Claims an AWS CloudHSM cluster by submitting the cluster certificate issued by your issuing certificate authority (CA) and the CA's root certificate. Before you can claim a cluster, you must sign the cluster's certificate signing request (CSR) with your issuing CA. To get the cluster's CSR, use DescribeClusters.

Parameter Syntax

$result = $client->initializeCluster([
    'ClusterId' => '<string>', // REQUIRED
    'SignedCert' => '<string>', // REQUIRED
    'TrustAnchor' => '<string>', // REQUIRED
]);

Parameter Details

Members

ClusterId

Required: Yes
Type: string

The identifier (ID) of the cluster that you are claiming. To find the cluster ID, use DescribeClusters.

SignedCert

Required: Yes
Type: string

The cluster certificate issued (signed) by your issuing certificate authority (CA). The certificate must be in PEM format and can contain a maximum of 5000 characters.

TrustAnchor

Required: Yes
Type: string

The issuing certificate of the issuing certificate authority (CA) that issued (signed) the cluster certificate. You must use a self-signed certificate. The certificate used to sign the HSM CSR must be directly available, and thus must be the root certificate. The certificate must be in PEM format and can contain a maximum of 5000 characters.

Result Syntax

[
    'State' => 'CREATE_IN_PROGRESS|UNINITIALIZED|INITIALIZE_IN_PROGRESS|INITIALIZED|ACTIVE|UPDATE_IN_PROGRESS|DELETE_IN_PROGRESS|DELETED|DEGRADED',
    'StateMessage' => '<string>',
]

Result Details

Members

State

Type: string

The cluster's state.

StateMessage

Type: string

A description of the cluster's state.

Errors

CloudHsmAccessDeniedException:
The request was rejected because the requester does not have permission to perform the requested operation.
CloudHsmInternalFailureException:
The request was rejected because of an AWS CloudHSM internal failure. The request can be retried.
CloudHsmInvalidRequestException:
The request was rejected because it is not a valid request.
CloudHsmResourceNotFoundException:
The request was rejected because it refers to a resource that cannot be found.
CloudHsmServiceException:
The request was rejected because an error occurred.

$result = $client->listTags([/* ... */]);
$promise = $client->listTagsAsync([/* ... */]);

Gets a list of tags for the specified AWS CloudHSM cluster.

This is a paginated operation, which means that each response might contain only a subset of all the tags. When the response contains only a subset of tags, it includes a NextToken value. Use this value in a subsequent ListTags request to get more tags. When you receive a response with no NextToken (or an empty or null value), that means there are no more tags to get.

Parameter Syntax

$result = $client->listTags([
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
    'ResourceId' => '<string>', // REQUIRED
]);

Parameter Details

Members

MaxResults

Type: int

The maximum number of tags to return in the response. When there are more tags than the number you specify, the response contains a NextToken value.

NextToken

Type: string

The NextToken value that you received in the previous response. Use this value to get more tags.

ResourceId

Required: Yes
Type: string

The cluster identifier (ID) for the cluster whose tags you are getting. To find the cluster ID, use DescribeClusters.

Result Syntax

[
    'NextToken' => '<string>',
    'TagList' => [
        [
            'Key' => '<string>',
            'Value' => '<string>',
        ],
        // ...
    ],
]

Result Details

Members

NextToken

Type: string

An opaque string that indicates that the response contains only a subset of tags. Use this value in a subsequent ListTags request to get more tags.

TagList

Required: Yes
Type: Array of Tag structures

A list of tags.

Errors

CloudHsmAccessDeniedException:
The request was rejected because the requester does not have permission to perform the requested operation.
CloudHsmInternalFailureException:
The request was rejected because of an AWS CloudHSM internal failure. The request can be retried.
CloudHsmInvalidRequestException:
The request was rejected because it is not a valid request.
CloudHsmResourceNotFoundException:
The request was rejected because it refers to a resource that cannot be found.
CloudHsmServiceException:
The request was rejected because an error occurred.
CloudHsmTagException:
The request was rejected because of a tagging failure. Verify the tag conditions in all applicable policies, and then retry the request.

ModifyBackupAttributes

$result = $client->modifyBackupAttributes([/* ... */]);
$promise = $client->modifyBackupAttributesAsync([/* ... */]);

Modifies attributes for AWS CloudHSM backup.

Parameter Syntax

$result = $client->modifyBackupAttributes([
    'BackupId' => '<string>', // REQUIRED
    'NeverExpires' => true || false, // REQUIRED
]);

Parameter Details

Members

BackupId

Required: Yes
Type: string

The identifier (ID) of the backup to modify. To find the ID of a backup, use the DescribeBackups operation.

NeverExpires

Required: Yes
Type: boolean

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.

Result Syntax

[
    'Backup' => [
        'BackupId' => '<string>',
        'BackupState' => 'CREATE_IN_PROGRESS|READY|DELETED|PENDING_DELETION',
        'ClusterId' => '<string>',
        'CopyTimestamp' => <DateTime>,
        'CreateTimestamp' => <DateTime>,
        'DeleteTimestamp' => <DateTime>,
        'NeverExpires' => true || false,
        'SourceBackup' => '<string>',
        'SourceCluster' => '<string>',
        'SourceRegion' => '<string>',
        'TagList' => [
            [
                'Key' => '<string>',
                'Value' => '<string>',
            ],
            // ...
        ],
    ],
]

Result Details

Members

Backup

Type: Backup structure

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.

Errors

CloudHsmAccessDeniedException:
The request was rejected because the requester does not have permission to perform the requested operation.
CloudHsmInternalFailureException:
The request was rejected because of an AWS CloudHSM internal failure. The request can be retried.
CloudHsmInvalidRequestException:
The request was rejected because it is not a valid request.
CloudHsmResourceNotFoundException:
The request was rejected because it refers to a resource that cannot be found.
CloudHsmServiceException:
The request was rejected because an error occurred.

ModifyCluster

$result = $client->modifyCluster([/* ... */]);
$promise = $client->modifyClusterAsync([/* ... */]);

Modifies AWS CloudHSM cluster.

Parameter Syntax

$result = $client->modifyCluster([
    'BackupRetentionPolicy' => [ // REQUIRED
        'Type' => 'DAYS',
        'Value' => '<string>',
    ],
    'ClusterId' => '<string>', // REQUIRED
]);

Parameter Details

Members

BackupRetentionPolicy

Required: Yes
Type: BackupRetentionPolicy structure

A policy that defines how the service retains backups.

ClusterId

Required: Yes
Type: string

The identifier (ID) of the cluster that you want to modify. To find the cluster ID, use DescribeClusters.

Result Syntax

[
    'Cluster' => [
        'BackupPolicy' => 'DEFAULT',
        'BackupRetentionPolicy' => [
            'Type' => 'DAYS',
            'Value' => '<string>',
        ],
        'Certificates' => [
            'AwsHardwareCertificate' => '<string>',
            'ClusterCertificate' => '<string>',
            'ClusterCsr' => '<string>',
            'HsmCertificate' => '<string>',
            'ManufacturerHardwareCertificate' => '<string>',
        ],
        'ClusterId' => '<string>',
        'CreateTimestamp' => <DateTime>,
        'HsmType' => '<string>',
        'Hsms' => [
            [
                'AvailabilityZone' => '<string>',
                'ClusterId' => '<string>',
                'EniId' => '<string>',
                'EniIp' => '<string>',
                'HsmId' => '<string>',
                'State' => 'CREATE_IN_PROGRESS|ACTIVE|DEGRADED|DELETE_IN_PROGRESS|DELETED',
                'StateMessage' => '<string>',
                'SubnetId' => '<string>',
            ],
            // ...
        ],
        'PreCoPassword' => '<string>',
        'SecurityGroup' => '<string>',
        'SourceBackupId' => '<string>',
        'State' => 'CREATE_IN_PROGRESS|UNINITIALIZED|INITIALIZE_IN_PROGRESS|INITIALIZED|ACTIVE|UPDATE_IN_PROGRESS|DELETE_IN_PROGRESS|DELETED|DEGRADED',
        'StateMessage' => '<string>',
        'SubnetMapping' => ['<string>', ...],
        'TagList' => [
            [
                'Key' => '<string>',
                'Value' => '<string>',
            ],
            // ...
        ],
        'VpcId' => '<string>',
    ],
]

Result Details

Members

Cluster

Type: Cluster structure

Contains information about an AWS CloudHSM cluster.

Errors

CloudHsmAccessDeniedException:
The request was rejected because the requester does not have permission to perform the requested operation.
CloudHsmInternalFailureException:
The request was rejected because of an AWS CloudHSM internal failure. The request can be retried.
CloudHsmInvalidRequestException:
The request was rejected because it is not a valid request.
CloudHsmResourceNotFoundException:
The request was rejected because it refers to a resource that cannot be found.
CloudHsmServiceException:
The request was rejected because an error occurred.

RestoreBackup

$result = $client->restoreBackup([/* ... */]);
$promise = $client->restoreBackupAsync([/* ... */]);

Restores a specified AWS CloudHSM backup that is in the PENDING_DELETION state. For mor information on deleting a backup, see DeleteBackup.

Parameter Syntax

$result = $client->restoreBackup([
    'BackupId' => '<string>', // REQUIRED
]);

Parameter Details

Members

BackupId

Required: Yes
Type: string

The ID of the backup to be restored. To find the ID of a backup, use the DescribeBackups operation.

Result Syntax

[
    'Backup' => [
        'BackupId' => '<string>',
        'BackupState' => 'CREATE_IN_PROGRESS|READY|DELETED|PENDING_DELETION',
        'ClusterId' => '<string>',
        'CopyTimestamp' => <DateTime>,
        'CreateTimestamp' => <DateTime>,
        'DeleteTimestamp' => <DateTime>,
        'NeverExpires' => true || false,
        'SourceBackup' => '<string>',
        'SourceCluster' => '<string>',
        'SourceRegion' => '<string>',
        'TagList' => [
            [
                'Key' => '<string>',
                'Value' => '<string>',
            ],
            // ...
        ],
    ],
]

Result Details

Members

Backup

Type: Backup structure

Information on the Backup object created.

Errors

CloudHsmAccessDeniedException:
The request was rejected because the requester does not have permission to perform the requested operation.
CloudHsmInternalFailureException:
The request was rejected because of an AWS CloudHSM internal failure. The request can be retried.
CloudHsmInvalidRequestException:
The request was rejected because it is not a valid request.
CloudHsmResourceNotFoundException:
The request was rejected because it refers to a resource that cannot be found.
CloudHsmServiceException:
The request was rejected because an error occurred.

TagResource

$result = $client->tagResource([/* ... */]);
$promise = $client->tagResourceAsync([/* ... */]);

Adds or overwrites one or more tags for the specified AWS CloudHSM cluster.

Parameter Syntax

$result = $client->tagResource([
    'ResourceId' => '<string>', // REQUIRED
    'TagList' => [ // REQUIRED
        [
            'Key' => '<string>', // REQUIRED
            'Value' => '<string>', // REQUIRED
        ],
        // ...
    ],
]);

Parameter Details

Members

ResourceId

Required: Yes
Type: string

The cluster identifier (ID) for the cluster that you are tagging. To find the cluster ID, use DescribeClusters.

TagList

Required: Yes
Type: Array of Tag structures

A list of one or more tags.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

CloudHsmAccessDeniedException:
The request was rejected because the requester does not have permission to perform the requested operation.
CloudHsmInternalFailureException:
The request was rejected because of an AWS CloudHSM internal failure. The request can be retried.
CloudHsmInvalidRequestException:
The request was rejected because it is not a valid request.
CloudHsmResourceNotFoundException:
The request was rejected because it refers to a resource that cannot be found.
CloudHsmServiceException:
The request was rejected because an error occurred.
CloudHsmTagException:
The request was rejected because of a tagging failure. Verify the tag conditions in all applicable policies, and then retry the request.

UntagResource

$result = $client->untagResource([/* ... */]);
$promise = $client->untagResourceAsync([/* ... */]);

Removes the specified tag or tags from the specified AWS CloudHSM cluster.

Parameter Syntax

$result = $client->untagResource([
    'ResourceId' => '<string>', // REQUIRED
    'TagKeyList' => ['<string>', ...], // REQUIRED
]);

Parameter Details

Members

ResourceId

Required: Yes
Type: string

The cluster identifier (ID) for the cluster whose tags you are removing. To find the cluster ID, use DescribeClusters.

TagKeyList

Required: Yes
Type: Array of strings

A list of one or more tag keys for the tags that you are removing. Specify only the tag keys, not the tag values.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

CloudHsmAccessDeniedException:
The request was rejected because the requester does not have permission to perform the requested operation.
CloudHsmInternalFailureException:
The request was rejected because of an AWS CloudHSM internal failure. The request can be retried.
CloudHsmInvalidRequestException:
The request was rejected because it is not a valid request.
CloudHsmResourceNotFoundException:
The request was rejected because it refers to a resource that cannot be found.
CloudHsmServiceException:
The request was rejected because an error occurred.
CloudHsmTagException:
The request was rejected because of a tagging failure. Verify the tag conditions in all applicable policies, and then retry the request.

Shapes

Backup

Description

Members

BackupId

Required: Yes
Type: string

The identifier (ID) of the backup.

BackupState

Type: string

The state of the backup.

ClusterId

Type: string

The identifier (ID) of the cluster that was backed up.

CopyTimestamp

Type: timestamp (string|DateTime or anything parsable by strtotime)

The date and time when the backup was copied from a source backup.

CreateTimestamp

Type: timestamp (string|DateTime or anything parsable by strtotime)

The date and time when the backup was created.

DeleteTimestamp

Type: timestamp (string|DateTime or anything parsable by strtotime)

The date and time when the backup will be permanently deleted.

NeverExpires

Type: boolean

SourceBackup

Type: string

The identifier (ID) of the source backup from which the new backup was copied.

SourceCluster

Type: string

The identifier (ID) of the cluster containing the source backup from which the new backup was copied.

SourceRegion

Type: string

The AWS Region that contains the source backup from which the new backup was copied.

TagList

Type: Array of Tag structures

The list of tags for the backup.

BackupRetentionPolicy

Description

A policy that defines the number of days to retain backups.

Members

Type

Type: string

The type of backup retention policy. For the DAYS type, the value is the number of days to retain backups.

Value

Type: string

Use a value between 7 - 379.

Certificates

Description

Contains one or more certificates or a certificate signing request (CSR).

Members

AwsHardwareCertificate

Type: string

The HSM hardware certificate issued (signed) by AWS CloudHSM.

ClusterCertificate

Type: string

The cluster certificate issued (signed) by the issuing certificate authority (CA) of the cluster's owner.

ClusterCsr

Type: string

The cluster's certificate signing request (CSR). The CSR exists only when the cluster's state is UNINITIALIZED.

HsmCertificate

Type: string

The HSM certificate issued (signed) by the HSM hardware.

ManufacturerHardwareCertificate

Type: string

Type: string

The cluster's backup policy.

BackupRetentionPolicy

Type: BackupRetentionPolicy structure

A policy that defines how the service retains backups.

Certificates

Type: Certificates structure

Contains one or more certificates or a certificate signing request (CSR).

ClusterId

Type: string

The cluster's identifier (ID).

CreateTimestamp

Type: timestamp (string|DateTime or anything parsable by strtotime)

The date and time when the cluster was created.

HsmType

Type: string

The type of HSM that the cluster contains.

Hsms

Type: Array of Hsm structures

Contains information about the HSMs in the cluster.

PreCoPassword

Type: string

The default password for the cluster's Pre-Crypto Officer (PRECO) user.

SecurityGroup

Type: string

The identifier (ID) of the cluster's security group.

SourceBackupId

Type: string

The identifier (ID) of the backup used to create the cluster. This value exists only when the cluster was created from a backup.

State

Type: string

The cluster's state.

StateMessage

Type: string

A description of the cluster's state.

SubnetMapping

Type: Associative array of custom strings keys (ExternalAz) to strings

A map from availability zone to the cluster’s subnet in that availability zone.

TagList

Type: Array of Tag structures

The list of tags for the cluster.

VpcId

Type: string

The identifier (ID) of the virtual private cloud (VPC) that contains the cluster.

DestinationBackup

Description

Contains information about the backup that will be copied and created by the CopyBackupToRegion operation.

Members

CreateTimestamp

Type: timestamp (string|DateTime or anything parsable by strtotime)

The date and time when both the source backup was created.

SourceBackup

Type: string

The identifier (ID) of the source backup from which the new backup was copied.

SourceCluster

Type: string

The identifier (ID) of the cluster containing the source backup from which the new backup was copied.

SourceRegion

Type: string

The AWS region that contains the source backup from which the new backup was copied.

Hsm

Description

Contains information about a hardware security module (HSM) in an AWS CloudHSM cluster.

Members

AvailabilityZone

Type: string

The Availability Zone that contains the HSM.

ClusterId

Type: string

The identifier (ID) of the cluster that contains the HSM.

EniId

Type: string

The identifier (ID) of the HSM's elastic network interface (ENI).

EniIp

Type: string

The IP address of the HSM's elastic network interface (ENI).

HsmId

Required: Yes
Type: string

The HSM's identifier (ID).

State

Type: string

The HSM's state.

StateMessage

Type: string

A description of the HSM's state.

SubnetId

Type: string

The subnet that contains the HSM's elastic network interface (ENI).

Namespaces

Classes

Interfaces

Traits

Exceptions

Functions

AWS CloudHSM V2 2017-04-28

Operation Summary

Paginators

Operations

CopyBackupToRegion

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

CreateCluster

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

CreateHsm

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

DeleteBackup

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

DeleteCluster

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

DeleteHsm

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

DescribeBackups

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

DescribeClusters

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

InitializeCluster

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details