aws-cdk-lib.aws_iam.RoleLookupOptions

RoleLookupOptions Struct

Properties for looking up an existing Role.

RoleLookupOptions

extends

• FromRoleArnOptions

Source

aws-iam/lib/role.ts

Type last changed

v2.192.0 · 25 Apr 2025

Example

const role = iam.Role.fromLookup(this, 'Role', {
  roleName: 'MyExistingRole',
});

Properties

addGrantsToResources?optionalbooleanadd_grants_to_resources?optionalbooladdGrantsToResources?optionalBooleanAddGrantsToResources?optionalboolAddGrantsToResources?optional*bool= false#

For immutable roles: add grants to resources instead of dropping them.

notes

If this is false or not specified, grant permissions added to this role are ignored. It is your own responsibility to make sure the role has the required permissions.

If this is true, any grant permissions will be added to the resource instead.

defaultPolicyName?optionalstringdefault_policy_name?optionalstrdefaultPolicyName?optionalStringDefaultPolicyName?optionalstringDefaultPolicyName?optional*string= 'Policy'#

Any policies created by this role will use this value as their ID, if specified.

notes

Specify this if importing the same role in multiple stacks, and granting it different permissions in at least two stacks. If this is not specified (or if the same name is specified in more than one stack), a CloudFormation issue will result in the policy created in whichever stack is deployed last overwriting the policies created by the others.

mutable?optionalbooleanmutable?optionalboolmutable?optionalBooleanMutable?optionalboolMutable?optional*bool= true#

Whether the imported role can be modified by attaching policy resources to it.

roleNamestringrole_namestrroleNameStringRoleNamestringRoleName*stringrequired#

The name of the role to lookup.

notes

If the role you want to lookup is a service role, you need to specify the role name without the 'service-role' prefix. For example, if the role arn is 'arn:aws:iam::123456789012:role/service-role/ExampleServiceExecutionRole', you need to specify the role name as 'ExampleServiceExecutionRole'.