Crear un alias Mostrar alias Actualizar un alias Eliminar un alias

Trabajar con alias

Los ejemplos de este tema utilizan la API de AWS KMS para crear, ver, actualizar y eliminar alias. Para obtener información acerca de los alias, consulte Uso de alias.

Temas

Crear un alias
Mostrar alias
Actualizar un alias
Eliminar un alias

Crear un alias

Al crear un AWS KMS key en la AWS Management Console, debe crear un alias para ello. Sin embargo, la CreateKeyoperación que crea una clave KMS no crea un alias.

Para crear un alias, utilice la CreateAliasoperación. El alias debe ser único en la cuenta y en la región de . No puede crear un alias que comience por aws/. El prefijo aws/ está reservado por Amazon Web Services para Claves administradas por AWS.

En los idiomas que requieren un objeto cliente, estos ejemplos usan el objeto cliente de AWS KMS que ha creado en Crear un cliente.

Java

Para conocer detalles, consulte el método createAlias en la Referencia de la API de 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#

Para obtener más información, consulte el método CreateAlias en 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

Para obtener más información, consulte el método create_alias en 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

Para obtener más información, consulte el método de instancia create_alias en 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

Para obtener más información, consulte el método CreateAlias en 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

Para obtener más información, consulta la propiedad CreateAlias en AWSel SDK JavaScript o en 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

Para crear un alias, utilice el cmdlet New-KMSalias. El nombre del alias distingue entre mayúsculas y minúsculas.


# 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

Para usar los AWS KMS PowerShell cmdlets, instale AWS.Tools. KeyManagementServicemódulo. Para obtener más información, consulte la AWS Tools for Windows PowerShellGuía del usuario de .

Mostrar alias

Para enumerar los alias de la cuenta y la región, utilice la ListAliasesoperación.

De forma predeterminada, el comando ListAliases devuelve todos los alias de la cuenta y la región. Esto incluye los alias que ha creado y asociado a las claves administradas por el cliente y los alias que AWS creó y asoció con su Claves administradas por AWS. La respuesta también podría incluir los alias que no tienen el campo TargetKeyId. Estos son los alias predefinidos que AWS ha creado, pero aún no se han asociado con una clave KMS.

En los idiomas que requieren un objeto cliente, estos ejemplos usan el objeto cliente de AWS KMS que ha creado en Crear un cliente.

Java

Para obtener más detalles sobre la implementación de Java, consulte el método listAliases en la Referencia de la API de AWS SDK for Java.


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

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

C#

Para obtener más información, consulte el método ListAliases en AWS SDK for .NET.


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

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

Python

Para obtener más información, consulte el método list_aliases en AWS SDK for Python (Boto3).


# List the aliases in this Cuenta de AWS

response = kms_client.list_aliases(
    Limit=10
)

Ruby

Para obtener más información, consulte el método de instancia list_aliases en AWS SDK for Ruby.


# List the aliases in this Cuenta de AWS

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

PHP

Para obtener más información, consulte el método List Aliases en el AWS SDK for PHP.


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

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

Node.js

Para obtener más información, consulta la propiedad ListAliases en AWSel SDK JavaScript o en Node.js.


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

PowerShell

Para ver una lista de los alias de la cuenta y la región, usa el cmdlet Get-KMS. AliasList

Para limitar el número de objetos de salida, este ejemplo usa el cmdlet Select-Object en lugar del parámetro Limit, que está quedando obsoleto en los cmdlet de la lista. Para obtener asistencia con la paginación de salida en AWS Tools for PowerShell, vea Paginación de salida con AWS Tools for PowerShell.


# List the aliases in this Cuenta de AWS
$limit = 10

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

Para usar los AWS KMS PowerShell cmdlets, instale AWS.Tools. KeyManagementServicemódulo. Para obtener más información, consulte la AWS Tools for Windows PowerShellGuía del usuario de .

Para mostrar solo los alias que están asociados con una determinada clave KMS en particular, utilice el parámetro KeyId. Su valor puede ser el ID de la clave o el ARN de la clave de cualquier clave KMS en la región. No puede especificar un nombre de alias o ARN de alias.

Java

