sym.sdk.flow

A parameterized instance of a Template.

Classes

Flow

The Flow class contains a particular parameterization of a Template.

Run

A Run represents an instance of a Flow in progress.

class sym.sdk.flow.Flow(srn: Union[sym.sdk.resource.SRN, str])

Bases: sym.sdk.resource.SymResource

The Flow class contains a particular parameterization of a Template.

Read more about Flows.

property fields

A dictionary with the field structure defined for the Flow in Terraform.

property srn

A SRN object that represents the unique identifier for this resource.

property vars

A dict containing user-supplied values from the Flow’s definition in Terraform.

This dict might contain, for example, your team’s PagerDuty schedule ID.

class sym.sdk.flow.Run(srn: Union[sym.sdk.resource.SRN, str])

Bases: sym.sdk.resource.SymResource

A Run represents an instance of a Flow in progress.

For example, each new access request using the sym:template:approval:1.0 Template would generate a new Run with data pertaining to that specific access request.

property actors

A dict mapping Event names to the User that created each Event. There will be one entry for each Event in the current Run.

For example, with a sym:approval Flow, after the “approve” Event is received, the actors may look like this:

{
    "prompt": <User A>,
    "request": <User A>,
    "approve": <User B>
}
property srn

A SRN object that represents the unique identifier for this resource.