Creazione di un alias Elenco degli alias Aggiornamento di un alias Eliminazione di un alias

Utilizzo degli alias

Gli esempi in questo argomento utilizzano l'API AWS KMS per creare, visualizzare, aggiornare ed eliminare gli alias. Per ulteriori informazioni sugli alias, consulta Utilizzo di alias.

Argomenti

Creazione di un alias
Elenco degli alias
Aggiornamento di un alias
Eliminazione di un alias

Creazione di un alias

Quando si crea una AWS KMS key nella AWS Management Console, devi creare un alias. Tuttavia, l'CreateKeyoperazione che crea una chiave KMS non crea un alias.

Per creare un alias, usa l'operazione. CreateAlias L'alias deve essere univoco nell'account e nella regione. Non è possibile creare un alias che inizia con aws/. Il prefisso aws/ viene riservato da Amazon Web Services alle Chiavi gestite da AWS.

Nelle lingue che richiedono un oggetto client, questi esempi utilizzano l'oggetto client AWS KMS creato in Creazione di un client.

Java

Per ulteriori informazioni, consulta il metodo createAlias nella Documentazione di riferimento dell'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#

Per maggiori dettagli, consultare il metodo CreateAlias in 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

Per maggiori dettagli, consultare il metodo create_alias in 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

Per maggiori dettagli, consultare il metodo dell'istanza create_alias in 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

Per maggiori dettagli, consultare il metodo CreateAlias in 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

Per i dettagli, vedete la proprietà CreateAlias nell'SDK per in AWS Node.js. JavaScript


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

Per creare un alias, utilizzare il cmdlet New-KMSalias. Il nome alias fa distinzione tra maiuscole e minuscole.


# 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

Per utilizzare i AWS KMS PowerShell cmdlet, installa AWS.Tools. KeyManagementServicemodulo. Per ulteriori informazioni, consulta la AWS Tools for Windows PowerShellGuida per l'utente.

Elenco degli alias

Per elencare gli alias nell'account e nella regione, usa l'ListAliasesoperazione.

Per impostazione predefinita, il comando ListAliases restituisce tutti gli alias nell'account e nella regione. Sono inclusi gli alias creati e associati alle chiavi gestite dal cliente e gli alias creati da AWS e associati alle tue Chiavi gestite da AWS. La risposta potrebbe anche includere alias che non hanno alcun campo TargetKeyId. Questi sono alias predefiniti che AWS ha creato, ma che non ha ancora associato a una chiave KMS.

Nelle lingue che richiedono un oggetto client, questi esempi utilizzano l'oggetto client AWS KMS creato in Creazione di un client.

Java

Per ulteriori informazioni sull'implementazione Java, consulta il metodo listAliases nella Documentazione di riferimento dell'API AWS SDK for Java.


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

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

C#

Per maggiori dettagli, consultare il metodo ListAliases in AWS SDK for .NET.


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

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

Python

Per maggiori dettagli, consultare il metodo list_aliases in AWS SDK for Python (Boto3).


# List the aliases in this Account AWS

response = kms_client.list_aliases(
    Limit=10
)

Ruby

Per maggiori dettagli, consultare il metodo dell'istanza list_aliases in AWS SDK for Ruby.


# List the aliases in this Account AWS

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

PHP

Per ulteriori informazioni, consulta il metodo List Aliases nella AWS SDK for PHP.


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

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

Node.js

Per i dettagli, vedete la proprietà ListAliases nell'SDK JavaScript per in AWS Node.js.


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

PowerShell

Per elencare gli alias nell'account e nella regione, utilizzare il cmdlet Get-KMS. AliasList

Per limitare il numero di oggetti di output, in questo esempio viene utilizzato il cmdlet Select-Object anziché il parametro Limit, che viene considerato obsoleto nei cmdlet list. Per informazioni sull'impaginazione dell'output in AWS Tools for PowerShell, consulta Paginazione output con AWS Tools for PowerShell.


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

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

Per utilizzare i cmdlet, installa AWS.Tools. AWS KMS PowerShell KeyManagementServicemodulo. Per ulteriori informazioni, consulta la AWS Tools for Windows PowerShellGuida per l'utente.

Per elencare solo gli alias associati a una determinata chiave KMS, utilizza il parametro KeyId. Il valore può essere l'ID chiave o l'ARN chiave di qualsiasi chiave KMS nella Regione. Non è possibile specificare un nome dell'alias o un ARN dell'alias.

