翻訳は機械翻訳により提供されています。提供された翻訳内容と英語版の間で齟齬、不一致または矛盾がある場合、英語版が優先します。

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 バージョン 3 AWS を使用した での認証 を参照)。AWS SDK for PHP からのインポート (AWS SDK for PHP バージョン 3 のインストール を参照)。

AWS Key Management Service (AWS KMS) の使用の詳細については、「AWS KMS デベロッパーガイド」を参照してください。

エイリアスの作成

KMS キーのエイリアスを作成するには、CreateAlias オペレーションを使用します。エイリアスはアカウントと AWS リージョンで一意であることが必要です。既にエイリアスがある KMS キー用にエイリアスを作成した場合、CreateAlias によって同じ KMS キーに対して別のエイリアスが作成されます。既存のエイリアスは置き換えられません。

インポート。

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";
}