Skip to content
v2.273.0

PolicyPrincipal Class ​

The principal a policy statement applies to.

Example ​

ts
import { PolicyPrincipal } from 'aws-cdk-lib/aws-bedrockagentcore';

PolicyPrincipal.any(); // principal
PolicyPrincipal.entityType('AgentCore::OAuthUser'); // principal is AgentCore::OAuthUser
PolicyPrincipal.entity('AgentCore::OAuthUser', 'user123'); // principal == AgentCore::OAuthUser::"user123"
PolicyPrincipal.inGroup('AgentCore::OAuthGroup', 'admins'); // principal in AgentCore::OAuthGroup::"admins"

Methods ​

any(): PolicyPrincipal // chainable@staticmethod def any() -> PolicyPrincipalpublic static PolicyPrincipal any()public static PolicyPrincipal Any()func Any() PolicyPrincipalstatic#
Any principal, whoever the caller is.
entity(entityType: string, entityId: string): PolicyPrincipal // chainable@staticmethod def entity(entity_type: str, entity_id: str) -> PolicyPrincipalpublic static PolicyPrincipal entity(String entityType, String entityId)public static PolicyPrincipal Entity(string entityType, string entityId)func Entity(EntityType *string, EntityId *string) PolicyPrincipalstatic#
One specific principal.
2 parameters

Parameters

  • entityTypeentity_typeentityTypeentityTypeEntityType — - The entity type, for example 'AgentCore::OAuthUser'.
  • entityIdentity_identityIdentityIdEntityId — - The entity identifier.
entityType(entityType: string): PolicyPrincipal // chainable@staticmethod def entity_type(entity_type: str) -> PolicyPrincipalpublic static PolicyPrincipal entityType(String entityType)public static PolicyPrincipal EntityType(string entityType)func EntityType(EntityType *string) PolicyPrincipalstatic#
Any principal of the given entity type.
1 parameter

Parameters

  • entityTypeentity_typeentityTypeentityTypeEntityType — - The entity type, for example 'AgentCore::OAuthUser'.
inGroup(groupType: string, groupId: string): PolicyPrincipal // chainable@staticmethod def in_group(group_type: str, group_id: str) -> PolicyPrincipalpublic static PolicyPrincipal inGroup(String groupType, String groupId)public static PolicyPrincipal InGroup(string groupType, string groupId)func InGroup(GroupType *string, GroupId *string) PolicyPrincipalstatic#
Any principal that is a member of the given group.
2 parameters

Parameters

  • groupTypegroup_typegroupTypegroupTypeGroupType — - The group entity type, for example 'AgentCore::OAuthGroup'.
  • groupIdgroup_idgroupIdgroupIdGroupId — - The group identifier.