DeploymentEvent

oneOf

ResourceDeploymentEvent

instanceIdstringrequired

The ID of the blueprint instance.

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

resourceIdstringrequired

The globally unique ID of the resource.

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

resourceNamestringrequired

THe logical name of the resource as defined in the source blueprint.

Example: my-resource

groupintegerrequired

The group number that the resource belongs to relative to the ordering for components in the current blueprint associated with the instance ID. A group is a collection of items that can be deployed or destroyed at the same time.

Example: 1

statusintegerrequired

The high-level status of the resource. See the ResourceState 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]

Example: 2

preciseStatusintegerrequired

The precise status of the resource. See the ResourceState 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, 19, 20, 21, 22]

Example: 3

failureReasonsstring[]nullable

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

attemptintegerrequired

The attempt number for deploying or destroying the resource.

Example: 1

canRetrybooleanrequired

Indicates if the operation for the resource can be retried after this attempt.

Example: false

updateTimestampintegerrequired

The unix timestamp of the event in seconds.

Example: 1678901234

durations objectnullable

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

• Config Complete (2)
• Created (3)
• Create Failed (4)
• Create Rollback Failed (6)
• Create Rollback Complete (7)
• Destroyed (9)
• Destroy Failed (10)
• Destroy Rollback Failed (12)
• Destroy Rollback Config Complete (13)
• Destroy Rollback Complete (14)
• Update Config Complete (16)
• Updated (17)
• Update Failed (18)
• Update Rollback Failed (20)
• Update Rollback Config Complete (21)
• Update Rollback Complete (22)

configCompleteDurationnumbernullable

The duration in milliseconds for the resource to be configured. This will only be set if the resource has reached the config complete status.

Example: 10000

totalDurationnumbernullable

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

Example: 20000

attemptDurationsnumber[]

The durations in milliseconds for each attempt to deploy the resource.

ChildDeploymentEvent

parentInstanceIdstringrequired

The ID of the parent blueprint instance.

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

childInstanceIdstringrequired

The ID of the child blueprint instance.

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

childNamestringrequired

The logical name of the child blueprint instance as defined in the parent blueprint source.

Example: my-child-blueprint

groupintegerrequired

The group number that the child blueprint instance belongs to relative to the ordering for components in the current blueprint associated with the instance ID. A group is a collection of items that can be deployed or destroyed at the same time.

Example: 1

statusintegerrequired

The high-level status of the child blueprint instance. See the BlueprintInstance 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, 19]

Example: 2

failureReasonsstring[]nullable

A list of failure reasons for the child blueprint instance that will contain values for failure events.

updateTimestampintegerrequired

The unix timestamp of the event in seconds.

Example: 1678901234

durations objectnullable

Duration information for a child blueprint instance deployment. Duration information is attached on one of the following instance status updates:

• Deployed (2)
• Deploy Failed (3)
• Destroyed (7)
• Updated (14)
• Update Failed (15)

prepareDurationnumbernullable

The duration in milliseconds for the preparation phase of a blueprint instance deployment to be completed.

Example: 10000

totalDurationnumbernullable

The duration in milliseconds for the blueprint instance to reach the final status.

Example: 20000

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.

InstanceUpdateDeploymentEvent

instanceIdstringrequired

The ID of the blueprint instance.

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

statusintegerrequired

The status of the blueprint instance deployment. See the BlueprintInstance 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, 19]

Example: 2

updateTimestampintegerrequired

The unix timestamp of the event in seconds.

Example: 1678901234

FinishDeploymentEvent

instanceIdstringrequired

The ID of the blueprint instance.

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

statusintegerrequired

The status of the blueprint instance deployment. See the BlueprintInstance 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, 19]

Example: 2

failureReasonsstring[]nullable

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

finishTimestampintegerrequired

The unix timestamp in seconds for when the deployment process finished.

Example: 1678901234

updateTimestampintegerrequired

The unix timestamp of the event in seconds for when the status update occurred.

Example: 1678901234

durations objectnullable

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

• Deploying (1) - preparation phase duration only
• Deployed (2)
• Deploy Failed (3)
• Deploy Rollback Failed (5)
• Deploy Rollback Complete (6)
• Destroyed (8)
• Destroy Failed (9)
• Destroy Rollback Failed (11)
• Destroy Rollback Complete (12)
• Updated (14)
• Update Failed (15)
• Update Rollback Failed (17)
• Update Rollback Complete (18)

prepareDurationnumbernullable

The duration in milliseconds for the preparation phase of a blueprint instance deployment to be completed.

Example: 10000

totalDurationnumbernullable

The duration in milliseconds for the blueprint instance to reach the final status.

Example: 20000

DeploymentEvent

{
  "instanceId": "16ef8989-af00-4a4a-8164-72493ceb1aa0",
  "resourceId": "16ef8989-af00-4a4a-8164-72493ceb1aa0",
  "resourceName": "my-resource",
  "group": 1,
  "status": 2,
  "preciseStatus": 3,
  "failureReasons": [
    "Invalid configuration for resource spec"
  ],
  "attempt": 1,
  "canRetry": false,
  "updateTimestamp": 1678901234,
  "durations": {
    "configCompleteDuration": 10000,
    "totalDuration": 20000,
    "attemptDurations": [
      20000
    ]
  }
}