CodeArtifact のドメイン名の命名ルールについて教えてください

2022.10.23

この記事は公開されてから1年以上経過しています。情報が古い可能性がありますので、ご注意ください。

困っていた内容

CodeArtifact のドメイン名の命名をする際に、将来的なことを考えて、どのように命名するべきか思案しています。

慣習的にどのような命名が望ましいか、DNS のドメイン名を基にした名前にするか否かなど、お伺いしたいです。

どう対応すればいいの?

CodeArtifact のドメインについて、ご質問をいただきました。

ドキュメントには、以下の記述があります。[1]

ひとつの組織が複数のドメインを使用することもできますが、開発チームが組織中でパッケージを見つけて共有できるように、公開されたアーティファクトをすべて含む 1 つの本稼働ドメインを使用することをお勧めします。二つ目の運用前ドメインがあれば、本稼働ドメイン設定の変更をテストするのに便利です。

マネジメントコンソールの画面には、次の説明が記載されていました。[2]

ドメイン名には通常、会社名が含まれます。 先頭は小文字の英字にする必要があります。小文字の英数字またはダッシュ (-) を含めることができます。

上記を参考に、ドメイン名をご指定ください。

会社名や組織名の小文字表記、もしくはそれらの略称などをお使いいただくことが多いと考えられます。

DNS のドメイン名とは、直接の関係はありませんので、同じにすることも、別にすることも可能です。

なお「.」(ドット)を含めることはできません。[2]

参考資料

[1] ドメインの概要 - CodeArtifact

[2] CodeArtifact - AWS Developer Tools

[3] AWS CodeArtifact でプライベートリポジトリを作ろう - Qiita

またドメインはクロスアカウントで利用可能です。組織の共通ドメインを作成し、各アカウントで独自のリポジトリを利用することができます。

[4] 弊社で使っているAWSリソースの命名規則を紹介します | DevelopersIO