Class PolicyEngine

java.lang.Object
software.amazon.awssdk.services.bedrockagentcorecontrol.model.PolicyEngine
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<PolicyEngine.Builder,PolicyEngine>
@Generated("software.amazon.awssdk:codegen") public final class PolicyEngine extends Object implements SdkPojo, Serializable, ToCopyableBuilder<PolicyEngine.Builder,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).

See Also:

  • Method Details

    • policyEngineId

      public final String policyEngineId()

      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.

      Returns:
      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.

    • name

      public final String name()

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

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

    • description

      public final String description()

      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.

      Returns:
      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.

    • createdAt

      public final Instant createdAt()

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

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

    • updatedAt

      public final Instant updatedAt()

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

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

    • policyEngineArn

      public final String policyEngineArn()

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

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

    • status

      public final PolicyEngineStatus status()

      The current status of the policy engine.

      If the service returns an enum value that is not available in the current SDK version, status will return PolicyEngineStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusAsString().

      Returns:
      The current status of the policy engine.
      See Also:

    • statusAsString

      public final String statusAsString()

      The current status of the policy engine.

      If the service returns an enum value that is not available in the current SDK version, status will return PolicyEngineStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusAsString().

      Returns:
      The current status of the policy engine.
      See Also:

    • hasStatusReasons

      public final boolean hasStatusReasons()
      For responses, this returns true if the service returned a value for the StatusReasons property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • statusReasons

      public final List<String> statusReasons()

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

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasStatusReasons() method.

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

    • toBuilder

      public PolicyEngine.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<PolicyEngine.Builder,PolicyEngine>
      Returns:
      a builder for type T

    • builder

      public static PolicyEngine.Builder builder()

    • serializableBuilderClass

      public static Class<? extends PolicyEngine.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class Object

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class Object

    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • toString

      public final String toString()
      Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
      Overrides:
      toString in class Object

    • getValueForField

      public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.