Role¶

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

Bases: aws_cdk.core.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.

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_id (Optional[str]) – (deprecated) ID that the role assumer needs to provide when assuming this role. If the configured and provided external IDs do not match, the AssumeRole operation will fail. Default: No external ID required
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)¶

Apply the given removal policy to this resource.

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.DELETE), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN).

Parameters

policy (RemovalPolicy) –

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_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.

Return type: str

assume_role_policy¶

The assume role policy document associated with this role.

Return type: Optional[PolicyDocument]

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.

Return type: ResourceEnvironment

grant_principal¶

The principal to grant permissions to.

Return type: IPrincipal

node¶

The construct tree node associated with this construct.

Return type: ConstructNode

permissions_boundary¶

Returns the permissions boundary attached to this role.

Return type: Optional[IManagedPolicy]

policy_fragment¶

Returns the role.

Return type: PrincipalPolicyFragment

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.

Return type: Optional[str]

role_arn¶

Returns the ARN of this role.

Return type: str

role_id¶

Returns the stable and unique string identifying the role.

For example, AIDAJQABLZS4A3QDU576Q.

Attribute: true
Return type: str

role_name¶

Returns the name of the role.

Return type: str

stack¶

The stack in which this resource is defined.

Return type: Stack

Static Methods

classmethod from_role_arn(scope, id, role_arn, *, add_grants_to_resources=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
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)¶

Return whether the given object is a Construct.

Parameters

x (Any) –

Return type

bool

classmethod is_resource(construct)¶

Check whether the given construct is a Resource.

Parameters

construct (IConstruct) –

Return type

bool