Arbeiten mit Aliasen - AWS Key Management Service
Erstellen eines AliasAuflisten von AliasenAktualisieren eines AliasLöschen eines Alias

Die vorliegende Übersetzung wurde maschinell erstellt. Im Falle eines Konflikts oder eines Widerspruchs zwischen dieser übersetzten Fassung und der englischen Fassung (einschließlich infolge von Verzögerungen bei der Übersetzung) ist die englische Fassung maßgeblich.

Arbeiten mit Aliasen

Die Beispiele in diesem Thema verwenden die AWS KMS-API zum Erstellen, Anzeigen, Aktualisieren und Löschen von Aliasen. Weitere Informationen zu Aliasen finden Sie unter Verwenden von Aliassen.

Erstellen eines Alias

Wenn Sie einen AWS KMS key in der AWS Management Console erstellen, müssen Sie einen Alias dafür erstellen. Die CreateKey Operation, die einen KMS-Schlüssel erstellt, erstellt jedoch keinen Alias.

Um einen Alias zu erstellen, verwenden Sie die -CreateAliasOperation. Ein Alias muss im Konto und der Region eindeutig sein. Sie können keinen Alias erstellen, der mit aws/ beginnt. Die aws/-Präfix wird von Amazon Web Services für Von AWS verwaltete Schlüssel reserviert.

In Sprachen, für die ein Client-Objekt erforderlich ist, verwenden diese Beispiele das AWS KMS-Client-Objekt, das Sie in Erstellen eines Clients erstellt haben.

Java

Weitere Informationen finden Sie in der Beschreibung der createAlias-Methode in der AWS SDK for Java-API-Referenz.

// 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#

Weitere Informationen finden Sie in der Beschreibung der CreateAlias encrypt-Methode im 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

Weitere Informationen finden Sie in der Beschreibung der create_aliasencrypt-Methode im AWS 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

Weitere Informationen finden Sie unter der create_alias-Instance-Methode encrypt im 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

Weitere Informationen finden Sie in der Beschreibung der CreateAlias encrypt-Methode im 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

Weitere Informationen finden Sie in der createAlias-Eigenschaft im AWS -SDK für JavaScript in Node.js.

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

Verwenden Sie zum Erstellen eines Alias das Cmdlet New-KMSAlias. Bei dem Aliasnamen wird zwischen Groß- und Kleinschreibung unterschieden.

# 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

Um die AWS KMS PowerShell Cmdlets zu verwenden, installieren Sie das AWS.Tools.KeyManagementService-Modul. Weitere Informationen finden Sie im AWS Tools for Windows PowerShell-Benutzerhandbuch.

Auflisten von Aliasen

Um Aliase im Konto und in der Region aufzulisten, verwenden Sie die -ListAliasesOperation.

Standardmäßig gibt der Befehl ListAliases alle Aliase innerhalb des Kontos und der Region zurück. Darunter fallen auch Aliase, die Sie mit Ihren benutzerverwalteten Schlüssel erstellt und zugeordnet haben, und Aliase, die AWS erstellt und Ihren Von AWS verwaltete Schlüssel zugeordnet hat. Die Antwort kann auch Aliase ohne das Feld TargetKeyId enthalten. Dies sind vordefinierte Aliase, die von AWS erstellt, aber noch keinem KMS-Schlüssel zugeordnet wurden.

In Sprachen, für die ein Client-Objekt erforderlich ist, verwenden diese Beispiele das AWS KMS-Client-Objekt, das Sie in Erstellen eines Clients erstellt haben.

Java

Weitere Informationen zur Java-Implementierung finden Sie in der Beschreibung der listAlias-Methode in der AWS SDK for Java-API-Referenz.

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

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

Weitere Informationen finden Sie in der Beschreibung der ListAliases encrypt-Methode im AWS SDK for .NET.

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

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

Weitere Informationen finden Sie in der Beschreibung der list_aliasesencrypt-Methode im AWS SDK for Python (Boto3).

# List the aliases in this AWS-Konto

response = kms_client.list_aliases(
    Limit=10
)
Ruby

Weitere Informationen finden Sie unter der list_aliases-Instance-Methode encrypt im AWS SDK for Ruby.

# List the aliases in this AWS-Konto

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

Weitere Informationen finden Sie in der Beschreibung der Methode List Aliases in der AWS SDK for PHP.

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

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

Weitere Informationen finden Sie in der listAliases-Eigenschaft im AWS -SDK für JavaScript in Node.js.

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

Verwenden Sie das Get-KMS-AliasListCmdlet, um die Aliase im Konto und in der Region aufzulisten.

Um die maximale Anzahl der Ausgabeobjekte zu begrenzen, verwendet dieses Beispiel das Select-Object-cmdlet anstelle des Limit-Parameters, der in Listen-cmdlets veraltet ist. Hilfe zum Paginieren der Ausgabe in AWS Tools for PowerShell finden Sie unter Ausgabepaginierung mit AWS Tools for PowerShell.

# List the aliases in this AWS-Konto
$limit = 10

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

Um die AWS KMS PowerShell Cmdlets zu verwenden, installieren Sie das AWS.Tools.KeyManagementService-Modul. Weitere Informationen finden Sie im AWS Tools for Windows PowerShell-Benutzerhandbuch.

Wenn Sie nur die Aliase auflisten möchten, die einem bestimmten KMS-Schlüssel zugeordnet sind, verwenden Sie den KeyId-Parameter. Sein Wert kann die Schlüssel-ID oder der Schlüssel-ARN eines beliebigen KMS-Schlüssels in der Region sein. Sie können keinen Aliasnamen oder Alias-ARN angeben.

