Fn::GetStackOutput

La función intrínseca Fn::GetStackOutput devuelve el valor de una salida desde otra pila. A diferencia de Fn::ImportValue, esta función no requiere que la pila a la que se hace referencia exporte explícitamente el valor de salida. También admite las referencias entre cuentas y entre regiones.

Utilice esta función cuando necesite hacer referencia a las salidas de las pilas de distintas cuentas o regiones de AWS, o cuando desee hacer referencia a las salidas sin gestionar exportaciones explícitas.

Declaración

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

Valor devuelto

El valor de la salida especificada de la pila a la que se hace referencia.

Ejemplos

Misma cuenta, misma región

El siguiente ejemplo hace referencia a la salida VpcId de una pila nombrada como ProducerStack en la misma cuenta y región. Como no se especifica ni Region ni RoleArn, CloudFormation usa la función de región y ejecución de la pila actual.

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

Fn::GetStackOutput:
  StackName: ProducerStack
  OutputName: VpcId

Misma cuenta, diferente región

El siguiente ejemplo hace referencia a la salida VpcId de la pila ProducerStack implementada en us-west-2, mientras que la pila consumidora se encuentra en una región diferente. El parámetro Region indica a CloudFormation que busque el valor al que se hace referencia en us-west-2.

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

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

Entre cuentas

El siguiente ejemplo hace referencia a la salida de VpcId de la ProducerStack en una cuenta 111111111111. La pila consumidora está en la cuenta 222222222222. RoleArn especifica un rol en la cuenta 111111111111 con permisos cloudformation:DescribeStacks, que debe ser asumida por el rol de ejecución de la pila consumidora.

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

Entre cuentas y entre regiones

El siguiente ejemplo hace referencia a la salida de una pila en una cuenta diferente y en una región también diferente. Se especifican los dos parámetros RoleArn y Region.

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

Configurar el rol de IAM

Al utilizar el parámetro RoleArn para referencias entre cuentas, el rol de IAM debe tener permiso para describir las pilas de la cuenta que contiene la pila a la que se hace referencia:

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

El rol debe tener una política de confianza que otorgue permisos de AssumeRole al rol de ejecución de la pila consumidora:

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

Funciones compatibles

Las siguientes funciones se pueden usar dentro de los valores de los parámetros de Fn::GetStackOutput (por ejemplo, para construir StackName o RoleArn). El valor de estas funciones no puede depender de un recurso.

Fn::GetStackOutput se puede utilizar en las siguientes posiciones de plantilla:

Consulte Limitaciones conocidas debajo para ver qué posiciones todavía no se admiten.

Por ejemplo, se puede utilizar Ref para pasar un valor de parámetro como nombre de la pila:

Parameters:
  SourceStackName:
    Type: String

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

Limitaciones conocidas

Esta versión no admite los siguientes patrones de uso. Todas devuelven un error InternalFailure. Se agregará compatibilidad para estos patrones en una actualización futura.

Use Fn::GetStackOutput directamente como valor de propiedad de un recurso o envuélvalo dentro de Fn::Join, Fn::If o Fn::Select.

Gestión de errores

CloudFormation valida las referencias Fn::GetStackOutput durante las operaciones de creación o actualización de pilas. A continuación, se enumeran errores comunes que puede encontrar:

Referencias entre regiones us-east-1 y regiones de suscripción voluntaria

Es posible que se produzca un error al implementar una referencia entre la región us-east-1 y una región de suscripción voluntaria. Para evitar este tipo de errores, siga esta guía para actualizar la compatibilidad de los tokens para el punto de conexión STS global.

Uso de Fn::GetStackOutput con AWS Cloud Development Kit (AWS CDK)

El AWS Cloud Development Kit (AWS CDK) (CDK) admite Fn::GetStackOutput a través del método Fn.getStackOutput(). Si tiene referencias entre regiones o entre cuentas entre pilas de CDK, ahora CDK puede utilizar Fn::GetStackOutput de forma nativa en lugar de generar recursos personalizados con parámetros de SSM. Esto simplifica las plantillas sintetizadas y elimina la necesidad de recurrir a la solución anterior crossRegionReferences.

Para obtener más información, consulte la Referencia de la API de CDK.

Comparación con Fn::ImportValue

Use Fn::ImportValue cuando necesite una sólida integridad referencial dentro de la misma cuenta y región. Use Fn::GetStackOutput cuando necesite referencias entre cuentas o regiones, o cuando desee evitar la gestión de exportaciones explícitas.

Prácticas recomendadas