sym.sdk.flow¶
Models representing Flows, Environments, and Runs.
Classes
The |
|
The |
|
- class sym.sdk.flow.Environment(srn: Union[sym.sdk.resource.SRN, str])¶
Bases:
sym.sdk.resource.SymResource
The
Environment
class represents an instance of asym_environment
resource, which contains shared configuration values acrossFlow
instances.Read more about Environments.
- dict()¶
Represent this resource as a dictionary.
- property integrations¶
A dictionary containing all
Integrations
that may be used in the implementation for aFlow
, as defined in Terraform.For example, if Slack and AWS Lambda
Integrations
are specified in theEnvironment
, theintegrations
dictionary would look like this:{ "slack": <sym.sdk.strategies.integration.Integration>, "aws_lambda": <sym.sdk.strategies.integration.Integration> }
- class sym.sdk.flow.Flow(srn: Union[sym.sdk.resource.SRN, str])¶
Bases:
sym.sdk.resource.SymResource
The
Flow
class represents an instance of asym_flow
resource, which defines an approval workflow in Sym, allowing users to request temporary and auto-expiring access to sensitive resources.Read more about Flows.
- dict()¶
Represent this resource as a dictionary.
- property environment¶
A reference to the
Environment
attached to thisFlow
.
- property fields¶
A dictionary of Prompt Field names to Prompt Field objects, as defined by the prompt_field blocks in Terraform.
- class sym.sdk.flow.Run(srn: Union[sym.sdk.resource.SRN, str])¶
Bases:
sym.sdk.resource.SymResource
A
Run
represents an instance of aFlow
in progress.For example, each new access request will generate a new
Run
with data pertaining to that specific access request.- property actors¶
A dict mapping
Event
names to theUser
that created eachEvent
. There will be one entry for eachEvent
in the currentRun
.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 contexts¶
A dict mapping
Event
names to the context attached to eachEvent
. There will be one entry for eachEvent
in the currentRun
.For example, with a sym:approval
Flow
, after the “approve”Event
is received, the contexts may look like this:{ "request": { "additional_id": "12345" } }
- dict()¶
Represent this resource as a dictionary.