ArnPrincipal

class aws_cdk.aws_iam.ArnPrincipal(arn)

Bases: aws_cdk.aws_iam.PrincipalBase

Specify a principal by the Amazon Resource Name (ARN).

You can specify AWS accounts, IAM users, Federated SAML users, IAM roles, and specific assumed-role sessions. You cannot specify IAM groups or instance profiles as principals

see :see: https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies_elements_principal.html

__init__(arn)
Parameters

arn (str) – Amazon Resource Name (ARN) of the principal entity (i.e. arn:aws:iam::123456789012:user/user-name).

Return type

None

Methods

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

arn

iam::123456789012:user/user-name).

Type

Amazon Resource Name (ARN) of the principal entity (i.e. arn

Type

aws

Return type

str

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