LazyRole

class aws_cdk.aws_iam.LazyRole(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

An IAM role that only gets attached to the construct tree once it gets used, not before.

This construct can be used to simplify logic in other constructs which need to create a role but only if certain configurations occur (such as when AutoScaling is configured). The role can be configured in one place, but if it never gets used it doesn’t get instantiated and will not be synthesized or deployed.

Resource:: AWS::IAM::Role
ExampleMetadata:: fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
import aws_cdk as cdk
from aws_cdk import aws_iam as iam

# managed_policy: iam.ManagedPolicy
# policy_document: iam.PolicyDocument
# principal: iam.IPrincipal

lazy_role = iam.LazyRole(self, "MyLazyRole",
    assumed_by=principal,

    # the properties below are optional
    description="description",
    external_ids=["externalIds"],
    inline_policies={
        "inline_policies_key": policy_document
    },
    managed_policies=[managed_policy],
    max_session_duration=cdk.Duration.minutes(30),
    path="path",
    permissions_boundary=managed_policy,
    role_name="roleName"
)

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 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.DESTROY), 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(identity, *actions)

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

Parameters:

identity (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

Attributes

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

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.

policy_fragment: Return the policy fragment that identifies this principal in a Policy.

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 (i.e. AIDAJQABLZS4A3QDU576Q).

Attribute:: true

role_name: Returns the name of this role.

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

Static Methods

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