Skip to main content

UpdateEnvironmentInput

Update an existing environment's name and description. The ID cannot be changed after creation.

input UpdateEnvironmentInput {
attributes: Map
decommissionProtection: Boolean
description: String
name: String
separationOfDuty: Boolean
}

Fields

UpdateEnvironmentInput.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.

UpdateEnvironmentInput.decommissionProtection ● Boolean scalar {#decommission-protection}

When true, blocks decommissionEnvironment and any per-instance deployment with action: DECOMMISSION against this environment. Toggle it off here before tearing down.

UpdateEnvironmentInput.description ● String scalar {#description}

An optional description of the environment's purpose

UpdateEnvironmentInput.name ● String scalar {#name}

A human-readable name for the environment

UpdateEnvironmentInput.separationOfDuty ● Boolean scalar {#separation-of-duty}

When true, approveDeployment rejects any approval from the account or service account that proposed the deployment — a proposal in this environment has to be approved by a second reviewer. Proposers can still reject their own proposals with rejectDeployment.

Member Of

updateEnvironment mutation