Ref - AWS CloudFormation

Ref

Die intrinsische Funktion Ref gibt den Wert des angegebenen Parameters oder der angegebenen Ressource zurück.

  • Wenn Sie den logischen Namen eines Parameters angeben, wird der Wert des Parameters zurückgegeben.

  • Wenn Sie den logischen Namen einer Ressource angeben, wird ein Wert zurückgegeben, mit dem Sie üblicherweise auf diese Ressource verweisen können, z. B. eine physische ID.

Wenn Sie eine Ressource in einer Vorlage deklarieren und eine andere Vorlagenressource mit dem Namen angeben müssen, können Sie mit der Ref-Funktion auf die andere Ressource verweisen. Im Allgemeinen gibt Ref den Namen der Ressource zurück. Beispielsweise gibt eine Referenz auf eine AWS::AutoScaling::AutoScalingGroup den Namen der Auto Scaling-Gruppenressource zurück.

Für einige Ressourcen wird eine ID zurückgegeben, die im Kontext der Ressource eine andere signifikante Bedeutung hat. Eine AWS::EC2::EIP-Ressource gibt beispielsweise die IP-Adresse zurück und eine AWS::EC2::Instance gibt die Instance-ID zurück.

Tipp

Sie können Ref auch zum Hinzufügen von Werten zu Ausgabenachrichten verwenden.

Weitere Informationen zu Ref-Rückgabewerten für eine bestimmte Ressource oder Eigenschaft finden Sie in der Dokumentation für die betreffende Ressource oder Eigenschaft in der Ressourcen- und Eigenschaftstypen.

Deklaration

JSON

{ "Ref" : "logicalName" }

YAML

Syntax für den vollständigen Funktionsnamen:

Ref: logicalName

Syntax für die Kurzform:

!Ref logicalName

Parameter

logicalName

Der logische Name der Ressource oder des Parameters, die bzw. der zu dereferenzieren ist.

Rückgabewert

Die physische ID der Ressource oder der Wert des Parameters.

Beispiel

In der folgenden Ressourcendeklaration für eine Elastic IP-Adresse wird die Instance-ID einer EC2-Instance benötigt und die Ref-Funktion verwendet, um die Instance-ID der Ressource MyEC2Instance anzugeben:

JSON

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

YAML

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

Unterstützte Funktionen

Sie können keinerlei Funktionen in der Ref-Funktion verwenden. Sie müssen eine Zeichenfolge angeben, die eine logische ID einer Ressource darstellt.