AWS CloudFormation
User Guide (API Version 2010-05-15)
AWS 服务或AWS文档中描述的功能,可能因地区/位置而异。请点击 Amazon AWS 入门,可查看中国地区的具体差异

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

短格式的语法:

!Ref logicalName

参数

logicalName

您想解除引用的资源或参数之逻辑名称。

返回值

资源的物理 ID 或参数的值。

示例

为弹性 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 的字符串。

资源返回示例

本部分列出了 Ref 所返回的特定 AWS CloudFormation 资源的示例值。有关特定资源或属性的 Ref 返回值的更多信息,请参考该资源或属性的文档。

资源类型 参考值 示例返回值

AWS::ApiGateway::Account

API 网关 账户资源 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 网关 资源 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

项目名称

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::DirectoryService::MicrosoftAD

Microsoft 目录 ID

d-12345ab592

AWS::DirectoryService::SimpleAD

目录 ID

d-12345ab592

AWS::DynamoDB::Table

表名称

MyDDBTable

AWS::EC2::EIP

弹性 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 资源名称 (ARN)

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

AWS::ElasticLoadBalancingV2::ListenerRule

侦听器规则的 Amazon 资源名称 (ARN)

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

AWS::ElasticLoadBalancingV2::LoadBalancer

应用程序负载均衡器的 Amazon 资源名称 (ARN)

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

AWS::ElasticLoadBalancingV2::TargetGroup

目标组的 Amazon 资源名称 (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::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

数据库子网组名称

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::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

Web 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

Web 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