これは新しい CloudFormation テンプレートリファレンスガイドです。ブックマークとリンクを更新してください。CloudFormation の開始方法については、『[AWS CloudFormation ユーザーガイド](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/Welcome.html)』を参照してください。
# `Fn::GetAtt`
`Fn::GetAtt` 組み込み関数は、テンプレートのリソースから属性の値を返します。
## 宣言
### JSON
```
{ "Fn::GetAtt" : [ "logicalNameOfResource", "attributeName" ] }
```
### YAML
完全関数名の構文:
```
Fn::GetAtt: [ logicalNameOfResource, attributeName ]
```
短縮形の構文:
```
!GetAtt logicalNameOfResource.attributeName
```
## パラメータ
`logicalNameOfResource`
必要な属性を含むリソースの論理名 (*論理 ID* とも呼ばれます)。
`attributeName`
必要としている値のある、リソース固有の属性の名前です。各リソースタイプで使用できる属性の詳細については、リソースの参照ページに説明されています。
## 戻り値
属性の値です。リソースの `GetAtt` 戻り値の詳細については、「[リソースとプロパティのリファレンス](aws-template-resource-type-ref.md)」のリソースのドキュメントを参照してください。
## 例
### 属性値を返す
次の例では、論理名 `myELB` を持ったロードバランサーの DNS 名を含む文字列が返されます。
#### JSON
```
"Fn::GetAtt" : [ "myELB" , "DNSName" ]
```
#### YAML
```
!GetAtt myELB.DNSName
```
#### 複数の属性値を返す
次の例では、`myELB` という論理名のロードバランサーの `SourceSecurityGroup.OwnerAlias` および `SourceSecurityGroup.GroupName` が返されます。
##### JSON
```
{
"AWSTemplateFormatVersion": "2010-09-09",
"Resources": {
"myELB": {
"Type": "AWS::ElasticLoadBalancing::LoadBalancer",
"Properties": {
"AvailabilityZones": [
"eu-west-1a"
],
"Listeners": [
{
"LoadBalancerPort": "80",
"InstancePort": "80",
"Protocol": "HTTP"
}
]
}
},
"myELBIngressGroup": {
"Type": "AWS::EC2::SecurityGroup",
"Properties": {
"GroupDescription": "ELB ingress group",
"SecurityGroupIngress": [
{
"IpProtocol": "tcp",
"FromPort": 80,
"ToPort": 80,
"SourceSecurityGroupOwnerId": {
"Fn::GetAtt": [
"myELB",
"SourceSecurityGroup.OwnerAlias"
]
},
"SourceSecurityGroupName": {
"Fn::GetAtt": [
"myELB",
"SourceSecurityGroup.GroupName"
]
}
}
]
}
}
}
}
```
##### YAML
```
AWSTemplateFormatVersion: 2010-09-09
Resources:
myELB:
Type: AWS::ElasticLoadBalancing::LoadBalancer
Properties:
AvailabilityZones:
- eu-west-1a
Listeners:
- LoadBalancerPort: '80'
InstancePort: '80'
Protocol: HTTP
myELBIngressGroup:
Type: AWS::EC2::SecurityGroup
Properties:
GroupDescription: ELB ingress group
SecurityGroupIngress:
- IpProtocol: tcp
FromPort: 80
ToPort: 80
SourceSecurityGroupOwnerId: !GetAtt myELB.SourceSecurityGroup.OwnerAlias
SourceSecurityGroupName: !GetAtt myELB.SourceSecurityGroup.GroupName
```
#### `Fn::GetAtt` 関数内の `Fn::Sub` を使用する
**注記**
`AWS::LanguageExtensions` 変換を使用すると、`Fn::GetAtt` を他の組み込み関数と組み合わせて使用できます。サポートされている関数については、「[サポートされている関数](#getatt-supported-functions)」を参照してください。
次の例では、テンプレートの長さと冗長性を減らすため、テンプレートの `Outputs` セクションで [`Fn::ForEach`](intrinsic-function-reference-foreach.md) と組み合わせて `Fn::GetAtt` を [`Fn::Sub`](intrinsic-function-reference-sub.md) と使用する方法が示されます。`Fn::GetAtt` 内で `Fn::Sub` を使用すると、`Fn::ForEach` 呼び出しが繰り返されるたびに異なるバケットを参照する組み込み関数を 1 つテンプレートに含めることができます。
##### JSON
```
{
"AWSTemplateFormatVersion": "2010-09-09",
"Transform": "AWS::LanguageExtensions",
"Mappings": {
"Buckets": {
"Properties": {
"Identifiers": ["A", "B", "C"]
}
}
},
"Resources": {
"Fn::ForEach::Buckets": [
"Identifier",
{"Fn::FindInMap": ["Buckets", "Properties", "Identifiers"]},
{
"S3Bucket${Identifier}": {
"Type": "AWS::S3::Bucket",
"Properties": {
"AccessControl": "PublicRead",
"MetricsConfigurations": [
{
"Id": {"Fn::Sub": "EntireBucket${Identifier}"}
}
],
"WebsiteConfiguration": {
"IndexDocument": "index.html",
"ErrorDocument": "error.html",
"RoutingRules": [
{
"RoutingRuleCondition": {
"HttpErrorCodeReturnedEquals": "404",
"KeyPrefixEquals": "out1/"
},
"RedirectRule": {
"HostName": "ec2-11-22-333-44.compute-1.amazonaws.com",
"ReplaceKeyPrefixWith": "report-404/"
}
}
]
}
},
"DeletionPolicy": "Retain",
"UpdateReplacePolicy": "Retain"
}
}
]
},
"Outputs": {
"Fn::ForEach::BucketOutputs": [
"Identifier",
{"Fn::FindInMap": ["Buckets", "Properties", "Identifiers"]},
{
"Fn::ForEach::GetAttLoop": [
"Property",
["Arn", "DomainName", "WebsiteURL"],
{
"S3Bucket${Identifier}${Property}": {
"Value": {
"Fn::GetAtt": [{"Fn::Sub": "S3Bucket${Identifier}"}, {"Ref": "Property"}]
}
}
}
]
}
]
}
}
```
##### YAML
```
AWSTemplateFormatVersion: 2010-09-09
Transform: AWS::LanguageExtensions
Mappings:
Buckets:
Properties:
Identifiers:
- A
- B
- C
Resources:
'Fn::ForEach::Buckets':
- Identifier
- Fn::FindInMap:
- Buckets
- Properties
- Identifiers
- 'S3Bucket${Identifier}':
Type: AWS::S3::Bucket
Properties:
AccessControl: PublicRead
MetricsConfigurations:
- Id:
Fn::Sub: 'EntireBucket${Identifier}'
WebsiteConfiguration:
IndexDocument: index.html
ErrorDocument: error.html
RoutingRules:
- RoutingRuleCondition:
HttpErrorCodeReturnedEquals: '404'
KeyPrefixEquals: out1/
RedirectRule:
HostName: ec2-11-22-333-44.compute-1.amazonaws.com
ReplaceKeyPrefixWith: report-404/
DeletionPolicy: Retain
UpdateReplacePolicy: Retain
Outputs:
'Fn::ForEach::BucketOutputs':
- Identifier
- Fn::FindInMap:
- Buckets
- Properties
- Identifiers
- 'Fn::ForEach::GetAttLoop':
- Property
- - Arn
- DomainName
- WebsiteURL
- 'S3Bucket${Identifier}${Property}':
Value: !GetAtt
- !Sub 'S3Bucket${Identifier}'
- !Ref Property
```
## サポートされている関数
[AWS::LanguageExtensions 変換](transform-aws-languageextensions.md) を使用するとき、`Fn::GetAtt` 関数内で次の関数を使用できます。これは `Fn::GetAtt` 論理リソース名でも `Fn::GetAtt` 属性名でも同じです。
+ [`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::Join`](intrinsic-function-reference-join.md)
+ [`Fn::Sub`](intrinsic-function-reference-sub.md)
+ [`Fn::ToJsonString`](intrinsic-function-reference-ToJsonString.md)
+ [`Ref`](intrinsic-function-reference-ref.md)
`AWS::LanguageExtensions` 変換を使用しないとき
+ `Fn::GetAtt` 属性名は [`Ref`](intrinsic-function-reference-ref.md) 関数のみを使用できます。
+ `Fn::GetAtt` 論理リソース名は関数を使用できません。リソースの論理 ID である文字列を指定する必要があります。