Trabalhar com aliases - AWS Key Management Service

Trabalhar com aliases

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

Criar um alias

Quando você cria uma AWS KMS key no AWS Management Console, é necessário criar um alias para ela. No entanto, a operação CreateKey que cria uma chave do KMS 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. Você não pode criar um alias que comece com aws/. O prefixo aws/ é reservado pela Amazon Web Services para Chaves gerenciadas pela 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 na Referência de APIs do 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 obter detalhes, consulte o Método CreateAlias no 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 obter detalhes, consulte o Método create_alias no 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 obter detalhes, consulte o método de instância create_alias no 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 obter detalhes, consulte o Método CreateAlias no 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 obter mais detalhes, consulte a propriedade createAlias no AWS SDK for 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

Para criar um alias, use o cmdlet New-KMSAlias. O nome do alias diferencia maiúsculas de 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 os cmdlets do PowerShell AWS KMS, instale o módulo AWS.Tools.KeyManagementService. Para obter mais informações, consulte o Manual do usuário do AWS Tools for 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. Isso inclui aliases que você criou e associou às suas chaves gerenciadas pelo cliente e aliases que a AWS criou e associou às suas Chaves gerenciadas pela AWS. A resposta também pode incluir aliases sem campo TargetKeyId. Estes são aliases predefinidos criados pela AWS, mas que ainda não estão associados a uma chave do KMS.

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 na Referência de APIs do AWS SDK for Java.

// List the aliases in this Conta da AWS // 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 for .NET.

// List the aliases in this Conta da AWS // 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 for Python (Boto3).

# List the aliases in this Conta da AWS response = kms_client.list_aliases( Limit=10 )
Ruby

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

# List the aliases in this Conta da AWS response = kmsClient.list_aliases({ limit: 10 })
PHP

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

// List the aliases in this Conta da AWS // $limit = 10; $result = $KmsClient->listAliases([ 'Limit' => $limit, ]);
Node.js

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

// List the aliases in this Conta da AWS // 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 for PowerShell, consulte Paginação de saída com o AWS Tools for PowerShell.

# List the aliases in this Conta da AWS $limit = 10 $result = Get-KMSAliasList | Select-Object -First $limit

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

Para relacionar apenas os aliases que estão associados a uma determinada chave do KMS, use o parâmetro KeyId. Seu valor pode ser o ID da chave ou i ARN de chave de qualquer chave do KMS na região. Você não pode especificar um nome de alias ou ARN de alias.

Java

Para obter detalhes sobre a implementação de Java, consulte o Método listAliases na Referência de APIs do 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 obter detalhes, consulte o Método ListAliases no 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 obter detalhes, consulte o Método list_aliases no 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 obter detalhes, consulte o método de instância list_aliases no 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 obter detalhes, consulte o Método List Aliases no 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 obter mais detalhes, consulte a propriedade listAliases no AWS SDK for 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

Para listar os aliases de uma chave do KMS, use o parâmetro KeyId do cmdlet Get-KMSAliasList.

# 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 os cmdlets do PowerShell AWS KMS, instale o módulo AWS.Tools.KeyManagementService. Para obter mais informações, consulte o Manual do usuário do AWS Tools for Windows PowerShell.

Atualizar um alias

Para associar um alias existente a uma chave do KMS diferente, use a operação UpdateAlias.

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 Referência de APIs do 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 obter detalhes, consulte o Método UpdateAlias no 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 obter detalhes, consulte o Método update_alias no 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 obter detalhes, consulte o método de instância update_alias no 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 obter detalhes, consulte o Método UpdateAlias no 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 obter mais detalhes, consulte a propriedade updateAlias no AWS SDK for 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

Para alterar a chave do KMS associada a um alias, use o cmdlet Update-KMSAlias. 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' # 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 os cmdlets do PowerShell AWS KMS, instale o módulo AWS.Tools.KeyManagementService. Para obter mais informações, consulte o Manual do usuário do AWS Tools for Windows PowerShell.

Excluir um alias

Para excluir um alias, use a operação DeleteAlias. A exclusão de um alias não afeta a chave do KMS associada.

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, na Referência de APIs do 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 obter detalhes, consulte o Método DeleteAlias no 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 obter detalhes, consulte o Método delete_alias no 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 obter detalhes, consulte o método de instância delete_alias no 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 obter detalhes, consulte o Método DeleteAlias no AWS SDK for PHP.

// Delete an alias for a KMS key // $aliasName = "alias/projectKey1"; $result = $KmsClient->deleteAlias([ 'AliasName' => $aliasName, ]);
Node.js

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

// Delete an alias for a KMS key // 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 for necessário suprimir o prompt de confirmação, adicione o parâmetro Confirm comum com um valor $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 KMS key $aliasName = 'alias/projectKey1' Remove-KMSAlias -AliasName $aliasName

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