CloudFormationテンプレートの書き方:基本ガイド

2024/07/27
x-logoline-logo

CloudFormationテンプレートの書き方:基本ガイド

2024/07/27
x-logoline-logo
PR

CloudFormationは、AWS(Amazon Web Services)が提供するサービスで、インフラをコードで管理するためのツールです。このサービスを使えば、AWSのリソースを簡単に作成したり、管理したりできます。

CloudFormationテンプレートの基本構造

CloudFormationテンプレートは、主にJSONまたはYAMLの形式で書かれます。このテンプレートには、AWSリソースの情報が含まれています。

YAML形式の例


AWSTemplateFormatVersion: '2010-09-09'
Description: My first CloudFormation template
Resources:
  MyS3Bucket:
    Type: AWS::S3::Bucket
    Properties:
      BucketName: my-first-bucket

JSON形式の例


{
  "AWSTemplateFormatVersion": "2010-09-09",
  "Description": "My first CloudFormation template",
  "Resources": {
    "MyS3Bucket": {
      "Type": "AWS::S3::Bucket",
      "Properties": {
        "BucketName": "my-first-bucket"
      }
    }
  }
}

重要なセクションの説明

AWSテンプレートフォーマットバージョン

最初に必ず記載する項目で、これによってAWSがテンプレートのバージョンを理解します。通常、「2010-09-09」と指定します。

説明(Description)

この部分には、テンプレートの簡単な説明を書くことができます。こうすることで、後から見返したときに何のためのテンプレートかわかりやすくなります。

リソース(Resources)

リソースセクションでは、作成したいAWSのリソースを記載します。ここで指定したリソースは、自動的に作成されます。

テンプレート作成のヒント

理解しやすい名前をつける

リソース名はわかりやすい名前をつけましょう。そうすることで、後からテンプレートを見たときに、どんなリソースなのかすぐにわかります。

コメントを活用する

YAML形式では「#」を使い、JSON形式では「//」を使ってコメントを記入できます。コメントを書くことで、他の人が見たときの理解を助けます。

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