Lüfter:: GetStackOutput

Die intrinsische Funktion Fn::GetStackOutput gibt den Wert einer Ausgabe aus einem anderen Stapel zurück. Im Gegensatz dazu erfordert diese Funktion nichtFn::ImportValue, dass der Stack, auf den verwiesen wird, den Ausgabewert explizit exportiert. Sie unterstützt auch konto- und regionsübergreifende Verweise.

Verwenden Sie diese Funktion, wenn Sie stapelübergreifende Ausgaben für AWS Konten oder Regionen referenzieren müssen oder wenn Sie auf Ausgaben verweisen möchten, ohne explizite Exporte zu verwalten.

Deklaration

{
  "Fn::GetStackOutput": {
    "StackName": "stack-name",
    "OutputName": "output-name",
    "Region": "region",
    "RoleArn": "role-arn"
  }
}

Fn::GetStackOutput:
  StackName: stack-name
  OutputName: output-name
  Region: region
  RoleArn: role-arn

!GetStackOutput
  StackName: stack-name
  OutputName: output-name
  Region: region
  RoleArn: role-arn

# Do not use
!GetStackOutput
  StackName: !Ref MyStackNameParam
  OutputName: VpcId

# Use this instead
Fn::GetStackOutput:
  StackName: !Ref MyStackNameParam
  OutputName: VpcId

Parameters

Rückgabewert

Der Wert der angegebenen Ausgabe aus dem referenzierten Stack.

Beispiele

Derselbe Account, gleiche Region

Das folgende Beispiel verweist auf die VpcId Ausgabe eines Stacks, der nach demselben Konto und derselben Region benannt ProducerStack ist. Da kein Region oder angegeben RoleArn ist, werden die Region und die Ausführungsrolle des aktuellen Stacks CloudFormation verwendet.

{
  "Fn::GetStackOutput": {
    "StackName": "ProducerStack",
    "OutputName": "VpcId"
  }
}

Fn::GetStackOutput:
  StackName: ProducerStack
  OutputName: VpcId

Gleiches Konto, andere Region

Das folgende Beispiel bezieht sich auf die VpcId Ausgabe von ProducerStack Deployed inus-west-2, während sich der verbrauchende Stack in einer anderen Region befindet. Der Region Parameter weist CloudFormation an, den referenzierten Wert in nachzuschlagenus-west-2.

{
  "Fn::GetStackOutput": {
    "StackName": "ProducerStack",
    "OutputName": "VpcId",
    "Region": "us-west-2"
  }
}

Fn::GetStackOutput:
  StackName: ProducerStack
  OutputName: VpcId
  Region: us-west-2

Cross-account

Das folgende Beispiel verweist auf die VpcId Ausgabe von ProducerStack in account111111111111. Der verbrauchende Stapel befindet sich im Konto222222222222. Das RoleArn gibt eine Rolle im Konto 111111111111 mit cloudformation:DescribeStacks Berechtigungen an, die von der Ausführungsrolle des verbrauchenden Stacks übernommen werden müssen.

{
  "Fn::GetStackOutput": {
    "StackName": "ProducerStack",
    "OutputName": "VpcId",
    "RoleArn": "arn:aws:iam::111111111111:role/GetStackOutputRole"
  }
}

Fn::GetStackOutput:
  StackName: ProducerStack
  OutputName: VpcId
  RoleArn: arn:aws:iam::111111111111:role/GetStackOutputRole

Cross-account und regionsübergreifend

Das folgende Beispiel verweist auf eine Ausgabe eines Stacks in einem anderen Konto und einer anderen Region. Sowohl die als RoleArn auch die Region Parameter sind angegeben.

{
  "Fn::GetStackOutput": {
    "StackName": "ProducerStack",
    "OutputName": "VpcId",
    "RoleArn": "arn:aws:iam::111111111111:role/GetStackOutputRole",
    "Region": "us-west-2"
  }
}

Fn::GetStackOutput:
  StackName: ProducerStack
  OutputName: VpcId
  RoleArn: arn:aws:iam::111111111111:role/GetStackOutputRole
  Region: us-west-2

