OBJECT

GuardrailsDesiredState

It is a combination of a guardrail template with required input parameters as well as the credentials metadata required to create infrastructure and enforce policies on the same. Guardrails DesiredState can be run on-demand, or on a pre-defined schedule, or in response to an event

GraphQL Schema definition

type GuardrailsDesiredState implements Node {
#   Unique identifier for guardrail DesiredState
id: ID! 
#   guardrails desired state context
accountStateContext: [GuardrailsDesiredStateContext!] @deprecated( reason: "DesiredStates are no more directly associated with accounts, the association is expressed using targets"  )
#   CSP user who created guardrail desired state
createdBy: User! 
#   Timestamp at which guardrail desired state is created. Expressed in UTC ISO-8601 
#   format
createdOn: DateTime! 
#   CSP project associated with guardrail desired state
cspProjectEntity: Entity 
#   Flag indicating whether the desired state is archived
deleted: Boolean 
#   Guardrail desired state description
description: String 
#   DesiredState runs
# 
# Arguments
#   accounts: filter runs for a specific accounts
#   after: Return records after the given cursor, as per GraphQL 
#   Relay spec
#   before: Return records before the given cursor, as per GraphQL 
#   Relay spec
#   first: Returns the latest N records
#   status: [Not documented]
desiredStateRunConnection(
accounts: [GuardrailsAccountSelector!],
after: String,
before: String,
first: Int,
status: [GuardrailsDesiredStateRunStatus!]
): GuardrailsDesiredStateRunConnection 
#   Enable/Disable continuous enforcement
enabled: Boolean 
#   Last run of the desired state
# 
# Arguments
#   accounts: filter runs for a specific accounts
latestRun(accounts: [GuardrailsAccountSelector!]): GuardrailsDesiredStateRun 
#   mode for desired state, can ENFORCEMENT or MONITOR
mode: GuardrailsDesiredStateMode! 
#   Name of guardrail desired state
name: String! 
#   Parameters required to run guardrail DesiredState.
parameters: JSON 
#   Severity of the guardrails desired state
severity: GuardrailsDesiredStateSeverity 
#   The target on which this desired state will be applied
target: GuardrailsDesiredStateTarget 
#   Guardrails template that will be enforced by this DesiredState
template: GuardrailsTemplate! 
#   CSP user who updated guardrail desired state
updatedBy: User 
#   Timestamp at which guardrail desired state is updated. Expressed in UTC ISO-8601 
#   format
updatedOn: DateTime 
}

GuardrailsDesiredState

link GraphQL Schema definition

link Require by

GraphQL Schema definition

Require by