GCP.ParameterManager reference

GetParameter

Source: src/GCP/ParameterManager/GetParameter.ts

Runtime binding for Parameter Manager parameters.get.

Bind this operation to a Parameter in a Function/Action init phase. Provide GetParameterHttp.

Grants roles/parametermanager.parameterViewer on the project under an IAM Condition matching only this parameter: Parameter Manager has no resource-level IAM.

GetParameter: Reading a Parameter

const getParameter = yield* GCP.ParameterManager.GetParameter(parameter);
const live = yield* getParameter();

GetParameterHttp

Source: src/GCP/ParameterManager/GetParameterHttp.ts Kind: Layer · Provides: GCP.ParameterManager.GetParameter

HTTP implementation of GetParameter.

GetParameterVersion

Source: src/GCP/ParameterManager/GetParameterVersion.ts

Runtime binding for Parameter Manager parameters.versions.get.

Bind this operation to a ParametersVersion in a Function/Action init phase. Provide GetParameterVersionHttp.

Grants roles/parametermanager.parameterViewer on the project under an IAM Condition matching only this version: Parameter Manager has no resource-level IAM.

GetParameterVersion: Reading a Parameter Version

Get payload

const getVersion = yield* GCP.ParameterManager.GetParameterVersion(version);
const live = yield* getVersion();

Metadata only

const getVersion = yield* GCP.ParameterManager.GetParameterVersion(version);
const live = yield* getVersion({ view: "BASIC" });

GetParameterVersionHttp

Source: src/GCP/ParameterManager/GetParameterVersionHttp.ts Kind: Layer · Provides: GCP.ParameterManager.GetParameterVersion

HTTP implementation of GetParameterVersion.

Parameter

Source: src/GCP/ParameterManager/Parameter.ts

A Parameter Manager parameter — metadata and encryption for versioned payloads. Version data lives on ParametersVersion.

Changing parameterId, location, or format replaces the parameter. Labels and kmsKey update in place.

Parameter: Creating a Parameter

Generated name

const parameter = yield* GCP.ParameterManager.Parameter("AppConfig", {});

Explicit id, format, and labels

const parameter = yield* GCP.ParameterManager.Parameter("AppConfig", {
  parameterId: "order-config",
  format: "JSON",
  labels: { env: "prod" },
});

Parameter: Parameter Versions

const parameter = yield* GCP.ParameterManager.Parameter("AppConfig", {
  format: "JSON",
});
const version = yield* GCP.ParameterManager.ParametersVersion("V1", {
  parameter: parameter.name,
  data: JSON.stringify({ host: "api.example.com" }),
});

ParametersVersion

Source: src/GCP/ParameterManager/ParametersVersion.ts

A Parameter Manager parameter version — an immutable payload attached to a Parameter. Versions have no labels field; list / nuke find versions whose parent parameter carries Alchemy labels.

Changing parameterVersionId, parameter, location, or the payload replaces the version. disabled updates in place.

ParametersVersion: Creating a ParametersVersion

UTF-8 payload

const parameter = yield* GCP.ParameterManager.Parameter("AppConfig", {});
const version = yield* GCP.ParameterManager.ParametersVersion("V1", {
  parameter: parameter.name,
  data: "host=api.example.com",
});

JSON payload on a JSON parameter

const parameter = yield* GCP.ParameterManager.Parameter("AppConfig", {
  format: "JSON",
});
const version = yield* GCP.ParameterManager.ParametersVersion("V1", {
  parameter: parameter.name,
  data: JSON.stringify({ host: "api.example.com" }),
});

ParametersVersion: Disabling a Version

const version = yield* GCP.ParameterManager.ParametersVersion("V1", {
  parameter: parameter.name,
  parameterVersionId: "v1",
  data: "host=api.example.com",
  disabled: true,
});

RenderParameterVersion

Source: src/GCP/ParameterManager/RenderParameterVersion.ts

Runtime binding for Parameter Manager parameters.versions.render.

Bind this operation to a ParametersVersion in a Function/Action init phase. Provide RenderParameterVersionHttp. Rendering substitutes Secret Manager references and only works for JSON or YAML parameters.

Grants roles/parametermanager.parameterAccessor on the project under an IAM Condition matching only this version: Parameter Manager has no resource-level IAM. Secrets the payload references need their own Secret Manager access.

RenderParameterVersion: Rendering a Parameter Version

const render = yield* GCP.ParameterManager.RenderParameterVersion(version);
const { renderedPayload } = yield* render();

RenderParameterVersionHttp

Source: src/GCP/ParameterManager/RenderParameterVersionHttp.ts Kind: Layer · Provides: GCP.ParameterManager.RenderParameterVersion

HTTP implementation of RenderParameterVersion.