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

Ref

組み込み関数 Ref は、指定したパラメーターまたはリソースの値を返します。

  • パラメーターの論理名を指定すると、それはパラメーターの値を返します。

  • リソースの論理名を指定すると、それはそのリソースを参照するために通常使用できる値を返します (物理 ID)。

テンプレートでリソースを宣言するときに別のテンプレートリソースを名前で指定する必要がある場合は、Ref を使用して別のリソースを参照できます。一般的に、Ref はリソースの名前を返します。たとえば、AWS::AutoScaling::AutoScalingGroup の参照は、Auto Scaling グループリソースの名前を返します。

一部のリソースでは、リソースのコンテキストにおいて別の重要な意味を持つ識別子が返されます。たとえば、AWS::EC2::EIP リソースは IP アドレスを返し、AWS::EC2::Instance はインスタンス ID を返します。

このトピックの末尾に、多くの一般的なリソースタイプに対して返される値をリストアップした表があります。特定のリソースまたはプロパティに対する Ref の戻り値の詳細については、そのリソースまたはプロパティのドキュメントを参照してください。

ヒント

Ref を使用して Output メッセージに値を追加することもできます。

宣言

JSON

Copy
{ "Ref" : "logicalName" }

YAML

完全名関数の構文:

Copy
Ref: logicalName

短縮形の構文:

Copy
!Ref logicalName

パラメータ

logicalName

参照解除するパラメーターまたはリソースの論理名。

戻り値

リソースの物理 ID またはパラメーターの値。

以下の Elastic IP アドレスのリソース宣言は、EC2 インスタンスのインスタンス ID を必要とし、Ref 関数を使用して MyEC2Instance リソースのインスタンス ID を指定します。

JSON

Copy
"MyEIP" : { "Type" : "AWS::EC2::EIP", "Properties" : { "InstanceId" : { "Ref" : "MyEC2Instance" } } }

YAML

Copy
MyEIP: Type: "AWS::EC2::EIP" Properties: InstanceId: !Ref MyEC2Instance

サポートされている関数

Ref 関数には関数を使用できません。リソースの論理 ID である文字列を指定する必要があります。

リソースの戻り値の例

このセクションでは、特定の AWS CloudFormation リソースに対して Ref から返される戻り値の例を示します。特定のリソースまたはプロパティに対する Ref の戻り値の詳細については、そのリソースまたはプロパティのドキュメントを参照してください。

リソースタイプ 参照値 戻り値の例

AWS::ApiGateway::Account

API Gateway アカウントのリソース ID

mysta-accou-01234b567890example

AWS::ApiGateway::ApiKey

API キー

m2m1k7sybf

AWS::ApiGateway::Authorizer

認証のリソース ID

abcde1

AWS::ApiGateway::ClientCertificate

クライアント証明書名

abc123

AWS::ApiGateway::Deployment

デプロイメントリソース ID

abc123

AWS::ApiGateway::DomainName

ドメイン名

example.mydomain.com

AWS::ApiGateway::Method

メソッドリソース ID

mysta-metho-01234b567890example

AWS::ApiGateway::Model

モデル名

myModel

AWS::ApiGateway::Resource

API Gateway リソース ID

abc123

AWS::ApiGateway::RestApi

Rest API リソース ID

a1bcdef2gh

AWS::ApiGateway::Stage

ステージ名

MyTestStage

AWS::ApplicationAutoScaling::ScalableTarget

スケーラブルなターゲット ID

service/ecsStack-MyECSCluster-AB12CDE3F4GH/ecsStack-MyECSService-AB12CDE3F4GH|ecs:service:DesiredCount|ecs

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

AWS::Athena::NamedQuery

名前付きクエリ名

abc123

AWS::AutoScaling::AutoScalingGroup

名前

mystack-myasgroup-NT5EUXTNTXXD

AWS::AutoScaling::LaunchConfiguration

名前

mystack-mylaunchconfig-1DDYF1E3B3I

AWS::AutoScaling::LifecycleHook

名前

mylifecyclehookname

AWS::AutoScaling::ScalingPolicy

スケーリングポリシーの Amazon リソースネーム (ARN)

arn:aws:autoscaling:us-east-1:123456789012:scalingPolicy:ab12c4d5-a1b2-a1b2-a1b2-ab12c4d56789:autoScalingGroupName/myStack-AutoScalingGroup-AB12C4D5E6:policyName/myStack-myScalingPolicy-AB12C4D5E6