Java

Weitere Informationen zur Java-Implementierung finden Sie in der Beschreibung der listAliases-Methode in der AWS SDK for Java-API-Referenz.

// 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#

Weitere Informationen finden Sie in der Beschreibung der ListAliases encrypt-Methode im 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

Weitere Informationen finden Sie in der Beschreibung der list_aliasesencrypt-Methode im AWS 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

Weitere Informationen finden Sie unter der list_aliases-Instance-Methode encrypt im 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

Weitere Informationen finden Sie in der Beschreibung der Methode List Aliases in der 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

Weitere Informationen finden Sie in der listAliases-Eigenschaft im AWS -SDK für JavaScript in 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

Um die Aliase für einen KMS-Schlüssel aufzulisten, verwenden Sie den -KeyIdParameter des Get-KMS-Cmdlets. AliasList 

# 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

Um die AWS KMS PowerShell Cmdlets zu verwenden, installieren Sie das AWS.Tools.KeyManagementService-Modul. Weitere Informationen finden Sie im AWS Tools for Windows PowerShell-Benutzerhandbuch.

Aktualisieren eines Alias

Um einen vorhandenen Alias einem anderen KMS-Schlüssel zuzuordnen, verwenden Sie die -UpdateAliasOperation.

In Sprachen, für die ein Client-Objekt erforderlich ist, verwenden diese Beispiele das AWS KMS-Client-Objekt, das Sie in Erstellen eines Clients erstellt haben.

Java

Weitere Informationen zur Java-Implementierung finden Sie in der Beschreibung der updateAlias-Methode in der AWS SDK for Java-API-Referenz.

// 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#

Weitere Informationen finden Sie in der Beschreibung der UpdateAlias encrypt-Methode im 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

Weitere Informationen finden Sie in der Beschreibung der update_aliasencrypt-Methode im AWS 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

Weitere Informationen finden Sie unter der update_alias-Instance-Methode encrypt im 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

Weitere Informationen finden Sie in der Beschreibung der UpdateAlias encrypt-Methode im 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

Weitere Informationen finden Sie in der updateAlias-Eigenschaft im AWS -SDK für JavaScript in Node.js.

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

Verwenden Sie zum Ändern des KMS-Schlüssels, der einem Alias zugeordnet ist das Update-KMSAlias-cmdlet. Bei dem Aliasnamen wird zwischen Groß- und Kleinschreibung unterschieden.

Das Cmdlet Update-KMSAlias gibt keine Ausgabe zurück. Um zu überprüfen, ob der Befehl funktioniert hat, verwenden Sie das Get-KMSAliasList-Cmdlet.

# 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

Um die AWS KMS PowerShell Cmdlets zu verwenden, installieren Sie das AWS.Tools.KeyManagementService-Modul. Weitere Informationen finden Sie im AWS Tools for Windows PowerShell-Benutzerhandbuch.

Löschen eines Alias

Um einen Alias zu löschen, verwenden Sie die -DeleteAliasOperation. Das Löschen eines Alias hat keine Auswirkungen auf den zugeordneten KMS-Schlüssel.

In Sprachen, für die ein Client-Objekt erforderlich ist, verwenden diese Beispiele das AWS KMS-Client-Objekt, das Sie in Erstellen eines Clients erstellt haben.

Java

Weitere Informationen finden Sie in der Beschreibung der deleteAlias-Methode in der AWS SDK for Java-API-Referenz.

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

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

Weitere Informationen finden Sie in der Beschreibung der DeleteAlias encrypt-Methode im 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

Weitere Informationen finden Sie in der Beschreibung der delete_aliasencrypt-Methode im AWS SDK for Python (Boto3).

# Delete an alias for a KMS key

alias_name = 'alias/projectKey1'

response = kms_client.delete_alias(
    AliasName=alias_name
)
Ruby

Weitere Informationen finden Sie unter der delete_alias-Instance-Methode encrypt im AWS SDK for Ruby.

# Delete an alias for a KMS key

alias_name = 'alias/projectKey1'

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

Weitere Informationen finden Sie in der Beschreibung der DeleteAlias encrypt-Methode im AWS SDK for PHP.

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

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

Weitere Informationen finden Sie in der deleteAlias-Eigenschaft ) im AWS -SDK für JavaScript in Node.js .

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

Verwenden Sie zum Löschen eines Alias das Cmdlet Remove-KMSAlias. Bei dem Aliasnamen wird zwischen Groß- und Kleinschreibung unterschieden.

Da dieses Cmdlet den Alias dauerhaft löscht, PowerShell werden Sie aufgefordert, den Befehl zu bestätigen. Die ConfirmImpact ist High, sodass Sie keine ConfirmPreference verwenden können, um diese Aufforderung zu unterdrücken. Wenn Sie die Bestätigungsaufforderung unterdrücken müssen, fügen Sie den allgemeinen Confirm-Parameter mit dem Wert $false hinzu, z. B.: -Confirm:$false.

Das Cmdlet Remove-KMSAlias gibt keine Ausgabe zurück. Verwenden Sie das Get-KMS-AliasListCmdlet, um zu überprüfen, ob der Befehl wirksam war.

# Delete an alias for a KMS key

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

Um die AWS KMS PowerShell Cmdlets zu verwenden, installieren Sie das AWS.Tools.KeyManagementService-Modul. Weitere Informationen finden Sie im AWS Tools for Windows PowerShell-Benutzerhandbuch.