CompositePrincipal

class aws_cdk.aws_iam.CompositePrincipal(*principals)

Bases: aws_cdk.aws_iam.PrincipalBase

Represents a principal that has multiple types of principals.

A composite principal cannot have conditions. i.e. multiple ServicePrincipals that form a composite principal

__init__(*principals)
Parameters

principals (PrincipalBase) –

Return type

None

Methods

add_principals(*principals)

Adds IAM principals to the composite principal.

Composite principals cannot have conditions.

Parameters

principals (PrincipalBase) – IAM principals that will be added to the composite principal.

Return type

CompositePrincipal

add_to_policy(statement)

Add to the policy of this principal.

Parameters

statement (PolicyStatement) –

Return type

bool

add_to_principal_policy(_statement)

Add to the policy of this principal.

Parameters

_statement (PolicyStatement) –

Return type

AddToPrincipalPolicyResult

to_json()

JSON-ify the principal.

Used when JSON.stringify() is called

Return type

Mapping[str, List[str]]

to_string()

Returns a string representation of an object.

Return type

str

with_conditions(conditions)

Returns a new PrincipalWithConditions using this principal as the base, with the passed conditions added.

When there is a value for the same operator and key in both the principal and the conditions parameter, the value from the conditions parameter will be used.

Parameters

conditions (Mapping[str, Any]) –

return :rtype: IPrincipal :return: a new PrincipalWithConditions object.

Attributes

assume_role_action

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

Return type

str

grant_principal

The principal to grant permissions to.

Return type

IPrincipal

policy_fragment

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

Return type

PrincipalPolicyFragment