별칭으로 작업

이 주제의 예제들은 AWS KMS API를 사용하여 별칭을 생성, 확인, 업데이트 및 삭제합니다. 별칭에 대한 자세한 내용은 별칭 사용 단원을 참조하십시오.

별칭 생성

AWS Management Console에서 AWS KMS key를 만들 때 별칭을 만들어야 합니다. 하지만 KMS 키를 생성하는 CreateKey작업에서는 별칭이 생성되지 않습니다.

별칭을 생성하려면 작업을 사용하십시오. CreateAlias 별칭은 계정 및 리전 내에서 고유해야 합니다. aws/로 시작하는 별칭을 생성할 수 없습니다. aws/ 접두사는 Amazon Web Services 에서 AWS 관리형 키용으로 예약되어 있습니다.

클라이언트 객체가 필요한 언어의 경우 이러한 예제에서는 클라이언트 만들기에서 생성한 AWS KMS 클라이언트 객체를 사용합니다.

Java

자세한 내용은 AWS SDK for Java API 참조의 createAlias 메서드를 참조하십시오.

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

자세한 내용은 AWS SDK for .NET의 CreateAlias 메서드를 참조하세요.

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

자세한 내용은 AWS SDK for Python (Boto3)의 create_alias 메서드를 참조하세요.

# 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

자세한 내용은 AWS SDK for Ruby의 create_alias 인스턴스 메서드를 참조하세요.

# 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

자세한 내용은 AWS SDK for PHP의 CreateAlias 메서드를 참조하세요.

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

자세한 내용은 Node.js 용 SDK의 CreateAlias 속성을 참조하십시오. AWS 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

별칭을 만들려면 New-KMSAlias cmdlet를 사용합니다. 별칭 이름은 대/소문자를 구분합니다.

# 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

AWS KMS PowerShell cmdlet을 사용하려면 AWS.tools를 설치하십시오. KeyManagementService모듈. 자세한 정보는 AWS Tools for Windows PowerShell 사용 설명서를 참조하세요.

별칭 나열

계정 및 지역의 별칭을 나열하려면 ListAliases작업을 사용하십시오.

기본적으로 ListAliases 명령은 계정 및 리전의 별칭을 모두 반환합니다. 여기에는 고객 관리 키와 연결하고 생성한 별칭과 AWS가 생성하고 AWS 관리형 키와 연결한 별칭이 포함됩니다. 응답에는 TargetKeyId 필드가 없는 별칭도 포함될 수 있습니다. 이러한 별칭은 미리 정의된 별칭으로, AWS에서 생성했지만 아직 KMS 키와 연결되지 않은 별칭입니다.

클라이언트 객체가 필요한 언어의 경우 이러한 예제에서는 클라이언트 만들기에서 생성한 AWS KMS 클라이언트 객체를 사용합니다.

Java

Java 구현에 대한 자세한 내용은 AWS SDK for Java API 참조의 listAliases 메서드를 참조하십시오.

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

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

C#

자세한 내용은 AWS SDK for .NET의 ListAliases 메서드를 참조하세요.

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

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

Python

자세한 내용은 AWS SDK for Python (Boto3)의 list_aliases 메서드를 참조하세요.

# List the aliases in this AWS 계정

response = kms_client.list_aliases(
    Limit=10
)

Ruby

자세한 내용은 AWS SDK for Ruby의 list_aliases 인스턴스 메서드를 참조하세요.

# List the aliases in this AWS 계정

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

PHP

자세한 내용은 AWS SDK for PHP의 List Aliases 메서드를 참조하십시오.

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

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

Node.js

자세한 내용은 Node.js 용 JavaScript SDK의 ListAliases 속성을 참조하십시오. AWS

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

PowerShell

계정 및 지역의 별칭을 나열하려면 Get-KMS cmdlet을 사용하십시오. AliasList

출력 개체 수를 제한하기 위해 이 예에서는 목록 cmdlet에서 더 이상 사용되지 않는 Limit 파라미터 대신 Select-Object cmdlet을 사용합니다. AWS Tools for PowerShell의 출력 페이지 매김에 대한 도움말은 AWS Tools for PowerShell를 사용하여 출력 페이지 매김을 참조하십시오.

# List the aliases in this AWS 계정
$limit = 10

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

cmdlet을 사용하려면 AWS.tools를 설치하십시오. AWS KMS PowerShell KeyManagementService모듈. 자세한 정보는 AWS Tools for Windows PowerShell 사용 설명서를 참조하세요.

특정 KMS 키와 연결된 별칭만 나열하려면 KeyId 파라미터를 사용합니다. 값은 리전 내 KMS 키의 키 ID이거나 키 ARN일 수 있습니다. 별칭 이름이나 별칭 ARN을 지정할 수 없습니다.

Java

Java 구현에 대한 자세한 내용은 AWS SDK for Java API 참조의 listAliases 메서드를 참조하십시오.

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

