PolicyStatementProps Struct
Properties for a policy statement.
Example
ts
declare const policyEngine: agentcore.PolicyEngine;
declare const gateway: agentcore.Gateway;
// Allow access unless the user is suspended
const policyWithUnless = new agentcore.Policy(this, "UnlessPolicy", {
policyEngine: policyEngine,
policyName: "unless_suspended",
statement: new agentcore.PolicyStatement({
effect: agentcore.PolicyEffect.PERMIT,
principal: agentcore.PolicyPrincipal.entityType('AgentCore::OAuthUser'),
action: agentcore.PolicyAction.any(),
resource: agentcore.PolicyResource.instance('AgentCore::Gateway', gateway.gatewayArn),
unless: [
agentcore.PolicyCondition.booleanEquals(
agentcore.PolicyAttribute.principal('suspended'), true),
],
}),
description: "Allow all actions unless user is suspended",
validationMode: agentcore.PolicyValidationMode.FAIL_ON_ANY_FINDINGS,
});
// Generated Cedar:
// permit(
// principal is AgentCore::OAuthUser,
// action,
// resource == AgentCore::Gateway::"arn:..."
// )
// unless {
// principal.suspended == true
// };
python
# policy_engine: agentcore.PolicyEngine
# gateway: agentcore.Gateway
# Allow access unless the user is suspended
policy_with_unless = agentcore.Policy(self, "UnlessPolicy",
policy_engine=policy_engine,
policy_name="unless_suspended",
statement=agentcore.PolicyStatement(
effect=agentcore.PolicyEffect.PERMIT,
principal=agentcore.PolicyPrincipal.entity_type("AgentCore::OAuthUser"),
action=agentcore.PolicyAction.any(),
resource=agentcore.PolicyResource.instance("AgentCore::Gateway", gateway.gateway_arn),
unless=[
agentcore.PolicyCondition.boolean_equals(
agentcore.PolicyAttribute.principal("suspended"), True)
]
),
description="Allow all actions unless user is suspended",
validation_mode=agentcore.PolicyValidationMode.FAIL_ON_ANY_FINDINGS
)
java
PolicyEngine policyEngine;
Gateway gateway;
// Allow access unless the user is suspended
Policy policyWithUnless = Policy.Builder.create(this, "UnlessPolicy")
.policyEngine(policyEngine)
.policyName("unless_suspended")
.statement(PolicyStatement.Builder.create()
.effect(PolicyEffect.PERMIT)
.principal(PolicyPrincipal.entityType("AgentCore::OAuthUser"))
.action(PolicyAction.any())
.resource(PolicyResource.instance("AgentCore::Gateway", gateway.getGatewayArn()))
.unless(List.of(PolicyCondition.booleanEquals(PolicyAttribute.principal("suspended"), true)))
.build())
.description("Allow all actions unless user is suspended")
.validationMode(PolicyValidationMode.FAIL_ON_ANY_FINDINGS)
.build();
csharp
// Install: dotnet add package Amazon.CDK.Lib
PolicyEngine policyEngine;
Gateway gateway;
// Allow access unless the user is suspended
var policyWithUnless = new Policy(this, "UnlessPolicy", new PolicyProps {
PolicyEngine = policyEngine,
PolicyName = "unless_suspended",
Statement = new PolicyStatement(new PolicyStatementProps {
Effect = PolicyEffect.PERMIT,
Principal = PolicyPrincipal.EntityType("AgentCore::OAuthUser"),
Action = PolicyAction.Any(),
Resource = PolicyResource.Instance("AgentCore::Gateway", gateway.GatewayArn),
Unless = new [] { PolicyCondition.BooleanEquals(PolicyAttribute.Principal("suspended"), true) }
}),
Description = "Allow all actions unless user is suspended",
ValidationMode = PolicyValidationMode.FAIL_ON_ANY_FINDINGS
});
go
// Install: go get github.com/aws/aws-cdk-go/awscdk/v2
var policyEngine PolicyEngine
var gateway Gateway
// Allow access unless the user is suspended
policyWithUnless := agentcore.NewPolicy(this, jsii.String("UnlessPolicy"), &PolicyProps{
PolicyEngine: policyEngine,
PolicyName: jsii.String("unless_suspended"),
Statement: agentcore.NewPolicyStatement(&PolicyStatementProps{
Effect: agentcore.PolicyEffect_PERMIT,
Principal: agentcore.PolicyPrincipal_EntityType(jsii.String("AgentCore::OAuthUser")),
Action: agentcore.PolicyAction_Any(),
Resource: agentcore.PolicyResource_Instance(jsii.String("AgentCore::Gateway"), gateway.GatewayArn),
Unless: []PolicyCondition{
agentcore.PolicyCondition_BooleanEquals(agentcore.PolicyAttribute_Principal(jsii.String("suspended")), jsii.Boolean(true)),
},
}),
Description: jsii.String("Allow all actions unless user is suspended"),
ValidationMode: agentcore.PolicyValidationMode_FAIL_ON_ANY_FINDINGS(),
})
Properties
The action the statement applies to.
Whether the statement permits or forbids the action.
principalPolicyPrincipalprincipalPolicyPrincipalprincipalPolicyPrincipalPrincipalPolicyPrincipalPrincipalPolicyPrincipalrequired#The principal the statement applies to.
resourcePolicyResourceresourcePolicyResourceresourcePolicyResourceResourcePolicyResourceResourcePolicyResourcerequired#The resource the statement applies to.
unlessoptionalPolicyCondition[]unlessoptionaltyping.List[PolicyCondition]unlessoptionalList<PolicyCondition>UnlessoptionalPolicyCondition[]Unlessoptional*[]PolicyCondition#Conditions that must not hold for the statement to apply.
Default: no exclusions
whenoptionalPolicyCondition[]whenoptionaltyping.List[PolicyCondition]whenoptionalList<PolicyCondition>WhenoptionalPolicyCondition[]Whenoptional*[]PolicyCondition#Conditions that must all hold for the statement to apply.
Default: the statement applies whenever its principal, action and resource match
Use PolicyCondition.anyOf() for a member that only needs one of several conditions to hold.