AffectedResource

Table of contents

  1. Description
  2. Properties
  3. @Example

Description

Represents your resource.

Properties

Field Type Description
resourceName string Name of the affected resource, e.g. application’s name
resourceType string Type of the affected resource, e.g. can be of type ‘application’
resourceInstance? string Resource instance, e.g. could be number of an instance
tags? object<string, string> Any other useful information about the event.

Some useful known tags by Alert Notification service are:
- ans:sourceEventId? - generated by the source, will be used for further stateful interactions with Alert Notification service
- ans:correlationId? - generated by the source in order to correlate this event with other activities or issues
- ans:status? - will be used for incient management systems. Possible values: ‘CREATE_OR_UPDATE’, ‘CREATE’, ‘UPDATE’, ‘COMMENT’ or ‘CLOSE’
- ans:recommendedActionLink? - a URL that contains details for recommended actions regarding this event
- ans:detailsLink? - a URL that contains details for this event, e.g. dashboards showing what triggered it

@Example

const affectedResource = {
    resourceName: 'test-resource',
    resourceType: 'application',
    resourceInstance: '123456',
    tags: {
        detailsLink: 'https://example.details.com'
    }
};