Resource
conditional_iam_policy
Revision-checked conditional policy contract for IaC; uses the same IAM policy storage and attachment IDs.
Configuration
nameString!RequiredPolicy name (required)
descriptionStringOptionalPolicy description
documentIAMDocument!RequiredPolicy document (required)
Input types
Fields for the structured values used in this resource’s configuration.
IAMDocumentInput
Input for a policy document
versionStringOptionalPolicy document version
statements[IAMStatementInput!]!RequiredPolicy statements (required)
IAMStatementInput
Input for a policy statement. Actions are validated at parse time.
conditionsIAMConditionInputOptionalRequest conditions that limit when the statement applies
filterIAMFilterInputOptionalFilter selecting the records the statement applies to; omit to apply to all matching resources
effectEffect!RequiredAllow or deny (required)
Allowed values
ALLOW — Allow the specified actions
DENY — Deny the specified actions (overrides allow)
actions[IAMAction!]!RequiredAction patterns - validated IAMAction values (required)
resources[String!]!RequiredResource patterns (required)
IAMRelatedAccessInput
Access to records related to the statement's root through a registered relationship
relationshipString!RequiredRegistered path from the statement's root to the target records
actions[IAMAction!]!RequiredExisting actions to grant through the relationship
IAMConditionInput
Request conditions that limit when a policy statement applies
networkZones[String!]OptionalNetwork zones the request must come from; omit for no network condition
notBeforeIAMPolicyInstantOptionalInstant before which the statement does not apply
expiresAtIAMPolicyInstantOptionalInstant from which the statement no longer applies
IAMFilterInput
Node of a conditional policy filter that selects the records a statement applies to. Kinds, comparisons and value kinds use this schema's enum values in GraphQL and in IaC policy documents alike.
kindIAMFilterKind!RequiredKind of filter node (COMPARE, MEMBER, IS_NULL, ALL or ANY); decides which other fields are required
Allowed values
COMPARE — Compare an attribute with an operand
MEMBER — Match when the attribute equals one of the listed values
IS_NULL — Match when the attribute has no value
ALL — Match when every child filter matches
ANY — Match when at least one child filter matches
attributeStringOptionalBusiness attribute tested by COMPARE, MEMBER and IS_NULL nodes
comparisonIAMComparisonOptionalOperator of a COMPARE node, such as EQUAL or GREATER_THAN_OR_EQUAL
Allowed values
EQUAL — Attribute equals the operand
LESS_THAN — Attribute is less than the operand
LESS_THAN_OR_EQUAL — Attribute is less than or equal to the operand
GREATER_THAN — Attribute is greater than the operand
GREATER_THAN_OR_EQUAL — Attribute is greater than or equal to the operand
operandIAMOperandInputOptionalValue a compare node compares with
values[IAMValueInput!]OptionalAllowed values of a member node
children[IAMFilterInput!]OptionalChild filters combined by an ALL or ANY node
IAMOperandInput
Right-hand side of a compare filter: set literal, or calendarYearsAgo with timeZone
literalIAMValueInputOptionalFixed value to compare with; omit for a relative date
calendarYearsAgoIntOptionalRelative date: the start of the calendar year this many years before the evaluation time; requires timeZone
timeZoneStringOptionalIANA time zone used to resolve calendarYearsAgo
IAMValueInput
Typed literal value in a conditional policy filter; set exactly one value field, matching kind
kindIAMValueKind!RequiredWhich of the typed value fields is set
Allowed values
IDENTIFIER — A record identifier, as the record's TypeID (for example `cus_…` for order.customer)
STRING — A text value
INSTANT — A point in time
BOOLEAN — A true/false value
identifierStringOptionalIdentifier value as the record's TypeID, when kind is identifier; a bare UUID is refused
stringStringOptionalText value, when kind is string
instantIAMPolicyInstantOptionalInstant value, when kind is instant
booleanBooleanOptionalBoolean value, when kind is boolean
Read-only values
Show values
idIAMPolicyID!Read onlyUnique identifier
computed by the platform
revisionString!Read onlyOpaque editable-content revision. Required as expectedRevision when updating.
computed by the platform
createdAtString!Read onlyCreation timestamp (ISO8601)
computed by the platform
updatedAtString!Read onlyLast update timestamp (ISO8601)
computed by the platform
Lifecycle
The CLI can create this resource. The platform assigns its id.
When replacement is needed, the existing resource is removed before its replacement is created.