AWS CDK Reference

Appearance

v2.273.0

IRole Interface ​

A Role object.

Source
aws-iam/lib/role.ts
Type last changed
v2.224.0 · 13 Nov 2025

Properties ​

assumeRoleActionstringassume_role_actionstrassumeRoleActionStringAssumeRoleActionstringAssumeRoleAction*stringrequired#
When this Principal is used in an AssumeRole policy, the action to use.
envResourceEnvironmentenvResourceEnvironmentenvResourceEnvironmentEnvResourceEnvironmentEnvResourceEnvironmentrequired#
The environment this resource belongs to.
notes

For resources that are created and managed in a Stack (those created by creating new class instances like new Role(), new Bucket(), etc.), this is always the same as the environment of the stack they belong to.

For referenced resources (those obtained from referencing methods like Role.fromRoleArn(), Bucket.fromBucketName(), etc.), they might be different than the stack they were imported into.

grantPrincipalIPrincipalgrant_principalIPrincipalgrantPrincipalIPrincipalGrantPrincipalIPrincipalGrantPrincipalIPrincipalrequired#
The principal to grant permissions to.
nodeNodenodeNodenodeNodeNodeNodeNodeNoderequired#
The tree node.
policyFragmentPrincipalPolicyFragmentpolicy_fragmentPrincipalPolicyFragmentpolicyFragmentPrincipalPolicyFragmentPolicyFragmentPrincipalPolicyFragmentPolicyFragmentPrincipalPolicyFragmentrequired#
Return the policy fragment that identifies this principal in a Policy.
principalAccountstringprincipal_accountstrprincipalAccountStringPrincipalAccountstringPrincipalAccount*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.

roleArnstringrole_arnstrroleArnStringRoleArnstringRoleArn*stringrequired#
Returns the ARN of this role.
roleNamestringrole_namestrroleNameStringRoleNamestringRoleName*stringrequired#
Returns the name of this role.
roleRefRoleReferencerole_refRoleReferenceroleRefRoleReferenceRoleRefRoleReferenceRoleRefRoleReferencerequired#
A reference to a Role resource.
stackStackstackStackstackStackStackStackStackStackrequired#
The stack in which this resource is defined.

Methods ​

addManagedPolicy(policy: IManagedPolicy): voiddef add_managed_policy(self, policy: IManagedPolicy) -> Nonepublic void addManagedPolicy(IManagedPolicy policy)public void AddManagedPolicy(IManagedPolicy policy)func AddManagedPolicy(Policy IManagedPolicy)#
Attaches a managed policy to this principal.
1 parameter

Parameters

  • policypolicypolicypolicyPolicy — The managed policy.
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.
applyRemovalPolicy(policy: RemovalPolicy): voiddef apply_removal_policy(self, policy: RemovalPolicy) -> Nonepublic void applyRemovalPolicy(RemovalPolicy policy)public void ApplyRemovalPolicy(RemovalPolicy policy)func ApplyRemovalPolicy(Policy RemovalPolicy)#
Apply the given removal policy to this resource.
notes

The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you've removed it from the CDK application or because you've made a change that requires the resource to be replaced.

The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN).

attachInlinePolicy(policy: Policy): voiddef attach_inline_policy(self, policy: Policy) -> Nonepublic void attachInlinePolicy(Policy policy)public void AttachInlinePolicy(Policy policy)func AttachInlinePolicy(Policy Policy)#
Attaches an inline policy to this principal.

This is the same as calling policy.addToXxx(principal).

1 parameter

Parameters

  • policypolicypolicypolicyPolicy — The policy resource to attach to this principal [disable-awslint:ref-via-interface].
grant(grantee: IPrincipal, ...actions: string[]): Grantdef grant(self, grantee: IPrincipal, actions: str) -> Grantpublic Grant grant(IPrincipal grantee, String actions)public Grant Grant(IPrincipal grantee, string actions)func Grant(Grantee IPrincipal, Actions *string) Grant#
Grant the actions defined in actions to the identity Principal on this resource.
grantAssumeRole(grantee: IPrincipal): Grantdef grant_assume_role(self, grantee: IPrincipal) -> Grantpublic Grant grantAssumeRole(IPrincipal grantee)public Grant GrantAssumeRole(IPrincipal grantee)func GrantAssumeRole(Grantee IPrincipal) Grant#
Grant permissions to the given principal to assume this role.
grantPassRole(grantee: IPrincipal): Grantdef grant_pass_role(self, grantee: IPrincipal) -> Grantpublic Grant grantPassRole(IPrincipal grantee)public Grant GrantPassRole(IPrincipal grantee)func GrantPassRole(Grantee IPrincipal) Grant#
Grant permissions to the given principal to pass this role.
with(...mixins: IMixin[]): IConstructdef with(self, mixins: IMixin) -> IConstructpublic IConstruct with(IMixin mixins)public IConstruct With(IMixin mixins)func With(Mixins IMixin) IConstruct#
Applies one or more mixins to this construct.

Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited.

1 parameter · returns

Parameters

  • mixinsmixinsmixinsmixinsMixins — The mixins to apply.

Returns: This construct for chaining