Membuat alias Membuat daftar alias Memperbarui alias Menghapus alias

Bekerja dengan alias

Contoh dalam topik ini menggunakan AWS KMS API untuk membuat, melihat, memperbarui, dan menghapus alias. Untuk informasi tentang cara alias, lihat Menggunakan alias.

Topik

Membuat alias
Membuat daftar alias
Memperbarui alias
Menghapus alias

Membuat alias

Ketika Anda membuat AWS KMS key diAWS Management Console, Anda harus membuat alias untuk itu. Namun, CreateKeyoperasi yang membuat kunci KMS tidak membuat alias.

Untuk membuat alias, gunakan CreateAliasoperasi. Alias harus unik di akun dan Wilayah. Anda tidak dapat membuat alias yang dimulai dengan aws/. aws/Awalan dicadangkan oleh Amazon Web Services untuk Kunci yang dikelola AWS.

Dalam bahasa yang memerlukan objek klien, contoh-contoh ini menggunakan objek klien AWS KMS yang Anda buat di Membuat klien.

Java

Untuk detailnya, lihat metode createAlias di Referensi API AWS SDK for Java.


// Create an alias for a KMS key
//
String aliasName = "alias/projectKey1";
// Replace the following example key ARN with a valid key ID or key ARN
String targetKeyId = "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab";

CreateAliasRequest req = new CreateAliasRequest().withAliasName(aliasName).withTargetKeyId(targetKeyId);
kmsClient.createAlias(req);

C#

Untuk detailnya, lihat CreateAlias metode di AWS SDK for .NET.


// Create an alias for a KMS key
//
String aliasName = "alias/projectKey1";
// Replace the following example key ARN with a valid key ID or key ARN
String targetKeyId = "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab";

CreateAliasRequest createAliasRequest = new CreateAliasRequest()
{
    AliasName = aliasName,
    TargetKeyId = targetKeyId
};
kmsClient.CreateAlias(createAliasRequest);

Python

Untuk detailnya, lihat create_aliasmetode diAWS SDK for Python (Boto3).


# Create an alias for a KMS key

alias_name = 'alias/projectKey1'
# Replace the following example key ARN with a valid key ID or key ARN
target_key_id = 'arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab'

response = kms_client.create_alias(
    AliasName=alias_name,
    TargetKeyId=key_id
)

Ruby

Untuk detailnya, lihat metode create_aliasinstance di AWS SDK for Ruby.


# Create an alias for a KMS key

alias_name = 'alias/projectKey1'
# Replace the following example key ARN with a valid key ID or key ARN
target_key_id = 'arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab'

response = kmsClient.create_alias({
  alias_name: alias_name,
  target_key_id: target_key_id
})

PHP

Untuk detailnya, lihat CreateAlias metode di AWS SDK for PHP.


// Create an alias for a KMS key
//
$aliasName = "alias/projectKey1";
// Replace the following example key ARN with a valid key ID or key ARN
$keyId = 'arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab';


$result = $KmsClient->createAlias([
    'AliasName' => $aliasName, 
    'TargetKeyId' =>  $keyId, 
]);

Node.js

Untuk detailnya, lihat properti createAlias di SDK untuk di AWS Node.js. JavaScript


// Create an alias for a KMS key
//
const AliasName = 'alias/projectKey1';

// Replace the following example key ARN with a valid key ID or key ARN
const TargetKeyId = 'arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab';
kmsClient.createAlias({ AliasName, TargetKeyId }, (err, data) => {
  ...
});

PowerShell

Untuk membuat alias, gunakan cmdlet New-KMSAlias. Nama alias peka terhadap huruf besar-kecil.


# Create an alias for a KMS key

$aliasName = 'alias/projectKey1'
# Replace the following example key ARN with a valid key ID or key ARN
$targetKeyId = 'arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab'

New-KMSAlias -TargetKeyId $targetKeyId -AliasName $aliasName

Untuk menggunakan AWS KMS PowerShell cmdlet, instal AWS.tools. KeyManagementServicemodul. Untuk informasi selengkapnya, lihat Panduan Pengguna AWS Tools for Windows PowerShell.

Membuat daftar alias

Untuk membuat daftar alias di akun dan wilayah, gunakan ListAliasesoperasi.

