Skip to main content

LinkDeploymentEvent

instanceIdstringrequired

The ID of the blueprint instance that the link belongs to.

Example: 16ef8989-af00-4a4a-8164-72493ceb1aa0
linkIdstringrequired

The globally unique ID of the link.

Example: 16ef8989-af00-4a4a-8164-72493ceb1aa0
linkNamestringrequired

The logical name of the link in the blueprint. This is a combination of the 2 resources that are linked. For example, if a link is between a VPC and a subnet, the link name would be "vpc::subnet".

Example: vpc::subnet
statusintegerrequired

The high-level status of the link. See the LinkState schema definition for more information on what each status means.

Possible values: [0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18]

Example: 2
preciseStatusintegerrequired

The precise status of the link. See the LinkState schema definition for more information on what each status means.

Possible values: [0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18]

Example: 3
failureReasonsstring[]nullable

A list of failure reasons for the link that will contain values for failure events.

currentStageAttemptintegerrequired

The current attempt number for applying the changes for the current stage of the link deployment/removal.

Example: 1
canRetryCurrentStagebooleanrequired

Indicates if the operation for the link can be retried after this attempt of the current stage.

Example: false
updateTimestampintegerrequired

The unix timestamp of the event in seconds.

Example: 1678901234
durations objectnullable

Duration information for a link deployment. Duration information is attached on one of the following precise status updates:

  • Resource A Updated (2)
  • Resource A Update Failed (3)
  • Resource A Update Rollback Failed (5)
  • Resource A Update Rollback Complete (6)
  • Resource B Updated (8)
  • Resource B Update Failed (9)
  • Resource B Update Rollback Failed (11)
  • Resource B Update Rollback Complete (12)
  • Intermediary Resources Updated (14)
  • Intermediary Resources Update Failed (15)
  • Intermediary Resources Update Rollback Failed (17)
  • Intermediary Resources Update Rollback Complete (18)
resourceAUpdate objectnullable

Duration information for the update of resource A in the link. This will only be present if the link has reached resource A updated status.

totalDurationnumbernullable

The duration in milliseconds for the link component change to reach the final status.

Example: 20000
attemptDurationsnumber[]

The durations in milliseconds for each attempt to deploy the link component. Attempt durations are in order as per the "attempt" field in a status update event.

resourceBUpdate objectnullable

Duration information for the update of resource B in the link. This will only be present if the link has reached resource B updated status.

totalDurationnumbernullable

The duration in milliseconds for the link component change to reach the final status.

Example: 20000
attemptDurationsnumber[]

The durations in milliseconds for each attempt to deploy the link component. Attempt durations are in order as per the "attempt" field in a status update event.

intermediaryResources objectnullable

Duration information for the update, creation or removal of intermediary resources in the link. This will only be present if the link has reached intermediary resources updated status.

totalDurationnumbernullable

The duration in milliseconds for the link component change to reach the final status.

Example: 20000
attemptDurationsnumber[]

The durations in milliseconds for each attempt to deploy the link component. Attempt durations are in order as per the "attempt" field in a status update event.

LinkDeploymentEvent
{
  "instanceId": "16ef8989-af00-4a4a-8164-72493ceb1aa0",
  "linkId": "16ef8989-af00-4a4a-8164-72493ceb1aa0",
  "linkName": "vpc::subnet",
  "status": 2,
  "preciseStatus": 3,
  "failureReasons": [
    "Invalid annotation value for link"
  ],
  "currentStageAttempt": 1,
  "canRetryCurrentStage": false,
  "updateTimestamp": 1678901234,
  "durations": {
    "resourceAUpdate": {
      "totalDuration": 20000,
      "attemptDurations": [
        20000
      ]
    },
    "resourceBUpdate": {
      "totalDuration": 20000,
      "attemptDurations": [
        20000
      ]
    },
    "intermediaryResources": {
      "totalDuration": 20000,
      "attemptDurations": [
        20000
      ]
    }
  }
}