Skip to main content

LinkChangesEvent

resourceANamestringrequired

The name of resource A in the link that will change when deploying the change set.

Example: my-resource-a
resourceBNamestringrequired

The name of resource B in the link that will change when deploying the change set.

Example: my-resource-b
removedbooleanrequired

If true, the link will be removed when deploying the change set.

Example: false
newbooleanrequired

Indicates whether or not the link will be created for the first time when deploying the change set.

Example: false
changes object

The changes that will be made to the link when deploying the change set.

modifiedFields object[]required

The fields that will be modified in the link between two resources.

  • Array [
  • fieldPathstringrequired

    The path to the field that has changed.

    Example: my-field
    prevValueAnyValuerequired

    A value of any type, can be a string, number, boolean, object or array.

    Example: old-value
    newValueAnyValuerequired

    A value of any type, can be a string, number, boolean, object or array.

    Example: new-value
    mustRecreatebooleanrequired

    If true, the resource must be recreated to apply the change.

    Example: false
  • ]
  • newFields object[]required

    The fields that will be added to the link between two resources.

  • Array [
  • fieldPathstringrequired

    The path to the field that has changed.

    Example: my-field
    prevValueAnyValuerequired

    A value of any type, can be a string, number, boolean, object or array.

    Example: old-value
    newValueAnyValuerequired

    A value of any type, can be a string, number, boolean, object or array.

    Example: new-value
    mustRecreatebooleanrequired

    If true, the resource must be recreated to apply the change.

    Example: false
  • ]
  • removedFieldsstring[]required

    The fields that will be removed from the link between two resources.

    unchangedFieldsstring[]required

    The fields that will not be changed in the link between two resources.

    fieldChangesKnownOnDeploystring[]required

    A list of field names for which changes will be known when the host blueprint is deployed.

    timestampintegerrequired

    The unix timestamp of the event in seconds.

    Example: 1678901234
    LinkChangesEvent
    {
    "resourceAName": "my-resource-a",
    "resourceBName": "my-resource-b",
    "removed": false,
    "new": false,
    "changes": {
    "modifiedFields": [
    {
    "fieldPath": "my-field",
    "prevValue": "old-value",
    "newValue": "new-value",
    "mustRecreate": false
    }
    ],
    "newFields": [
    {
    "fieldPath": "my-field",
    "prevValue": "old-value",
    "newValue": "new-value",
    "mustRecreate": false
    }
    ],
    "removedFields": [
    "my-old-field"
    ],
    "unchangedFields": [
    "my-field"
    ],
    "fieldChangesKnownOnDeploy": [
    "my-field"
    ]
    },
    "timestamp": 1678901234
    }