CopyBackupToRegion

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

Copy an CloudHSM cluster backup to a different region.

Cross-account use: No. You cannot perform this operation on an CloudHSM backup in a different Amazon Web Services account.

Parameter Syntax

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

Parameter Details

Result Syntax

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

Result Details

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 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 CloudHSM cluster.

Cross-account use: Yes. To perform this operation with an CloudHSM backup in a different AWS account, specify the full backup ARN in the value of the SourceBackupId parameter.

Parameter Syntax

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

Parameter Details

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>',
        'HsmTypeRollbackExpiration' => <DateTime>,
        'Hsms' => [
            [
                'AvailabilityZone' => '<string>',
                'ClusterId' => '<string>',
                'EniId' => '<string>',
                'EniIp' => '<string>',
                'EniIpV6' => '<string>',
                'HsmId' => '<string>',
                'HsmType' => '<string>',
                'State' => 'CREATE_IN_PROGRESS|ACTIVE|DEGRADED|DELETE_IN_PROGRESS|DELETED',
                'StateMessage' => '<string>',
                'SubnetId' => '<string>',
            ],
            // ...
        ],
        'Mode' => 'FIPS|NON_FIPS',
        'NetworkType' => 'IPV4|DUALSTACK',
        'PreCoPassword' => '<string>',
        'SecurityGroup' => '<string>',
        'SourceBackupId' => '<string>',
        'State' => 'CREATE_IN_PROGRESS|UNINITIALIZED|INITIALIZE_IN_PROGRESS|INITIALIZED|ACTIVE|UPDATE_IN_PROGRESS|MODIFY_IN_PROGRESS|ROLLBACK_IN_PROGRESS|DELETE_IN_PROGRESS|DELETED|DEGRADED',
        'StateMessage' => '<string>',
        'SubnetMapping' => ['<string>', ...],
        'TagList' => [
            [
                'Key' => '<string>',
                'Value' => '<string>',
            ],
            // ...
        ],
        'VpcId' => '<string>',
    ],
]

Result Details

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 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 CloudHSM cluster.

Cross-account use: No. You cannot perform this operation on an CloudHSM cluster in a different Amazon Web Service account.

Parameter Syntax

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

Parameter Details

Result Syntax

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

Result Details

Errors

CloudHsmInternalFailureException:

The request was rejected because of an 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 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.

Cross-account use: No. You cannot perform this operation on an CloudHSM backup in a different Amazon Web Services account.

Parameter Syntax

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

Parameter Details

Result Syntax

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

Result Details

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

Cross-account use: No. You cannot perform this operation on an CloudHSM cluster in a different Amazon Web Services account.

Parameter Syntax

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

Parameter Details

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>',
        'HsmTypeRollbackExpiration' => <DateTime>,
        'Hsms' => [
            [
                'AvailabilityZone' => '<string>',
                'ClusterId' => '<string>',
                'EniId' => '<string>',
                'EniIp' => '<string>',
                'EniIpV6' => '<string>',
                'HsmId' => '<string>',
                'HsmType' => '<string>',
                'State' => 'CREATE_IN_PROGRESS|ACTIVE|DEGRADED|DELETE_IN_PROGRESS|DELETED',
                'StateMessage' => '<string>',
                'SubnetId' => '<string>',
            ],
            // ...
        ],
        'Mode' => 'FIPS|NON_FIPS',
        'NetworkType' => 'IPV4|DUALSTACK',
        'PreCoPassword' => '<string>',
        'SecurityGroup' => '<string>',
        'SourceBackupId' => '<string>',
        'State' => 'CREATE_IN_PROGRESS|UNINITIALIZED|INITIALIZE_IN_PROGRESS|INITIALIZED|ACTIVE|UPDATE_IN_PROGRESS|MODIFY_IN_PROGRESS|ROLLBACK_IN_PROGRESS|DELETE_IN_PROGRESS|DELETED|DEGRADED',
        'StateMessage' => '<string>',
        'SubnetMapping' => ['<string>', ...],
        'TagList' => [
            [
                'Key' => '<string>',
                'Value' => '<string>',
            ],
            // ...
        ],
        'VpcId' => '<string>',
    ],
]

