メニュー
AWS CloudFormation
ユーザーガイド (API Version 2010-05-15)

一般的なテンプレートスニペット

次の例では、AWS サービスに固有ではない異なる AWS CloudFormation テンプレートの特徴を示します。

UserData プロパティの Base64 エンコード

この例では、Fn::Base64 関数と Fn::Join 関数を使用して UserData プロパティを作成しています。MyValueMyName のリファレンスはパラメーターです。これらのパラメーターは、テンプレートの Parameters セクションで定義されている必要があります。それらとは別に、リテラル文字列の Hello World も、UserData の一部として渡しています。

JSON

Copy
"UserData" : { "Fn::Base64" : { "Fn::Join" : [ ",", [ { "Ref" : "MyValue" }, { "Ref" : "MyName" }, "Hello World" ] ] } }

YAML

Copy
UserData: Fn::Base64: !Sub | Ref: MyValue Ref: MyName Hello World

AccessKey と SecretKey を含む UserData プロパティの Base64 エンコード

この例では、Fn::Base64 関数と Fn::Join 関数を使用して UserData プロパティを作成しています。このプロパティには、AccessKeySecretKey の情報が含まれています。AccessKeySecretKey のリファレンスはパラメーターです。これらのパラメーターは、テンプレートの Parameters セクションで定義されている必要があります。

JSON

Copy
"UserData" : { "Fn::Base64" : { "Fn::Join" : [ "", [ "ACCESS_KEY=", { "Ref" : "AccessKey" }, "SECRET_KEY=", { "Ref" : "SecretKey" } ] ] } }

YAML

Copy
UserData: Fn::Base64: !Sub | ACCESS_KEY=${AccessKey} SECRET_KEY=${SecretKey}

Parameters セクション (リテラル文字列パラメーターが 1 つ存在)

次の例は、String 型パラメーターが 1 つだけ宣言された有効な Parameters セクションの宣言を表しています。

JSON

Copy
"Parameters" : { "UserName" : { "Type" : "String", "Default" : "nonadmin", "Description" : "Assume a vanilla user if no command-line spec provided" } }

YAML

Copy
Parameters: UserName: Type: String Default: nonadmin Description: Assume a vanilla user if no command-line spec provided

Parameters セクション (正規表現制約を設定した文字列パラメーターが存在)

次の例は、String 型パラメーターが 1 つだけ宣言された有効な Parameters セクションの宣言を表しています。AdminUserAccount パラメーターには、デフォルトとして "admin" が設定されています。このパラメーターの値は、長さが 1~16 で、かつアルファベット文字と数字で構成されている必要があります。また、先頭の文字はアルファベット文字であることが必要です。

JSON

Copy
"Parameters" : { "AdminUserAccount": { "Default": "admin", "NoEcho": "true", "Description" : "The admin account user name", "Type": "String", "MinLength": "1", "MaxLength": "16", "AllowedPattern" : "[a-zA-Z][a-zA-Z0-9]*" } }

YAML

Copy
Parameters: AdminUserAccount: Default: admin NoEcho: true Description: The admin account user name Type: String MinLength: 1 MaxLength: 16 AllowedPattern: '[a-zA-Z][a-zA-Z0-9]*'

Parameters セクション (MinValue と MaxValue の制約を持つ数値パラメーターが存在)

次の例は、Number 型パラメーターが 1 つだけ宣言された有効な Parameters セクションの宣言を表しています。WebServerPort パラメーターはデフォルト値が 80 で、最小値が 1、最大値が 65535 です。

JSON

Copy
"Parameters" : { "WebServerPort": { "Default": "80", "Description" : "TCP/IP port for the web server", "Type": "Number", "MinValue": "1", "MaxValue": "65535" } }

YAML

Copy
Parameters: WebServerPort: Default: 80 Description: TCP/IP port for the web server Type: Number MinValue: 1 MaxValue: 65535

Parameters セクション (AllowedValues 制約を持つ数値パラメーターが存在)

次の例は、Number 型パラメーターが 1 つだけ宣言された有効な Parameters セクションの宣言を表しています。WebServerPort パラメーターは、デフォルト値が 80 で、許容される値は 80 と 8888 だけです。

JSON

Copy
"Parameters" : { "WebServerPortLimited": { "Default": "80", "Description" : "TCP/IP port for the web server", "Type": "Number", "AllowedValues" : ["80", "8888"] } }

YAML

Copy
Parameters: WebServerPortLimited: Default: 80 Description: TCP/IP port for the web server Type: Number AllowedValues: - 80 - 8888

Parameters セクション (リテラル CommaDelimitedList パラメーターが 1 つ存在)

次の例は、CommaDelimitedList 型パラメーターが 1 つだけ宣言された有効な Parameters セクションの宣言を表しています。NoEcho プロパティが TRUE に設定されているため、aws cloudformation describe-stacks の出力ではこのプロパティの値がアスタリスク (*****) でマスクされます。

JSON

Copy
"Parameters" : { "UserRoles" : { "Type" : "CommaDelimitedList", "Default" : "guest,newhire", "NoEcho" : "TRUE" } }

YAML