Para obtener más detalles sobre la implementación de Java, consulte el método listAliases en la Referencia de la API de 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#

Para obtener más información, consulte el método ListAliases en 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

Para obtener más información, consulte el método list_aliases en 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

Para obtener más información, consulte el método de instancia list_aliases en 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

Para obtener más información, consulte el método List Aliases en el 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

Para obtener más información, consulta la propiedad ListAliases en AWSel SDK JavaScript o en 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

Para enumerar los alias de una clave KMS, utilice el KeyId parámetro del cmdlet Get-KMS. 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

Para usar los AWS KMS PowerShell cmdlets, instale AWS.Tools. KeyManagementServicemódulo. Para obtener más información, consulte la AWS Tools for Windows PowerShellGuía del usuario de .

Actualizar un alias

Para asociar un alias existente a una clave de KMS diferente, utilice la UpdateAliasoperación.

En los idiomas que requieren un objeto cliente, estos ejemplos usan el objeto cliente de AWS KMS que ha creado en Crear un cliente.

Java

Para obtener más detalles sobre la implementación de Java, consulte el método updateAlias en la Referencia de la API de 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#

Para obtener más información, consulte el método UpdateAlias en 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

Para obtener más información, consulte el método update_alias en 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

Para obtener más información, consulte el método de instancia update_alias en 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

Para obtener más información, consulte el método UpdateAlias en 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

Para obtener más información, consulta la propiedad UpdateAlias en AWSel SDK JavaScript o en 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

Para cambiar la clave KMS que está asociada a un alias, use el cmdlet Update-KMSAlias. El nombre del alias distingue entre mayúsculas y minúsculas.

El cmdlet Update-KMSAlias no devuelve ningún resultado. Para comprobar que el comando ha funcionado, utilice el cmdlet AliasListGet-KMS.


# 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

Para usar los AWS KMS PowerShell cmdlets, instale AWS.Tools. KeyManagementServicemódulo. Para obtener más información, consulte la AWS Tools for Windows PowerShellGuía del usuario de .

Eliminar un alias

Para eliminar un alias, utilice la DeleteAliasoperación. La eliminación de un alias no afecta a la clave KMS asociada.

En los idiomas que requieren un objeto cliente, estos ejemplos usan el objeto cliente de AWS KMS que ha creado en Crear un cliente.

Java

Para obtener más detalles, consulte el método deleteAlias en la Referencia de la API de 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#

Para obtener más información, consulte el método DeleteAlias en 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

Para obtener más información, consulte el método delete_alias en 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

Para obtener más información, consulte el método de instancia delete_alias en AWS SDK for Ruby.


# Delete an alias for a KMS key

alias_name = 'alias/projectKey1'

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

PHP

Para obtener más información, consulte el método DeleteAlias en AWS SDK for PHP.


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

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

Node.js

Para obtener más información, consulta la propiedad (deleteAlias) en AWSel SDK JavaScript o en Node.js.


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

PowerShell

Para eliminar un alias, utilice el cmdlet Remove-KMSalias. El nombre del alias distingue entre mayúsculas y minúsculas.

Como este cmdlet elimina el alias de forma permanente, PowerShell le pide que confirme el comando. El valor de ConfirmImpact es High, por lo que no se puede utilizar ConfirmPreference para suprimir esta solicitud. Si debe suprimir la solicitud de confirmación, agregue el parámetro común Confirm con el valor $false; por ejemplo: -Confirm:$false.

El cmdlet Remove-KMSAlias no devuelve ningún resultado. Para comprobar la eficacia del comando, utilice el cmdlet Get-KMS. AliasList


# Delete an alias for a KMS key

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

Para usar los AWS KMS PowerShell cmdlets, instale AWS.Tools. KeyManagementServicemódulo. Para obtener más información, consulte la Guía del usuario de AWS Tools for Windows PowerShell.

Aviso JavaScript está desactivado o no está disponible en su navegador.

Para utilizar la documentación de AWS, debe estar habilitado JavaScript. Para obtener más información, consulte las páginas de ayuda de su navegador.

Convenciones del documento

Trabajo con claves

Cifrar y descifrar claves de datos