AWS SAM テンプレートの構造

AWS SAM テンプレートファイルは テンプレートファイルの形式に厳密に従います。詳細については、 AWS CloudFormation ユーザーガイドの AWS CloudFormation 「テンプレートの分析」を参照してください。 AWS SAM テンプレートファイルと AWS CloudFormation テンプレートファイルの主な違いは次のとおりです。

• 変換の宣言。Transform: AWS::Serverless-2016-10-31 宣言は AWS SAM テンプレートファイルに必須です。この宣言は、 AWS CloudFormation テンプレートファイルを テンプレートファイルとして識別します AWS SAM 。Transform の詳細については、AWS CloudFormation ユーザーガイドの「Transform」を参照してください。

• Globals セクション。Globals セクションは に固有です AWS SAM。これは、すべてのサーバーレス関数と API に共通するプロパティを定義します。Globals セクションで定義されているプロパティは、すべての AWS::Serverless::Function、AWS::Serverless::Api、および AWS::Serverless::SimpleTable リソースによって継承されます。このセクションの詳細については、「AWS SAM テンプレートの Globals セクション」を参照してください。

• Resources セクション。 AWS SAM テンプレートでは、 Resourcesセクションに AWS CloudFormation リソースと AWS SAM リソースの組み合わせを含めることができます。 AWS CloudFormation リソースの詳細については、「 ユーザーガイド」の「 AWS リソースタイプとプロパティタイプのリファレンス」を参照してください。 AWS CloudFormation AWS SAM リソースの詳細については、「」を参照してくださいAWS SAM リソースとプロパティのリファレンス。

• Parameters セクション。Parameters セクションで宣言されるオブジェクトによって、sam deploy --guided コマンドがユーザーに追加のプロンプトを表示するようになります。宣言されたオブジェクトと対応するプロンプトの例については、 AWS SAM CLI コマンドリファレンスの「sam deploy」を参照してください。

AWS SAM テンプレートファイルの他のすべてのセクションは、同じ名前の AWS CloudFormation テンプレートファイルセクションに対応しています。

YAML

以下の例は、YAML 形式のテンプレートフラグメントを示しています。

Transform: AWS::Serverless-2016-10-31

Globals:
  set of globals

Description:
  String

Metadata:
  template metadata

Parameters:
  set of parameters

Mappings:
  set of mappings

Conditions:
  set of conditions

Resources:
  set of resources

Outputs:
  set of outputs

テンプレートセクション

AWS SAM テンプレートには、いくつかの主要なセクションを含めることができます。必須のセクションは、Transform と Resources のみです。

テンプレートセクションは任意の順序で含めることができますが、ただし、言語拡張を使用する場合は、次の例に示すように、サーバーレス変換AWS::LanguageExtensionsの前 (つまり の前AWS::Serverless-2016-10-31) に を追加する必要があります。

Transform:
  - AWS::LanguageExtensions
  - AWS::Serverless-2016-10-31

テンプレートを構築するときは、次のリストに示す論理的な順序を使用することをお勧めします。これは、1 つのセクションの値が前のセクションの値を参照している可能性があるためです。

変換 (必須)

AWS SAM テンプレートの場合は、 の値でこのセクションを含める必要がありますAWS::Serverless-2016-10-31。

追加の transform はオプションです。Transform の詳細については、AWS CloudFormation ユーザーガイドの「Transform」を参照してください。

グローバル (オプション)

すべてのサーバーレス関数、API、および単純テーブルに共通のプロパティです。Globals セクションで定義されているプロパティは、すべての AWS::Serverless::Function、AWS::Serverless::Api、および AWS::Serverless::SimpleTable リソースによって継承されます。

このセクションは に固有のものです AWS SAM。 AWS CloudFormation テンプレートに対応するセクションはありません。

Description (オプション)

テンプレートを説明するテキスト文字列です。

このセクションは、 AWS CloudFormation テンプレートの Descriptionセクションに直接対応しています。

メタデータ (オプション)

テンプレートに関する追加情報を提供するオブジェクトです。

このセクションは、 AWS CloudFormation テンプレートの Metadataセクションに直接対応しています。

パラメータ (任意)

実行時 (スタックを作成または更新するとき) にテンプレートに渡す値です。テンプレートの Resources および Outputs セクションからのパラメータを参照できます。

sam deploy コマンドの --parameter-overrides パラメータ (および設定ファイルのエントリ) を使用することで渡される値で、 AWS SAM テンプレートファイルよりも優先されます。sam deploy コマンドの詳細については、 AWS SAM CLI コマンドリファレンスの「sam deploy」を参照してください。設定ファイルの詳細については、「AWS SAM CLI 設定ファイル」を参照してください。

マッピング (任意)

キーと関連する値のマッピングで、条件パラメータ値の指定に使用でき、ルックアップテーブルに似ています。Resources セクションと Outputs セクションで Fn::FindInMap 組み込み関数を使用することによって、キーを対応する値と一致させることができます。

このセクションは、 AWS CloudFormation テンプレートの Mappingsセクションに直接対応しています。

条件 (オプション)

スタックの作成中または更新中に、特定のリソースが作成されるかどうか、または特定のリソースプロパティに値が割り当てられるかどうかを制御する条件です。例えば、スタックが実稼働用であるかテスト環境用であるかに依存するリソースを、条件付きで作成できます。

このセクションは、 AWS CloudFormation テンプレートの Conditionsセクションに直接対応しています。

リソース (必須)

Amazon Elastic Compute Cloud (Amazon EC2) インスタンスや Amazon Simple Storage Service (Amazon S3) バケットなどのスタックリソースとそれらのプロパティです。テンプレートの Resources と Outputs セクションのリソースを参照できます。

このセクションは、 AWS CloudFormation テンプレートの Resources セクションに似ています。 AWS SAM テンプレートでは、このセクションに AWS SAM リソースに加えて AWS CloudFormation リソースを含めることができます。

出力 (任意)

スタックのプロパティを表示するたびに返される値です。例えば、S3 バケット名の出力を宣言し、 aws cloudformation describe-stacks AWS Command Line Interface （AWS CLI) コマンドを呼び出して名前を表示できます。

このセクションは、 AWS CloudFormation テンプレートの Outputs セクションに直接対応します。

次のステップ

AWS SAM テンプレートファイルを含むサンプルサーバーレスアプリケーションをダウンロードしてデプロイするには、「」を参照AWS SAM の開始方法し、「」の手順に従いますチュートリアル: Hello World アプリケーションのデプロイ。