Criar um alias Listar aliases Atualizar um alias Excluir um alias

Trabalhar com aliases

Os exemplos neste tópico usam a API do AWS KMS para criar, visualizar, atualizar e excluir aliases. Para obter informações sobre pseudónimos, consulte Usar aliases.

Tópicos

Criar um alias
Listar aliases
Atualizar um alias
Excluir um alias

Criar um alias

Quando cria uma chave mestre de cliente (CMK) no Console de gerenciamento da AWS, é necessário criar um alias para ele. No entanto, o chave de crias operação que cria cenas não cria um alias.

Para criar um alias, use a operação CreateAlias. O alias deve ser exclusivo na conta e na região. Não pode criar um nome alternativo que comece com aws/. O aws/ prefixo está reservado por Amazon Web Services para Gestão de AWS.

Em linguagens que exigem um objeto cliente, esses exemplos usam o objeto cliente do AWS KMS criado em Criar um cliente.

Java

Para obter detalhes, consulte o Método createAlias no AWS SDK for Java API Reference.


// Create an alias for a CMK
//
String aliasName = "alias/projectKey1";
// Substitua o ARN de chave de exemplo a seguir por um ID de chave ou ARN de chave válido
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 obter detalhes, consulte o Método CreateAlias no AWS SDK para .NET.


// Create an alias for a CMK
//
String aliasName = "alias/projectKey1";
// Substitua o ARN de chave de exemplo a seguir por um ID de chave ou ARN de chave válido
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 obter detalhes, consulte o Método create_alias no AWS SDK para Python (Boto3).


# Create an alias for a CMK

alias_name = 'alias/projectKey1'
# Substitua o ARN de chave de exemplo a seguir por um ID de chave ou ARN de chave válido
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 obter detalhes, consulte o método de instância create_alias no AWS SDK para Ruby.


# Create an alias for a CMK

alias_name = 'alias/projectKey1'
# Substitua o ARN de chave de exemplo a seguir por um ID de chave ou ARN de chave válido
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 obter detalhes, consulte o Método CreateAlias no AWS SDK para PHP.


// Create an alias for a CMK
//
$aliasName = "alias/projectKey1";
// Substitua o ARN de chave de exemplo a seguir por um ID de chave ou ARN de chave válido
$keyId = 'arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab';


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

Node.js

Para obter detalhes, consulte a Propriedade createAlias no AWS SDK for JavaScript in Node.js.


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

// Substitua o ARN de chave de exemplo a seguir por um ID de chave ou ARN de chave válido
const TargetKeyId = 'arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab';
kmsClient.createAlias({ AliasName, TargetKeyId }, (err, data) => {
  ...
});

PowerShell

Para criar um alias, use o cmdlet New-KMSAlias. O nome do alias diferencia maiúsculas de minúsculas.


# Create an alias for a CMK

$aliasName = 'alias/projectKey1'
# Substitua o ARN de chave de exemplo a seguir por um ID de chave ou ARN de chave válido
$targetKeyId = 'arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab'

New-KMSAlias -TargetKeyId $targetKeyId -AliasName $aliasName

Para usar os cmdlets do AWS KMS PowerShell, instale o módulo AWS.Tools.KeyManagementService. Para obter mais informações, consulte o Guia do usuário do AWS Tools para Windows PowerShell.

Listar aliases

Para listar os aliases na conta e na região, use a operação ListAliases.

Por padrão, o comando ListAliases gera todos os aliases na conta e na região. Isto inclui pseudónimos que criou e associados ao seu gerido pelo cliente CMKse os pseudónimos que os AWS criaram e associados ao seu Gestão AWS CMKs. A resposta também pode incluir aliases sem campo TargetKeyId. Estes são alias predefinidas que a AWS criou mas ainda não está associada a uma CMK.

Em linguagens que exigem um objeto cliente, esses exemplos usam o objeto cliente do AWS KMS criado em Criar um cliente.

Java

Para obter detalhes sobre a implementação de Java, consulte o Método listAliases no AWS SDK for Java API Reference.


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

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

C#

Para obter detalhes, consulte o Método ListAliases no AWS SDK para .NET.


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

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

Python

Para obter detalhes, consulte o Método list_aliases no AWS SDK para Python (Boto3).


# List the aliases in this AWS account

response = kms_client.list_aliases(
    Limit=10
)

Ruby

