Fn::GetStackOutput

Fn::GetStackOutput 組み込み関数は、別のスタックからの出力の値を返します。Fn::ImportValue とは異なり、この関数では参照されるスタックが出力値を明示的にエクスポートする必要はありません。また、クロスアカウント参照とクロスリージョン参照もサポートしています。

AWS アカウントまたはリージョン間でスタック出力を参照する必要がある場合、または明示的なエクスポートを管理せずに出力を参照する場合は、この関数を使用します。

宣言

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

パラメータ

戻り値

参照されるスタックから指定された出力の値。

例

同じアカウント、同じリージョン

次の例では、同じアカウントおよびリージョンの ProducerStack という名前のスタックからの VpcId 出力を参照します。Region または RoleArn が指定されていないため、CloudFormation は現在のスタックのリージョンと実行ロールを使用します。

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

Fn::GetStackOutput:
  StackName: ProducerStack
  OutputName: VpcId

同じアカウント、異なるリージョン

次の例では、us-west-2 にデプロイされた ProducerStack からの VpcId 出力を参照しますが、消費スタックは別のリージョンにあります。Region パラメータは、CloudFormation に で参照される値を検索するように指示しますus-west-2。

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

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

クロスアカウント

次の例では、アカウント 111111111111の ProducerStack からの VpcId 出力を参照します。消費スタックはアカウント 222222222222 にあります。RoleArn は、cloudformation:DescribeStacks アクセス許可を持つアカウント 111111111111 のロールを指定します。これは、消費スタックの実行ロールによって引き受け可能である必要があります。

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

クロスアカウントおよびクロスリージョン

次の例では、別のアカウントと別のリージョンのスタックからの出力を参照します。パラメータ RoleArn とパラメータ 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

IAM ロールの設定

クロスアカウント参照に RoleArn パラメータを使用する場合、IAM ロールには、参照されたスタックを含むアカウントのスタックを記述するアクセス許可が必要です。

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

ロールには、消費スタックの実行ロールに AssumeRole アクセス許可を付与する信頼ポリシーが必要です。

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

サポートされている関数

次の関数は、Fn::GetStackOutput のパラメータ値内で使用できます (例えば、StackName または RoleArn をコンストラクトします)。これらの関数の値はリソースに依存することはできません。

Fn::GetStackOutput 自体は、次のテンプレート位置で使用できます。

まだサポートされていないポジションについては、以下の 既知の制限事項 を参照してください。

例えば、Ref を使用してパラメータ値をスタック名として渡すことができます。

Parameters:
  SourceStackName:
    Type: String

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

既知の制限事項

このリリースでは、次の使用パターンはサポートされていません。すべてが InternalFailure エラーを返します。これらのパターンのサポートは、今後の更新で追加されます。

Fn::GetStackOutput をリソースプロパティ値として直接使用するか、Fn::Join、Fn::If、または Fn::Select 内にラップします。

エラー処理

CloudFormation は、スタックの作成または更新オペレーション中に Fn::GetStackOutput 参照を検証します。発生する可能性のある一般的なエラーを次に示します。

us-east-1 とオプトインリージョン間のリファレンス

us-east-1 リージョンとオプトインリージョンの間にリファレンスを実装するときにエラーが発生することがあります。このようなエラーを回避するには、このガイドに従ってグローバル STS エンドポイントのトークンの互換性を更新します。

AWS Cloud Development Kit (AWS CDK) での Fn::GetStackOutput の使用

AWS Cloud Development Kit (AWS CDK) (CDK) は Fn.getStackOutput() メソッドを通じて Fn::GetStackOutput をサポートします。CDK スタック間にクロスリージョンまたはクロスアカウント参照がある場合、CDK は SSM パラメータを使用してカスタムリソースを生成する代わりにネイティブに Fn::GetStackOutput を使用できるようになりました。これにより、合成されたテンプレートが簡素化され、以前の crossRegionReferences 回避策が不要になります。

詳細については、「 CDK API リファレンス」を参照してください。

Fn::ImportValue との比較

同じアカウントおよびリージョン内で強力な参照整合性が必要な場合は、Fn::ImportValue を使用します。クロスアカウントまたはクロスリージョン参照が必要な場合、または明示的なエクスポートの管理を避ける場合は、Fn::GetStackOutput を使用します。

ベストプラクティス