Secara default, perintah ListAliases mengembalikan semua alias di akun dan Wilayah. Ini termasuk alias yang Anda buat dan kaitkan dengan kunci yang dikelola pelanggan Anda, dan alias yang AWS dibuat dan dikaitkan dengan Anda. Kunci yang dikelola AWS Respons mungkin juga menyertakan alias yang tidak memiliki bidang TargetKeyId. Ini adalah alias yang AWS telah ditentukan sebelumnya yang telah dibuat tetapi belum dikaitkan dengan kunci KMS.

Dalam bahasa yang memerlukan objek klien, contoh-contoh ini menggunakan objek klien AWS KMS yang Anda buat di Membuat klien.

Java

Untuk detail tentang implementasi Java, lihat metode listAliases di Referensi API AWS SDK for Java.


// List the aliases in this Akun AWS
//
Integer limit = 10;

ListAliasesRequest req = new ListAliasesRequest().withLimit(limit);
ListAliasesResult result = kmsClient.listAliases(req);

C#

Untuk detailnya, lihat ListAliases metode di AWS SDK for .NET.


// List the aliases in this Akun AWS
//
int limit = 10;

ListAliasesRequest listAliasesRequest = new ListAliasesRequest()
{
    Limit = limit
};
ListAliasesResponse listAliasesResponse = kmsClient.ListAliases(listAliasesRequest);

Python

Untuk detailnya, lihat list_aliasesmetode diAWS SDK for Python (Boto3).


# List the aliases in this Akun AWS

response = kms_client.list_aliases(
    Limit=10
)

Ruby

Untuk detailnya, lihat metode list_aliasesinstance di AWS SDK for Ruby.


# List the aliases in this Akun AWS

response = kmsClient.list_aliases({
  limit: 10
})

PHP

Untuk detailnya, lihat metode List Aliases di AWS SDK for PHP.


// List the aliases in this Akun AWS
//
$limit = 10;

$result = $KmsClient->listAliases([
    'Limit' => $limit,
]);

Node.js

Untuk detailnya, lihat properti ListAliases di SDK AWS JavaScript untuk di Node.js.


// List the aliases in this Akun AWS
//
const Limit = 10;
kmsClient.listAliases({ Limit }, (err, data) => {
  ...
});

PowerShell

Untuk membuat daftar alias di akun dan Wilayah, gunakan cmdlet AliasListGet-KMS.

Untuk membatasi jumlah objek output, contoh ini menggunakan cmdlet Select-Object, bukan parameter Limit, yang tidak lagi digunakan dalam cmdlet daftar. Untuk bantuan dengan output pemberian nomor halaman di AWS Tools for PowerShell, lihat Output Pemberian Nomor Halaman dengan AWS Tools for PowerShell.


# List the aliases in this Akun AWS
$limit = 10

$result = Get-KMSAliasList | Select-Object -First $limit

Untuk menggunakan AWS KMS PowerShell cmdlet, instal AWS.tools. KeyManagementServicemodul. Untuk informasi selengkapnya, silakan lihat Panduan Pengguna AWS Tools for Windows PowerShell.

Untuk daftar hanya alias yang terkait dengan kunci KMS tertentu, gunakan parameter. KeyId Nilainya dapat berupa ID kunci atau kunci ARN dari setiap kunci KMS di wilayah tersebut. Anda tidak dapat menentukan nama alias atau ARN alias.

Java

Untuk detail tentang implementasi Java, lihat metode listAliases di Referensi API AWS SDK for Java.


// List the aliases for one KMS key
//
// Replace the following example key ARN with a valid key ID or key ARN
String keyId = "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab";

ListAliasesRequest req = new ListAliasesRequest().withKeyId(keyId);
ListAliasesResult result = kmsClient.listAliases(req);

C#

Untuk detailnya, lihat ListAliases metode di AWS SDK for .NET.


// List the aliases for one KMS key
//
// Replace the following example key ARN with a valid key ID or key ARN
String keyId = "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab";

ListAliasesRequest listAliasesRequest = new ListAliasesRequest()
{
    KeyId = keyId
};
ListAliasesResponse listAliasesResponse = kmsClient.ListAliases(listAliasesRequest);

Python

Untuk detailnya, lihat list_aliasesmetode diAWS SDK for Python (Boto3).


# List the aliases for one KMS key

# Replace the following example key ARN with a valid key ID or key ARN
key_id = 'arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab'

response = kms_client.list_aliases(
    KeyId=key_id
)

Ruby

Untuk detailnya, lihat metode list_aliasesinstance di AWS SDK for Ruby.


# List the aliases for one KMS key

# Replace the following example key ARN with a valid key ID or key ARN
key_id = 'arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab'

response = kmsClient.list_aliases({
  key_id: key_id
})

