aws-cdk-lib.aws_iam.IComparablePrincipal

IComparablePrincipal Interface

Interface for principals that can be compared.

This only needs to be implemented for principals that could potentially be value-equal. Identity-equal principals will be handled correctly by default.

IComparablePrincipal

extends

• IPrincipal

implemented by

• AccountPrincipal,
• AccountRootPrincipal,
• AnyPrincipal,
• ArnPrincipal,
• 14 more

  • CanonicalUserPrincipal,
  • CompositePrincipal,
  • FederatedPrincipal,
  • OpenIdConnectPrincipal,
  • OrganizationPrincipal,
  • PrincipalBase,
  • PrincipalWithConditions,
  • SamlConsolePrincipal,
  • SamlPrincipal,
  • ServicePrincipal,
  • SessionTagsPrincipal,
  • StarPrincipal,
  • WebIdentityPrincipal,
  • ViaServicePrincipal

Source

aws-iam/lib/principals.ts

Type last changed

v2.26.0 · 30 May 2022

Properties

assumeRoleActionstringassume_role_actionstrassumeRoleActionStringAssumeRoleActionstringAssumeRoleAction*string#

When this Principal is used in an AssumeRole policy, the action to use.

grantPrincipalIPrincipalgrant_principalIPrincipalgrantPrincipalIPrincipalGrantPrincipalIPrincipalGrantPrincipalIPrincipal#

The principal to grant permissions to.

policyFragmentPrincipalPolicyFragmentpolicy_fragmentPrincipalPolicyFragmentpolicyFragmentPrincipalPolicyFragmentPolicyFragmentPrincipalPolicyFragmentPolicyFragmentPrincipalPolicyFragment#

Return the policy fragment that identifies this principal in a Policy.

principalAccount?may be undefinedstringprincipal_account?may be undefinedstrprincipalAccount?may be undefinedStringPrincipalAccount?may be undefinedstringPrincipalAccount?may be undefined*string#

The AWS account ID of this principal.

Can be undefined when the account is not known (for example, for service principals). Can be a Token - in that case, it's assumed to be AWS::AccountId.

Methods

addToPrincipalPolicy(statement: PolicyStatement): AddToPrincipalPolicyResultdef add_to_principal_policy(self, statement: PolicyStatement) -> AddToPrincipalPolicyResultpublic AddToPrincipalPolicyResult addToPrincipalPolicy(PolicyStatement statement)public AddToPrincipalPolicyResult AddToPrincipalPolicy(PolicyStatement statement)func AddToPrincipalPolicy(Statement PolicyStatement) AddToPrincipalPolicyResult#

Add to the policy of this principal.

dedupeString(): stringdef dedupe_string(self, ) -> strpublic String dedupeString()public string DedupeString()func DedupeString() *string#

Return a string format of this principal which should be identical if the two principals are the same.