CloudFormationで既存リソースインポート時に”As part of the import operation, you cannot modify or add [Outputs]”エラーになるときの対処方法

Outputs無しのテンプレートでインポート後、更新もしくは変更セットでOutputs付きテンプレートを読み込む

#AWS

#AWS CloudFormation

杉金晋

2022.12.08

この記事は公開されてから1年以上経過しています。情報が古い可能性がありますので、ご注意ください。

みなさんこんにちは、杉金です。　
CloudFormationでは既存リソースのインポートをサポートしています。既存リソースのインポート時に以下のエラーになった場合の対処方法について今回ご紹介します。

As part of the import operation, you cannot modify or add [Outputs]

先に結論

Outputsセクションが含まれるCloudFormationテンプレートは既存リソースのインポートでは使用できません。対処として以下の手順を踏む必要があります。

Outputsセクションの記述を削除したテンプレートで既存リソースのインポートを行う
作成されたスタックに対して、更新もしくは変更セットからOutputsセクション付きテンプレートで更新

以降では、より詳細な情報や具体的な操作方法を説明していきます。

エラーについて

まず、このエラーに関するAWS公式ページがあり、簡単な説明と解決方法について記載されています。

その中に以下の重要な記述があります。

重要: インポート操作には、論理ID、説明、値、エクスポート、および出力のその他のプロパティへの追加と変更を含めることはできません。

実際に試して動きを見てみましょう。

試してみる

エラーの再現

以下のCloudFormationテンプレートを用意します。セキュリティグループを1つ定義するものです。11〜15行目でOutputsを記述しており、セキュリティグループIDを出力させるようにしています。

AWSTemplateFormatVersion: 2010-09-09
Description: Test importing existing resources into a stack
Resources:
  TestSecurityGroup:
    Type: AWS::EC2::SecurityGroup
    Properties:
      GroupName: TestSecurityGroup
      GroupDescription : TestSecurityGroup
      VpcId : vpc-xxxxxxxxx
    DeletionPolicy : Retain
Outputs:
  TestSecurityGroupSgId:
    Value: !Ref TestSecurityGroup
    Export:
      Name: TestSecurityGroupSgId

テンプレートで定義されている「TestSecurityGroup」リソースは手動で作成済みとします。既存のリソースとしてCloudFormationスタックにインポートします。AWSマネジメントコンソールのCloudFormation スタック画面から「スタックの作成」→「既存リソースを使用（リソースをインポート）」を選びます。

テンプレートファイルでは上記テンプレートを指定します。テンプレートファイルの指定や既存リソースID指定はスクショを省略します。リソースのインポート直前の画面まで進めていくと今回のエラーになります。

対処方法

まずテンプレートからOutputsセクションを削除します。

AWSTemplateFormatVersion: 2010-09-09
Description: Test importing existing resources into a stack
Resources:
  TestSecurityGroup:
    Type: AWS::EC2::SecurityGroup
    Properties:
      GroupName: TestSecurityGroup
      GroupDescription : TestSecurityGroup
      VpcId : vpc-xxxxxxxxx
    DeletionPolicy : Retain

修正したテンプレートで再度「既存リソースを使用（リソースをインポート）」を進めると、今度はエラーなくインポートできます。

インポート後にスタックの画面から確認するとリソースとして認識されていることが分かります。

Outputsセクションは削除したため「出力」タブには何も表示されません。

続いて元々のOutputs付きのテンプレートを用意します。

AWSTemplateFormatVersion: 2010-09-09
Description: Test importing existing resources into a stack
Resources:
  TestSecurityGroup:
    Type: AWS::EC2::SecurityGroup
    Properties:
      GroupName: TestSecurityGroup
      GroupDescription : TestSecurityGroup
      VpcId : vpc-xxxxxxxxx
    DeletionPolicy : Retain
Outputs:
  TestSecurityGroupSgId:
    Value: !Ref TestSecurityGroup
    Export:
      Name: TestSecurityGroupSgId

このテンプレートを読み込む方法としては更新また変更セットの2通りあります。更新に比べて変更セットの方が影響するリソースを変更前にレビューできるため、変更セットの方が個人的にはオススメです。それぞれの違いは以下のページも合わせてご覧ください。