Customizing EC2 instance scheduled event notifications to include instance tags

[SpComb]

Community Note

• Please vote on this issue by adding a 👍 reaction to the original issue to help the community and maintainers prioritize this request
• Please do not leave "+1" or other comments that do not add relevant new information or questions, they generate extra noise for issue followers and do not help prioritize the request
• If you are interested in working on this issue or have submitted a pull request, please leave a comment

Description

By default, the email notifications that AWS sends for EC2 instance scheduled events only include the instance ID. However, it is also possible to configure these to include instance tags, making it easier to keep track of these events: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/monitoring-instances-status-check_sched.html#customizing_scheduled_event_notifications

This seems to be a regional per-account configuration.

New or Affected Resource(s)

• aws_instance_event_notification_attributes (new)

Potential Terraform Configuration

resource "aws_instance_event_notification_attributes" "main" {
  instance_tag_attributes {
    instance_tag_keys = ["Name", "Environment"]
  }
}

References

• https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/monitoring-instances-status-check_sched.html#customizing_scheduled_event_notifications
• https://docs.aws.amazon.com/cli/latest/reference/ec2/register-instance-event-notification-attributes.html
• https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_RegisterInstanceEventNotificationAttributes.html

[handlerbot]

FYI, my testing shows this to be per-region, not global.

[seanorama]

The documentation confirms that this is per region: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/monitoring-instances-status-check_sched.html

The tags that you choose to include apply to all resources (instances and Dedicated Hosts) in the selected Region. To customize event notifications in other Regions, first select the required Region and then perform the following steps.

[SpComb]

Apologies for the poor choice of wording and resulting confusion, I should have written "regional".

Fixed/edited in the issue description.

[aaron-hastings-travelport]

This is something we would like to see also, so that we can ensure full automation of our AWS accounts without having to do this manual step.

[datfinesoul]

It would be great if this could be added to the provider at some point with both of these options configurable.

• https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/register-instance-event-notification-attributes.html

{
  "IncludeAllTagsOfInstance": true|false,
  "InstanceTagKeys": ["string", ...]
}