AWS::AutoScaling::ScheduledAction

名前

mystack-myscheduledaction-NT5EUXTNTXXD

AWS::Batch::ComputeEnvironment

AWS Batch コンピューティング環境 Amazon リソースネーム (ARN)

arn:aws:batch:us-east-1:555555555555:compute-environment/M4OnDemand

AWS::Batch::JobDefinition

AWS Batch ジョブ定義の Amazon リソースネーム (ARN)

arn:aws:batch:us-east-1:111122223333:job-definition/test-gpu:2

AWS::Batch::JobQueue

AWS Batch ジョブキューの Amazon リソースネーム (ARN)

arn:aws:batch:us-east-1:111122223333:job-queue/HighPriority

AWS::CertificateManager::Certificate

証明書 Amazon リソースネーム (ARN)

arn:aws:acm:us-east-1:123456789012:certificate/12ab3c4d-56789-0ef1-2345-3dab6fa3ee50

AWS::CloudFormation::Stack

スタック ID

arn:aws:cloudformation:us-east-2:803981987763:stack/mystack-mynestedstack-sggfrhxhum7w/f449b250-b969-11e0-a185-5081d0136786

AWS::CloudFormation::WaitCondition

名前

arn:aws:cloudformation:us-east-2:803981987763:stack/mystack/c325e210-bdf2-11e0-9638-50690880c386/mywaithandle

AWS::CloudFormation::WaitConditionHandle

待機条件シグナル URL

https://cloudformation-waitcondition-us-east-2.s3.amazonaws.com/arn%3Aaws%3Acloudformation%3Aus-east-2%3A803981987763%3Astack%2Fwaittest%2F054a33d0-bdee-11e0-8816-5081c490a786%2FmyWaitHandle?Expires=1312475488&AWSAccessKeyId=AKIAIOSFODNN7EXAMPLE&Signature=tUsrW3WvWVT46K69zMmgbEkwVGo%3D

AWS::CloudFront::Distribution

ディストリビューション ID

E27LVI50CSW06W

AWS::CloudTrail::Trail

証跡名

awscloudtrail-example

AWS::CloudWatch::Alarm

名前

mystack-myalarm-3AOHFRGOXR5T

AWS::CodeBuild::Project

Project name

myProjectName

AWS::CodeCommit::Repository

リポジトリ ID

12a345b6-bbb7-4bb6-90b0-8c9577a2d2b9

AWS::CodeDeploy::Application

アプリケーション名

myapplication-a123d0d1

AWS::CodeDeploy::DeploymentConfig

デプロイ設定名

mydeploymentconfig-a123d0d1

AWS::CodeDeploy::DeploymentGroup

デプロイグループ名

mydeploymentgroup-a123d0d1

AWS::CodePipeline::CustomActionType

カスタムアクション名

mysta-MyCus-A1BCDEFGHIJ2

AWS::CodePipeline::Pipeline

パイプライン名

mysta-MyPipeline-A1BCDEFGHIJ2

AWS::Config::ConfigRule

設定ルール名

mystack-MyConfigRule-12ABCFPXHV4OV

AWS::Config::ConfigurationRecorder

設定レコーダー名

default

AWS::Config::DeliveryChannel

配信チャネル名

default

AWS::DataPipeline::Pipeline

パイプライン ID

df-sample322HVPGK130TOD

AWS::DAX::Cluster

Name

例: MyDAXCluster

AWS::DirectoryService::MicrosoftAD

Microsoft ディレクトリ ID

d-12345ab592

AWS::DirectoryService::SimpleAD

ディレクトリ ID

d-12345ab592

AWS::DynamoDB::Table

テーブル名

MyDDBTable

AWS::EC2::EIP

Elastic IP アドレス

192.0.2.0

AWS::EC2::EIPAssociation

名前

mystack-myeipa-1NU3IL8LJ313N

AWS::EC2::FlowLog

フローログ ID

fl-1a23b456

AWS::EC2::Host

ホスト ID

h-0ab123c45d67ef89

AWS::EC2::Instance

インスタンス ID

i-636be302

AWS::EC2::NatGateway

NAT ゲートウェイ ID

nat-0a12bc456789de0fg

AWS::EC2::NetworkInterfacePermission

ネットワークインターフェイスアクセス権限 ID

eni-perm-055663b682ea24b48

AWS::EC2::PlacementGroup

