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

Fn::ImportValue

内部函数 Fn::ImportValue 返回由另一个堆栈导出的输出的值。您通常使用此函数来创建跨堆栈引用。在下面的示例模板代码段中,堆栈 A 导出 VPC 安全组值,而堆栈 B 导入这些值。

注意

以下限制适用于跨堆栈引用:

  • 对于每个 AWS 账户,Export 名称在一个区域内必须是唯一的。

  • 不能在区域之间创建跨堆栈引用。您只能使用内部函数 Fn::ImportValue 导入在同一区域内已经导出的值。

  • 对于输出,ExportName 属性值不能使用依赖于资源的函数 (RefGetAtt)。

    同样,ImportValue 函数不能包括依赖于资源的函数 (RefGetAtt)。

  • 如果另一个堆栈引用一个堆栈的其中一个输出,则您无法删除被引用堆栈。

  • 您无法修改或删除由另一个堆栈引用的输出值。

堆栈 A 导出

Copy
"Outputs" : { "PublicSubnet" : { "Description" : "The subnet ID to use for public web servers", "Value" : { "Ref" : "PublicSubnet" }, "Export" : { "Name" : {"Fn::Sub": "${AWS::StackName}-SubnetID" }} }, "WebServerSecurityGroup" : { "Description" : "The security group ID to use for public web servers", "Value" : { "Fn::GetAtt" : ["WebServerSecurityGroup", "GroupId"] }, "Export" : { "Name" : {"Fn::Sub": "${AWS::StackName}-SecurityGroupID" }} } }

堆栈 B 导入

Copy
"Resources" : { "WebServerInstance" : { "Type" : "AWS::EC2::Instance", "Properties" : { "InstanceType" : "t2.micro", "ImageId" : "ami-a1b23456", "NetworkInterfaces" : [{ "GroupSet" : [{"Fn::ImportValue" : {"Fn::Sub" : "${NetworkStackNameParameter}-SecurityGroupID"}}], "AssociatePublicIpAddress" : "true", "DeviceIndex" : "0", "DeleteOnTermination" : "true", "SubnetId" : {"Fn::ImportValue" : {"Fn::Sub" : "${NetworkStackNameParameter}-SubnetID"}} }] } } }

声明

JSON

Copy
{ "Fn::ImportValue" : sharedValueToImport }

YAML

您可以使用完整的函数名称:

Copy
Fn::ImportValue: sharedValueToImport

或者,您也可以使用短格式:

Copy
!ImportValue sharedValueToImport

重要

当它包含 !Sub 时,不能使用 !ImportValue 的简写形式。下面的示例适用于 AWS CloudFormation,但对 YAML 无效

Copy
!ImportValue !Sub "${NetworkStack}-SubnetID"

此时,您必须使用完整的函数名称,例如:

Copy
Fn::ImportValue: !Sub "${NetworkStack}-SubnetID"

参数

sharedValueToImport

要导入的堆栈输出值。

返回值

堆栈输出值。

示例

JSON

Copy
{ "Fn::ImportValue" : {"Fn::Sub": "${NetworkStackNameParameter}-SubnetID" } }

YAML

Copy
Fn::ImportValue: !Sub "${NetworkStackName}-SecurityGroupID"

支持的函数

您可在 Fn::ImportValue 函数中使用以下函数。这些函数的值无法依赖资源。

  • Fn::Base64

  • Fn::FindInMap

  • Fn::If

  • Fn::Join

  • Fn::Select

  • Fn::Split

  • Fn::Sub

  • Ref