Para obter detalhes, consulte o método de instância list_aliases no AWS SDK para Ruby.


# List the aliases in this AWS account

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

PHP

Para obter detalhes, consulte o Método List Aliases no AWS SDK para PHP.


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

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

Node.js

Para obter detalhes, consulte a Propriedade listAliases no AWS SDK for JavaScript in Node.js.


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

PowerShell

Para listar os aliases na conta e região, use o cmdlet Get-KMSAliasList.

Para limitar o número de objetos de saída, este exemplo usa o cmdlet Select-Object em vez do parâmetro Limit, que está defasado nos cmdlets da lista. Para obter ajuda com a saída da paginação no AWS Tools para PowerShell, consulte Paginação de saída com o AWS Tools para PowerShell.


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

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

Para usar os cmdlets do AWS KMS PowerShell, instale o módulo AWS.Tools.KeyManagementService. Para obter mais informações, consulte o Guia do usuário do AWS Tools para Windows PowerShell.

Para listar apenas os pseudónimos associados a um determinado CMK, utilize o KeyId parâmetro. O seu valor pode ser o ID chave ou chave ARN de qualquer CMK na região. Não é possível especificar um nome de alias ou um ARN de alias.

Java

Para obter detalhes sobre a implementação de Java, consulte o Método listAliases no AWS SDK for Java API Reference.


// List the aliases for one CMK
//
// Substitua o ARN de chave de exemplo a seguir por um ID de chave ou ARN de chave válido
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 obter detalhes, consulte o Método ListAliases no AWS SDK para .NET.


// List the aliases for one CMK
//
// Substitua o ARN de chave de exemplo a seguir por um ID de chave ou ARN de chave válido
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 obter detalhes, consulte o Método list_aliases no AWS SDK para Python (Boto3).


# List the aliases for one CMK

# Substitua o ARN de chave de exemplo a seguir por um ID de chave ou ARN de chave válido
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 obter detalhes, consulte o método de instância list_aliases no AWS SDK para Ruby.


# List the aliases for one CMK

# Substitua o ARN de chave de exemplo a seguir por um ID de chave ou ARN de chave válido
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 obter detalhes, consulte o Método List Aliases no AWS SDK para PHP.


// List the aliases for one CMK
//
// Substitua o ARN de chave de exemplo a seguir por um ID de chave ou ARN de chave válido
$keyId = 'arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab';

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

Node.js

Para obter detalhes, consulte a Propriedade listAliases no AWS SDK for JavaScript in Node.js.


// List the aliases for one CMK
//
// Substitua o ARN de chave de exemplo a seguir por um ID de chave ou ARN de chave válido
const KeyId = 'arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab';
kmsClient.listAliases({ KeyId }, (err, data) => {
  ...
});

PowerShell

Para enumerar os pseudónimos para um CMK, utilize o KeyId parâmetro do Obter-kmsaliaslist sem.


# List the aliases for one CMK

# Substitua o ARN de chave de exemplo a seguir por um ID de chave ou ARN de chave válido
$keyId = 'arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab'

$response = Get-KmsAliasList -KeyId $keyId

Para usar os cmdlets do AWS KMS PowerShell, instale o módulo AWS.Tools.KeyManagementService. Para obter mais informações, consulte o Guia do usuário do AWS Tools para Windows PowerShell.

Atualizar um alias

Para associar um pseudónimo existente com um CMK, utilize o paracritilizador operação.

Em linguagens que exigem um objeto cliente, esses exemplos usam o objeto cliente do AWS KMS criado em Criar um cliente.

Java

Para obter detalhes sobre a implementação de Java, consulte o Método updateAlias no AWS SDK for Java API Reference.


// Updating an alias
//
String aliasName = "alias/projectKey1";
// Substitua o ARN de chave de exemplo a seguir por um ID de chave ou ARN de chave válido
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 obter detalhes, consulte o Método UpdateAlias no AWS SDK para .NET.


// Updating an alias
//
String aliasName = "alias/projectKey1";
// Substitua o ARN de chave de exemplo a seguir por um ID de chave ou ARN de chave válido
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 obter detalhes, consulte o Método update_alias no AWS SDK para Python (Boto3).


# Updating an alias

alias_name = 'alias/projectKey1'
# Substitua o ARN de chave de exemplo a seguir por um ID de chave ou ARN de chave válido
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 obter detalhes, consulte o método de instância update_alias no AWS SDK para Ruby.