Result Details

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

Cross-account use: No. You cannot perform this operation on an CloudHSM hsm in a different Amazon Web Services account.

Parameter Syntax

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

Parameter Details

Result Syntax

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

Result Details

Errors

CloudHsmInternalFailureException:

The request was rejected because of an 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.

DeleteResourcePolicy

$result = $client->deleteResourcePolicy([/* ... */]);
$promise = $client->deleteResourcePolicyAsync([/* ... */]);

Deletes an CloudHSM resource policy. Deleting a resource policy will result in the resource being unshared and removed from any RAM resource shares. Deleting the resource policy attached to a backup will not impact any clusters created from that backup.

Cross-account use: No. You cannot perform this operation on an CloudHSM resource in a different Amazon Web Services account.

Parameter Syntax

$result = $client->deleteResourcePolicy([
    'ResourceArn' => '<string>',
]);

Parameter Details

Result Syntax

[
    'Policy' => '<string>',
    'ResourceArn' => '<string>',
]

Result Details

Errors

CloudHsmInternalFailureException:

The request was rejected because of an 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.

DescribeBackups

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

Gets information about backups of CloudHSM clusters. Lists either the backups you own or the backups shared with you when the Shared parameter is true.

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.

Cross-account use: Yes. Customers can describe backups in other Amazon Web Services accounts that are shared with them.

Parameter Syntax

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

Parameter Details

Result Syntax

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

Result Details

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

Cross-account use: No. You cannot perform this operation on CloudHSM clusters in a different Amazon Web Services account.

Parameter Syntax

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

Parameter Details

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>',
            'HsmTypeRollbackExpiration' => <DateTime>,
            'Hsms' => [
                [
                    'AvailabilityZone' => '<string>',
                    'ClusterId' => '<string>',
                    'EniId' => '<string>',
                    'EniIp' => '<string>',
                    'EniIpV6' => '<string>',
                    'HsmId' => '<string>',
                    'HsmType' => '<string>',
                    'State' => 'CREATE_IN_PROGRESS|ACTIVE|DEGRADED|DELETE_IN_PROGRESS|DELETED',
                    'StateMessage' => '<string>',
                    'SubnetId' => '<string>',
                ],
                // ...
            ],
            'Mode' => 'FIPS|NON_FIPS',
            'NetworkType' => 'IPV4|DUALSTACK',
            'PreCoPassword' => '<string>',
            'SecurityGroup' => '<string>',
            'SourceBackupId' => '<string>',
            'State' => 'CREATE_IN_PROGRESS|UNINITIALIZED|INITIALIZE_IN_PROGRESS|INITIALIZED|ACTIVE|UPDATE_IN_PROGRESS|MODIFY_IN_PROGRESS|ROLLBACK_IN_PROGRESS|DELETE_IN_PROGRESS|DELETED|DEGRADED',
            'StateMessage' => '<string>',
            'SubnetMapping' => ['<string>', ...],
            'TagList' => [
                [
                    'Key' => '<string>',
                    'Value' => '<string>',
                ],
                // ...
            ],
            'VpcId' => '<string>',
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

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

GetResourcePolicy

$result = $client->getResourcePolicy([/* ... */]);
$promise = $client->getResourcePolicyAsync([/* ... */]);

Retrieves the resource policy document attached to a given resource.

Cross-account use: No. You cannot perform this operation on an CloudHSM resource in a different Amazon Web Services account.

Parameter Syntax

$result = $client->getResourcePolicy([
    'ResourceArn' => '<string>',
]);

Parameter Details

Result Syntax

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

Result Details

Errors

CloudHsmInternalFailureException:

The request was rejected because of an 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.

InitializeCluster

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

Claims an 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.

Cross-account use: No. You cannot perform this operation on an CloudHSM cluster in a different Amazon Web Services account.

Parameter Syntax

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

Parameter Details

Result Syntax

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

Result Details

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

ListTags

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