プレイスメントグループ名

mystack-myplacementgroup-CU6107MRVLR7

AWS::EC2::RouteTable

ルートテーブル ID

rtb-12a34567

AWS::EC2::SecurityGroup

名前またはセキュリティグループ ID (デフォルト VPC がない VPC セキュリティグループの場合)

mystack-mysecuritygroup-QQB406M8FISX or sg-94b3a1f6

AWS::EC2::SecurityGroupIngress

名前

mysecuritygroupingress

AWS::EC2::SpotFleet

名前

sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE

AWS::EC2::Subnet

サブネット ID

subnet-e19f0178

AWS::EC2::Volume

ボリューム ID

vol-3cdd3f56

AWS::EC2::VolumeAttachment

名前

mystack-myvola-ERXHJITXMRLT

AWS::EC2::VPC

VPC ID

vpc-18ac277d

AWS::EC2::VPCPeeringConnection

VPC ピア接続 ID

pcx-75de3e1d

AWS::EC2::VPCEndpoint

エンドポイント ID

vpce-a123d0d1

AWS::ECR::Repository

リポジトリ名

test-repository

AWS::ECS::Cluster

名前

MyStack-MyECSCluster-NT5EUXTNTXXD

AWS::ECS::Service

サービス ARN

arn:aws:ecs:us-west-2:123456789012:service/sample-webapp

AWS::ECS::TaskDefinition

タスク定義 ARN

arn:aws:ecs:us-west-2:123456789012:task-definition/TaskDefinitionFamily:1

AWS::EFS::FileSystem

ファイルシステム ID

fs-47a2c22e

AWS::EFS::MountTarget

マウントターゲット ID

fsmt-55a4413c

AWS::ElastiCache::ReplicationGroup

名前

abc12xmy3d1w3hv6

AWS::ElastiCache::SubnetGroup

名前

myCachesubnetgroup

AWS::ElasticLoadBalancingV2::Listener

リスナーの Amazon Resource Name (ARN)

arn:aws:elasticloadbalancing:us-west-2:123456789012:listener/app/my-load-balancer/50dc6c495c0c9188/f2f7dc8efc522ab2

AWS::ElasticLoadBalancingV2::ListenerRule

リスナーのルールの Amazon Resource Name (ARN)

arn:aws:elasticloadbalancing:us-west-2:123456789012:listener-rule/app/my-load-balancer/50dc6c495c0c9188/f2f7dc8efc522ab2/9683b2d02a6cabee

AWS::ElasticLoadBalancingV2::LoadBalancer

アプリケーションロードバランサーの Amazon Resource Name (ARN)

arn:aws:elasticloadbalancing:us-west-2:123456789012:loadbalancer/app/my-internal-load-balancer/50dc6c495c0c9188

AWS::ElasticLoadBalancingV2::TargetGroup

ターゲットグループの Amazon Resource Name (ARN)

arn:aws:elasticloadbalancing:us-west-2:123456789012:targetgroup/my-targets/73e2d6bc24d8a067

AWS::Elasticsearch::Domain

ドメイン名

mystack-elasticsea-abc1d2efg3h4

AWS::EMR::Cluster

クラスター ID

j-1ABCD123AB1A

AWS::EMR::InstanceGroupConfig

インスタンスグループ ID

ig-ABC12DEF3456

AWS::EMR::Step

ステップ ID

s-1A2BC3D4EFG56

AWS::ElasticBeanstalk::Application

名前

mystack-myapplication-FM6BIXY7U8PK

AWS::ElasticBeanstalk::ApplicationVersion

名前

mystack-myapplicationversion-iy8ptveuxjly

AWS::ElasticBeanstalk::ConfigurationTemplate

名前

mystack-myconfigurationtemplate-108RPH64J195

AWS::ElasticBeanstalk::Environment

名前

mystack-myenv-LKGNQSFHO1DB

AWS::ElasticLoadBalancing::LoadBalancer

名前

mystack-myelb-1WQN7BJGDB5YQ

AWS::Events::Rule

イベントルール ID

mystack-ScheduledRule-ABCDEFGHIJK

AWS::GameLift::Alias

エイリアス ID

myalias-a01234b56-7890-1de2-f345-g67h8i901j2k

AWS::GameLift::Build

ビルド ID

mybuild-a01234b56-7890-1de2-f345-g67h8i901j2k

AWS::GameLift::Fleet

フリート ID

