Skip to content
v2.277.0

PolicyCondition Class ​

A condition on a policy statement.

A condition compares a request attribute against a value. Conditions are grouped into the when and unless clauses of a statement, where the members of a clause must all hold.

Comparisons are named for the type of value they accept, so each one takes a concrete type rather than a union. Use allOf and anyOf to build a nested boolean expression, which also makes the grouping explicit in the generated Cedar.

Example ​

ts
import { PolicyAttribute, PolicyCondition } from 'aws-cdk-lib/aws-bedrockagentcore';

// principal.department == "Engineering"
PolicyCondition.stringEquals(PolicyAttribute.principal('department'), 'Engineering');

// (principal.department == "Engineering" || principal.department == "Support")
PolicyCondition.anyOf([
  PolicyCondition.stringEquals(PolicyAttribute.principal('department'), 'Engineering'),
  PolicyCondition.stringEquals(PolicyAttribute.principal('department'), 'Support'),
]);
python
from aws_cdk.aws_bedrockagentcore import PolicyAttribute, PolicyCondition


# principal.department == "Engineering"
PolicyCondition.string_equals(PolicyAttribute.principal("department"), "Engineering")

# (principal.department == "Engineering" || principal.department == "Support")
PolicyCondition.any_of([
    PolicyCondition.string_equals(PolicyAttribute.principal("department"), "Engineering"),
    PolicyCondition.string_equals(PolicyAttribute.principal("department"), "Support")
])
java
import software.amazon.awscdk.services.bedrockagentcore.PolicyAttribute;
import software.amazon.awscdk.services.bedrockagentcore.PolicyCondition;


// principal.department == "Engineering"
PolicyCondition.stringEquals(PolicyAttribute.principal("department"), "Engineering");

// (principal.department == "Engineering" || principal.department == "Support")
PolicyCondition.anyOf(List.of(PolicyCondition.stringEquals(PolicyAttribute.principal("department"), "Engineering"), PolicyCondition.stringEquals(PolicyAttribute.principal("department"), "Support")));
csharp
// Install: dotnet add package Amazon.CDK.Lib
using Amazon.CDK.AWS.BedrockAgentCore;


// principal.department == "Engineering"
PolicyCondition.StringEquals(PolicyAttribute.Principal("department"), "Engineering");

// (principal.department == "Engineering" || principal.department == "Support")
PolicyCondition.AnyOf(new [] { PolicyCondition.StringEquals(PolicyAttribute.Principal("department"), "Engineering"), PolicyCondition.StringEquals(PolicyAttribute.Principal("department"), "Support") });
go
// Install: go get github.com/aws/aws-cdk-go/awscdk/v2
import "github.com/aws/aws-cdk-go/awscdk"


// principal.department == "Engineering"
awscdk.PolicyCondition_StringEquals(awscdk.PolicyAttribute_Principal(jsii.String("department")), jsii.String("Engineering"))

// (principal.department == "Engineering" || principal.department == "Support")
awscdk.PolicyCondition_AnyOf([]PolicyCondition{
	awscdk.PolicyCondition_StringEquals(awscdk.PolicyAttribute_Principal(jsii.String("department")), jsii.String("Engineering")),
	awscdk.PolicyCondition_StringEquals(awscdk.PolicyAttribute_Principal(jsii.String("department")), jsii.String("Support")),
})

Methods ​

allOf(conditions: PolicyCondition[]): PolicyCondition // chainable@staticmethod def all_of(conditions: typing.List[PolicyCondition]) -> PolicyConditionpublic static PolicyCondition allOf(List<PolicyCondition> conditions)public static PolicyCondition AllOf(PolicyCondition[] conditions)func AllOf(Conditions *[]PolicyCondition) PolicyConditionstatic#
All of the given conditions must hold.

Renders as a parenthesised && group, so it can be nested inside anyOf without relying on operator precedence.

1 parameter

Parameters

  • conditionsconditionsconditionsconditionsConditions — - The conditions to combine, at least one.
anyOf(conditions: PolicyCondition[]): PolicyCondition // chainable@staticmethod def any_of(conditions: typing.List[PolicyCondition]) -> PolicyConditionpublic static PolicyCondition anyOf(List<PolicyCondition> conditions)public static PolicyCondition AnyOf(PolicyCondition[] conditions)func AnyOf(Conditions *[]PolicyCondition) PolicyConditionstatic#
At least one of the given conditions must hold.

Renders as a parenthesised || group, so it can be nested inside allOf or combined with the surrounding clause without relying on operator precedence.

1 parameter