PHP

Untuk detailnya, lihat metode List Aliases di AWS SDK for PHP.


// List the aliases for one KMS key
//
// Replace the following example key ARN with a valid key ID or key ARN
$keyId = 'arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab';

$result = $KmsClient->listAliases([
    'KeyId' => $keyId,
]);

Node.js

Untuk detailnya, lihat properti ListAliases di SDK AWS JavaScript untuk di Node.js.


// List the aliases for one KMS key
//
// Replace the following example key ARN with a valid key ID or key ARN
const KeyId = 'arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab';
kmsClient.listAliases({ KeyId }, (err, data) => {
  ...
});

PowerShell

Untuk membuat daftar alias untuk kunci KMS, gunakan KeyId parameter cmdlet AliasListGet-KMS.


# List the aliases for one KMS key

# Replace the following example key ARN with a valid key ID or key ARN
$keyId = 'arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab'

$response = Get-KmsAliasList -KeyId $keyId

Untuk menggunakan AWS KMS PowerShell cmdlet, instal AWS.tools. KeyManagementServicemodul. Untuk informasi selengkapnya, lihat Panduan Pengguna AWS Tools for Windows PowerShell.

Memperbarui alias

Untuk mengaitkan alias yang ada dengan kunci KMS yang berbeda, gunakan operasi. UpdateAlias

Dalam bahasa yang memerlukan objek klien, contoh-contoh ini menggunakan objek klien AWS KMS yang Anda buat di Membuat klien.

Java

Untuk detail tentang implementasi Java, lihat metode updateAlias di Referensi API AWS SDK for Java.


// Updating an alias
//
String aliasName = "alias/projectKey1";
// Replace the following example key ARN with a valid key ID or key ARN
String targetKeyId = "arn:aws:kms:us-west-2:111122223333:key/0987dcba-09fe-87dc-65ba-ab0987654321";

UpdateAliasRequest req = new UpdateAliasRequest()
     .withAliasName(aliasName)
     .withTargetKeyId(targetKeyId);
     
kmsClient.updateAlias(req);

C#

Untuk detailnya, lihat UpdateAlias metode di AWS SDK for .NET.


// Updating an alias
//
String aliasName = "alias/projectKey1";
// Replace the following example key ARN with a valid key ID or key ARN
String targetKeyId = "arn:aws:kms:us-west-2:111122223333:key/0987dcba-09fe-87dc-65ba-ab0987654321";

UpdateAliasRequest updateAliasRequest = new UpdateAliasRequest()
{
    AliasName = aliasName,
    TargetKeyId = targetKeyId
};

kmsClient.UpdateAlias(updateAliasRequest);

Python

Untuk detailnya, lihat update_aliasmetode diAWS SDK for Python (Boto3).


# Updating an alias

alias_name = 'alias/projectKey1'
# Replace the following example key ARN with a valid key ID or key ARN
key_id = 'arn:aws:kms:us-west-2:111122223333:key/0987dcba-09fe-87dc-65ba-ab0987654321'

response = kms_client.update_alias(
    AliasName=alias_name,
    TargetKeyID=key_id
)

Ruby

Untuk detailnya, lihat metode update_aliasinstance di AWS SDK for Ruby.


# Updating an alias

alias_name = 'alias/projectKey1'
# Replace the following example key ARN with a valid key ID or key ARN
key_id = 'arn:aws:kms:us-west-2:111122223333:key/0987dcba-09fe-87dc-65ba-ab0987654321'

response = kmsClient.update_alias({
  alias_name: alias_name,
  target_key_id: key_id
})

PHP

Untuk detailnya, lihat UpdateAlias metode di AWS SDK for PHP.


// Updating an alias
//
$aliasName = "alias/projectKey1";

// Replace the following example key ARN with a valid key ID or key ARN
$keyId = 'arn:aws:kms:us-west-2:111122223333:key/0987dcba-09fe-87dc-65ba-ab0987654321';

$result = $KmsClient->updateAlias([
    'AliasName' => $aliasName, 
    'TargetKeyId' =>  $keyId, 
]);

Node.js

Untuk detailnya, lihat properti updateAlias di SDK untuk di Node.js. AWS JavaScript


// Updating an alias
//
const AliasName = 'alias/projectKey1';
 
// Replace the following example key ARN with a valid key ID or key ARN
const TargetKeyId = 'arn:aws:kms:us-west-2:111122223333:key/0987dcba-09fe-87dc-65ba-ab0987654321';
kmsClient.updateAlias({ AliasName, TargetKeyId }, (err, data) => {
  ...
});