myfleet-a01234b56-7890-1de2-f345-g67h8i901j2k

AWS::Glue::Classifier

名前

abc123

AWS::Glue::Connection

ConnectionInput name

abc123

AWS::Glue::Crawler

名前

abc123

AWS::Glue::Database

DatabaseInput name

abc123

AWS::Glue::Job

名前

abc123

AWS::Glue::Table

TableInput name

abc123

AWS::Glue::Trigger

名前

abc123

AWS::IAM::AccessKey

AccessKeyId

AKIAIOSFODNN7EXAMPLE

AWS::IAM::Group

グループ名

mystack-mygroup-1DZETITOWEKVO

AWS::IAM::ManagedPolicy

ポリシー ARN

arn:aws:iam::123456789012:policy/teststack-CreateTestDBPolicy-16M23YE3CS700

AWS::IAM::User

ユーザー名

mystack-myuser-1CCXAFG2H2U4D

AWS::IoT::Certificate 証明書 ID a1234567b89c012d3e4fg567hij8k9l01mno1p23q45678901rs234567890t1u2
AWS::IoT::Policy ポリシー名 MyPolicyName
AWS::IoT::Thing モノの名前 MyStack-MyThing-AB1CDEFGHIJK
AWS::IoT::TopicRule トピックのルール名 MyStackMyTopicRule12ABC3D456EFG

AWS::Kinesis::Stream

名前

mystack-mystream-1NAOH4L1RIQ7I

AWS::KinesisFirehose::DeliveryStream

配信ストリーム名

mystack-deliverystream-1ABCD2EF3GHIJ

AWS::KMS::Alias

エイリアス名

alias/myAlias

AWS::KMS::Key

キー ID

123ab456-a4c2-44cb-95fd-b781f32fbb37

AWS::Lambda::Alias

AWS Lambda エイリアスの Amazon リソースネーム

arn:aws:lambda:us-west-2:123456789012:function:helloworld:BETA

AWS::Lambda::EventSourceMapping

名前

MyStack-lambdaeventsourcemapping-CU6107MRVLR7

AWS::Lambda::Function

名前

MyStack-AMILookUp-NT5EUXTNTXXD

AWS::Lambda::Version

AWS Lambda バージョンの Amazon リソースネーム

arn:aws:lambda:us-west-2:123456789012:function:helloworld:1

AWS::Logs::Destination

送信先名

TestDestination

AWS::Logs::LogGroup

名前

mystack-myLogGroup-1341JS4M96031

AWS::Logs::LogStream

ログストリーム名

MyAppLogStream

AWS::OpsWorks::App

AWS OpsWorks アプリケーション ID

4fee5b96-0d10-4af1-bcc5-25f92e3c6acf

AWS::OpsWorks::Instance

AWS OpsWorks インスタンス ID

aa2e9ae2-2b4b-491c-aeb6-8bf3ce9400fe

AWS::OpsWorks::Layer

AWS OpsWorks レイヤー ID

730b238b-f7c4-461d-b7c0-3feb7ef1152a

AWS::OpsWorks::Stack

AWS OpsWorks スタック ID

5c9f04e8-370e-4bd3-ae09-a4bbcc2998bb

AWS::OpsWorks::UserProfile

IAM ユーザーの Amazon リソースネーム

arn:aws:iam::123456789012:user/opsworksuser

AWS::OpsWorks::Volume

AWS OpsWorks ボリューム ID

1ab23cd4-92ff-4501-b37c-example

AWS::RDS::DBCluster

クラスター名

test-rdscluster-pdedtss0mfqr

AWS::RDS::DBClusterParameterGroup

パラメーターグループ名

test-dbparamgroup-4l8qqx46vjby

AWS::RDS::DBInstance

名前

mystack-mydb-ea5ugmfvuaxg

AWS::RDS::DBSecurityGroup

名前

mystack-mydbsecuritygroup-1k5u5dxjb0nxs

AWS::RDS::DBSubnetGroup

DB サブネットグループ名

mystack-mydbsubnetgroup-1k5u5dxjb0nxs

AWS::RDS::OptionGroup

名前

mystack-myoptiongroup-1qmfawfea4vmz

AWS::Redshift::Cluster

名前

mystack-myredshiftcluster-ranmiv3f0mad

AWS::Redshift::ClusterParameterGroup

名前

mysta-mypar-1AJYM1FL3WQBW

AWS::Redshift::ClusterSecurityGroup

