Package software.amazon.awscdk.cfnpropertymixins.services.bedrockagentcore

Interface CfnGatewayPropsMixin.GatewayPolicyEngineConfigurationProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnGatewayPropsMixin.GatewayPolicyEngineConfigurationProperty.Jsii$Proxy

Enclosing class:

CfnGatewayPropsMixin

@Stability(Stable)
public static interface CfnGatewayPropsMixin.GatewayPolicyEngineConfigurationProperty
extends software.amazon.jsii.JsiiSerializable

The configuration for a policy engine associated with a gateway.

A policy engine is a collection of policies that evaluates and authorizes agent tool calls. When associated with a gateway, the policy engine intercepts all agent requests and determines whether to allow or deny each action based on the defined policies.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.cfnpropertymixins.services.bedrockagentcore.*;
 GatewayPolicyEngineConfigurationProperty gatewayPolicyEngineConfigurationProperty = GatewayPolicyEngineConfigurationProperty.builder()
         .arn("arn")
         .mode("mode")
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-gateway-gatewaypolicyengineconfiguration.html

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnGatewayPropsMixin.GatewayPolicyEngineConfigurationProperty.Builder	A builder for CfnGatewayPropsMixin.GatewayPolicyEngineConfigurationProperty
static final class	CfnGatewayPropsMixin.GatewayPolicyEngineConfigurationProperty.Jsii$Proxy	An implementation for CfnGatewayPropsMixin.GatewayPolicyEngineConfigurationProperty

Method Summary

Modifier and Type	Method	Description
static CfnGatewayPropsMixin.GatewayPolicyEngineConfigurationProperty.Builder	builder()
default String	getArn()	The ARN of the policy engine.
default String	getMode()	The enforcement mode for the policy engine.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getArn

@Stability(Stable)
@Nullable
default String getArn()

The ARN of the policy engine.

The policy engine contains Cedar policies that define fine-grained authorization rules specifying who can perform what actions on which resources as agents interact through the gateway.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-gateway-gatewaypolicyengineconfiguration.html#cfn-bedrockagentcore-gateway-gatewaypolicyengineconfiguration-arn

getMode

@Stability(Stable)
@Nullable
default String getMode()

The enforcement mode for the policy engine.

LOG_ONLY - The policy engine evaluates each action against your policies and adds traces on whether tool calls would be allowed or denied, but does not enforce the decision. Use this mode to test and validate policies before enabling enforcement. ENFORCE - The policy engine evaluates actions against your policies and enforces decisions by allowing or denying agent operations. Test and validate policies in LOG_ONLY mode before enabling enforcement to avoid unintended denials or adversely affecting production traffic.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-gateway-gatewaypolicyengineconfiguration.html#cfn-bedrockagentcore-gateway-gatewaypolicyengineconfiguration-mode

builder

@Stability(Stable)
static CfnGatewayPropsMixin.GatewayPolicyEngineConfigurationProperty.Builder builder()

Returns:

a CfnGatewayPropsMixin.GatewayPolicyEngineConfigurationProperty.Builder of CfnGatewayPropsMixin.GatewayPolicyEngineConfigurationProperty