class Role (construct)

Language	Type name
.NET	`Amazon.CDK.AWS.IAM.Role`
Go	`github.com/aws/aws-cdk-go/awscdk/v2/awsiam#Role`
Java	`software.amazon.awscdk.services.iam.Role`
Python	`aws_cdk.aws_iam.Role`
TypeScript (source)	`aws-cdk-lib` » `aws_iam` » `Role`

Implements IConstruct, IDependable, IResource, IRole, IGrantable, IPrincipal, IIdentity

IAM Role.

Defines an IAM role. The role is created with an assume policy document associated with the specified AWS service principal defined in serviceAssumeRole.

Example

// Option 3: Create a new role that allows the account root principal to assume. Add this role in the `system:masters` and witch to this role from the AWS console.
declare const cluster: eks.Cluster;

const consoleReadOnlyRole = new iam.Role(this, 'ConsoleReadOnlyRole', {
  assumedBy: new iam.ArnPrincipal('arn_for_trusted_principal'),
});
consoleReadOnlyRole.addToPolicy(new iam.PolicyStatement({
  actions: [
    'eks:AccessKubernetesApi',
    'eks:Describe*',
    'eks:List*',
],
  resources: [ cluster.clusterArn ],
}));

// Add this role to system:masters RBAC group
cluster.awsAuth.addMastersRole(consoleReadOnlyRole)

Initializer

new Role(scope: Construct, id: string, props: RoleProps)

Parameters

scope Construct
id string
props RoleProps

Construct Props

Name	Type	Description
assumedBy	`IPrincipal`	The IAM principal (i.e. `new ServicePrincipal('sns.amazonaws.com')`) which can assume this role.
description?	`string`	A description of the role.
externalIds?	`string[]`	List of IDs that the role assumer needs to provide one of when assuming this role.
inlinePolicies?	`{ [string]:` `PolicyDocument` `}`	A list of named policies to inline into this role.
managedPolicies?	`IManagedPolicy[]`	A list of managed policies associated with this role.
maxSessionDuration?	`Duration`	The maximum session duration that you want to set for the specified role.
path?	`string`	The path associated with this role.
permissionsBoundary?	`IManagedPolicy`	AWS supports permissions boundaries for IAM entities (users or roles).
roleName?	`string`	A name for the IAM role.

assumedBy

Type: IPrincipal

The IAM principal (i.e. new ServicePrincipal('sns.amazonaws.com')) which can assume this role.

You can later modify the assume role policy document by accessing it via the assumeRolePolicy property.

description?

Type: string (optional, default: No description.)

A description of the role.

It can be up to 1000 characters long.

externalIds?

Type: string[] (optional, default: No external ID required)

List of IDs that the role assumer needs to provide one of when assuming this role.

If the configured and provided external IDs do not match, the AssumeRole operation will fail.

inlinePolicies?

Type: { [string]: PolicyDocument } (optional, default: No policy is inlined in the Role resource.)

A list of named policies to inline into this role.

These policies will be created with the role, whereas those added by addToPolicy are added using a separate CloudFormation resource (allowing a way around circular dependencies that could otherwise be introduced).

managedPolicies?

Type: IManagedPolicy[] (optional, default: No managed policies.)

A list of managed policies associated with this role.

You can add managed policies later using addManagedPolicy(ManagedPolicy.fromAwsManagedPolicyName(policyName)).

maxSessionDuration?

Type: Duration (optional, default: Duration.hours(1))

The maximum session duration that you want to set for the specified role.

This setting can have a value from 1 hour (3600sec) to 12 (43200sec) hours.

Anyone who assumes the role from the AWS CLI or API can use the DurationSeconds API parameter or the duration-seconds CLI parameter to request a longer session. The MaxSessionDuration setting determines the maximum duration that can be requested using the DurationSeconds parameter.

If users don't specify a value for the DurationSeconds parameter, their security credentials are valid for one hour by default. This applies when you use the AssumeRole* API operations or the assume-role* CLI operations but does not apply when you use those operations to create a console URL.

path?

Type: string (optional, default: /)

The path associated with this role.

For information about IAM paths, see Friendly Names and Paths in IAM User Guide.

permissionsBoundary?

Type: IManagedPolicy (optional, default: No permissions boundary.)

