software.amazon.awscdk.services.iam

Class Group

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.Resource

software.amazon.awscdk.services.iam.Group

All Implemented Interfaces:

IResource, IGrantable, IGroup, IIdentity, IPrincipal, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.29.0 (build 41df200)",
           date="2021-06-02T09:55:31.403Z")
 @Stability(value=Experimental)
public class Group
extends Resource
implements IGroup

(experimental) An IAM Group (collection of IAM users) lets you specify permissions for multiple users, which can make it easier to manage permissions for those users.

See Also:

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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Group.Builder (experimental) A fluent builder for Group.

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.amazon.awscdk.services.iam.IGroup

IGroup.Jsii$Default, IGroup.Jsii$Proxy

Constructor Summary

Constructors

Modifier	Constructor and Description
	Group(software.constructs.Construct scope, String id)
	Group(software.constructs.Construct scope, String id, GroupProps props)
protected	Group(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	Group(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
void	addManagedPolicy(IManagedPolicy policy) (experimental) Attaches a managed policy to this group.
Boolean	addToPolicy(PolicyStatement statement) (experimental) Add to the policy of this principal.
AddToPrincipalPolicyResult	addToPrincipalPolicy(PolicyStatement statement) (experimental) Adds an IAM statement to the default policy.
void	addUser(IUser user) (experimental) Adds a user to this group.
void	attachInlinePolicy(Policy policy) (experimental) Attaches a policy to this group.
static IGroup	fromGroupArn(software.constructs.Construct scope, String id, String groupArn) (experimental) Import an external group by ARN.
String	getAssumeRoleAction() (experimental) When this Principal is used in an AssumeRole policy, the action to use.
IPrincipal	getGrantPrincipal() (experimental) The principal to grant permissions to.
String	getGroupArn() (experimental) Returns the IAM Group ARN.
String	getGroupName() (experimental) Returns the IAM Group Name.
PrincipalPolicyFragment	getPolicyFragment() (experimental) Return the policy fragment that identifies this principal in a Policy.
String	getPrincipalAccount() (experimental) The AWS account ID of this principal.

Methods inherited from class software.amazon.awscdk.Resource

applyRemovalPolicy, generatePhysicalName, getEnv, getPhysicalName, getResourceArnAttribute, getResourceNameAttribute, getStack, isResource

Methods inherited from class software.constructs.Construct

getNode, isConstruct, toString

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awscdk.IResource

getEnv, getStack

Methods inherited from interface software.constructs.IConstruct

getNode

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Constructor Detail

Group

protected Group(software.amazon.jsii.JsiiObjectRef objRef)

Group

protected Group(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

Group

@Stability(value=Experimental)
public Group(@NotNull
                                            software.constructs.Construct scope,
                                            @NotNull
                                            String id,
                                            @Nullable
                                            GroupProps props)

Parameters:

scope - This parameter is required.

id - This parameter is required.

props -

Group

@Stability(value=Experimental)
public Group(@NotNull
                                            software.constructs.Construct scope,
                                            @NotNull
                                            String id)

Parameters:

scope - This parameter is required.

id - This parameter is required.

Method Detail

fromGroupArn

@Stability(value=Experimental)
 @NotNull
public static IGroup fromGroupArn(@NotNull
                                                                           software.constructs.Construct scope,
                                                                           @NotNull
                                                                           String id,
                                                                           @NotNull
                                                                           String groupArn)

(experimental) Import an external group by ARN.

If the imported Group ARN is a Token (such as a CfnParameter.valueAsString or a Fn.importValue()) and the referenced group has a path (like arn:...:group/AdminGroup/NetworkAdmin), the groupName 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 Group ARN should be supplied without the path in order to resolve the correct group resource.

Parameters:

scope - construct scope. This parameter is required.

id - construct id. This parameter is required.

groupArn - the ARN of the group to import (e.g. `arn:aws:iam::account-id:group/group-name`). This parameter is required.

addManagedPolicy

@Stability(value=Experimental)
public void addManagedPolicy(@NotNull
                                                            IManagedPolicy policy)

(experimental) Attaches a managed policy to this group.

Specified by:

addManagedPolicy in interface IIdentity

Parameters:

policy - The managed policy to attach. This parameter is required.

addToPolicy

@Stability(value=Experimental)
 @NotNull
public Boolean addToPolicy(@NotNull
                                                                    PolicyStatement statement)

(experimental) Add to the policy of this principal.

Parameters:

statement - This parameter is required.

addToPrincipalPolicy

@Stability(value=Experimental)
 @NotNull
public AddToPrincipalPolicyResult addToPrincipalPolicy(@NotNull
                                                                                                PolicyStatement statement)

(experimental) Adds an IAM statement to the default policy.

Specified by:

addToPrincipalPolicy in interface IPrincipal

Parameters:

statement - This parameter is required.

addUser

@Stability(value=Experimental)
public void addUser(@NotNull
                                                   IUser user)

(experimental) Adds a user to this group.

Parameters:

user - This parameter is required.

attachInlinePolicy

@Stability(value=Experimental)
public void attachInlinePolicy(@NotNull
                                                              Policy policy)

(experimental) Attaches a policy to this group.

Specified by:

attachInlinePolicy in interface IIdentity

Parameters:

policy - The policy to attach. This parameter is required.

getAssumeRoleAction

@Stability(value=Experimental)
 @NotNull
public String getAssumeRoleAction()

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

Specified by:

getAssumeRoleAction in interface IPrincipal

getGrantPrincipal

@Stability(value=Experimental)
 @NotNull
public IPrincipal getGrantPrincipal()

(experimental) The principal to grant permissions to.

Specified by:

getGrantPrincipal in interface IGrantable

getGroupArn

@Stability(value=Experimental)
 @NotNull
public String getGroupArn()

(experimental) Returns the IAM Group ARN.

Specified by:

getGroupArn in interface IGroup

getGroupName

@Stability(value=Experimental)
 @NotNull
public String getGroupName()

(experimental) Returns the IAM Group Name.

Specified by:

getGroupName in interface IGroup

getPolicyFragment

@Stability(value=Experimental)
 @NotNull
public PrincipalPolicyFragment getPolicyFragment()

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

Specified by:

getPolicyFragment in interface IPrincipal

getPrincipalAccount

@Stability(value=Experimental)
 @Nullable
public String getPrincipalAccount()

(experimental) 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.

Specified by:

getPrincipalAccount in interface IPrincipal