Ref
組み込み関数 Ref は、指定したパラメータまたはリソースの値を返します。
-
パラメーターの論理名を指定すると、それはパラメーターの値を返します。
-
リソースの論理名を指定すると、それはそのリソースを参照するために通常使用できる値を返します (物理 ID)。
テンプレートでリソースを宣言するときに別のテンプレートリソースを名前で指定する必要がある場合は、Ref を使用して別のリソースを参照できます。一般的に、Ref はリソースの名前を返します。たとえば、AWS::AutoScaling::AutoScalingGroup の参照は、Auto Scaling グループリソースの名前を返します。
一部のリソースでは、リソースのコンテキストにおいて別の重要な意味を持つ識別子が返されます。たとえば、AWS::EC2::EIP リソースは IP アドレスを返し、AWS::EC2::Instance はインスタンス ID を返します。
このトピックの末尾に、多くの一般的なリソースタイプに対して返される値をリストアップした表があります。特定のリソースまたはプロパティに対する Ref の戻り値の詳細については、そのリソースまたはプロパティのドキュメントを参照してください。
ヒント
Ref を使用して Output メッセージに値を追加することもできます。
宣言
JSON
{ "Ref" : "logicalName" }
YAML
完全名関数の構文:
Ref:logicalName
短縮形の構文:
!ReflogicalName
パラメータ
- logicalName
-
参照解除するパラメーターまたはリソースの論理名。
戻り値
リソースの物理 ID またはパラメーターの値。
例
以下の Elastic IP アドレスのリソース宣言は、EC2 インスタンスのインスタンス ID を必要とし、Ref 関数を使用して MyEC2Instance リソースのインスタンス ID を指定します。
JSON
"MyEIP" : { "Type" : "AWS::EC2::EIP", "Properties" : { "InstanceId" : { "Ref" : "MyEC2Instance" } } }
YAML
MyEIP: Type: "AWS::EC2::EIP" Properties: InstanceId: !Ref MyEC2Instance
サポートされている関数
Ref 関数には関数を使用できません。リソースの論理 ID である文字列を指定する必要があります。
リソースの戻り値の例
このセクションでは、特定の AWS CloudFormation リソースに対して Ref から返される戻り値の例を示します。特定のリソースまたはプロパティに対する Ref の戻り値の詳細については、そのリソースまたはプロパティのドキュメントを参照してください。
| リソースタイプ | 参照値 | 戻り値の例 |
|---|---|---|
| Alexa::ASK::Skill | Alexa スキル ID | amzn1.ask.skill.a3103cee-c48c-40a0-a2c9-251141888863 |
| AWS::AmazonMQ::Broker | Amazon MQ ブローカー ID | b-1234a5b6-78cd-901e-2fgh-3i45j6k178l9 |
| AWS::AmazonMQ::Configuration | Amazon MQ 設定 ID | c-1234a5b6-78cd-901e-2fgh-3i45j6k178l9 |
| AWS::AmazonMQ::ConfigurationAssociation | Amazon MQ configurationassociation ID | c-1234a5b6-78cd-901e-2fgh-3i45j6k178l9 |
|
API Gateway アカウントのリソース ID |
|
|
|
API キー |
|
|
|
認証のリソース ID |
|
|
|
クライアント証明書名 |
|
|
|
デプロイメントリソース ID |
|
|
|
ドメイン名 |
|
|
|
メソッドリソース ID |
|
|
|
モデル名 |
|
|
|
API Gateway リソース ID |
|
|
|
Rest API リソース ID |
|
|
|
ステージ名 |
|
|
| AWS::ApplicationAutoScaling::ScalableTarget |
スケーラブルなターゲット ID |
|
| AWS::ApplicationAutoScaling::ScalingPolicy |
Application Auto Scaling ポリシー Amazon リソースネーム (ARN) |
arn:aws:autoscaling:us-east-1:123456789012:scalingPolicy:12ab3c4d-56789-0ef1-2345-6ghi7jk8lm90:resource/ecs/service/ecsStack-MyECSCluster-AB12CDE3F4GH/ecsStack-MyECSService-AB12CDE3F4GH:policyName/MyStepPolicy |
|
名前付きクエリ名 |
|
|
|
名前 |
|
|
|
名前 |
|
|
|
名前 |
|
|
|
スケーリングポリシーの Amazon リソースネーム (ARN) |
|
|
|
名前 |
|
|
| AWS::Batch::ComputeEnvironment |
AWS Batch コンピューティング環境 Amazon リソースネーム (ARN) |
|
| AWS::Batch::JobDefinition |
AWS Batch ジョブ定義の Amazon リソースネーム (ARN) |
|
| AWS::Batch::JobQueue |
AWS Batch ジョブキューの Amazon リソースネーム (ARN) |
|
| AWS::CertificateManager::Certificate |
証明書 Amazon リソースネーム (ARN) |
|
|
開発環境 ID |
|
|
|
スタック ID |
|
|
|
名前 |
|
|
|
待機条件シグナル URL |
|
|
|
ディストリビューション ID |
|
|
|
証跡名 |
|
|
|
名前 |
|
|
|
Project name |
|
|
|
リポジトリ ID |
|
|
| AWS::CodeDeploy::Application |
アプリケーション名 |
|
| AWS::CodeDeploy::DeploymentConfig |
デプロイ設定名 |
|
| AWS::CodeDeploy::DeploymentGroup |
デプロイグループ名 |
|
| AWS::CodePipeline::CustomActionType |
カスタムアクション名 |
|
| AWS::CodePipeline::Pipeline |
パイプライン名 |
|
| AWS::CodePipeline::Webhook |
Webhook の名前 |
|
| AWS::Config::ConfigRule |
設定ルール名 |
|
| AWS::Config::ConfigurationRecorder |
設定レコーダー名 |
|
| AWS::Config::DeliveryChannel |
配信チャネル名 |
|
| AWS::DataPipeline::Pipeline |
パイプライン ID |
|
|
|
|
|
| AWS::DirectoryService::MicrosoftAD |
Microsoft ディレクトリ ID |
|
| AWS::DirectoryService::SimpleAD |
ディレクトリ ID |
|
| AWS::DLM::LifecyclePolicy | ポリシー ID |
|
| AWS::DocDB::DBCluster |
DB クラスター名 |
|
| AWS::DocDB::DBClusterParameterGroup |
DB クラスターのパラメータグループ名 |
|
| AWS::DocDB::DBInstance |
DB インスタンス名 |
|
| AWS::DocDB::DBSubnetGroup |
DB サブネットグループ名 |
|
| AWS::DynamoDB::Table |
テーブル名 |
|
|
フリート ID |
|
|
|
Elastic IP アドレス |
|
|
|
名前 |
|
|
|
フローログ ID |
|
|
|
ホスト ID |
|
|
|
インスタンス ID |
|
|
|
NAT ゲートウェイ ID |
|
|
|
ネットワークインターフェイスアクセス権限 ID |
|
|
|
プレイスメントグループ名 |
|
|
|
ルートテーブル ID |
rtb-12a34567 |
|
|
名前またはセキュリティグループ ID (デフォルト VPC がない VPC セキュリティグループの場合) |
|
|
|
名前 |
|
|
|
名前 |
|
|
|
サブネット ID |
|
|
|
ボリューム ID |
|
|
|
名前 |
|
|
|
VPC ID |
|
|
| AWS::EC2::VPCPeeringConnection |
VPC ピア接続 ID |
|
|
エンドポイント ID |
|
|
|
リポジトリ名 |
|
|
|
名前 |
|
|
|
サービス ARN |
|
|
|
タスク定義 ARN |
|
|
|
ファイルシステム ID |
|
|
|
マウントターゲット ID |
|
|
|
名前 |
|
|
|
名前 |
|
|
|
名前 |
|
|
|
リスナーの Amazon Resource Name (ARN) |
|
|
|
リスナーのルールの Amazon Resource Name (ARN) |
|
|
|
Application Load Balancer の Amazon Resource Name (ARN) |
|
|
|
ターゲットグループの Amazon Resource Name (ARN) |
|
|
|
ドメイン名 |
|
|
|
クラスター ID |
|
|
|
インスタンスグループ ID |
|
|
|
名前 |
|
|
|
ステップ ID |
|
|
|
名前 |
|
|
|
名前 |
|
|
|
名前 |
|
|
|
名前 |
|
|
|
名前 |
|
|
|
イベントバスポリシーの ID |
|
|
|
イベントルール ID |
|
|
|
エイリアス ID |
|
|
|
ビルド ID |
|
|
|
フリート ID |
|
|
|
名前 |
|
|
|
|
|
|
|
名前 |
|
|
|
|
|
|
|
名前 |
|
|
|
|
|
|
|
名前 |
|
|
|
探知機 ID |
|
|
|
IPSet ID |
|
|
|
マスター ID |
|
|
|
メンバー ID |
|
|
|
脅威インテリジェンスセット ID |
|
|
|
AccessKeyId |
|
|
|
グループ名 |
|
|
|
ポリシー ARN |
|
|
|
名前 |
|
|
|
ユーザー名 |
|
|
| AWS::IoT::Certificate | 証明書 ID | a1234567b89c012d3e4fg567hij8k9l01mno1p23q45678901rs234567890t1u2 |
| AWS::IoT::Policy | ポリシー名 | MyPolicyName |
| AWS::IoT::Thing | モノの名前 | MyStack-MyThing-AB1CDEFGHIJK |
| AWS::IoT::TopicRule | トピックのルール名 | MyStackMyTopicRule12ABC3D456EFG |
| AWS::IoT1Click::Placement | プレイスメント名 (プロジェクトに関連付けられている)。 | region3 |
| AWS::IoT1Click::Project | プロジェクトの ARN。 | arn:aws:iot1click:us-west-2:0123456789012:projects/seattle-region |
| AWS::IoT1Click::Device | デバイスの ARN。 | arn:aws:iot1click:us-west-2:123456789012:devices/G030PX0312744DWM |
|
名前 |
|
|
|
コンシューマーの ARN |
|
|
|
配信ストリーム名 |
|
|
|
エイリアス名 |
|
|
|
キー ID |
|
|
|
AWS Lambda エイリアスの Amazon リソースネーム |
arn:aws:lambda:us-west-2:123456789012:function:helloworld:BETA |
|
|
名前 |
|
|
|
名前 |
|
|
|
レイヤーバージョン ARN。 |
|
|
|
ステートメント ID 付きのレイヤバージョン ARN。 |
|
|
|
AWS Lambda バージョンの Amazon リソースネーム |
arn:aws:lambda:us-west-2:123456789012:function:helloworld:1 |
|
|
送信先名 |
|
|
|
名前 |
|
|
|
ログストリーム名 |
|
|
|
AWS OpsWorks アプリケーション ID |
|
|
|
AWS OpsWorks インスタンス ID |
|
|
|
AWS OpsWorks レイヤー ID |
|
|
|
AWS OpsWorks スタック ID |
|
|
|
IAM ユーザーの Amazon リソースネーム |
|
|
|
AWS OpsWorks ボリューム ID |
|
|
|
AWS OpsWorks CM サーバーの Amazon リソースネーム |
|
|
|
クラスター名 |
|
|
|
パラメータグループ名 |
|
|
|
名前 |
|
|
|
名前 |
|
|
|
DB サブネットグループ名 |
|
|
|
名前 |
|
|
|
名前 |
|
|
|
名前 |
|
|
|
名前 |
|
|
|
名前 |
|
|
|
Amazon Route 53 ヘルスチェック ID |
|
|
| ホストゾーン ID |
|
|
| エンドポイント ID |
|
|
| ルール ID |
|
|
| リゾルバールールの関連付け ID |
|
|
|
名前 |
|
|
| AWS::SecretsManager::Secret | シークレット ARN | arn:aws:secretsmanager:us-east-2:123456789012:secret:MyPath/MySecretName-a1b2c3 |
|
ID |
|
|
|
名前 |
|
|
|
名前 |
|
|
|
名前 |
|
|
|
トピック ARN |
|
|
|
キュー URL |
|
|
|
SSM ドキュメント名 |
|
|
|
メンテナンスウィンドウ ID |
|
|
|
メンテナンスウィンドウのターゲット ID |
|
|
|
メンテナンスウィンドウのタスク ID |
|
|
|
パッチベースライン ID |
AWS によって提供されるデフォルトのパッチベースラインの ID は、ARN (例: |
|
| AWS::StepFunctions::Activity | AWS Step Functions アクティビティの Amazon リソースネーム (ARN) | arn:aws:states:us-east-1:111122223333:activity:myActivity |
| AWS::StepFunctions::StateMachine | 作成された Step Functions ステートマシンの ARN | arn:aws:states:us-east-1:111122223333:stateMachine:MyStateMachine-ABCDEFGHIJ1K |
|
バイト一致 ID |
|
|
|
IP セット ID |
|
|
|
ルール ID |
|
|
|
サイズ制限設定 ID |
|
|
|
SQL 一致セット ID |
|
|
|
ウェブ ACL ID |
|
|
|
XSS 一致セット ID |
|
|
|
バイト一致 ID |
|
|
|
IP セット ID |
|
|
|
ルール ID |
|
|
|
サイズ制限設定 ID |
|
|
|
SQL 一致セット ID |
|
|
|
ウェブ ACL ID |
|
|
|
XSS 一致セット ID |
|
|
|
ワークスペース ID |
|
|
|
AWS::AccountId |
|
|
|
AWS::NotificationARNs |
|
|
|
AWS::NoValue |
値を返しません。 |
|
|
AWS::Partition |
|
|
|
AWS::Region |
|
|
|
AWS::StackId |
|
|
|
AWS::StackName |
|
