SRN

S-tier ARNs

What is a SRN?

A SRN (Sym Resource Name) is a colon-separated unique identifier for a Sym Resource.

SRNs have the following structure:

<organization>:<resource>[:<resource-type]:<slug>:<version>[:identifier]

Where version is either a semver string (e.g. 1.0.0) or latest. The "resource-type" indicates the type of the model, if the model is subtyped. This is often the type field of the resource defined in Terraform. For example a integration can have a type slack. And the identifier is an optional instance identifier, such as a UUID.

Example: Flow

Given the following sym_flow resource for an organization healthy-health

resource "sym_flow" "this" {
  name     = "my-fun-flow"
  template = "sym:template:approval:1.0.0"

  implementation = "./impl.py"
  environment_id = sym_environment.this.id

  params = ... # truncated
}

The SRN could be

healthy-health:flow:my-fun-flow:1.0.0:d47782bc-88be-44df-9e34-5fae0dbdea22

or with latest as the version

healthy-health:flow:my-fun-flow:latest:d47782bc-88be-44df-9e34-5fae0dbdea22

or with no identifier

healthy-health:flow:my-fun-flow:latest

Note that between the resource name flow and the slug my-fun-flow, there is no resource-type. This is because sym_flow resources do not have a type.

Example: Sym Integration, Slack

Given the following sym_integration resource for an organization healthy-health

resource "sym_integration" "slack" {
  type        = "slack"
  name        = "prod"
  external_id = "T12345"
}

The SRN could be

healthy-health:integration:slack:prod:1.0.0:d47782bc-88be-44df-9e34-5fae0dbdea22

or

healthy-health:integration:slack:prod:latest:d47782bc-88be-44df-9e34-5fae0dbdea22

or

healthy-health:integration:slack:prod:latest

Note that between the resource name integration and the slug prod, there is a type value slack. This is because sym_integrationresources have atype`.

SRN Usage

SRNs are used in Sym's Request API as inputs and used in the Log Entries sent by Sym's Reporting system as identifiers.

How to locate your SRNs

Your Sym resources can be listed with the symflow command

symflow resources list [resource-name]

such as

symflow resources list sym_flow

For more information, see: Manage Resources


Did this page help you?