Package software.amazon.awscdk.services.iam

Class CfnGroup

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.CfnElement
software.amazon.awscdk.CfnRefElement
software.amazon.awscdk.CfnResource
software.amazon.awscdk.services.iam.CfnGroup
All Implemented Interfaces:
IInspectable, IGroupRef, IEnvironmentAware, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.120.0 (build 192dc88)", date="2025-12-12T17:54:14.774Z") @Stability(Stable) public class CfnGroup extends CfnResource implements IInspectable, IGroupRef
Creates a new group.

For information about the number of groups you can create, see Limitations on IAM Entities in the IAM User Guide .

Example: 

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.iam.*;
 Object policyDocument;
 CfnGroup cfnGroup = CfnGroup.Builder.create(this, "MyCfnGroup")
         .groupName("groupName")
         .managedPolicyArns(List.of("managedPolicyArns"))
         .path("path")
         .policies(List.of(PolicyProperty.builder()
                 .policyDocument(policyDocument)
                 .policyName("policyName")
                 .build()))
         .build();

See Also:

  • Field Details

    • CFN_RESOURCE_TYPE_NAME

      @Stability(Stable) public static final String CFN_RESOURCE_TYPE_NAME
      The CloudFormation resource type name for this resource class.

  • Constructor Details

    • CfnGroup

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

    • CfnGroup

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

    • CfnGroup

      @Stability(Stable) public CfnGroup(@NotNull software.constructs.Construct scope, @NotNull String id, @Nullable CfnGroupProps props)
      Create a new AWS::IAM::Group.

      Parameters:
      scope - Scope in which this resource is defined. This parameter is required.
      id - Construct identifier for this resource (unique in its scope). This parameter is required.
      props - Resource properties.

    • CfnGroup

      @Stability(Stable) public CfnGroup(@NotNull software.constructs.Construct scope, @NotNull String id)
      Create a new AWS::IAM::Group.

      Parameters:
      scope - Scope in which this resource is defined. This parameter is required.
      id - Construct identifier for this resource (unique in its scope). This parameter is required.

  • Method Details

    • arnForGroup

      @Stability(Stable) @NotNull public static String arnForGroup(@NotNull IGroupRef resource)
      Parameters:
      resource - This parameter is required.

    • isCfnGroup

      @Stability(Stable) @NotNull public static Boolean isCfnGroup(@NotNull Object x)
      Checks whether the given object is a CfnGroup.

      Parameters:
      x - This parameter is required.

    • inspect

      @Stability(Stable) public void inspect(@NotNull TreeInspector inspector)
      Examines the CloudFormation resource and discloses attributes.

      Specified by:
      inspect in interface IInspectable
      Parameters:
      inspector - tree inspector to collect and process attributes. This parameter is required.

    • renderProperties

      @Stability(Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String,Object> props)
      Overrides:
      renderProperties in class CfnResource
      Parameters:
      props - This parameter is required.

    • getAttrArn

      @Stability(Stable) @NotNull public String getAttrArn()
      Returns the Amazon Resource Name (ARN) for the specified AWS::IAM::Group resource.

      For example: arn:aws:iam::123456789012:group/mystack-mygroup-1DZETITOWEKVO .

    • getCfnProperties

      @Stability(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class CfnResource

    • getGroupRef

      @Stability(Stable) @NotNull public GroupReference getGroupRef()
      A reference to a Group resource.
      Specified by:
      getGroupRef in interface IGroupRef

    • getGroupName

      @Stability(Stable) @Nullable public String getGroupName()
      The name of the group to create.

      Do not include the path in this value.

    • setGroupName

      @Stability(Stable) public void setGroupName(@Nullable String value)
      The name of the group to create.

      Do not include the path in this value.

    • getManagedPolicyArns

      @Stability(Stable) @Nullable public List<String> getManagedPolicyArns()
      The Amazon Resource Name (ARN) of the IAM policy you want to attach.

    • setManagedPolicyArns

      @Stability(Stable) public void setManagedPolicyArns(@Nullable List<String> value)
      The Amazon Resource Name (ARN) of the IAM policy you want to attach.

    • getPath

      @Stability(Stable) @Nullable public String getPath()
      The path to the group.

      For more information about paths, see IAM identifiers in the IAM User Guide .

    • setPath

      @Stability(Stable) public void setPath(@Nullable String value)
      The path to the group.

      For more information about paths, see IAM identifiers in the IAM User Guide .

    • getPolicies

      @Stability(Stable) @Nullable public Object getPolicies()
      Adds or updates an inline policy document that is embedded in the specified IAM group.

      Returns union: either IResolvable or Listinvalid input: '<'either IResolvable or CfnGroup.PolicyProperty>

    • setPolicies

      @Stability(Stable) public void setPolicies(@Nullable IResolvable value)
      Adds or updates an inline policy document that is embedded in the specified IAM group.

    • setPolicies

      @Stability(Stable) public void setPolicies(@Nullable List<Object> value)
      Adds or updates an inline policy document that is embedded in the specified IAM group.