IGroup¶

class aws_cdk.aws_iam.IGroup(*args, **kwds)¶

Bases: aws_cdk.aws_iam.IIdentity, typing_extensions.Protocol

Represents an IAM Group.

See: https://docs.aws.amazon.com/IAM/latest/UserGuide/id_groups.html

Methods

add_managed_policy(policy)¶

Attaches a managed policy to this principal.

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

add_to_policy(statement)¶

(deprecated) Add to the policy of this principal.

Parameters

statement (PolicyStatement) –

Return type

bool

Returns

true if the statement was added, false if the principal in question does not have a policy document to add the statement to.

Deprecated: Use addToPrincipalPolicy instead.
Stability: deprecated

add_to_principal_policy(statement)¶

Add to the policy of this principal.

Parameters

statement (PolicyStatement) –

Return type

AddToPrincipalPolicyResult

attach_inline_policy(policy)¶

Attaches an inline policy to this principal.

This is the same as calling policy.addToXxx(principal).

Parameters: policy (Policy) – The policy resource to attach to this principal [disable-awslint:ref-via-interface].
Return type: None

Attributes

assume_role_action¶

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

Return type: str

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

group_arn¶

Returns the IAM Group ARN.

Attribute: true
Return type: str

group_name¶

Returns the IAM Group Name.

Attribute: true
Return type: str

node¶

The construct tree node for this construct.

Return type: ConstructNode

policy_fragment¶

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

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]

stack¶

The stack in which this resource is defined.

Return type: Stack