Gets a list of tags for the specified 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.

Cross-account use: No. You cannot perform this operation on an CloudHSM resource in a different Amazon Web Services account.

Parameter Syntax

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

Parameter Details

Result Syntax

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

Result Details

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 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 CloudHSM backup.

Cross-account use: No. You cannot perform this operation on an CloudHSM backup in a different Amazon Web Services account.

Parameter Syntax

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

Parameter Details

Result Syntax

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

Result Details

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 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 CloudHSM cluster.

Cross-account use: No. You cannot perform this operation on an CloudHSM cluster in a different Amazon Web Services account.

Parameter Syntax

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

Parameter Details

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>',
        'HsmTypeRollbackExpiration' => <DateTime>,
        'Hsms' => [
            [
                'AvailabilityZone' => '<string>',
                'ClusterId' => '<string>',
                'EniId' => '<string>',
                'EniIp' => '<string>',
                'EniIpV6' => '<string>',
                'HsmId' => '<string>',
                'HsmType' => '<string>',
                'State' => 'CREATE_IN_PROGRESS|ACTIVE|DEGRADED|DELETE_IN_PROGRESS|DELETED',
                'StateMessage' => '<string>',
                'SubnetId' => '<string>',
            ],
            // ...
        ],
        'Mode' => 'FIPS|NON_FIPS',
        'NetworkType' => 'IPV4|DUALSTACK',
        'PreCoPassword' => '<string>',
        'SecurityGroup' => '<string>',
        'SourceBackupId' => '<string>',
        'State' => 'CREATE_IN_PROGRESS|UNINITIALIZED|INITIALIZE_IN_PROGRESS|INITIALIZED|ACTIVE|UPDATE_IN_PROGRESS|MODIFY_IN_PROGRESS|ROLLBACK_IN_PROGRESS|DELETE_IN_PROGRESS|DELETED|DEGRADED',
        'StateMessage' => '<string>',
        'SubnetMapping' => ['<string>', ...],
        'TagList' => [
            [
                'Key' => '<string>',
                'Value' => '<string>',
            ],
            // ...
        ],
        'VpcId' => '<string>',
    ],
]

Result Details

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

PutResourcePolicy

$result = $client->putResourcePolicy([/* ... */]);
$promise = $client->putResourcePolicyAsync([/* ... */]);

Creates or updates an CloudHSM resource policy. A resource policy helps you to define the IAM entity (for example, an Amazon Web Services account) that can manage your CloudHSM resources. The following resources support CloudHSM resource policies:

• Backup - The resource policy allows you to describe the backup and restore a cluster from the backup in another Amazon Web Services account.

In order to share a backup, it must be in a 'READY' state and you must own it.

Cross-account use: No. You cannot perform this operation on an CloudHSM resource in a different Amazon Web Services account.

Parameter Syntax

$result = $client->putResourcePolicy([
    'Policy' => '<string>',
    'ResourceArn' => '<string>',
]);

Parameter Details

Result Syntax

[
    'Policy' => '<string>',
    'ResourceArn' => '<string>',
]

Result Details

Errors

CloudHsmInternalFailureException:

The request was rejected because of an 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.

RestoreBackup

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

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

Cross-account use: No. You cannot perform this operation on an CloudHSM backup in a different Amazon Web Services account.

Parameter Syntax

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

Parameter Details

Result Syntax

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

Result Details

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 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 CloudHSM cluster.

Cross-account use: No. You cannot perform this operation on an CloudHSM resource in a different Amazon Web Services account.

Parameter Syntax

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

Parameter Details

Result Syntax

[]

Result Details

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 CloudHSM internal failure. The request can be retried.

CloudHsmInvalidRequestException:

The request was rejected because it is not a valid request.

CloudHsmResourceLimitExceededException:

The request was rejected because it exceeds an CloudHSM limit.

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 CloudHSM cluster.

Cross-account use: No. You cannot perform this operation on an CloudHSM resource in a different Amazon Web Services account.

Parameter Syntax

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

Parameter Details

Result Syntax

[]

Result Details

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