Class: Aws::BedrockAgentCoreControl::Types::PolicyEngine

Inherits:

Struct

• Object
• Struct
• Aws::BedrockAgentCoreControl::Types::PolicyEngine

Defined in:

gems/aws-sdk-bedrockagentcorecontrol/lib/aws-sdk-bedrockagentcorecontrol/types.rb

Overview

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:

• AWS API Documentation

Constant Summary

SENSITIVE =

[:description]

Instance Attribute Summary

• #created_at ⇒ Time

  The timestamp when the policy engine was originally created.

• #description ⇒ String

  A human-readable description of the policy engine's purpose and scope.

• #encryption_key_arn ⇒ String

  The Amazon Resource Name (ARN) of the KMS key used to encrypt the policy engine data.

• #name ⇒ String

  The customer-assigned immutable name for the policy engine.

• #policy_engine_arn ⇒ String

  The Amazon Resource Name (ARN) of the policy engine.

• #policy_engine_id ⇒ String

  The unique identifier for the policy engine.

• #status ⇒ String

  The current status of the policy engine.

• #status_reasons ⇒ Array<String>

  Additional information about the policy engine status.

• #updated_at ⇒ Time

  The timestamp when the policy engine was last modified.

Instance Attribute Details

#created_at ⇒ Time

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

Returns:

• (Time)

# File 'gems/aws-sdk-bedrockagentcorecontrol/lib/aws-sdk-bedrockagentcorecontrol/types.rb', line 17766

class PolicyEngine < Struct.new(
  :policy_engine_id,
  :name,
  :created_at,
  :updated_at,
  :policy_engine_arn,
  :status,
  :encryption_key_arn,
  :description,
  :status_reasons)
  SENSITIVE = [:description]
  include Aws::Structure
end

#description ⇒ String

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:

• (String)

# File 'gems/aws-sdk-bedrockagentcorecontrol/lib/aws-sdk-bedrockagentcorecontrol/types.rb', line 17766

class PolicyEngine < Struct.new(
  :policy_engine_id,
  :name,
  :created_at,
  :updated_at,
  :policy_engine_arn,
  :status,
  :encryption_key_arn,
  :description,
  :status_reasons)
  SENSITIVE = [:description]
  include Aws::Structure
end

#encryption_key_arn ⇒ String

The Amazon Resource Name (ARN) of the KMS key used to encrypt the policy engine data.

Returns:

• (String)

# File 'gems/aws-sdk-bedrockagentcorecontrol/lib/aws-sdk-bedrockagentcorecontrol/types.rb', line 17766

class PolicyEngine < Struct.new(
  :policy_engine_id,
  :name,
  :created_at,
  :updated_at,
  :policy_engine_arn,
  :status,
  :encryption_key_arn,
  :description,
  :status_reasons)
  SENSITIVE = [:description]
  include Aws::Structure
end

#name ⇒ String

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:

• (String)

# File 'gems/aws-sdk-bedrockagentcorecontrol/lib/aws-sdk-bedrockagentcorecontrol/types.rb', line 17766

class PolicyEngine < Struct.new(
  :policy_engine_id,
  :name,
  :created_at,
  :updated_at,
  :policy_engine_arn,
  :status,
  :encryption_key_arn,
  :description,
  :status_reasons)
  SENSITIVE = [:description]
  include Aws::Structure
end

#policy_engine_arn ⇒ String

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:

• (String)

# File 'gems/aws-sdk-bedrockagentcorecontrol/lib/aws-sdk-bedrockagentcorecontrol/types.rb', line 17766

class PolicyEngine < Struct.new(
  :policy_engine_id,
  :name,
  :created_at,
  :updated_at,
  :policy_engine_arn,
  :status,
  :encryption_key_arn,
  :description,
  :status_reasons)
  SENSITIVE = [:description]
  include Aws::Structure
end

#policy_engine_id ⇒ String

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:

• (String)

# File 'gems/aws-sdk-bedrockagentcorecontrol/lib/aws-sdk-bedrockagentcorecontrol/types.rb', line 17766

class PolicyEngine < Struct.new(
  :policy_engine_id,
  :name,
  :created_at,
  :updated_at,
  :policy_engine_arn,
  :status,
  :encryption_key_arn,
  :description,
  :status_reasons)
  SENSITIVE = [:description]
  include Aws::Structure
end

#status ⇒ String

The current status of the policy engine.

Returns:

• (String)

# File 'gems/aws-sdk-bedrockagentcorecontrol/lib/aws-sdk-bedrockagentcorecontrol/types.rb', line 17766

class PolicyEngine < Struct.new(
  :policy_engine_id,
  :name,
  :created_at,
  :updated_at,
  :policy_engine_arn,
  :status,
  :encryption_key_arn,
  :description,
  :status_reasons)
  SENSITIVE = [:description]
  include Aws::Structure
end

#status_reasons ⇒ Array<String>

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

Returns:

• (Array<String>)

# File 'gems/aws-sdk-bedrockagentcorecontrol/lib/aws-sdk-bedrockagentcorecontrol/types.rb', line 17766

class PolicyEngine < Struct.new(
  :policy_engine_id,
  :name,
  :created_at,
  :updated_at,
  :policy_engine_arn,
  :status,
  :encryption_key_arn,
  :description,
  :status_reasons)
  SENSITIVE = [:description]
  include Aws::Structure
end

#updated_at ⇒ Time

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

Returns:

• (Time)

# File 'gems/aws-sdk-bedrockagentcorecontrol/lib/aws-sdk-bedrockagentcorecontrol/types.rb', line 17766

class PolicyEngine < Struct.new(
  :policy_engine_id,
  :name,
  :created_at,
  :updated_at,
  :policy_engine_arn,
  :status,
  :encryption_key_arn,
  :description,
  :status_reasons)
  SENSITIVE = [:description]
  include Aws::Structure
end