IAM-Rollenkonfiguration

Wenn Sie den RoleArn Parameter für kontoübergreifende Verweise verwenden, muss die IAM-Rolle berechtigt sein, Stacks in dem Konto zu beschreiben, das den Stack enthält, auf den verwiesen wird:

{
  "Version": "2012-10-17",
  "Statement": [
    {
      "Effect": "Allow",
      "Action": [
        "cloudformation:DescribeStacks"
      ],
      "Resource": "*"
    }
  ]
}

Die Rolle muss über eine Vertrauensrichtlinie verfügen, die der Ausführungsrolle des Stacks, der den Stack nutzt, AssumeRole Berechtigungen gewährt:

{
  "Version": "2012-10-17",
  "Statement": [
    {
      "Effect": "Allow",
      "Principal": {
        "AWS": "arn:aws:iam::222222222222:role/CloudFormationExecutionRole"
      },
      "Action": "sts:AssumeRole"
    }
  ]
}

Unterstützte Funktionen

Die folgenden Funktionen können innerhalb der Parameterwerte von verwendet werden Fn::GetStackOutput (z. B. um das StackName Oder zu konstruierenRoleArn). Der Wert dieser Funktionen darf nicht von einer Ressource abhängen.

Fn::GetStackOutputselbst kann an den folgenden Template-Positionen verwendet werden:

Bekannte BeschränkungenUnten finden Sie Positionen, die noch nicht unterstützt werden.

Sie können beispielsweise verwenden, Ref um einen Parameterwert als Stacknamen zu übergeben:

Parameters:
  SourceStackName:
    Type: String

Resources:
  MyResource:
    Type: AWS::EC2::Instance
    Properties:
      SubnetId:
        Fn::GetStackOutput:
          StackName: !Ref SourceStackName
          OutputName: SubnetId

Bekannte Beschränkungen

Die folgenden Verwendungsmuster werden in dieser Version nicht unterstützt. Alle geben einen InternalFailure Fehler zurück. Die Support für diese Muster wird in einem future Update hinzugefügt.

Verwenden Sie ihn Fn::GetStackOutput direkt als Eigenschaftswert einer Ressource oder fügen Sie ihn in Fn::JoinFn::If, oder einFn::Select.

Fehlerbehandlung

CloudFormation validiert Fn::GetStackOutput Verweise bei der Erstellung oder Aktualisierung von Stacks. Im Folgenden sind die häufigsten Fehler aufgeführt, auf die Sie möglicherweise stoßen können:

Verweise zwischen US-East-1- und Opt-In-Regionen

Bei der Implementierung eines Verweises zwischen der us-east-1 Region und einer Opt-in-Region kann ein Fehler auftreten. Um solche Fehler zu vermeiden, folgen Sie dieser Anleitung zur Aktualisierung der Token-Kompatibilität für den globalen STS-Endpunkt.

Verwenden von Fn:: GetStackOutput mit AWS Cloud Development Kit (AWS CDK)

Das AWS Cloud Development Kit (AWS CDK) (CDK) unterstützt Fn::GetStackOutput durch die Fn.getStackOutput() Methode. Wenn Sie über regionsübergreifende oder kontenübergreifende Verweise zwischen CDK-Stacks verfügen, kann das CDK diese nun Fn::GetStackOutput nativ verwenden, anstatt benutzerdefinierte Ressourcen mit SSM-Parametern zu generieren. Dies vereinfacht die synthetisierten Vorlagen und macht die vorherige Problemumgehung überflüssig. crossRegionReferences

Weitere Informationen finden Sie in der CDK-API-Referenz.

Vergleich mit Fn: ImportValue

Verwenden Sie diese Fn::ImportValue Option, wenn Sie eine starke referenzielle Integrität innerhalb desselben Kontos und derselben Region benötigen. Verwenden Sie diese OptionFn::GetStackOutput, wenn Sie konto- oder regionsübergreifende Referenzen benötigen oder wenn Sie die Verwaltung expliziter Exporte vermeiden möchten.

Best Practices