Création d'un alias Établissement de la liste des alias Mise à jour d'un alias Suppression d'un alias

Utilisation des alias

Les exemples de cette rubrique utilisent l'API AWS KMS pour créer, afficher, mettre à jour et supprimer des alias. Pour en savoir plus sur les alias, veuillez consulter Utilisation des alias.

Création d'un alias

Lorsque vous créez une AWS KMS key dans la AWS Management Console, vous devez créer un alias pour cela. Toutefois, l'CreateKeyopération qui crée une clé KMS ne crée pas d'alias.

Pour créer un alias, utilisez l'CreateAliasopération. L'alias doit être unique dans le compte et la région. Vous ne pouvez pas créer un alias commençant par aws/. Le préfixe aws/ est réservé par Amazon Web Services pour Clés gérées par AWS.

Dans les langues qui nécessitent un objet client, ces exemples utilisent l'objet client AWS KMS que vous avez créé dans Création d'un client.

Java

Pour obtenir des détails, veuillez consulter la méthode createAlias dans la Référence d'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#

Pour obtenir des détails, consultez la méthode CreateAlias dans 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

Pour obtenir des détails, consultez la méthode create_alias dans 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

Pour obtenir des détails, consultez la méthode d'instance create_alias dans le kit 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

Pour obtenir des détails, consultez la méthode CreateAlias dans 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

Pour plus de détails, consultez la propriété CreateAlias dans le AWSSDK pour JavaScript 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

Pour créer un alias, utilisez l'applet de commande New-KMSAlias. Le nom de l'alias est sensible à la casse.


# 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

Pour utiliser les AWS KMS PowerShell applets de commande, installez le fichier AWS.tools. KeyManagementServicemodule. Pour plus d’informations, consultez le Guide de l’utilisateur AWS Tools for Windows PowerShell.

Établissement de la liste des alias

Pour répertorier les alias du compte et de la région, utilisez l'ListAliasesopération.

Par défaut, la commande ListAliases retourne tous les alias figurant dans le compte et la région. Cela inclut les alias que vous avez créés et associés à vos clés KMS gérées par le client et les alias créés par AWS et associés à vos Clés gérées par AWS. La réponse peut également inclure des alias ne disposant pas de champ TargetKeyId. Ces alias prédéfinis ont été créés par AWS qui ne les a pas encore associés à une clé KMS.

Dans les langues qui nécessitent un objet client, ces exemples utilisent l'objet client AWS KMS que vous avez créé dans Création d'un client.

Java

Pour plus de détails sur l'implémentation Java, veuillez consulter la méthode listAliases dans la Référence d'API AWS SDK for Java.


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

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

C#

Pour obtenir des détails, consultez la méthode ListAliases dans AWS SDK for .NET.


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

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

Python

Pour obtenir des détails, consultez la méthode list_aliases dans AWS SDK for Python (Boto3).


# List the aliases in this Compte AWS

response = kms_client.list_aliases(
    Limit=10
)

Ruby

Pour obtenir des détails, consultez la méthode d'instance list_aliases dans le kit AWS SDK for Ruby.


# List the aliases in this Compte AWS

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

PHP

Pour obtenir des détails, consultez la méthode List Aliases dans le kit AWS SDK for PHP.


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

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

Node.js

Pour plus de détails, consultez la propriété ListAliases dans AWS le SDK pour Node.js. JavaScript


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

PowerShell

Pour répertorier les alias du compte et de la région, utilisez l'applet de commande AliasListGet-KMS.

Pour limiter le nombre d'objets en sortie, cet exemple utilise l'applet de commande Select-Object au lieu du paramètre Limit, obsolète dans cette applet de commande. Pour obtenir de l'aide sur la pagination de sortie dans AWS Tools for PowerShell, veuillez consulter le billet de blog Output Pagination with AWS Tools for PowerShell.


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

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

Pour répertorier uniquement les alias associés à une clé KMS spécifique, utilisez le paramètre KeyId. Sa valeur peut être l'ID de clé ou l'ARN de clé de n'importe quelle clé KMS dans la région. Vous ne pouvez pas spécifier de nom d'alias ou d'ARN d'alias.

