ParameterRegistry

Defined in: packages/core/src/registry/parameter-registry.ts:15

Constructors

Constructor

new ParameterRegistry(appName, stageName): ParameterRegistry

Defined in: packages/core/src/registry/parameter-registry.ts:16

Parameters

appName

string

stageName

string

Returns

ParameterRegistry

Methods

get()

get(scope, key): string

Defined in: packages/core/src/registry/parameter-registry.ts:72

Read a parameter value token (resolved at deploy time, not synth time).

Parameters

scope

Stack

key

string

Returns

string

---

getMany()

getMany<K>(scope, keys): Record<K, string>

Defined in: packages/core/src/registry/parameter-registry.ts:79

Read multiple parameters in one call. Returns a typed record.

Type Parameters

K

K extends string

Parameters

scope

Stack

keys

readonly K[]

Returns

Record<K, string>

---

getVersioned()

getVersioned(scope, key, version): string

Defined in: packages/core/src/registry/parameter-registry.ts:90

Read a versioned parameter (use in prod for sensitive values).

Parameters

scope

Stack

key

string

version

number

Returns

string

---

paramName()

paramName(key): string

Defined in: packages/core/src/registry/parameter-registry.ts:29

Build the full SSM parameter path for a key. e.g. (“dynamodb/urlTableArn”) → “/readyurl/prod/dynamodb/urlTableArn”

Parameters

key

string

Returns

string

---

put()

put(scope, logicalId, key, value): StringParameter

Defined in: packages/core/src/registry/parameter-registry.ts:40

Write a single StringParameter.

Removal policy:

• prod → RETAIN (safe default — prevents accidental deletion)
• other → DESTROY (clean up after teardown)

Parameters

scope

Stack

logicalId

string

key

string

value

string

Returns

StringParameter

---

putMany()

putMany(scope, idPrefix, entries): void

Defined in: packages/core/src/registry/parameter-registry.ts:60

Write a batch of parameters in one call.

Logical IDs are derived from the key so they are stable — adding or reordering entries will NOT trigger replacement of existing parameters.

Parameters

scope

Stack

CDK Stack

idPrefix

string

Prefix for CFN logical IDs (use unique string per stack)

entries

Record<string, string | undefined>

Record<ssm-key, value>. undefined values are skipped.

Returns

void