Ventilateur : GetStackOutput

La fonction intrinsèque Fn::GetStackOutput renvoie la valeur d'une sortie d'une autre pile. Contrairement à cette fonctionFn::ImportValue, il n'est pas nécessaire que la pile référencée exporte explicitement la valeur de sortie. Il prend également en charge les références entre comptes et entre régions.

Utilisez cette fonction lorsque vous devez référencer des sorties empilées entre AWS des comptes ou des régions, ou lorsque vous souhaitez référencer des sorties sans gérer d'exportations explicites.

Déclaration

{
  "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

Valeur renvoyée

La valeur de la sortie spécifiée à partir de la pile référencée.

Exemples

Même compte, même région

L'exemple suivant fait référence à la VpcId sortie d'une pile nommée ProducerStack dans le même compte et dans la même région. Comme aucun Region ou n'RoleArnest spécifié, CloudFormation utilise la région et le rôle d'exécution de la pile actuelle.

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

Fn::GetStackOutput:
  StackName: ProducerStack
  OutputName: VpcId

Même compte, région différente

L'exemple suivant fait référence à la VpcId sortie du produit ProducerStack déployé dansus-west-2, alors que la pile consommatrice se trouve dans une région différente. Le Region paramètre indique CloudFormation de rechercher la valeur référencée dansus-west-2.

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

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

Cross-account

L'exemple suivant fait référence à la VpcId sortie de ProducerStack in account111111111111. La pile consommatrice est prise en compte222222222222. RoleArnSpécifie un rôle dans le compte 111111111111 avec cloudformation:DescribeStacks des autorisations, qui doit être assumé par le rôle d'exécution de la pile consommatrice.

{
  "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 et interrégional

L'exemple suivant fait référence à une sortie provenant d'une pile d'un autre compte et d'une autre région. Les Region paramètres RoleArn et sont tous deux spécifiés.

{
  "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

Configuration du rôle IAM

Lorsque vous utilisez le RoleArn paramètre pour les références entre comptes, le rôle IAM doit être autorisé à décrire les piles du compte contenant la pile référencée :

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

Le rôle doit avoir une politique de confiance qui accorde des AssumeRole autorisations au rôle d'exécution de la pile consommatrice :

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

Fonctions prises en charge

Les fonctions suivantes peuvent être utilisées dans les valeurs des paramètres de Fn::GetStackOutput (par exemple, pour construire le StackName ouRoleArn). La valeur de ces fonctions ne peut pas dépendre d'une ressource.

Fn::GetStackOutputlui-même peut être utilisé dans les positions de modèle suivantes :

Voir Limitations connues ci-dessous les postes qui ne sont pas encore pris en charge.

Par exemple, vous pouvez utiliser Ref pour transmettre une valeur de paramètre comme nom de pile :

Parameters:
  SourceStackName:
    Type: String

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

Limitations connues

Les modèles d'utilisation suivants ne sont pas pris en charge dans cette version. Toutes renvoient un InternalFailure message d'erreur. Support pour ces modèles sera ajouté dans une future mise à jour.

Fn::GetStackOutputUtilisez-la directement comme valeur de propriété de ressource ou insérez-la dans Fn::JoinFn::If, ouFn::Select.

Gestion des erreurs

CloudFormation valide les Fn::GetStackOutput références lors des opérations de création ou de mise à jour de piles. Les erreurs les plus courantes que vous pouvez rencontrer sont les suivantes :

Références entre les régions us-east-1 et opt-in

Il se peut que vous rencontriez une erreur lors de la mise en œuvre d'une référence entre la us-east-1 région et une région optionnelle. Pour éviter de telles erreurs, suivez ce guide pour mettre à jour la compatibilité des jetons pour le point de terminaison STS global.

Utilisation de Fn : : GetStackOutput avec AWS Cloud Development Kit (AWS CDK)

Le AWS Cloud Development Kit (AWS CDK) (CDK) prend en charge Fn::GetStackOutput le Fn.getStackOutput() procédé. Lorsque vous avez des références entre régions ou entre comptes entre des piles de CDK, le CDK peut désormais les utiliser de Fn::GetStackOutput manière native au lieu de générer des ressources personnalisées avec des paramètres SSM. Cela simplifie les modèles synthétisés et élimine le besoin de la solution de crossRegionReferences contournement précédente.

Pour plus d'informations, consultez la référence de l'API CDK.

Comparaison avec Fn : ImportValue

Fn::ImportValueÀ utiliser lorsque vous avez besoin d'une solide intégrité référentielle au sein d'un même compte et d'une même région. Fn::GetStackOutputÀ utiliser lorsque vous avez besoin de références entre comptes ou entre régions, ou lorsque vous souhaitez éviter de gérer des exportations explicites.

Bonnes pratiques