Parameters

  • conditionsconditionsconditionsconditionsConditions — - The conditions to combine, at least one.
booleanEquals(attribute: PolicyAttribute, value: boolean): PolicyCondition // chainable@staticmethod def boolean_equals(attribute: PolicyAttribute, value: bool) -> PolicyConditionpublic static PolicyCondition booleanEquals(PolicyAttribute attribute, Boolean value)public static PolicyCondition BooleanEquals(PolicyAttribute attribute, bool value)func BooleanEquals(Attribute PolicyAttribute, Value *bool) PolicyConditionstatic#
The attribute equals a boolean value.
2 parameters

Parameters

  • attributeattributeattributeattributeAttribute — - The attribute to compare.
  • valuevaluevaluevalueValue — - The value to compare against.
ipInRange(attribute: PolicyAttribute, cidr: string): PolicyCondition // chainable@staticmethod def ip_in_range(attribute: PolicyAttribute, cidr: str) -> PolicyConditionpublic static PolicyCondition ipInRange(PolicyAttribute attribute, String cidr)public static PolicyCondition IpInRange(PolicyAttribute attribute, string cidr)func IpInRange(Attribute PolicyAttribute, Cidr *string) PolicyConditionstatic#
The attribute is an IP address inside the given CIDR range.
2 parameters

Parameters

  • attributeattributeattributeattributeAttribute — - The attribute holding an IP address.
  • cidrcidrcidrcidrCidr — - The range in CIDR notation, for example '192.168.1.0/24'.
numberEquals(attribute: PolicyAttribute, value: number): PolicyCondition // chainable@staticmethod def number_equals(attribute: PolicyAttribute, value: int | float) -> PolicyConditionpublic static PolicyCondition numberEquals(PolicyAttribute attribute, Number value)public static PolicyCondition NumberEquals(PolicyAttribute attribute, double value)func NumberEquals(Attribute PolicyAttribute, Value *float64) PolicyConditionstatic#
The attribute equals a number value.

Cedar whole numbers are 64-bit signed integers, so the value must be an integer.

2 parameters

Parameters

  • attributeattributeattributeattributeAttribute — - The attribute to compare.
  • valuevaluevaluevalueValue — - The value to compare against.
numberGreaterThan(attribute: PolicyAttribute, value: number): PolicyCondition // chainable@staticmethod def number_greater_than(attribute: PolicyAttribute, value: int | float) -> PolicyConditionpublic static PolicyCondition numberGreaterThan(PolicyAttribute attribute, Number value)public static PolicyCondition NumberGreaterThan(PolicyAttribute attribute, double value)func NumberGreaterThan(Attribute PolicyAttribute, Value *float64) PolicyConditionstatic#
The attribute is greater than a number value.
2 parameters

Parameters

  • attributeattributeattributeattributeAttribute — - The attribute to compare.
  • valuevaluevaluevalueValue — - The value to compare against.
numberGreaterThanOrEquals(attribute: PolicyAttribute, value: number): PolicyCondition // chainable@staticmethod def number_greater_than_or_equals(attribute: PolicyAttribute, value: int | float) -> PolicyConditionpublic static PolicyCondition numberGreaterThanOrEquals(PolicyAttribute attribute, Number value)public static PolicyCondition NumberGreaterThanOrEquals(PolicyAttribute attribute, double value)func NumberGreaterThanOrEquals(Attribute PolicyAttribute, Value *float64) PolicyConditionstatic#
The attribute is greater than or equal to a number value.
2 parameters

Parameters

  • attributeattributeattributeattributeAttribute — - The attribute to compare.
  • valuevaluevaluevalueValue — - The value to compare against.
numberIn(attribute: PolicyAttribute, values: number[]): PolicyCondition // chainable@staticmethod def number_in(attribute: PolicyAttribute, values: typing.List[int | float]) -> PolicyConditionpublic static PolicyCondition numberIn(PolicyAttribute attribute, List<Number> values)public static PolicyCondition NumberIn(PolicyAttribute attribute, double[] values)func NumberIn(Attribute PolicyAttribute, Values *[]*float64) PolicyConditionstatic#
The attribute is one of the given number values.
2 parameters

Parameters

  • attributeattributeattributeattributeAttribute — - The attribute to compare.
  • valuesvaluesvaluesvaluesValues — - The allowed values, at least one.
