Updating registry settings - Amazon ECR Public

Updating registry settings

Your public registry provides settings to configure a custom alias and display name.

By default, your public registry is assigned a default alias after your first public repository is created. You can request a custom alias for your registry, and if approved, both the default alias and custom alias can be used to access your public repositories. The registry display name appears on each repository in the Amazon ECR Public Gallery as well.

When requesting a custom alias, the following words or phrases should be avoided:

  • An alias that includes aws, amazon, or the name of an AWS service

  • An alias using a company name for which you do not have permission to use

  • Generic names, such as test, public, and marketplace

  • Offensive, inappropriate, or non-inclusive words and phrases

Required IAM permissions

When editing your Amazon ECR public registry settings to request a custom alias, the IAM principal must have permission to call the ecr-public:PutRegistryAlias API. This is a private API.


Setting a Display name for your Amazon ECR public registry doesn't require any additional permissions.

The following IAM policy can be added as an inline policy to the principal performing the public registry edit. Replace the example AWS account ID in this example with your own account ID.

{ "Version": "2012-10-17", "Statement": [ { "Effect": "Allow", "Action": "ecr-public:PutRegistryAlias", "Resource": "arn:aws:ecr-public::123456789012:registry/*" } ] }

Updating your registry settings

Use the following steps to edit your public registry settings.

To edit public registry settings (AWS Management Console)
  1. Open the Amazon ECR console at https://console.aws.amazon.com/ecr/.

  2. From the navigation bar, choose the Region to edit your public registry settings in.

  3. In the navigation pane, choose Registries.

  4. On the Registries page, select your Public registry and then choose Edit.

  5. For Custom alias, enter a custom alias to request.

  6. For Display name, enter a display name for your registry.

  7. Choose Save changes.