Role

class aws_cdk.aws_iam.Role(scope, id, *, assumed_by, description=None, external_ids=None, inline_policies=None, managed_policies=None, max_session_duration=None, path=None, permissions_boundary=None, role_name=None)

Bases: Resource

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.

ExampleMetadata:: infused

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.
# cluster: eks.Cluster


console_read_only_role = iam.Role(self, "ConsoleReadOnlyRole",
    assumed_by=iam.ArnPrincipal("arn_for_trusted_principal")
)
console_read_only_role.add_to_policy(iam.PolicyStatement(
    actions=["eks:AccessKubernetesApi", "eks:Describe*", "eks:List*"
    ],
    resources=[cluster.cluster_arn]
))

# Add this role to system:masters RBAC group
cluster.aws_auth.add_masters_role(console_read_only_role)

Parameters:

scope (Construct) –
id (str) –
assumed_by (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 (Optional[str]) – A description of the role. It can be up to 1000 characters long. Default: - No description.
external_ids (Optional[Sequence[str]]) – 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. Default: No external ID required
inline_policies (Optional[Mapping[str, PolicyDocument]]) – 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). Default: - No policy is inlined in the Role resource.
managed_policies (Optional[Sequence[IManagedPolicy]]) – A list of managed policies associated with this role. You can add managed policies later using addManagedPolicy(ManagedPolicy.fromAwsManagedPolicyName(policyName)). Default: - No managed policies.
max_session_duration (Optional[Duration]) – 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. Default: Duration.hours(1)
path (Optional[str]) – The path associated with this role. For information about IAM paths, see Friendly Names and Paths in IAM User Guide. Default: /
permissions_boundary (Optional[IManagedPolicy]) – 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. Default: - No permissions boundary.
role_name (Optional[str]) – 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. Default: - AWS CloudFormation generates a unique physical ID and uses that ID for the role name.

Methods

add_managed_policy(policy)

Attaches a managed policy to this role.

Parameters:: policy (IManagedPolicy) – The the managed policy to attach.
Return type:: None

add_to_policy(statement)

Add to the policy of this principal.

Parameters:

statement (PolicyStatement) –

Return type:

bool

add_to_principal_policy(statement)

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

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

Parameters:: statement (PolicyStatement) – The permission statement to add to the policy document.
Return type:: AddToPrincipalPolicyResult

apply_removal_policy(policy)

Skip applyRemovalPolicy if role synthesis is prevented by customizeRoles.

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

Parameters:: policy (RemovalPolicy) – RemovalPolicy.
Override:: true
Return type:: None

attach_inline_policy(policy)

Attaches a policy to this role.

Parameters:: policy (Policy) – The policy to attach.
Return type:: None

grant(grantee, *actions)

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

Parameters:

grantee (IPrincipal) –
actions (str) –

Return type:

Grant

grant_assume_role(identity)

Grant permissions to the given principal to assume this role.

Parameters:

identity (IPrincipal) –

Return type:

Grant

grant_pass_role(identity)

Grant permissions to the given principal to pass this role.

Parameters:

identity (IPrincipal) –

Return type:

Grant

to_string()

Returns a string representation of this construct.

Return type:: str

without_policy_updates(*, add_grants_to_resources=None)

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.

Parameters:: add_grants_to_resources (Optional[bool]) – 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. Default: false
Return type:: IRole

Attributes

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

assume_role_policy: The assume role policy document associated with this role.

env

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.

grant_principal: The principal to grant permissions to.

node: The tree node.

permissions_boundary: Returns the permissions boundary attached to this role.

policy_fragment: Returns the role.

principal_account

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.

role_arn: Returns the ARN of this role.

role_id

Returns the stable and unique string identifying the role.

For example, AIDAJQABLZS4A3QDU576Q.

Attribute:: true

role_name: Returns the name of the role.

stack: The stack in which this resource is defined.

Static Methods

classmethod customize_roles(scope, *, prevent_synthesis=None, use_precreated_roles=None)

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.

Parameters:

scope (Construct) – construct scope to customize role creation.
prevent_synthesis (Optional[bool]) – Whether or not to synthesize the resource into the CFN template. Set this to false if you still want to create the resources and you also want to create the policy report. Default: true
use_precreated_roles (Optional[Mapping[str, str]]) – A list of precreated IAM roles to substitute for roles that CDK is creating. The constructPath can be either a relative or absolute path from the scope that customizeRoles is used on to the role being created. Default: - there are no precreated roles. Synthesis will fail if preventSynthesis=true

Return type:

None

Example:

# app: App

iam.Role.customize_roles(app,
    use_precreated_roles={
        "ConstructPath/To/Role": "my-precreated-role-name"
    }
)

classmethod from_role_arn(scope, id, role_arn, *, add_grants_to_resources=None, default_policy_name=None, mutable=None)

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.

Parameters:

scope (Construct) – construct scope.
id (str) – construct id.
role_arn (str) – the ARN of the role to import.
add_grants_to_resources (Optional[bool]) – 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. Default: false
default_policy_name (Optional[str]) – 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. Default: ‘Policy’
mutable (Optional[bool]) – Whether the imported role can be modified by attaching policy resources to it. Default: true

Return type:

IRole

classmethod from_role_name(scope, id, role_name, *, add_grants_to_resources=None, default_policy_name=None, mutable=None)

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.

Parameters:

scope (Construct) – construct scope.
id (str) – construct id.
role_name (str) – the name of the role to import.
add_grants_to_resources (Optional[bool]) – 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. Default: false
default_policy_name (Optional[str]) – 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. Default: ‘Policy’
mutable (Optional[bool]) – Whether the imported role can be modified by attaching policy resources to it. Default: true

Return type:

IRole

classmethod is_construct(x)

Checks if x is a construct.

Use this method instead of instanceof to properly detect Construct instances, even when the construct library is symlinked.

Explanation: in JavaScript, multiple copies of the constructs library on disk are seen as independent, completely different libraries. As a consequence, the class Construct in each copy of the constructs library is seen as a different class, and an instance of one class will not test as instanceof the other class. npm install will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the constructs library can be accidentally installed, and instanceof will behave unpredictably. It is safest to avoid using instanceof, and using this type-testing method instead.

Parameters:: x (Any) – Any object.
Return type:: bool
Returns:: true if x is an object created from a class which extends Construct.

classmethod is_owned_resource(construct)

Returns true if the construct was created by CDK, and false otherwise.

Parameters:

construct (IConstruct) –

Return type:

bool

classmethod is_resource(construct)

Check whether the given construct is a Resource.

Parameters:

construct (IConstruct) –

Return type:

bool

classmethod is_role(x)

Return whether the given object is a Role.

Parameters:

x (Any) –

Return type:

bool