これは新しい CloudFormation テンプレートリファレンスガイドです。ブックマークとリンクを更新してください。CloudFormation の開始方法については、『[AWS CloudFormation ユーザーガイド](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/Welcome.html)』を参照してください。
# `Ref`
`Ref` 組み込み関数は、指定されたパラメータ、リソース、別の組み込み関数の値を返します。この関数は、CloudFormation テンプレート内のリソース間に参照を作成するためによく使用されます。
## 宣言
### JSON
```
{ "Ref" : "logicalName" }
```
```
{ "Ref" : "IntrinsicFunction" }
```
### YAML
完全関数名の構文:
```
Ref: logicalName
```
```
Ref:
IntrinsicFunction
```
短縮形の構文:
```
!Ref logicalName
```
```
!Ref
IntrinsicFunction
```
## パラメータ
logicalName
参照するリソースまたはパラメータの論理名。
IntrinsicFunction
有効な文字列に解決される組み込み関数。パラメーターまたは識別子のリファレンスを含める必要があり、かつリソースの論理識別子を含めることはできません。
## 戻り値
`Ref` の戻り値は、参照されるエンティティのタイプによって異なります。
+ パラメータの論理名を指定すると、それはパラメータの値を返します。詳細については、「[CloudFormation テンプレート Parameters の構文](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/parameters-section-structure.html)」を参照してください。
+ リソースの論理名を指定すると、そのリソースを識別するために使用する値が返されます。通常、これはリソースの名前です。ただし、一部のリソースでは、リソースのコンテキストにおいて別の重要な意味を持つ識別子が返されます。例えば、`AWS::EC2::EIP` リソースは IP アドレスを返し、`AWS::EC2::Instance` はインスタンス ID を返します。リソースに対する `Ref` の戻り値の詳細については、「[リソースとプロパティのリファレンス](aws-template-resource-type-ref.md)」でそのリソースのドキュメントを参照してください。
+ 組み込み関数を指定すると、その関数の出力を返します。
## 例
### リソース間の参照を作成する
Elastic IP アドレスの次のリソース宣言には、EC2 インスタンスのインスタンス ID が必要です。`Ref` 関数を使用し、テンプレートの他の場所で宣言された `MyEC2Instance` リソースのインスタンス ID を指定します。
#### JSON
```
{
"AWSTemplateFormatVersion":"2010-09-09",
"Resources":{
...
"MyEIP":{
"Type":"AWS::EC2::EIP",
"Properties":{
"InstanceId":{
"Ref":"MyEC2Instance"
}
}
}
}
}
```
#### YAML
```
AWSTemplateFormatVersion: 2010-09-09
Resources:
...
MyEIP:
Type: AWS::EC2::EIP
Properties:
InstanceId: !Ref MyEC2Instance
```
### リソース識別子をスタック出力として返す
次の例では、`Ref` 関数を使用して `MyBucket` の論理名をスタック出力として持つ Amazon S3 バケットの名前を返す方法が示されます。
#### JSON
```
{
"AWSTemplateFormatVersion":"2010-09-09",
"Resources":{
"MyBucket":{
"Type":"AWS::S3::Bucket",
"Properties":{
"BucketName":{
"Fn::Sub": "${AWS::StackName}-mybucket"
}
}
}
},
"Outputs":{
"BucketNameOutput":{
"Description":"The name of the S3 bucket",
"Value":{
"Ref":"MyBucket"
}
}
}
}
```
#### YAML
```
AWSTemplateFormatVersion: 2010-09-09
Resources:
MyBucket:
Type: AWS::S3::Bucket
Properties:
BucketName: !Sub ${AWS::StackName}-mybucket
Outputs:
BucketNameOutput:
Description: The name of the S3 bucket
Value: !Ref MyBucket
```
### `Ref` 関数内で `Fn::Join` 組み込み関数を使用する
**注記**
`AWS::LanguageExtensions` 変換を使用すると、`Ref` を他の組み込み関数と組み合わせて使用できます。サポートされている関数については、「[サポートされている関数](#ref-supported-functions)」を参照してください。
次の例では、`Fn::Sub` 組み込み関数、条件、`Stage` パラメータの入力を使用してリソースの識別子を設定する方法が示されます。`Ref` および `Fn::GetAtt` 関数は、ステージに基づいて適切な値を参照します。`Fn::Sub` は最初に `Fn::GetAtt` と一緒に使用して適切な Amazon SQS キューの ARN を取得し、Amazon CloudWatch アラームのディメンションを設定します。次に、[`Fn::Join`](intrinsic-function-reference-join.md) は `Ref` と一緒に使用し、`AlarmActions` プロパティの SNS トピックの名前を作成します。
#### JSON
```
{
"AWSTemplateFormatVersion": "2010-09-09",
"Transform": "AWS::LanguageExtensions",
"Parameters": {
"Stage": {
"Type": "String",
"Default": "Dev",
"AllowedValues": [
"Dev",
"Prod"
]
}
},
"Conditions": {
"isProd": {
"Fn::Equals": [
{"Ref": "Stage"},
"Prod"
]
},
"isDev": {
"Fn::Equals": [
{"Ref": "Stage"},
"Dev"
]
}
},
"Resources": {
"DevQueue": {
"Type": "AWS::SQS::Queue",
"Condition": "isDev",
"Properties": {
"QueueName": {"Fn::Sub": "My${Stage}Queue"}
}
},
"ProdQueue": {
"Type": "AWS::SQS::Queue",
"Condition": "isProd",
"Properties": {
"QueueName": {"Fn::Sub": "My${Stage}Queue"}
}
},
"DevTopic": {
"Condition": "isDev",
"Type": "AWS::SNS::Topic"
},
"ProdTopic": {
"Condition": "isProd",
"Type": "AWS::SNS::Topic"
},
"MyAlarm": {
"Type": "AWS::CloudWatch::Alarm",
"Properties": {
"AlarmDescription": "Alarm if queue depth grows beyond 10 messages",
"Namespace": "AWS/SQS",
"MetricName": "ApproximateNumberOfMessagesVisible",
"Dimensions":[
{
"Name": {"Fn::Sub": "${Stage}Queue"},
"Value": {"Fn::GetAtt": [{"Fn::Sub": "${Stage}Queue"}, "QueueName"]}
}
],
"Statistic": "Sum",
"Period": 300,
"EvaluationPeriods": 1,
"Threshold": 10,
"ComparisonOperator": "GreaterThanThreshold",
"AlarmActions": [
{
"Ref": {"Fn::Join": ["", [{"Ref": "Stage"}, "Topic"]]}
}
]
}
}
}
}
```
#### YAML
```
AWSTemplateFormatVersion: 2010-09-09
Transform: AWS::LanguageExtensions
Parameters:
Stage:
Type: String
Default: Dev
AllowedValues:
- Dev
- Prod
Conditions:
isProd: !Equals
- !Ref Stage
- Prod
isDev: !Equals
- !Ref Stage
- Dev
Resources:
DevQueue:
Type: AWS::SQS::Queue
Condition: isDev
Properties:
QueueName: !Sub My${Stage}Queue
ProdQueu:
Type: AWS::SQS::Queue
Condition: isProd
Properties:
QueueName: !Sub My${Stage}Queue
DevTopic:
Condition: isDev
Type: AWS::SNS::Topic
ProdTopic:
Condition: isProd
Type: AWS::SNS::Topic
MyAlarm:
Type: AWS::CloudWatch::Alarm
Properties:
AlarmDescription: Alarm if queue depth grows beyond 10 messages
Namespace: AWS/SQS
MetricName: ApproximateNumberOfMessagesVisible
Dimensions:
- Name: !Sub '${Stage}Queue'
Value: !GetAtt
- !Sub '${Stage}Queue'
- QueueName
Statistic: Sum
Period: 300
EvaluationPeriods: 1
Threshold: 10
ComparisonOperator: GreaterThanThreshold
AlarmActions:
- !Ref
'Fn::Join':
- ''
- - !Ref Stage
- Topic
```
## サポートされている関数
[AWS::LanguageExtensions 変換](transform-aws-languageextensions.md) を使用するとき、`Ref` 関数内で次の関数を使用できます。
+ [`Fn::Base64`](intrinsic-function-reference-base64.md)
+ [`Fn::FindInMap`](intrinsic-function-reference-findinmap.md)
+ [`Fn::If`](intrinsic-function-reference-conditions.md#intrinsic-function-reference-conditions-if)
+ [`Fn::ImportValue`](intrinsic-function-reference-importvalue.md)
+ [`Fn::Join`](intrinsic-function-reference-join.md)
+ [`Fn::Sub`](intrinsic-function-reference-sub.md)
+ [`Fn::ToJsonString`](intrinsic-function-reference-ToJsonString.md)
+ `Ref`