Java

Per ulteriori informazioni sull'implementazione Java, consulta il metodo listAliases nella Documentazione di riferimento dell'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#

Per maggiori dettagli, consultare il metodo ListAliases in 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

Per maggiori dettagli, consultare il metodo list_aliases in 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

Per maggiori dettagli, consultare il metodo dell'istanza list_aliases in 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

Per ulteriori informazioni, consulta il metodo List Aliases nella 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

Per i dettagli, vedete la proprietà ListAliases nell'SDK JavaScript per in AWS 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

Per elencare gli alias per una chiave KMS, utilizzare il KeyId parametro 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

Per utilizzare i cmdlet, installa AWS.Tools. AWS KMS PowerShell KeyManagementServicemodulo. Per ulteriori informazioni, consulta la AWS Tools for Windows PowerShellGuida per l'utente.

Aggiornamento di un alias

Per associare un alias esistente a una chiave KMS diversa, usa l'UpdateAliasoperazione.

Nelle lingue che richiedono un oggetto client, questi esempi utilizzano l'oggetto client AWS KMS creato in Creazione di un client.

Java

Per ulteriori informazioni sull'implementazione Java, consulta il metodo updateAlias nella Documentazione di riferimento dell'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#

Per maggiori dettagli, consultare il metodo UpdateAlias in 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

Per maggiori dettagli, consultare il metodo update_alias in 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

Per maggiori dettagli, consultare il metodo dell'istanza update_alias in 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

Per maggiori dettagli, consultare il metodo UpdateAlias in 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

Per i dettagli, vedete la proprietà UpdateAlias nell'SDK per in AWS Node.js. JavaScript


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

Per modificare la chiave KMS associata a un alias utilizza il cmdlet Update-KMSAlias. Il nome alias fa distinzione tra maiuscole e minuscole.

Il cmdlet Update-KMSAlias non restituisce alcun output. Per verificare che il comando abbia funzionato, utilizzare il cmdlet 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

Per utilizzare i AWS KMS PowerShell cmdlet, installa AWS.Tools. KeyManagementServicemodulo. Per ulteriori informazioni, consulta la AWS Tools for Windows PowerShellGuida per l'utente.

Eliminazione di un alias

Per eliminare un alias, usa l'DeleteAliasoperazione. L'eliminazione di un alias non ha alcun effetto sulla chiave KMS associata.

Nelle lingue che richiedono un oggetto client, questi esempi utilizzano l'oggetto client AWS KMS creato in Creazione di un client.

Java

Per ulteriori informazioni, consulta il metodo deleteAlias nella Documentazione di riferimento dell'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#

Per maggiori dettagli, consultare il metodo DeleteAlias in 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

Per maggiori dettagli, consultare il metodo delete_alias in 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

Per maggiori dettagli, consultare il metodo dell'istanza delete_alias in AWS SDK for Ruby.


# Delete an alias for a KMS key

alias_name = 'alias/projectKey1'

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

PHP

Per maggiori dettagli, consultare il metodo DeleteAlias in AWS SDK for PHP.


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

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

Node.js

Per i dettagli, vedete la proprietà deleteAlias) nell'SDK per in AWS Node.js. JavaScript


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

PowerShell

Per eliminare un alias, utilizzare il cmdlet Remove-KMSAlias. Il nome alias fa distinzione tra maiuscole e minuscole.

Poiché questo cmdlet elimina definitivamente l'alias, richiede di confermare il comando. PowerShell ConfirmImpact è High, quindi non è possibile utilizzare ConfirmPreference per annullare questo prompt. Se è necessario annullare il prompt di conferma, aggiungere il parametro comune Confirm con un valore $false, ad esempio: -Confirm:$false.

Il cmdlet Remove-KMSAlias non restituisce alcun output. Per verificare l'efficacia del comando, utilizzare il cmdlet Get-KMS. AliasList


# Delete an alias for a KMS key

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

Per utilizzare i AWS KMS PowerShell cmdlet, installa AWS.Tools. KeyManagementServicemodulo. Per ulteriori informazioni, consulta la Guida per l'utente AWS Tools for Windows PowerShell.

Avvertimento JavaScript è disabilitato o non è disponibile nel tuo browser.

Per usare la documentazione AWS, JavaScript deve essere abilitato. Consulta le pagine della guida del browser per le istruzioni.

Convenzioni dei documenti

Utilizzo delle chiavi

Crittografia e decrittografia delle chiavi di dati