# Updating an alias

alias_name = 'alias/projectKey1'
# Substitua o ARN de chave de exemplo a seguir por um ID de chave ou ARN de chave válido
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 obter detalhes, consulte o Método UpdateAlias no AWS SDK para PHP.


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

// Substitua o ARN de chave de exemplo a seguir por um ID de chave ou ARN de chave válido
$keyId = 'arn:aws:kms:us-west-2:111122223333:key/0987dcba-09fe-87dc-65ba-ab0987654321';

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

Node.js

Para obter detalhes, consulte a Propriedade updateAlias no AWS SDK for JavaScript in Node.js.


// Updating an alias
//
const AliasName = 'alias/projectKey1';
 
// Substitua o ARN de chave de exemplo a seguir por um ID de chave ou ARN de chave válido
const TargetKeyId = 'arn:aws:kms:us-west-2:111122223333:key/0987dcba-09fe-87dc-65ba-ab0987654321';
kmsClient.updateAlias({ AliasName, TargetKeyId }, (err, data) => {
  ...
});

PowerShell

Para alterar o CMK que está associado a um pseudónimo, utilize o Atualizar-kmsalias sem. O nome do alias diferencia maiúsculas de minúsculas.

O cmdlet Update-KMSAlias não retorna nenhuma saída. Para verificar se o comando funcionou, use o cmdlet Get-KMSAliasList.


# Updating an alias

$aliasName = 'alias/projectKey1'
# Substitua o ARN de chave de exemplo a seguir por um ID de chave ou ARN de chave válido
$keyId = 'arn:aws:kms:us-west-2:111122223333:key/0987dcba-09fe-87dc-65ba-ab0987654321'

Update-KMSAlias -AliasName $aliasName -TargetKeyID $keyId

Para usar os cmdlets do AWS KMS PowerShell, instale o módulo AWS.Tools.KeyManagementService. Para obter mais informações, consulte o Guia do usuário do AWS Tools para Windows PowerShell.

Excluir um alias

Para excluir um alias, use a operação DeleteAlias. Eliminar um alias não tem qualquer efeito no CMK.

Em linguagens que exigem um objeto cliente, esses exemplos usam o objeto cliente do AWS KMS criado em Criar um cliente.

Java

Para obter detalhes, consulte o Método deleteAlias no AWS SDK for Java API Reference.


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

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

C#

Para obter detalhes, consulte o Método DeleteAlias no AWS SDK para .NET.


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

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

Python

Para obter detalhes, consulte o Método delete_alias no AWS SDK para Python (Boto3).


# Delete an alias for a CMK

alias_name = 'alias/projectKey1'

response = kms_client.delete_alias(
    AliasName=alias_name
)

Ruby

Para obter detalhes, consulte o método de instância delete_alias no AWS SDK para Ruby.


# Delete an alias for a CMK

alias_name = 'alias/projectKey1'

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

PHP

Para obter detalhes, consulte o Método DeleteAlias no AWS SDK para PHP.


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

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

Node.js

Para obter detalhes, consulte a Propriedade deleteAlias no AWS SDK for JavaScript in Node.js.


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

PowerShell

Para excluir um alias, use o cmdlet Remove-KMSAlias. O nome do alias diferencia maiúsculas de minúsculas.

Como esse cmdlet exclui permanentemente o alias, o PowerShell solicita que você confirme o comando. O ConfirmImpact é High, portanto, não é possível usar um ConfirmPreference para suprimir esse prompt. Se tiver de suprimir o prompt de confirmação, adicione o Confirm parâmetro comum com um valor de $false, por exemplo: -Confirm:$false.

O cmdlet Remove-KMSAlias não retorna nenhuma saída. Para verificar se o comando entrou em vigor, use o cmdlet Get-KMSAliasList.


# Delete an alias for a CMK

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

Para usar os cmdlets do AWS KMS PowerShell, instale o módulo AWS.Tools.KeyManagementService. Para obter mais informações, consulte o Guia do usuário do AWS Tools para Windows PowerShell.

Atenção O Javascript está desativado ou não está disponível no seu navegador.

Para usar a documentação da AWS, o Javascript deve estar ativado. Consulte as páginas de Ajuda do navegador para obter instruções.

Convenções do documento

Trabalhar com chaves

Criptografar e descriptografar chaves de dados