Copy
Parameters: UserRoles: Type: CommaDelimitedList Default: "guest,newhire" NoEcho: true

Parameters セクション (擬似パラメーターに基づくパラメーター値が存在)

次の例は、擬似パラメーター AWS::StackName および AWS::Region を使用する EC2 ユーザーデータのコマンドです。擬似パラメーターの詳細については、「擬似パラメーター参照」を参照してください。

JSON

Copy
"UserData" : { "Fn::Base64" : { "Fn::Join" : ["", [ "#!/bin/bash -xe\n", "yum install -y aws-cfn-bootstrap\n", "/opt/aws/bin/cfn-init -v ", " --stack ", { "Ref" : "AWS::StackName" }, " --resource LaunchConfig ", " --region ", { "Ref" : "AWS::Region" }, "\n", "/opt/aws/bin/cfn-signal -e $? ", " --stack ", { "Ref" : "AWS::StackName" }, " --resource WebServerGroup ", " --region ", { "Ref" : "AWS::Region" }, "\n" ]]}} }

YAML

Copy
UserData: Fn::Base64: !Sub | #!/bin/bash -xe yum update -y aws-cfn-bootstrap /opt/aws/bin/cfn-init -v --stack ${AWS::StackName} --resource LaunchConfig --region ${AWS::Region} /opt/aws/bin/cfn-signal -e $? --stack ${AWS::StackName} --resource WebServerGroup --region ${AWS::Region}

3 つのマッピングを持つ Mappings セクション

次の例は、3 つのマッピングを含んだ有効な Mappings セクションの宣言を表しています。このマップは、StopSlowDownGo の各マッピングキーと比較され、対応する RGBColor 属性に割り当てられた RGB 値を返します。

JSON

Copy
"Mappings" : { "LightColor" : { "Stop" : { "Description" : "red", "RGBColor" : "RED 255 GREEN 0 BLUE 0" }, "SlowDown" : { "Description" : "yellow", "RGBColor" : "RED 255 GREEN 255 BLUE 0" }, "Go" : { "Description" : "green", "RGBColor" : "RED 0 GREEN 128 BLUE 0" } } }

YAML

Copy
Mappings: LightColor: Stop: Description: red RGBColor: "RED 255 GREEN 0 BLUE 0" SlowDown: Description: yellow RGBColor: "RED 255 GREEN 255 BLUE 0" Go: Description: green RGBColor: "RED 0 GREEN 128 BLUE 0"

リテラル文字列による説明

次の例は、リテラル文字列を値に使用した有効な Description セクションの宣言を表しています。このスニペットは、テンプレート、パラメーター、リソース、プロパティ、出力に使用できます。

JSON

Copy
"Description" : "Replace this value"

YAML

Copy
Description: "Replace this value"

Outputs セクション (リテラル文字列の出力が 1 つ存在)

この例では、リテラル文字列によって出力の割り当てを行っています。

JSON

Copy
"Outputs" : { "MyPhone" : { "Value" : "Please call 555-5555", "Description" : "A random message for aws cloudformation describe-stacks" } }

YAML

Copy
Outputs: MyPhone: Value: Please call 555-5555 Description: A random message for aws cloudformation describe-stacks

Outputs セクション (リソースリファレンスが 1 つ、擬似リファレンス出力が 1 つ存在)

この例は、出力の割り当てが 2 つ存在する Outputs セクションを示します。1 つはリソースに、もう 1 つは擬似リファレンスに基づいて出力を割り当てています。

JSON

Copy
"Outputs" : { "SNSTopic" : { "Value" : { "Ref" : "MyNotificationTopic" } }, "StackName" : { "Value" : { "Ref" : "AWS::StackName" } } }

YAML

Copy
Outputs: SNSTopic: Value: Ref: MyNotificationTopic StackName: Value: Ref: AWS::StackName

Outputs セクション (関数、リテラル文字列、リファレンス、擬似パラメーターによる出力)

この例は、出力の割り当てが 1 つ存在する Outputs セクションを示します。Join 関数を使用し、パーセント記号を区切り文字に使用して値を連結しています。

JSON

Copy
"Outputs" : { "MyOutput" : { "Value" : { "Fn::Join" : [ "%", [ "A-string", {"Ref" : "AWS::StackName" } ] ] } } }

YAML

Copy
Outputs: MyOutput: Value: !Join [ %, [ 'A-string', !Ref 'AWS::StackName' ]]

Template Format Version

次のスニペットは、有効な Template Format Version セクションの宣言を表しています。

JSON

Copy
"AWSTemplateFormatVersion" : "2010-09-09"

YAML

Copy
AWSTemplateFormatVersion: '2010-09-09'

AWS の Tag プロパティ

この例は、AWS の Tag プロパティを示します。このプロパティは、リソースの Properties セクションに指定します。作成されたリソースは、宣言したタグでタグ付けされます。

JSON

Copy
"Tags" : [ { "Key" : "keyname1", "Value" : "value1" }, { "Key" : "keyname2", "Value" : "value2" } ] }

YAML

Copy
Tags: - Key: "keyname1" Value: "value1" - Key: "keyname2" Value: "value2"