# 一般的なテンプレートスニペット
<a name="quickref-general"></a>

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

**Topics**
+ [Base64 エンコードされた UserData プロパティ](#scenario-userdata-base64)
+ [AccessKey および SecretKey で Base64 エンコードされた UserData プロパティ](#scenario-userdata-base64-with-keys)
+ [Parameters セクション (リテラル文字列パラメータが 1 つ存在)](#scenario-one-string-parameter)
+ [Parameters セクション (正規表現制約を設定した文字列パラメータが存在)](#scenario-constraint-string-parameter)
+ [Parameters セクション (MinValue および MaxValue 制約を設定した数値パラメータが存在)](#scenario-one-number-min-parameter)
+ [Parameters セクション (AllowedValues 制約を設定した数値パラメータが存在)](#scenario-one-number-parameter)
+ [Parameters セクション (1 つのリテラル CommaDelimitedList パラメータが存在)](#scenario-one-list-parameter)
+ [Parameters セクション (擬似パラメータに基づくパラメータ値が存在)](#scenario-one-pseudo-parameter)
+ [Mapping セクション (3 つのマッピングが存在)](#scenario-mapping-with-four-maps)
+ [リテラル文字列を使用した Description](#scenario-description-from-literal-string)
+ [Outputs セクション (リテラル文字列の出力が 1 つ存在)](#scenario-output-with-literal-string)
+ [Outputs セクション (リソースリファレンスが 1 つ、擬似リファレンス出力が 1 つ存在)](#scenario-output-with-ref-and-pseudo-ref)
+ [Outputs セクション (関数、リテラル文字列、リファレンス、擬似パラメータによる出力)](#scenario-output-with-complex-spec)
+ [テンプレート形式バージョン](#scenario-format-version)
+ [AWS Tags プロパティ](#scenario-format-aws-tag)

## Base64 エンコードされた UserData プロパティ
<a name="scenario-userdata-base64"></a>

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

### JSON
<a name="quickref-general-example-1.json"></a>

```
1. "UserData" : {
2.     "Fn::Base64" : {
3.         "Fn::Join" : [ ",", [
4.             { "Ref" : "MyValue" },
5.             { "Ref" : "MyName" },
6.             "Hello World" ] ]
7.     }
8. }
```

### YAML
<a name="quickref-general-example-1.yaml"></a>

```
1. UserData:
2.   Fn::Base64: !Sub |
3.      Ref: MyValue
4.      Ref: MyName
5.      Hello World
```

## AccessKey および SecretKey で Base64 エンコードされた UserData プロパティ
<a name="scenario-userdata-base64-with-keys"></a>

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

### JSON
<a name="quickref-general-example-2.json"></a>

```
1. "UserData" : {
2.     "Fn::Base64" : {
3.         "Fn::Join" : [ "", [
4.             "ACCESS_KEY=", { "Ref" : "AccessKey" },
5.             "SECRET_KEY=", { "Ref" : "SecretKey" } ]
6.         ]
7.     }
8. }
```

### YAML
<a name="quickref-general-example-2.yaml"></a>

```
1. UserData:
2.   Fn::Base64: !Sub |
3.      ACCESS_KEY=${AccessKey}
4.      SECRET_KEY=${SecretKey}
```

## Parameters セクション (リテラル文字列パラメータが 1 つ存在)
<a name="scenario-one-string-parameter"></a>

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

### JSON
<a name="quickref-general-example-3.json"></a>

```
1. "Parameters" : {
2.     "UserName" : {
3.         "Type" : "String",
4.         "Default" : "nonadmin",
5.         "Description" : "Assume a vanilla user if no command-line spec provided"
6.     }
7. }
```

### YAML
<a name="quickref-general-example-3.yaml"></a>

```
1. Parameters:
2.   UserName:
3.     Type: String
4.     Default: nonadmin
5.     Description: Assume a vanilla user if no command-line spec provided
```

## Parameters セクション (正規表現制約を設定した文字列パラメータが存在)
<a name="scenario-constraint-string-parameter"></a>

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

### JSON
<a name="quickref-general-example-4.json"></a>

```
 1. "Parameters" : {
 2.     "AdminUserAccount": {
 3.       "Default": "admin",
 4.       "NoEcho": "true",
 5.       "Description" : "The admin account user name",
 6.       "Type": "String",
 7.       "MinLength": "1",
 8.       "MaxLength": "16",
 9.       "AllowedPattern" : "[a-zA-Z][a-zA-Z0-9]*"
10.     }
11. }
```

### YAML
<a name="quickref-general-example-4.yaml"></a>

```
1. Parameters:
2.   AdminUserAccount:
3.     Default: admin
4.     NoEcho: true
5.     Description: The admin account user name
6.     Type: String
7.     MinLength: 1
8.     MaxLength: 16
9.     AllowedPattern: '[a-zA-Z][a-zA-Z0-9]*'
```

## Parameters セクション (MinValue および MaxValue 制約を設定した数値パラメータが存在)
<a name="scenario-one-number-min-parameter"></a>

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

### JSON
<a name="quickref-general-example-5.json"></a>

```
1. "Parameters" : {
2.     "WebServerPort": {
3.       "Default": "80",
4.       "Description" : "TCP/IP port for the web server",
5.       "Type": "Number",
6.       "MinValue": "1",
7.       "MaxValue": "65535"
8.     }
9. }
```

### YAML
<a name="quickref-general-example-5.yaml"></a>

```
1. Parameters:
2.   WebServerPort:
3.     Default: 80
4.     Description: TCP/IP port for the web server
5.     Type: Number
6.     MinValue: 1
7.     MaxValue: 65535
```

## Parameters セクション (AllowedValues 制約を設定した数値パラメータが存在)
<a name="scenario-one-number-parameter"></a>

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

### JSON
<a name="quickref-general-example-6.json"></a>

```
1. "Parameters" : {
2.     "WebServerPortLimited": {
3.       "Default": "80",
4.       "Description" : "TCP/IP port for the web server",
5.       "Type": "Number",
6.       "AllowedValues" : ["80", "8888"]
7.     }
8. }
```

### YAML
<a name="quickref-general-example-6.yaml"></a>

```
1. Parameters:
2.   WebServerPortLimited:
3.     Default: 80
4.     Description: TCP/IP port for the web server
5.     Type: Number
6.     AllowedValues:
7.     - 80
8.     - 8888
```

## Parameters セクション (1 つのリテラル CommaDelimitedList パラメータが存在)
<a name="scenario-one-list-parameter"></a>

次の例は、`CommaDelimitedList` タイプパラメータが 1 つだけ宣言された有効な `Parameters` セクションの宣言を表しています。`NoEcho` プロパティは `TRUE` に設定されます。この場合、その値は **describe-stacks** 出力でアスタリスク (\$1\$1\$1\$1\$1) によってマスクされます。ただし、以下に指定した場所に保存されている情報は除きます。

**重要**  
`NoEcho` 属性を使用しても、以下に保存されている情報はマスクされません。  
`Metadata` テンプレートセクション。CloudFormation は、`Metadata` セクションに含める情報の変換、変更、または編集を行いません。詳細については、「[メタデータ](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html)」を参照してください。
`Outputs` テンプレートセクション。詳細については、「[出力](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/outputs-section-structure.html)」を参照してください。
リソース定義の `Metadata` 属性。詳細については、「[`Metadata` 属性](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/aws-attribute-metadata.html)」を参照してください。
パスワードやシークレットなどの機密情報を含めるには、これらのメカニズムを使用しないことを強くお勧めします。

**重要**  
機密情報は、CloudFormation テンプレートに直接埋め込むのではなく、スタックテンプレートの動的パラメータを使用して CloudFormation の外部 (AWS Systems Manager パラメータストアや AWS Secrets Manager など) に保存して管理した上で 参照することをお勧めします。  
詳細については、「[テンプレートに認証情報を埋め込まない](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/security-best-practices.html#creds)」のベストプラクティスを参照してください。

### JSON
<a name="quickref-general-example-7.json"></a>

```
1. "Parameters" : {
2.     "UserRoles" : {
3.         "Type" : "CommaDelimitedList",
4.         "Default" : "guest,newhire",
5.         "NoEcho" : "TRUE"
6.     }
7. }
```

### YAML
<a name="quickref-general-example-7.yaml"></a>

```
1. Parameters:
2.   UserRoles:
3.     Type: CommaDelimitedList
4.     Default: "guest,newhire"
5.     NoEcho: true
```

## Parameters セクション (擬似パラメータに基づくパラメータ値が存在)
<a name="scenario-one-pseudo-parameter"></a>

次の例は、擬似パラメーター `AWS::StackName` および `AWS::Region` を使用する EC2 ユーザーデータのコマンドです。疑似 Parameters の詳細については、「[擬似パラメータを使用して AWS 値を取得する](pseudo-parameter-reference.md)」を参照してください。

### JSON
<a name="quickref-general-example-10.json"></a>

```
 1.           "UserData"       : { "Fn::Base64" : { "Fn::Join" : ["", [
 2.              "#!/bin/bash -xe\n",
 3.              "yum install -y aws-cfn-bootstrap\n",
 4. 
 5.              "/opt/aws/bin/cfn-init -v ",
 6.              "         --stack ", { "Ref" : "AWS::StackName" },
 7.              "         --resource LaunchConfig ",
 8.              "         --region ", { "Ref" : "AWS::Region" }, "\n",
 9. 
10.              "/opt/aws/bin/cfn-signal -e $? ",
11.              "         --stack ", { "Ref" : "AWS::StackName" },
12.              "         --resource WebServerGroup ",
13.              "         --region ", { "Ref" : "AWS::Region" }, "\n"
14.         ]]}}
15.       }
```

### YAML
<a name="quickref-general-example-10.yaml"></a>

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

## Mapping セクション (3 つのマッピングが存在)
<a name="scenario-mapping-with-four-maps"></a>

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

### JSON
<a name="quickref-general-example-11.json"></a>

```
 1. "Mappings" : {
 2.     "LightColor" : {
 3.         "Stop" : {
 4.             "Description" : "red",
 5.             "RGBColor" : "RED 255 GREEN 0 BLUE 0"
 6.         },
 7.         "SlowDown" : {
 8.             "Description" : "yellow",
 9.             "RGBColor" : "RED 255 GREEN 255 BLUE 0"
10.         },
11.         "Go" : {
12.             "Description" : "green",
13.             "RGBColor" : "RED 0 GREEN 128 BLUE 0"
14.         }
15.     }
16. }
```

### YAML
<a name="quickref-general-example-11.yaml"></a>

```
 1. Mappings:
 2.   LightColor:
 3.     Stop:
 4.       Description: red
 5.       RGBColor: "RED 255 GREEN 0 BLUE 0"
 6.     SlowDown:
 7.       Description: yellow
 8.       RGBColor: "RED 255 GREEN 255 BLUE 0"
 9.     Go:
10.       Description: green
11.       RGBColor: "RED 0 GREEN 128 BLUE 0"
```

## リテラル文字列を使用した Description
<a name="scenario-description-from-literal-string"></a>

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

### JSON
<a name="quickref-general-example-8.json"></a>

```
1. "Description" : "Replace this value"
```

### YAML
<a name="quickref-general-example-8.yaml"></a>

```
1. Description: "Replace this value"
```

## Outputs セクション (リテラル文字列の出力が 1 つ存在)
<a name="scenario-output-with-literal-string"></a>

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

### JSON
<a name="quickref-general-example-12.json"></a>

```
1. "Outputs" : {
2.     "MyPhone" : {
3.         "Value" : "Please call 555-5555",
4.         "Description" : "A random message for aws cloudformation describe-stacks"
5.     }
6. }
```

### YAML
<a name="quickref-general-example-12.yaml"></a>

```
1. Outputs:
2.   MyPhone:
3.     Value: Please call 555-5555
4.     Description: A random message for aws cloudformation describe-stacks
```

## Outputs セクション (リソースリファレンスが 1 つ、擬似リファレンス出力が 1 つ存在)
<a name="scenario-output-with-ref-and-pseudo-ref"></a>

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

### JSON
<a name="quickref-general-example-13.json"></a>

```
1. "Outputs" : {
2.    "SNSTopic" : { "Value" : { "Ref" : "MyNotificationTopic" } },
3.    "StackName" : { "Value" : { "Ref" : "AWS::StackName" } }
4. }
```

### YAML
<a name="quickref-general-example-13.yaml"></a>

```
1. Outputs:
2.   SNSTopic:
3.     Value: !Ref MyNotificationTopic
4.   StackName:
5.     Value: !Ref AWS::StackName
```

## Outputs セクション (関数、リテラル文字列、リファレンス、擬似パラメータによる出力)
<a name="scenario-output-with-complex-spec"></a>

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

### JSON
<a name="quickref-general-example-14.json"></a>

```
1. "Outputs" : {
2.     "MyOutput" : {
3.         "Value" : { "Fn::Join" :
4.             [ "%", [ "A-string", {"Ref" : "AWS::StackName" } ] ]
5.         }
6.     }
7. }
```

### YAML
<a name="quickref-general-example-14.yaml"></a>

```
1. Outputs:
2.   MyOutput:
3.     Value: !Join [ %, [ 'A-string', !Ref 'AWS::StackName' ]]
```

## テンプレート形式バージョン
<a name="scenario-format-version"></a>

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

### JSON
<a name="quickref-general-example-9.json"></a>

```
1. "AWSTemplateFormatVersion" : "2010-09-09"
```

### YAML
<a name="quickref-general-example-9.yaml"></a>

```
1. AWSTemplateFormatVersion: '2010-09-09'
```

## AWS Tags プロパティ
<a name="scenario-format-aws-tag"></a>

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

### JSON
<a name="quickref-general-example-15.json"></a>

```
 1. "Tags" : [
 2.       {
 3.         "Key" : "keyname1",
 4.         "Value" : "value1"
 5.       },
 6.       {
 7.         "Key" : "keyname2",
 8.         "Value" : "value2"
 9.       }
10.     ]
```

### YAML
<a name="quickref-general-example-15.yaml"></a>

```
1. Tags: 
2.   - 
3.     Key: "keyname1"
4.     Value: "value1"
5.   - 
6.     Key: "keyname2"
7.     Value: "value2"
```