CloudFormationの出力(Outputs)の設定方法

2024/07/27
x-logoline-logo

CloudFormationの出力(Outputs)の設定方法

2024/07/27
x-logoline-logo
PR

AWS CloudFormationは、インフラをコードで管理するための非常に便利なツールです。その中の「Outputs」セクションは、スタックを作成した後に知りたい情報を出力するために使います。この記事では、初めてCloudFormationを触るあなたに向けて、Outputsの設定方法について説明します。

Outputsとは?

Outputsは、CloudFormationスタックの作成が終わった後に、重要な情報を表示するための部分です。例えば、作成したEC2インスタンスのIPアドレスや、RDSのエンドポイントなどが出力されます。これによって、スタックの状態を簡単に確認することができます。

Outputsの設定方法

次に、Outputsを設定する方法を見ていきましょう。基本的な書き方は以下の通りです。

YAML形式の例

Outputs:
  MyEC2InstancePublicIP:
    Description: "EC2インスタンスのパブリックIPアドレス"
    Value: !GetAtt MyEC2Instance.PublicIp
  MyRDSInstanceEndpoint:
    Description: "RDSインスタンスのエンドポイント"
    Value: !GetAtt MyRDSInstance.Endpoint.Address

JSON形式の例

{
  "Outputs": {
    "MyEC2InstancePublicIP": {
      "Description": "EC2インスタンスのパブリックIPアドレス",
      "Value": { "Fn::GetAtt": ["MyEC2Instance", "PublicIp"] }
    },
    "MyRDSInstanceEndpoint": {
      "Description": "RDSインスタンスのエンドポイント",
      "Value": { "Fn::GetAtt": ["MyRDSInstance", "Endpoint", "Address"] }
    }
  }
}

Outputsを設定する際のポイント

Outputsを設定する時には、いくつか気をつけるポイントがあります。

出力名は分かりやすく

出力名は他の人が見てもわかりやすい名前にしましょう。例えば、「MyRDSInstanceEndpoint」ではなく、「RDSインスタンスのエンドポイント」とすると、何が出力されるのかがはっきりします。

必要な情報だけを出力する

Outputsには必要な情報のみを出力するよう心がけましょう。多くの情報を出力すると管理が難しくなる場合があります。

まとめ

CloudFormationのOutputsを使うと、スタック作成後の大切な情報を簡単に確認できます。

この記事はAIを使用して作成されています。
PR