IRole

class aws_cdk.aws_iam.IRole(*args, **kwargs)

Bases: aws_cdk.aws_iam.IIdentity, typing_extensions.Protocol

A Role object.

__init__(*args, **kwargs)

Methods

add_managed_policy(policy)

Attaches a managed policy to this principal.

Parameters

policy (IManagedPolicy) – The managed policy.

Return type

None

add_to_policy(statement)

Add to the policy of this principal.

Parameters

statement (PolicyStatement) –

return :rtype: bool :return:

true if the statement was added, false if the principal in question does not have a policy document to add the statement to.

attach_inline_policy(policy)

Attaches an inline policy to this principal. This is the same as calling policy.addToXxx(principal).

Parameters

policy (Policy) – The policy resource to attach to this principal [disable-awslint:ref-via-interface].

Return type

None

grant(grantee, *actions)

Grant the actions defined in actions to the identity Principal on this resource.

Parameters
Return type

Grant

grant_pass_role(grantee)

Grant permissions to the given principal to pass this role.

Parameters

grantee (IPrincipal) –

Return type

Grant

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

node

The construct node in the tree.

Return type

ConstructNode

policy_fragment

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

Return type

PrincipalPolicyFragment

role_arn

Returns the ARN of this role.

attribute: :attribute:: true

Return type

str

role_name

Returns the name of this role.

attribute: :attribute:: true

Return type

str

stack

The stack in which this resource is defined.

Return type

Stack