Skip to main content

aliases

Retrieves a list of aliases in a region

Overview

Namealiases
TypeResource
Descriptionaliases
Idawscc.kms.aliases

Fields

NameDatatypeDescription
alias_namestringSpecifies the alias name. This value must begin with ``alias/`` followed by a name, such as ``alias/ExampleAlias``. <br/> If you change the value of the ``AliasName`` property, the existing alias is deleted and a new alias is created for the specified KMS key. This change can disrupt applications that use the alias. It can also allow or deny access to a KMS key affected by attribute-based access control (ABAC).<br/> The alias must be string of 1-256 characters. It can contain only alphanumeric characters, forward slashes (/), underscores (_), and dashes (-). The alias name cannot begin with ``alias/aws/``. The ``alias/aws/`` prefix is reserved for [](https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#aws-managed-cmk).
regionstringAWS region.

Methods

Currently only SELECT is supported for this resource resource.

Example

SELECT
region,
alias_name
FROM awscc.kms.aliases
WHERE region = 'us-east-1'

Permissions

To operate on the aliases resource, the following permissions are required:

Create

kms:CreateAlias

List

kms:ListAliases