AWS supports permissions boundaries for IAM entities (users or roles).

A permissions boundary is an advanced feature for using a managed policy to set the maximum permissions that an identity-based policy can grant to an IAM entity. An entity's permissions boundary allows it to perform only the actions that are allowed by both its identity-based policies and its permissions boundaries.

roleName?

Type: string (optional, default: AWS CloudFormation generates a unique physical ID and uses that ID for the role name.)

A name for the IAM role.

For valid values, see the RoleName parameter for the CreateRole action in the IAM API Reference.

IMPORTANT: If you specify a name, you cannot perform updates that require replacement of this resource. You can perform updates that require no or some interruption. If you must replace the resource, specify a new name.

If you specify a name, you must specify the CAPABILITY_NAMED_IAM value to acknowledge your template's capabilities. For more information, see Acknowledging IAM Resources in AWS CloudFormation Templates.

Properties

Name	Type	Description
assumeRoleAction	`string`	When this Principal is used in an AssumeRole policy, the action to use.
env	`ResourceEnvironment`	The environment this resource belongs to.
grantPrincipal	`IPrincipal`	The principal to grant permissions to.
node	`Node`	The tree node.
policyFragment	`PrincipalPolicyFragment`	Returns the role.
roleArn	`string`	Returns the ARN of this role.
roleId	`string`	Returns the stable and unique string identifying the role.
roleName	`string`	Returns the name of the role.
stack	`Stack`	The stack in which this resource is defined.
assumeRolePolicy?	`PolicyDocument`	The assume role policy document associated with this role.
permissionsBoundary?	`IManagedPolicy`	Returns the permissions boundary attached to this role.
principalAccount?	`string`	The AWS account ID of this principal.

assumeRoleAction

Type: string

When this Principal is used in an AssumeRole policy, the action to use.

env

Type: ResourceEnvironment

The environment this resource belongs to.

For resources that are created and managed by the CDK (generally, those created by creating new class instances like Role, Bucket, etc.), this is always the same as the environment of the stack they belong to; however, for imported resources (those obtained from static methods like fromRoleArn, fromBucketName, etc.), that might be different than the stack they were imported into.

grantPrincipal

Type: IPrincipal

The principal to grant permissions to.

node

Type: Node

The tree node.

policyFragment

Type: PrincipalPolicyFragment

Returns the role.

roleArn

Type: string

Returns the ARN of this role.

roleId

Type: string

Returns the stable and unique string identifying the role.

For example, AIDAJQABLZS4A3QDU576Q.

roleName

Type: string

Returns the name of the role.

stack

Type: Stack

The stack in which this resource is defined.

assumeRolePolicy?

Type: PolicyDocument (optional)

The assume role policy document associated with this role.

permissionsBoundary?

Type: IManagedPolicy (optional)

Returns the permissions boundary attached to this role.

principalAccount?

Type: string (optional)

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.

Methods

Name	Description
addManagedPolicy(policy)	Attaches a managed policy to this role.
addToPolicy(statement)	Add to the policy of this principal.
addToPrincipalPolicy(statement)	Adds a permission to the role's default policy document.
applyRemovalPolicy(policy)	Skip applyRemovalPolicy if role synthesis is prevented by customizeRoles.
attachInlinePolicy(policy)	Attaches a policy to this role.
grant(grantee, ...actions)	Grant the actions defined in actions to the identity Principal on this resource.
grantAssumeRole(identity)	Grant permissions to the given principal to assume this role.
grantPassRole(identity)	Grant permissions to the given principal to pass this role.
toString()	Returns a string representation of this construct.
withoutPolicyUpdates(options?)	Return a copy of this Role object whose Policies will not be updated.
static customizeRoles(scope, options?)	Customize the creation of IAM roles within the given scope.
static fromRoleArn(scope, id, roleArn, options?)	Import an external role by ARN.
static fromRoleName(scope, id, roleName, options?)	Import an external role by name.
static isRole(x)	Return whether the given object is a Role.

addManagedPolicy(policy)

public addManagedPolicy(policy: IManagedPolicy): void

Parameters

policy IManagedPolicy — The the managed policy to attach.

Attaches a managed policy to this role.

addToPolicy(statement)

public addToPolicy(statement: PolicyStatement): boolean

Parameters

statement PolicyStatement

Returns

boolean