자세한 내용은 AWS SDK for .NET의 ListAliases 메서드를 참조하세요.

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

자세한 내용은 AWS SDK for Python (Boto3)의 list_aliases 메서드를 참조하세요.

# 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

자세한 내용은 AWS SDK for Ruby의 list_aliases 인스턴스 메서드를 참조하세요.

# 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

자세한 내용은 AWS SDK for PHP의 List Aliases 메서드를 참조하십시오.

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

자세한 내용은 Node.js 용 JavaScript SDK의 ListAliases 속성을 참조하십시오. AWS

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

KMS 키의 별칭을 나열하려면 Get-KMS cmdlet의 KeyId 매개 변수를 사용하십시오. 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

cmdlet을 사용하려면 AWS.tools를 설치하십시오. AWS KMS PowerShell KeyManagementService모듈. 자세한 정보는 AWS Tools for Windows PowerShell 사용 설명서를 참조하세요.

별칭 업데이트

기존 별칭을 다른 KMS 키와 연결하려면 작업을 사용하십시오. UpdateAlias

클라이언트 객체가 필요한 언어의 경우 이러한 예제에서는 클라이언트 만들기에서 생성한 AWS KMS 클라이언트 객체를 사용합니다.

Java

Java 구현에 대한 자세한 내용은 AWS SDK for Java API 참조의 updateAlias 메서드를 참조하십시오.

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

자세한 내용은 AWS SDK for .NET의 UpdateAlias 메서드를 참조하세요.

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

자세한 내용은 AWS SDK for Python (Boto3)의 update_alias 메서드를 참조하세요.

# 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

자세한 내용은 AWS SDK for Ruby의 update_alias 인스턴스 메서드를 참조하세요.

# 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

자세한 내용은 AWS SDK for PHP의 UpdateAlias 메서드를 참조하세요.

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

자세한 내용은 Node.js 용 SDK의 UpdateAlias 속성을 참조하십시오. AWS 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

별칭과 연동되어 있는 KMS 키를 변경하려면 KMSAliasalias cmdlet를 사용합니다. 별칭 이름은 대/소문자를 구분합니다.

Update-KMSAlias cmdlet는 출력을 반환하지 않습니다. 명령이 제대로 실행되었는지 확인하려면 Get-KMS cmdlet을 사용하십시오. 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

AWS KMS PowerShell cmdlet을 사용하려면 AWS.tools를 설치하십시오. KeyManagementService모듈. 자세한 정보는 AWS Tools for Windows PowerShell 사용 설명서를 참조하세요.

별칭 삭제

별칭을 삭제하려면 DeleteAlias작업을 사용하십시오. 별칭을 삭제해도 연결된 KMS 키에 영향을 미치지 않습니다.

클라이언트 객체가 필요한 언어의 경우 이러한 예제에서는 클라이언트 만들기에서 생성한 AWS KMS 클라이언트 객체를 사용합니다.

Java

자세한 내용은 AWS SDK for Java API 참조의 deleteAlias 메서드를 참조하십시오.

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

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

C#

자세한 내용은 AWS SDK for .NET의 DeleteAlias 메서드를 참조하세요.

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

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

Python

자세한 내용은 AWS SDK for Python (Boto3)의 delete_alias 메서드를 참조하세요.

# Delete an alias for a KMS key

alias_name = 'alias/projectKey1'

response = kms_client.delete_alias(
    AliasName=alias_name
)

Ruby

자세한 내용은 AWS SDK for Ruby의 delete_alias 인스턴스 메서드를 참조하세요.

# Delete an alias for a KMS key

alias_name = 'alias/projectKey1'

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

PHP

자세한 내용은 AWS SDK for PHP의 DeleteAlias 메서드를 참조하세요.

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

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

Node.js

자세한 내용은 Node.js 용 SDK의 DeleteAlias 속성) 을 참조하십시오. AWS JavaScript

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

PowerShell

별칭을 삭제하려면 Remove-KMSAlias cmdlet를 사용합니다. 별칭 이름은 대/소문자를 구분합니다.

이 cmdlet은 별칭을 영구적으로 삭제하므로 명령을 확인하라는 메시지가 표시됩니다. PowerShell ConfirmImpact가 High이므로 ConfirmPreference를 사용하여 이 프롬프트를 숨길 수 없습니다. 확인 프롬프트를 숨겨야 하는 경우 값이 $false인 Confirm 공통 파라미터를 추가합니다(예: -Confirm:$false).

Remove-KMSAlias cmdlet는 출력을 반환하지 않습니다. 명령이 효과적인지 확인하려면 Get-KMS cmdlet을 사용하십시오. AliasList

# Delete an alias for a KMS key

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

AWS KMS PowerShell cmdlet을 사용하려면 AWS.tools를 설치하십시오. KeyManagementService모듈. 자세한 내용은 AWS Tools for Windows PowerShell 사용 설명서를 참조하세요.