numberLessThan(attribute: PolicyAttribute, value: number): PolicyCondition // chainable@staticmethod def number_less_than(attribute: PolicyAttribute, value: int | float) -> PolicyConditionpublic static PolicyCondition numberLessThan(PolicyAttribute attribute, Number value)public static PolicyCondition NumberLessThan(PolicyAttribute attribute, double value)func NumberLessThan(Attribute PolicyAttribute, Value *float64) PolicyConditionstatic#
The attribute is less than a number value.
2 parameters

Parameters

  • attributeattributeattributeattributeAttribute — - The attribute to compare.
  • valuevaluevaluevalueValue — - The value to compare against.
numberLessThanOrEquals(attribute: PolicyAttribute, value: number): PolicyCondition // chainable@staticmethod def number_less_than_or_equals(attribute: PolicyAttribute, value: int | float) -> PolicyConditionpublic static PolicyCondition numberLessThanOrEquals(PolicyAttribute attribute, Number value)public static PolicyCondition NumberLessThanOrEquals(PolicyAttribute attribute, double value)func NumberLessThanOrEquals(Attribute PolicyAttribute, Value *float64) PolicyConditionstatic#
The attribute is less than or equal to a number value.
2 parameters

Parameters

  • attributeattributeattributeattributeAttribute — - The attribute to compare.
  • valuevaluevaluevalueValue — - The value to compare against.
numberNotEquals(attribute: PolicyAttribute, value: number): PolicyCondition // chainable@staticmethod def number_not_equals(attribute: PolicyAttribute, value: int | float) -> PolicyConditionpublic static PolicyCondition numberNotEquals(PolicyAttribute attribute, Number value)public static PolicyCondition NumberNotEquals(PolicyAttribute attribute, double value)func NumberNotEquals(Attribute PolicyAttribute, Value *float64) PolicyConditionstatic#
The attribute does not equal a number value.
2 parameters

Parameters

  • attributeattributeattributeattributeAttribute — - The attribute to compare.
  • valuevaluevaluevalueValue — - The value to compare against.
setContains(attribute: PolicyAttribute, value: string): PolicyCondition // chainable@staticmethod def set_contains(attribute: PolicyAttribute, value: str) -> PolicyConditionpublic static PolicyCondition setContains(PolicyAttribute attribute, String value)public static PolicyCondition SetContains(PolicyAttribute attribute, string value)func SetContains(Attribute PolicyAttribute, Value *string) PolicyConditionstatic#
The attribute is a set that contains the given value.

Use this when the attribute itself holds a set, for example principal.groups. To test a scalar attribute against a list of allowed values, use stringIn or numberIn instead.

2 parameters

Parameters

  • attributeattributeattributeattributeAttribute — - The attribute holding a set.
  • valuevaluevaluevalueValue — - The member to look for.
stringEquals(attribute: PolicyAttribute, value: string): PolicyCondition // chainable@staticmethod def string_equals(attribute: PolicyAttribute, value: str) -> PolicyConditionpublic static PolicyCondition stringEquals(PolicyAttribute attribute, String value)public static PolicyCondition StringEquals(PolicyAttribute attribute, string value)func StringEquals(Attribute PolicyAttribute, Value *string) PolicyConditionstatic#
The attribute equals a string value.
2 parameters

Parameters

  • attributeattributeattributeattributeAttribute — - The attribute to compare.
  • valuevaluevaluevalueValue — - The value to compare against.
stringIn(attribute: PolicyAttribute, values: string[]): PolicyCondition // chainable@staticmethod def string_in(attribute: PolicyAttribute, values: typing.List[str]) -> PolicyConditionpublic static PolicyCondition stringIn(PolicyAttribute attribute, List<String> values)public static PolicyCondition StringIn(PolicyAttribute attribute, string[] values)func StringIn(Attribute PolicyAttribute, Values *[]*string) PolicyConditionstatic#
The attribute is one of the given string values.
2 parameters

Parameters

  • attributeattributeattributeattributeAttribute — - The attribute to compare.
  • valuesvaluesvaluesvaluesValues — - The allowed values, at least one.
stringNotEquals(attribute: PolicyAttribute, value: string): PolicyCondition // chainable@staticmethod def string_not_equals(attribute: PolicyAttribute, value: str) -> PolicyConditionpublic static PolicyCondition stringNotEquals(PolicyAttribute attribute, String value)public static PolicyCondition StringNotEquals(PolicyAttribute attribute, string value)func StringNotEquals(Attribute PolicyAttribute, Value *string) PolicyConditionstatic#
The attribute does not equal a string value.
2 parameters

Parameters

  • attributeattributeattributeattributeAttribute — - The attribute to compare.
  • valuevaluevaluevalueValue — - The value to compare against.