PolicyEngine

Represents a policy engine resource within the AgentCore Policy system. Policy engines serve as containers for grouping related policies and provide the execution context for policy evaluation and management. Each policy engine can be associated with one Gateway (one engine per Gateway), where it intercepts all agent tool calls and evaluates them against the contained policies before allowing tools to execute. The policy engine maintains the Cedar schema generated from the Gateway's tool manifest, ensuring that policies are validated against the actual tools and parameters available. Policy engines support two enforcement modes that can be configured when associating with a Gateway: log-only mode for testing (evaluates decisions without blocking) and enforce mode for production (actively allows or denies based on policy evaluation).

Types

Link copied to clipboard
class Builder
Link copied to clipboard
object Companion

Properties

Link copied to clipboard
val createdAt: <Error class: unknown class>

The timestamp when the policy engine was originally created. This is automatically set by the service and used for auditing and lifecycle management.

Link copied to clipboard

A human-readable description of the policy engine's purpose and scope. Limited to 4,096 characters, this helps administrators understand the policy engine's role in the overall governance strategy.

Link copied to clipboard

The customer-assigned immutable name for the policy engine. This human-readable identifier must be unique within the account and cannot exceed 48 characters.

Link copied to clipboard

The Amazon Resource Name (ARN) of the policy engine. This globally unique identifier can be used for cross-service references and IAM policy statements.

Link copied to clipboard

The unique identifier for the policy engine. This system-generated identifier consists of the user name plus a 10-character generated suffix and serves as the primary key for policy engine operations.

Link copied to clipboard

The current status of the policy engine.

Link copied to clipboard

Additional information about the policy engine status. This provides details about any failures or the current state of the policy engine lifecycle.

Link copied to clipboard
val updatedAt: <Error class: unknown class>

The timestamp when the policy engine was last modified. This tracks the most recent changes to the policy engine configuration or metadata.

Functions

Link copied to clipboard
inline fun copy(block: PolicyEngine.Builder.() -> Unit = {}): PolicyEngine
Link copied to clipboard
open operator override fun equals(other: Any?): Boolean
Link copied to clipboard
open override fun hashCode(): Int
Link copied to clipboard
open override fun toString(): String