使用 AWS KMS API 和AWS SDK for PHP版本 3 使用別名 - AWS SDK for PHP

本文為英文版的機器翻譯版本,如內容有任何歧義或不一致之處,概以英文版為準。

使用 AWS KMS API 和AWS SDK for PHP版本 3 使用別名

AWS Key Management Service(AWS KMS) AWS KMS key為呼叫的別名提供選擇性的顯示名稱。

下列範例示範如何:

所有的範例程式碼都可以AWS SDK for PHP在這裡取得 GitHub。

登入資料

在執行範例程式碼之前,請依照中的說明設定您的AWS認證憑證。然後匯入AWS SDK for PHP,如中所述基本使用

如需使用 AWS Key Management Service (AWS KMS) 的詳細資訊,請參閱AWS KMS開發人員指南

建立別名

若要建立 KMS 金鑰的別名,請使用此CreateAlias作業。別名在帳戶和AWS區域中必須是唯一的。如果您為已有別名的 KMS 金鑰建立別名,請為相同的 KMS 金鑰CreateAlias建立另一個別名。其並不會取代現有的別名。

匯入

require 'vendor/autoload.php'; use Aws\Exception\AwsException;

範例程式碼

$KmsClient = new Aws\Kms\KmsClient([ 'profile' => 'default', 'version' => '2014-11-01', 'region' => 'us-east-2' ]); $keyId = 'arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab'; $aliasName = "alias/projectKey1"; try { $result = $KmsClient->createAlias([ 'AliasName' => $aliasName, 'TargetKeyId' => $keyId, ]); var_dump($result); } catch (AwsException $e) { // output error message if fails echo $e->getMessage(); echo "\n"; }

檢視別名

若要列出呼叫者和中的所有別名 AWS 帳戶AWS 區域,請使用此ListAliases作業。

匯入

require 'vendor/autoload.php'; use Aws\Exception\AwsException;

範例程式碼

$KmsClient = new Aws\Kms\KmsClient([ 'profile' => 'default', 'version' => '2014-11-01', 'region' => 'us-east-2' ]); $limit = 10; try { $result = $KmsClient->listAliases([ 'Limit' => $limit, ]); var_dump($result); } catch (AwsException $e) { // output error message if fails echo $e->getMessage(); echo "\n"; }

更新別名

若要將現有別名與不同的 KMS 金鑰建立關聯,請使用此UpdateAlias作業。

匯入

require 'vendor/autoload.php'; use Aws\Exception\AwsException;

範例程式碼

$KmsClient = new Aws\Kms\KmsClient([ 'profile' => 'default', 'version' => '2014-11-01', 'region' => 'us-east-2' ]); $keyId = 'arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab'; $aliasName = "alias/projectKey1"; try { $result = $KmsClient->updateAlias([ 'AliasName' => $aliasName, 'TargetKeyId' => $keyId, ]); var_dump($result); } catch (AwsException $e) { // output error message if fails echo $e->getMessage(); echo "\n"; }

刪除別名

若要刪除別名,請使用此DeleteAlias作業。刪除別名對基礎 KMS 金鑰沒有影響。

匯入

require 'vendor/autoload.php'; use Aws\Exception\AwsException;

範例程式碼

$KmsClient = new Aws\Kms\KmsClient([ 'profile' => 'default', 'version' => '2014-11-01', 'region' => 'us-east-2' ]); $aliasName = "alias/projectKey1"; try { $result = $KmsClient->deleteAlias([ 'AliasName' => $aliasName, ]); var_dump($result); } catch (AwsException $e) { // output error message if fails echo $e->getMessage(); echo "\n"; }