コンテンツにスキップ

ドメイン

Load Balanced Web Service

Copilot では、Load Balanced Web Service にカスタムドメインを使用する方法が 2 つあります。

  1. アプリケーション作成時に --domain を使用すると、同じアカウントで Route 53 ドメインを関連付けることができます。
  2. Environment Manifest の http.[public/private].certificates フィールドを使用して、検証済みの ACM 証明書を Environment にインポートします。

Attention

現時点では、 copilot app init を実行した時のみに Route 53　ドメインが関連づけられます。 Application のドメインをアップデートしたい場合 (#3045) 、新しいドメインを関連付けるために --domain を使用して新しい Application を作成する前に、copilot app delete を実行して古い Application を削除する必要があります。

Load Balanced Web Service

Applicationで説明したように、 copilot app init を実行するときに Application のドメイン名を設定できます。 Load Balanced Web Service をデプロイすると以下のようなドメイン名を使ってアクセスできるようになります。

Application に関連するルートドメインを使用する

Applicationで説明したように、 copilot app init --domain を実行するときに Application のドメイン名を設定できます。

Service のデフォルトのドメイン名

Load Balanced Web Service をデプロイすると、デフォルトでは以下のようなドメイン名を使ってアクセスできるようになります。 

${SvcName}.${EnvName}.${AppName}.${DomainName}

上記は、Application Load Balancer を利用している場合です。

${SvcName}-nlb.${EnvName}.${AppName}.${DomainName}

これは、Network Load Balancer を利用している場合です。

具体的には、 https://kudo.test.coolapp.example.aws や kudo-nlb.test.coolapp.example.aws:443 となります。

ドメインエイリアスのカスタマイズ

Copilot が Service に割り当てるデフォルトのドメイン名を使いたくない場合は、Manifest の alias セクションを編集して、Service のカスタムエイリアスを設定することができます。以下のスニペットは Service にエイリアスを設定する例です。

# copilot/{service name}/manifest.yml のなかで
http:
  path: '/'
  alias: example.aws

同様に、Service が Network Load Balancer を使用している場合、以下のように指定することができます。 

nlb:
  port: 443/tls
  alias: example-v1.aws

ただし、サブドメインの権限を Route 53 に委任しているため、指定するエイリアスは、以下の Copilot 対応パターンのいずれかに従ってください。

  • {domain}, such as example.aws
  • {subdomain}.{domain}, such as v1.example.aws
  • {appName}.{domain}, such as coolapp.example.aws
  • {subdomain}.{appName}.{domain}, such as v1.coolapp.example.aws
  • {envName}.{appName}.{domain}, such as test.coolapp.example.aws
  • {subdomain}.{envName}.{appName}.{domain}, such as v1.test.coolapp.example.aws

裏で何がおきているか

裏側では Copilot は

  • Application を作成したアカウント内で ${AppName}.${DomainName} というサブドメイン用のホストゾーンを作成し
  • Environment があるアカウント内で ${EnvName}.${AppName}.${DomainName} という新しい Environment 用のサブドメインのために別のホストゾーンを作成し
  • Environment 用のサブドメインに使う ACM 証明書の作成と検証し
  • ACM 証明書を
    • エイリアスが Application Load Balancer　(http.alias) として利用されている場合、HTTPS リスナーと関連づけて HTTP のトラフィックを HTTPS にリダイレクトし
    • エイリアスが nlb.alias として利用されていて、 TLS ターミーネーションが有効な場合、 Network Load Balancer の TLS リスナーと関連づけて
  • エイリアス用でオプションの A レコードを作成しています。

どのように見えるか

AWS Copilot CLI v1.8.0 Release Highlights

既存の有効な証明書に含まれるドメインを使用する

生成される ACM 証明書をより細かく制御したい場合や、default alias options が十分に柔軟でない場合は、エイリアスを含む有効な ACM 証明書を Environment にインポートすることができます。Environment マニフェストで http.[public/private].certificates を指定します。

type: Environment
http:
  public:
    certificates:
      - arn:aws:acm:us-east-1:123456789012:certificate/12345678-1234-1234-1234-123456789012

Service の Manifest において、次のどちらかを行います。

  • Copilot が A レコードを追加するホストゾーンの ID を指定します。 
    # in copilot/{service name}/manifest.yml
http:
  path: '/'
  alias: example.aws
  hosted_zone: Z0873220N255IR3MTNR4
  • hosted_zone フィールドを指定せずに Service をデプロイし、 その Environment に作成した ALB （Application Load Balancer） の DNS を、エイリアスのドメインがホストされている場所に A レコードとして手動で追加してください。

ブログ記事にも 2 つ目の例を掲載しています。

Request-Driven Web Service

Request-Driven Web Service にカスタムドメインを追加もできます。Load Balanced Web Service と同様に、Manifest の alias フィールドを変更することで追加できます。 

# in copilot/{service name}/manifest.yml
http:
  path: '/'
  alias: web.example.aws

Load Balanced Web Service 同様、Request-Driven Web Service がドメインを使用するためには Application がドメイン (例：example.aws) と関連付けられている必要があります。

Info

現時点では、web.example.aws のような 1 レベルのサブドメインのみをサポートしています。

Environment レベルのドメイン (例：web.${envName}.${appName}.example.aws) や、Application レベルのドメイン (例：web.${appName}.example.aws)、 ルートドメイン (例：example.aws) はまだサポートされていません。これは、サブドメインが Application 名と衝突してはいけないということでもあります。

Copilot は内部的には以下のような処理を行なっています。

  • ドメインを app runner service に関連付けます。
  • ルートドメインのホストゾーンにドメインレコードと検証レコードを作成します。