Add to the policy of this principal.

addToPrincipalPolicy(statement)

public addToPrincipalPolicy(statement: PolicyStatement): AddToPrincipalPolicyResult

Parameters

statement PolicyStatement — The permission statement to add to the policy document.

Returns

AddToPrincipalPolicyResult

Adds a permission to the role's default policy document.

If there is no default policy attached to this role, it will be created.

applyRemovalPolicy(policy)

public applyRemovalPolicy(policy: RemovalPolicy): void

Parameters

policy RemovalPolicy — RemovalPolicy.

Skip applyRemovalPolicy if role synthesis is prevented by customizeRoles.

Because in this case, this construct does not have a CfnResource in the tree.

attachInlinePolicy(policy)

public attachInlinePolicy(policy: Policy): void

Parameters

policy Policy — The policy to attach.

Attaches a policy to this role.

grant(grantee, ...actions)

public grant(grantee: IPrincipal, ...actions: string[]): Grant

Parameters

grantee IPrincipal
actions string

Returns

Grant

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

grantAssumeRole(identity)

public grantAssumeRole(identity: IPrincipal): Grant

Parameters

identity IPrincipal

Returns

Grant

Grant permissions to the given principal to assume this role.

grantPassRole(identity)

public grantPassRole(identity: IPrincipal): Grant

Parameters

identity IPrincipal

Returns

Grant

Grant permissions to the given principal to pass this role.

toString()

public toString(): string

Returns

string

Returns a string representation of this construct.

withoutPolicyUpdates(options?)

public withoutPolicyUpdates(options?: WithoutPolicyUpdatesOptions): IRole

Parameters

options WithoutPolicyUpdatesOptions

Returns

IRole

Return a copy of this Role object whose Policies will not be updated.

Use the object returned by this method if you want this Role to be used by a construct without it automatically updating the Role's Policies.

If you do, you are responsible for adding the correct statements to the Role's policies yourself.

static customizeRoles(scope, options?)

public static customizeRoles(scope: Construct, options?: CustomizeRolesOptions): void

Parameters

scope Construct — construct scope to customize role creation.
options CustomizeRolesOptions — options for configuring role creation.

Customize the creation of IAM roles within the given scope.

It is recommended that you do not use this method and instead allow CDK to manage role creation. This should only be used in environments where CDK applications are not allowed to created IAM roles.

This can be used to prevent the CDK application from creating roles within the given scope and instead replace the references to the roles with precreated role names. A report will be synthesized in the cloud assembly (i.e. cdk.out) that will contain the list of IAM roles that would have been created along with the IAM policy statements that the role should contain. This report can then be used to create the IAM roles outside of CDK and then the created role names can be provided in usePrecreatedRoles. Example

declare const app: App;
iam.Role.customizeRoles(app, {
  usePrecreatedRoles: {
    'ConstructPath/To/Role': 'my-precreated-role-name',
  },
});

static fromRoleArn(scope, id, roleArn, options?)

public static fromRoleArn(scope: Construct, id: string, roleArn: string, options?: FromRoleArnOptions): IRole

Parameters

scope Construct — construct scope.
id string — construct id.
roleArn string — the ARN of the role to import.
options FromRoleArnOptions — allow customizing the behavior of the returned role.

Returns

IRole

Import an external role by ARN.

If the imported Role ARN is a Token (such as a CfnParameter.valueAsString or a Fn.importValue()) and the referenced role has a path (like arn:...:role/AdminRoles/Alice), the roleName property will not resolve to the correct value. Instead it will resolve to the first path component. We unfortunately cannot express the correct calculation of the full path name as a CloudFormation expression. In this scenario the Role ARN should be supplied without the path in order to resolve the correct role resource.

static fromRoleName(scope, id, roleName, options?)

public static fromRoleName(scope: Construct, id: string, roleName: string, options?: FromRoleNameOptions): IRole

Parameters

scope Construct — construct scope.
id string — construct id.
roleName string — the name of the role to import.
options FromRoleNameOptions — allow customizing the behavior of the returned role.

Returns

IRole

Import an external role by name.

The imported role is assumed to exist in the same account as the account the scope's containing Stack is being deployed to.

static isRole(x)

public static isRole(x: any): boolean

Parameters

x any

Returns

boolean

Return whether the given object is a Role.