PowerShell

Untuk mengubah kunci KMS yang terkait dengan alias, gunakan cmdlet Update-KMSalias. Nama alias peka terhadap huruf besar-kecil.

Cmdlet Update-KMSAlias tidak mengembalikan output apa pun. Untuk memverifikasi bahwa perintah berfungsi, gunakan cmdlet Get-KMS AliasList.


# Updating an alias

$aliasName = 'alias/projectKey1'
# Replace the following example key ARN with a valid key ID or key ARN
$keyId = 'arn:aws:kms:us-west-2:111122223333:key/0987dcba-09fe-87dc-65ba-ab0987654321'

Update-KMSAlias -AliasName $aliasName -TargetKeyID $keyId

Untuk menggunakan AWS KMS PowerShell cmdlet, instal AWS.tools. KeyManagementServicemodul. Untuk informasi selengkapnya, lihat Panduan Pengguna AWS Tools for Windows PowerShell.

Menghapus alias

Untuk menghapus alias, gunakan DeleteAliasoperasi. Menghapus alias tidak berpengaruh pada kunci KMS terkait.

Dalam bahasa yang memerlukan objek klien, contoh-contoh ini menggunakan objek klien AWS KMS yang Anda buat di Membuat klien.

Java

Untuk detailnya, lihat Metode deleteAlias di Referensi API AWS SDK for Java.


// Delete an alias for a KMS key
//
String aliasName = "alias/projectKey1";

DeleteAliasRequest req  = new DeleteAliasRequest().withAliasName(aliasName);
kmsClient.deleteAlias(req);

C#

Untuk detailnya, lihat DeleteAlias metode di AWS SDK for .NET.


// Delete an alias for a KMS key
//
String aliasName = "alias/projectKey1";

DeleteAliasRequest deleteAliasRequest = new DeleteAliasRequest()
{
    AliasName = aliasName
};
kmsClient.DeleteAlias(deleteAliasRequest);

Python

Untuk detailnya, lihat delete_aliasmetode diAWS SDK for Python (Boto3).


# Delete an alias for a KMS key

alias_name = 'alias/projectKey1'

response = kms_client.delete_alias(
    AliasName=alias_name
)

Ruby

Untuk detailnya, lihat metode delete_aliasinstance di AWS SDK for Ruby.


# Delete an alias for a KMS key

alias_name = 'alias/projectKey1'

response = kmsClient.delete_alias({
  alias_name: alias_name
})

PHP

Untuk detailnya, lihat DeleteAlias metode di AWS SDK for PHP.


// Delete an alias for a KMS key
//
$aliasName = "alias/projectKey1";

$result = $KmsClient->deleteAlias([
    'AliasName' => $aliasName, 
]);

Node.js

Untuk detailnya, lihat properti DeleteAlias) di SDK untuk di AWS Node.js. JavaScript


// Delete an alias for a KMS key
//
const AliasName = 'alias/projectKey1';
kmsClient.deleteAlias({ AliasName }, (err, data) => {
  ...
});

PowerShell

Untuk menghapus alias, gunakan cmdlet Remove-KMSAlias. Nama alias peka terhadap huruf besar-kecil.

Karena cmdlet ini menghapus alias secara permanen, PowerShell meminta Anda untuk mengonfirmasi perintah. ConfirmImpact adalah High, sehingga Anda tidak dapat menggunakan ConfirmPreference untuk menekan prompt ini. Jika Anda harus menekan prompt konfirmasi, tambahkan parameter umum Confirm dengan nilai $false, misalnya: -Confirm:$false.

Cmdlet Remove-KMSAlias tidak mengembalikan output apa pun. Untuk memverifikasi bahwa perintah itu efektif, gunakan cmdlet Get-KMS AliasList.


# Delete an alias for a KMS key

$aliasName = 'alias/projectKey1'
Remove-KMSAlias -AliasName $aliasName

Untuk menggunakan AWS KMS PowerShell cmdlet, instal AWS.tools. KeyManagementServicemodul. Untuk informasi selengkapnya, lihat Panduan Pengguna AWS Tools for Windows PowerShell.

Awas Javascript dinonaktifkan atau tidak tersedia di browser Anda.

Untuk menggunakan Dokumentasi AWS, Javascript harus diaktifkan. Lihat halaman Bantuan browser Anda untuk petunjuk.

Konvensi Dokumen

Bekerja dengan kunci

Mengenkripsi dan mendekripsi kunci data