Java

Pour plus de détails sur l'implémentation Java, veuillez consulter la méthode listAliases dans la Référence d'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#

Pour obtenir des détails, consultez la méthode ListAliases dans 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

Pour obtenir des détails, consultez la méthode list_aliases dans 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

Pour obtenir des détails, consultez la méthode d'instance list_aliases dans le kit 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

Pour obtenir des détails, consultez la méthode List Aliases dans le kit 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

Pour plus de détails, consultez la propriété ListAliases dans AWS le SDK pour Node.js. JavaScript


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

Pour répertorier les alias d'une clé KMS, utilisez le KeyId paramètre de l'applet de commande 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

Mise à jour d'un alias

Pour associer un alias existant à une autre clé KMS, utilisez l'UpdateAliasopération.

Dans les langues qui nécessitent un objet client, ces exemples utilisent l'objet client AWS KMS que vous avez créé dans Création d'un client.

Java

Pour plus de détails sur l'implémentation Java, veuillez consulter la méthode updateAlias dans la Référence d'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#

Pour obtenir des détails, consultez la méthode UpdateAlias dans 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

Pour obtenir des détails, consultez la méthode update_alias dans 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

Pour obtenir des détails, consultez la méthode d'instance update_alias dans le kit 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

Pour obtenir des détails, consultez la méthode UpdateAlias dans 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

Pour plus de détails, consultez la propriété UpdateAlias dans AWSle SDK JavaScript pour 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

Pour modifier la clé KMS associée à un alias, utilisez l'applet de commande Update-KMSAlias. Le nom de l'alias est sensible à la casse.

L'applet de commande Update-KMSAlias ne renvoie aucune sortie. Pour vérifier que la commande a fonctionné, utilisez l'applet de commande 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

Suppression d'un alias

Pour supprimer un alias, utilisez l'DeleteAliasopération. La suppression d'un alias n'a aucun effet sur la clé KMS associée.

Dans les langues qui nécessitent un objet client, ces exemples utilisent l'objet client AWS KMS que vous avez créé dans Création d'un client.

Java

Pour obtenir des détails, veuillez consulter la méthode deleteAlias dans la Référence d'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#

Pour obtenir des détails, consultez la méthode DeleteAlias dans 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

Pour obtenir des détails, consultez la méthode delete_alias dans 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

Pour obtenir des détails, consultez la méthode d'instance delete_alias dans le kit AWS SDK for Ruby.


# Delete an alias for a KMS key

alias_name = 'alias/projectKey1'

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

PHP

Pour obtenir des détails, consultez la méthode DeleteAlias dans AWS SDK for PHP.


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

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

Node.js

Pour plus de détails, consultez la propriété DeleteAlias (propriété) dans AWSle SDK JavaScript pour Node.js.


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

PowerShell

Pour supprimer un alias, utilisez l'applet de commande Remove-KMSAlias. Le nom de l'alias est sensible à la casse.

Comme cette applet de commande supprime définitivement l'alias, elle vous PowerShell invite à confirmer la commande. Le paramètre ConfirmImpact étant défini sur High, vous ne pouvez pas utiliser ConfirmPreference pour supprimer cette invite. Si vous devez supprimer l'invite de confirmation, ajoutez le paramètre Confirm courant avec la valeur $false, par exemple : -Confirm:$false.

L' applet de commande Remove-KMSAlias ne renvoie aucune sortie. Pour vérifier l'efficacité de la commande, utilisez l'applet de commande Get-KMS AliasList.


# Delete an alias for a KMS key

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

Pour utiliser les AWS KMS PowerShell applets de commande, installez le fichier AWS.tools. KeyManagementServicemodule. Pour de plus amples informations, veuillez consulter le Guide de l'utilisateur AWS Tools for Windows PowerShell.

Avertissement JavaScript est désactivé ou n'est pas disponible dans votre navigateur.

Pour que vous puissiez utiliser la documentation AWS, Javascript doit être activé. Vous trouverez des instructions sur les pages d'aide de votre navigateur.

Conventions de rédaction

Utilisation de clés

Chiffrement et déchiffrement des clés de données