Add replace field to copy-instance-tags

[HappyKid117]

Implemented replace field in copy-instance-tags action as an enhancement. Closes #7544

Description

The action copy-instance-tags copies all the tags mentioned in the policy from an ec2 instance to its ebs volume. If a tag already exists in the ebs volume, it gets replaced. The field replace is introduced to give users more control over this. If its value is false, the policy skips copying existing tags in the ebs volume.

Usage

If the user does not mention this field in the policy, then its default value is set to true, making it a backward-compatible feature.
replace : false : skips the tags that already exist in the ebs volume.
replace : true : replaces the ebs tags with the ec2 tags.

Example

EC2 tags

Lets use this EC2 instance with the given tags and their values for the following examples.

• Name = ec2-foo
• Technical:ApplicationID = 1234
• Technical:ApplicationName = ec2_app
• Technical:Environment = ec2_env
• Technical:PlatformOwner = ec2_owner

Example Policy with replace: false

policies:
  - name: ebs-copy-instance-tags
    resource: ebs
    filters:
      - type: value
        key: "Attachments[0].Device"
        value: not-null
    actions:
      - type: copy-instance-tags
        replace: false
        tags:
          - Name
          - Technical:ApplicationID
          - Technical:ApplicationName
          - Technical:Environment
          - Technical:PlatformOwner

Before running the policy

EBS tags

• Name : ebs-foo
• Technical:ApplicationID = 6789

After running the policy

EBS tags

• Name : ebs-foo
• Technical:ApplicationID = 6789
• Technical:ApplicationName = ec2_app
• Technical:Environment = ec2_env
• Technical:PlatformOwner = ec2_owner

*Notice that the tags Name and Technical:ApplicationName have not been replaced.

Example Policy without replace

policies:
  - name: ebs-copy-instance-tags
    resource: ebs
    filters:
      - type: value
        key: "Attachments[0].Device"
        value: not-null
    actions:
      - type: copy-instance-tags
        tags:
          - Name
          - Technical:ApplicationID
          - Technical:ApplicationName
          - Technical:Environment
          - Technical:PlatformOwner

Before running the policy

EBS tags

• Name : ebs-foo
• Technical:ApplicationID = 6789

After running the policy

EBS tags

• Name = ec2-foo
• Technical:ApplicationID = 1234
• Technical:ApplicationName = ec2_app
• Technical:Environment = ec2_env
• Technical:PlatformOwner = ec2_owner

*Notice that the tags Name and Technical:ApplicationName have been replaced.

[linux-foundation-easycla]

The committers listed above are authorized under a signed CLA.

• ✅ login: HappyKid117 / name: Happy Kid (af17637)

[ajkerrigan]

This looks reasonable to me, and using replace feels like a good choice over skip to avoid potential confusion with the skip-missing option from copy-related-tag. Thanks for the contribution, and for making it backward-compatible too 👍

We'll want to make sure checks clear, and add a test for this new behavior before merging.

[linux-foundation-easycla]

• ✅ login: HappyKid117 / name: Happy Kid (fdfcf4b, af17637, 9ac96fb, 023ea8b, a4edb01)
• ✅ login: ajkerrigan / name: AJ Kerrigan (f337aa2, 26724df, e84c448)
• ✅ login: kevinl-grab (4dc6aea)
• ✅ login: logachev / name: Kirill Logachev (5c0981e)
• ✅ login: ritch2022 (4084e29, d0e9b59)
• ✅ login: thisisshi / name: Sonny (65605bc, 032593d, 7538f4e, d0f6439, 2498a5a, d5aa53c, 2824931, 30eb5df, 7b4b27a, f70418b, ff5d154)
• ✅ login: kapilt / name: Kapil Thangavelu (fe36121, 36b6ac1, 3597699, c6c4c16, d2fb1c0, c3c4f10, 3898f99, 0555ee6, f12858a, e04d9d0, 0bd4fc6, 544e897)
• ✅ login: Kiranmoka / name: Kiran Moka (4c43870)
• ✅ login: anovis / name: Austen (2721f33)
• ✅ login: jasgrover / name: Jasvinder Grover (e517e3b, ba13f67)
• ✅ login: PratMis / name: Pratyush Mishra (499ec3e, 2b708ed)
• ✅ login: castrojo / name: Jorge O. Castro (deccc11)
• ✅ login: raghavendarreddyg (225170e)
• ✅ login: StevenGunn / name: Steven (144e07c, 305d1c2, 7d9e293)
• ✅ login: sontek / name: John Anderson (c57bdd0, 24a9d73)
• ✅ login: naohito-intuit / name: Naohito Takeuchi (8cd2bb3)
• ✅ login: kk1532 / name: Kalaiselvan Krishnan (a114e02)
• ✅ login: AndyChenGitHub (2552a4e)
• ✅ login: cahn1 / name: Kayden Ahn (f926df0, 73c78a4)
• ✅ login: darrendao / name: Darren Dao (1bea02a)
• ✅ login: howbazaar / name: Tim Penhey (2f43ece)
• ✅ login: 723514372466 / name: wenlongma (30aa8e1, 93b0cd0)
• ✅ login: harishachappa / name: Harish Achappa (55de136)
• ✅ login: farzanv (7bfadc3)
• ❌ The commit (b78de12, cdfee3a). This user is missing the User's ID, preventing the EasyCLA check. Consult GitHub Help to resolve.For further assistance with EasyCLA, please submit a support request ticket.

[HappyKid117]

This looks reasonable to me, and using replace feels like a good choice over skip to avoid potential confusion with the skip-missing option from copy-related-tag. Thanks for the contribution, and for making it backward-compatible too +1

We'll want to make sure checks clear, and add a test for this new behavior before merging.

@ajkerrigan 2 Tests have been added to test this behaviour