Skip to main content

ForkEnvironmentInput

Attributes for the new environment. The fork references the parent via parentId and seeds each package from the parent's params. Re-forking against the same parent re-runs the seed — params and version reset to the parent's current values, and the copy* flags re-apply — so the mutation behaves as a desired-state converge (use it to reset local edits, or to backfill secrets and remote references that a prior call didn't request). Re-forking with a different parent is rejected; a fork's parent is immutable.

input ForkEnvironmentInput {
  attributes: Map
  copyEnvironmentDefaults: Boolean
  copyRemoteReferences: Boolean
  copySecrets: Boolean
  decommissionProtection: Boolean
  description: String
  id: String!
  name: String!
}

Fields​

ForkEnvironmentInput.attributes ● Map scalar {#attributes}​

Key-value attributes for this environment. Keys and values must be strings. Must conform to the organization's custom attributes for the environment scope.

ForkEnvironmentInput.copyEnvironmentDefaults ● Boolean scalar {#copy-environment-defaults}​

When true, copies the parent environment's default resource connections into the fork.

ForkEnvironmentInput.copyRemoteReferences ● Boolean scalar {#copy-remote-references}​

When true, copies every package's remote resource references from the parent into the fork. Applies the same behavior as copyInstance(copyRemoteReferences: true) to every package in one call. Defaults to false.

ForkEnvironmentInput.copySecrets ● Boolean scalar {#copy-secrets}​

When true, copies every package's secret values from the parent into the fork. Applies the same behavior as copyInstance(copySecrets: true) to every package in one call. Defaults to false.

ForkEnvironmentInput.decommissionProtection ● Boolean scalar {#decommission-protection}​

When true, blocks decommissionEnvironment and any per-instance deployment with action: DECOMMISSION against this environment. Disable it via updateEnvironment before tearing down. Defaults to false.

ForkEnvironmentInput.description ● String scalar {#description}​

An optional description of the forked environment's purpose

ForkEnvironmentInput.id ● String! non-null scalar {#id}​

A short, memorable identifier for looking up this environment in the API and CLI. This becomes the second segment of instance identifiers. Max 20 characters, lowercase alphanumeric only (a-z, 0-9). Immutable after creation.

ForkEnvironmentInput.name ● String! non-null scalar {#name}​

A human-readable name for the forked environment

Member Of​

forkEnvironment mutation