PulumiでIgnoreChangesを使う際の注意点

Terraformはリソースの特定のプロパティの変更を無視するのにignore_changes: [array]を用いますが、これと同様のことがPulumiのIgnoreChangesオプションで可能です。 PulumiのIgnoreChangesはドキュメントで解説されているのですが、Pulumiで入れ子のキーをIgnoreChangesで無視する方法について記載がないようなのでメモしておきます。

単純なIgnoreChangesの例
入れ子のキーをIgnoreChangesで無視する方法
入れ子のキーがなかったのに後からクラウド側が追加してきてそれを無視したい場合
参考

単純なIgnoreChangesの例

例えばリソースにPropsというプロパティがある場合、そのプロパティのスタック内部での表現propをIgnoreChangesで無視すればよいです。単純ですね。

new MyResource("res", new MyResourceArgs {
  Prop = "new-value"
}, new CustomResourceOptions { IgnoreChanges = { "prop" } });

入れ子のキーをIgnoreChangesで無視する方法

例えば以下のようなコードがあったとします。TagsプロパティはTagsというプロパティがあり、その中にEnvironmentやOwnerというキーが入れ子になっています。

new Aws.S3.Bucket("my-bucket", new Aws.S3.BucketArgs
{
    Tags = new InputMap<string>
    {
        { "Environment", "Dev" },
        { "Owner", "Alice" },
    }
});

このとき、Tagsのうち"Owner"キーだけをIgnoreChangesで無視したい場合、以下のように入れ子の親プロパティ[\"入れ子の子プロパティキー\"]と記述します。

new Aws.S3.Bucket("my-bucket", new Aws.S3.BucketArgs
{
    Tags = new InputMap<string>
    {
        { "Environment", "Dev" },
        { "Owner", "Alice" },
    }
}, new CustomResourceOptions
{
    IgnoreChanges = { "tags[\"Owner\"]" }
});

これにより、Tagsの"Owner"キーの変更はPulumiの差分検出から無視されるようになります。

入れ子のキーがなかったのに後からクラウド側が追加してきてそれを無視したい場合

注意点として、もしリソース作成時に入れ子のキーが存在しなかった場合、PulumiはそのキーをIgnoreChangesで無視できません。例えば、上記の例で"verified"キーが最初は存在せず、後からクラウド側が追加してきた場合、そのキーをIgnoreChangesで指定しても効果がありません。

new Aws.S3.Bucket("my-bucket", new Aws.S3.BucketArgs
{
    Tags = new InputMap<string>
    {
        { "Environment", "Dev" },
        { "Owner", "Alice" },
        // クラウドが後から"verified"キーを追加してきた
    }
}, new CustomResourceOptions
{
    IgnoreChanges = { "tags[\"verified\"]" } // 意味がない
});

この場合、Terraformなら存在しなかったキーを定義上で追加すればIgnoreChangesで無視できますが、Pulumiではできません。リソースにもよりますが、最初から作っておけば無視されるようです。

new Aws.S3.Bucket("my-bucket", new Aws.S3.BucketArgs
{
    Tags = new InputMap<string>
    {
        { "Environment", "Dev" },
        { "Owner", "Alice" },
        { "verified", "true" }, // 存在しなかったキーを定義上で追加
    }
}, new CustomResourceOptions
{
    IgnoreChanges = { "tags[\"verified\"]" } // 無視される
});