名前

mystack-myredshiftclustersecuritygroup-bjy2afmhy3ee

AWS::Redshift::ClusterSubnetGroup

名前

mystack-myredshiftclustersubnetgroup-aq6rsdq8rp71

AWS::Route53::HealthCheck

Amazon Route 53 ヘルスチェック ID

e0a123b4-4dba-4650-935e-example

AWS::Route53::HostedZone

ホストゾーン ID

Z23ABC4XYZL05B

AWS::S3::Bucket

名前

mystack-mys3bucket-1hbsmonr9mytq

AWS::SDB::Domain

名前

mystack-mysdbdomain-IVNAOZTDFVXL

AWS::SNS::Topic

トピック ARN

arn:aws:sns:us-east-2:123456789012:mystack-mytopic-NZJ5JSMVGFIE

AWS::SQS::Queue

キュー URL

https://sqs.us-east-2.amazonaws.com/803981987763/aa4-MyQueue-Z5NOSZO2PZE9

AWS::SSM::Document

SSM ドキュメント名

ssm-myinstanceconfig-ABCNPH3XCAO6

AWS::SSM::MaintenanceWindow

メンテナンスウィンドウ ID

mw-abcde1234567890yz

AWS::SSM::MaintenanceWindowTarget

メンテナンスウィンドウのターゲット ID

12a345b6-bbb7-4bb6-90b0-8c9577a2d2b9

AWS::SSM::MaintenanceWindowTask

メンテナンスウィンドウのタスク ID

12a345b6-bbb7-4bb6-90b0-8c9577a2d2b9

AWS::SSM::PatchBaseline

パッチベースライン ID

pb-abcde1234567890yz

AWS によって提供されるデフォルトのパッチベースライン ID は、arn:aws:ssm:us-west-2:123456789012:patchbaseline/abcde1234567890yz のような 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

AWS::WAF::ByteMatchSet

バイト一致 ID

aabc123a-fb4f-4fc6-becb-2b00831cadcf

AWS::WAF::IPSet

IP セット ID

aabc123a-fb4f-4fc6-becb-2b00831cadcf

AWS::WAF::Rule

ルール ID

aabc123a-fb4f-4fc6-becb-2b00831cadcf

AWS::WAF::SizeConstraintSet

サイズ制限設定 ID

aabc123a-fb4f-4fc6-becb-2b00831cadcf

AWS::WAF::SqlInjectionMatchSet

SQL 一致セット ID

aabc123a-fb4f-4fc6-becb-2b00831cadcf

AWS::WAF::WebACL

ウェブ ACL ID

aabc123a-fb4f-4fc6-becb-2b00831cadcf

AWS::WAF::XssMatchSet

XSS 一致セット ID

aabc123a-fb4f-4fc6-becb-2b00831cadcf

AWS::WAFRegional::ByteMatchSet

バイト一致 ID

aabc123a-fb4f-4fc6-becb-2b00831cadcf

AWS::WAFRegional::IPSet

IP セット ID

aabc123a-fb4f-4fc6-becb-2b00831cadcf

AWS::WAFRegional::Rule

ルール ID

aabc123a-fb4f-4fc6-becb-2b00831cadcf

AWS::WAFRegional::SizeConstraintSet

サイズ制限設定 ID

aabc123a-fb4f-4fc6-becb-2b00831cadcf

AWS::WAFRegional::SqlInjectionMatchSet

SQL 一致セット ID

aabc123a-fb4f-4fc6-becb-2b00831cadcf

AWS::WAFRegional::WebACL

ウェブ ACL ID

aabc123a-fb4f-4fc6-becb-2b00831cadcf

AWS::WAFRegional::XssMatchSet

XSS 一致セット ID

aabc123a-fb4f-4fc6-becb-2b00831cadcf

AWS::WorkSpaces::Workspace

ワークスペース ID

ws-cdd1gggh7

擬似パラメーター

AWS::AccountId

123456789012

擬似パラメーター

AWS::NotificationARNs

[arn:aws:sns:us-east-1:123456789012:MyTopic]

擬似パラメーター

AWS::NoValue

値を返しません。

擬似パラメーター

AWS::Region

us-east-2

擬似パラメーター

AWS::StackId

arn:aws:cloudformation:us-east-1:123456789012:stack/MyStack/1c2fa620-982a-11e3-aff7-50e2416294e0

擬似パラメーター

AWS::StackName

MyStack