![[PukiWiki]](image/pukiwiki.png "[PukiWiki]")
概要 †AWS CloudFormation を利用するとインフラ全体をテキストファイルでモデル(ソース)化できる。 SAMの仕様 テンプレートのサンプル 目次 †
テンプレート形式 †https://docs.aws.amazon.com/ja_jp/AWSCloudFormation/latest/UserGuide/template-formats.html CloudFormation テンプレートは JSON または YAML で以下の形式で記述する。 AWSTemplateFormatVersion: "2010-09-09"
Description: Sample template
Resources:
SampleResource1: # リソースの論理名
Type: AWS::Xxxx::Xxxx # リソースタイプ
Properties: # リソースのプロパティ
.
.
SampleResource2: # リソースの論理名
Type: AWS::Xxxx::Xxxx # リソースタイプ
Properties: # リソースのプロパティ
.
.
各項目の内容は以下の通り。
擬似パラメーター参照 †リージョン名やアカウントID、スタック名などをパラメータ参照する事ができる。 参考 利用例) .
.
# Sub関数で利用
!Sub "${AWS::AccountId}"
# Ref関数で利用
!Ref AWS::StackName
組み込み関数の利用 †スタックの管理に役立ついくつかの組み込み関数が用意されている。 GetAtt †GetAtt はテンプレートのリソースから属性の値を返す事ができる。 YAMLの場合 Fn::GetAtt: [ logicalNameOfResource, attributeName ] # 完全名関数 !GetAtt logicalNameOfResource.attributeName # 短縮形 Ref †Ref は指定したパラメータまたはリソースの値を返す事ができる。 YAMLの場合 Ref: logicalName # 完全名関数 !Ref logicalName # 短縮形 尚、返される内容はリソースの種類によって異なるので注意が必要。( ARN、ID、名前 の何れかが返されるものが殆どだが ) マクロの利用 †AWS::Serverless 変換 †TODO:
https://docs.aws.amazon.com/ja_jp/AWSCloudFormation/latest/UserGuide/transform-aws-serverless.html 定型コンテンツの挿入 †パラメータを使用する †Parameters セクションを利用すると、スタックを作成または更新する際にテンプレートにカスタム値を入力できる。 テンプレートの記述例 †以下に Lambda関数名の接頭文字をパラメータ化する例を記載する。 AWSTemplateFormatVersion : '2010-09-09'
Transform: "AWS::Serverless-2016-10-31"
Description: "Sample Lambda Environments."
Parameters:
FuncNamePrefix:
Type: String
Default: "My"
Resources:
SampleLambdaEnv:
Type: "AWS::Serverless::Function"
Properties:
FunctionName: !Sub '${FuncNamePrefix}-SampleLambda'
.
.
パラメータの設定方法 †create-stack でパラメータをセット場合は --parameters オプションを指定する aws cloudformation create-stack --stack-name SampleStack --template-body file://template.yml --parameters FuncNamePrefix="Test" --capabilities CAPABILITY_IAM CAPABILITY_AUTO_EXPAND deploy でパラメータをセットする場合は --parameter-overrides オプションを使用する aws cloudformation deploy --stack-name SampleStack --template-file packaged-template.yml --parameter-overrides FuncNamePrefix="Test" --capabilities CAPABILITY_NAMED_IAM CAPABILITY_AUTO_EXPAND 関連 †条件を指定する †他スタックの定義を再利用する †定義のエクスポート †スタックの出力値をエクスポートして、他のテンプレートで使用する事ができる。 テーブル名 及び テーブルのARN をエクスポートする例） .
.
Resources:
SampleTable01:
Type: AWS::DynamoDB::Table
Properties:
TableName: SampleTable01
Outputs:
SampleTable01Name:
Value: !Ref SampleTable01
Export:
Name: MyTable01Name
SampleTable01Arn:
Value: !GetAtt SampleTable01.Arn
Export:
Name: MyTable01Arn
また、エクスポートされている値の一覧は aws cloudformation list-exports で確認する事ができる。 aws cloudformation list-exports
{
"Exports": [
{
"ExportingStackId": "arn:aws:cloudformation:ap-northeast-1:XXXXXXXXXXXX:stack/SampleCreateTables/dbd...5d08",
"Value": "arn:aws:dynamodb:ap-northeast-1:XXXXXXXXXXXX:table/SampleTable01",
"Name": "MyTable01Arn"
},
{
"ExportingStackId": "arn:aws:cloudformation:ap-northeast-1:XXXXXXXXXXXX:stack/SampleCreateTables/dbd...5d08",
"Value": "SampleTable01",
"Name": "MyTable01Name"
}
]
}
整形して出力 # aws cloudformation list-exports | awk 'BEGIN {value=""}{ if ($1 == "\"Value\":") value=$2; if ($1 == "\"Name\":") print $2"\t"value}' | sed 's/[",]//g'
aws cloudformation list-exports --output text | awk '{print $3" "$4}'
MyTable01Arn arn:aws:dynamodb:ap-northeast-1:XXXXXXXXXXXX:table/SampleTable01
MyTable01Name SampleTable01
エクスポート済みの値の参照 †エクスポートした値は Fn::ImportValue を使用して別のテンプレートから参照する事ができる。 SampleIotDataTablePutItemRole:
Type: AWS::IAM::Role
Properties:
.
.
Policies:
- PolicyName: "SampleIotDataTablePutItemPolicy"
PolicyDocument:
Version: "2012-10-17"
Statement:
- Effect: "Allow"
Action: "dynamoDB:PutItem"
Resource: !ImportValue MyTable01Arn
参考
サンプル †参考: AWS リソースおよびプロパティタイプのリファレンス S3バケット †参考) 例) AWSTemplateFormatVersion: "2010-09-09"
Description: sample s3 bucket template
Resources:
ServerlogBucket:
Type: AWS::S3::Bucket
Properties:
BucketName: !Sub '${AWS::AccountId}-serverlogs'
Lambda、API Gateway †Lambda＆API GatewayをCloudFormationで作成する を参照。 参考
DynamoDB †例) AWSTemplateFormatVersion: "2010-09-09"
Description: sample dynamodb template
Resources:
SampleTable01:
Type: AWS::DynamoDB::Table
Properties:
# テーブル名(必須)
TableName: SampleTable01
# 請求モード
BillingMode: PROVISIONED # プロビジョニング(デフォルト): PROVISIONED、オンデマンド:PAY_PER_REQUEST
# テーブルキー 及び インデックスのキー項目(必須)
AttributeDefinitions:
- AttributeName: pkeyCol # 項目名
AttributeType: S # 文字列:S、数値:N、バイナリ:B
- AttributeName: skeyCol
AttributeType: S
- AttributeName: gsiCol
AttributeType: S
- AttributeName: lsiCol
AttributeType: S
# キャパシティユニット( BillingMode が PROVISIONED の場合は必須 )
ProvisionedThroughput:
ReadCapacityUnits: 5 # 読み込みキャパシティユニット
WriteCapacityUnits: 5 # 書き込みキャパシティユニット
# テーブルのキー項目(必須)
KeySchema:
- AttributeName: pkeyCol # 項目名
KeyType: HASH # HASH or RANGE
- AttributeName: skeyCol
KeyType: RANGE
# GSI
GlobalSecondaryIndexes:
-
# インデックス名
IndexName: SampleTable01_GSI1
# キー項目
KeySchema:
- AttributeName: gsiCol
KeyType: HASH
# 射影
Projection:
ProjectionType: KEYS_ONLY # KEYS_ONLY or INCLUDE or ALL
# キャパシティユニット
ProvisionedThroughput:
ReadCapacityUnits: 5 # 読み込みキャパシティユニット
WriteCapacityUnits: 5 # 書き込みキャパシティユニット
# LSI
LocalSecondaryIndexes:
-
# インデックス名
IndexName: SampleTable01_LSI1
# キー項目
KeySchema:
- AttributeName: pkeyCol
KeyType: HASH
- AttributeName: lsiCol
KeyType: RANGE
# 射影
Projection:
ProjectionType: KEYS_ONLY # KEYS_ONLY or INCLUDE or ALL
参考URL
尚、AutoScaling の設定は AWS::ApplicationAutoScaling::ScalableTarget 及び AWS::ApplicationAutoScaling::ScalingPolicy で設定する必要がある。 SQS †参考 AWSTemplateFormatVersion: "2010-09-09"
Description: sample sqs
Resources:
SampleQueue:
Type: AWS::SQS::Queue
Properties:
QueueName: "SampleQueue" # キュー名(FIFOキューにする場合は末尾は .fifo にする必要がある)
#FifoQueue: true # FIFOキューにする場合はtrue
#ReceiveMessageWaitTimeSeconds: 0 # 待機期間 ※ デフォルト: 0(1 〜 20) ※1以上を指定するとデフォルトでロングポーリングとなる
#VisibilityTimeout: Integer # 可視性タイムアウト ※ デフォルト: 30
#ContentBasedDeduplication: Boolean # 同一内容のメッセージを重複を除去するかどうか(FIFOキューの時のみ)
#DelaySeconds: Integer # 遅延秒数(デフォルト: 0)
#KmsMasterKeyId: String # KMSのマスターキーID
#KmsDataKeyReusePeriodSeconds: Integer # KMSのキーを再利用できる期間
#MaximumMessageSize: Integer # メッセージの最大サイズ ※ デフォルト: 256KiB(1 〜 256)
#MessageRetentionPeriod: Integer # メッセージの保持期間 ※ デフォルト: 345600 秒(4日) (60〜1209600秒(14日))
#RedrivePolicy:
# deadLetterTargetArn: String # デッドレターキュー
# maxReceiveCount: Integer # 失敗時の配信回数
#Tags:
# Resource Tag # タグ
Outputs:
SampleQueue:
Export:
Name: SampleQueueName
Value: !GetAtt SampleQueue.QueueName
実行方法 †関連: Lambda＆API GatewayをCloudFormationで作成する#デプロイ用シェル create-stack で作成する場合 †# スタック名 STACK_NAME=SampleStack # 検証＆作成＆作成完了まで待つ aws cloudformation validate-template --template-body file://template.yml \ && aws cloudformation create-stack --stack-name $STACK_NAME --template-body file://template.yml --capabilities CAPABILITY_IAM \ && aws cloudformation wait stack-create-complete --stack-name $STACK_NAME package & deploy で作成する場合 †# スタック名
STACK_NAME=SampleStack
# アカウントIDの取得
ACCOUNT_ID=`aws sts get-caller-identity | grep Account | awk '{print $2}' | sed -e "s/[^0-9]//g"`
# S3バケットの作成(バケット名は世界で唯一である必要がある為、末尾にアカウントID等を付与しておく)
aws s3api create-bucket --create-bucket-configuration '{"LocationConstraint": "ap-northeast-1"}' --bucket my-cloudformation-templates-${ACCOUNT_ID}
# 検証＆パッケージング＆デプロイ
aws cloudformation validate-template --template-body file://template.yml \
&& aws cloudformation package --template-file template.yml --s3-bucket my-cloudformation-templates-${ACCOUNT_ID} --output-template-file packaged-template.yml \
&& aws cloudformation deploy --template-file packaged-template.yml --stack-name $STACK_NAME --capabilities CAPABILITY_IAM
尚、エラーがあった場合は describe-stack-events で内容を確認できる。 aws cloudformation describe-stack-events --stack-name $STACK_NAME |
