# FromRoleNameOptions

Options allowing customizing the behavior of `Role.fromRoleName`.

Extends: FromRoleNameOptions
Extends: FromRoleArnOptions

- Source: [`aws-iam/lib/role.ts`](https://github.com/aws/aws-cdk/blob/v2.275.0/packages/aws-cdk-lib/aws-iam/lib/role.ts#L265)
- Type last changed: v2.29.0 · 23 Jun 2022

## Example

```ts
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_iam as iam } from 'aws-cdk-lib';
const fromRoleNameOptions: iam.FromRoleNameOptions = {
  addGrantsToResources: false,
  defaultPolicyName: 'defaultPolicyName',
  mutable: false,
};
```

## Properties

- `addGrantsToResources`: boolean = false — For immutable roles: add grants to resources instead of dropping them.

  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`: string = 'Policy' — Any policies created by this role will use this value as their ID, if specified.

  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`: boolean = true — Whether the imported role can be modified by attaching policy resources to it.