Package software.amazon.awscdk.services.cognito

Class CfnUserPoolUserToGroupAttachment

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.cognito.CfnUserPoolUserToGroupAttachment
All Implemented Interfaces:
IEnvironmentAware, IInspectable, IUserPoolUserToGroupAttachmentRef, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.118.0 (build 02eec31)", date="2025-11-10T13:40:01.234Z") @Stability(Stable) public class CfnUserPoolUserToGroupAttachment extends CfnResource implements IInspectable, IUserPoolUserToGroupAttachmentRef
Adds a user to a group.

A user who is in a group can present a preferred-role claim to an identity pool, and populates a cognito:groups claim to their access and identity tokens.

Amazon Cognito evaluates AWS Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you must use IAM credentials to authorize requests, and you must grant yourself the corresponding IAM permission in a policy.

Learn more - Signing AWS API Requests

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.cognito.*;
 CfnUserPoolUserToGroupAttachment cfnUserPoolUserToGroupAttachment = CfnUserPoolUserToGroupAttachment.Builder.create(this, "MyCfnUserPoolUserToGroupAttachment")
         .groupName("groupName")
         .username("username")
         .userPoolId("userPoolId")
         .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

    • CfnUserPoolUserToGroupAttachment

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

    • CfnUserPoolUserToGroupAttachment

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

    • CfnUserPoolUserToGroupAttachment

      @Stability(Stable) public CfnUserPoolUserToGroupAttachment(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull CfnUserPoolUserToGroupAttachmentProps props)
      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. This parameter is required.

  • Method Details

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

    • getCfnProperties

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

    • getUserPoolUserToGroupAttachmentRef

      @Stability(Stable) @NotNull public UserPoolUserToGroupAttachmentReference getUserPoolUserToGroupAttachmentRef()
      A reference to a UserPoolUserToGroupAttachment resource.
      Specified by:
      getUserPoolUserToGroupAttachmentRef in interface IUserPoolUserToGroupAttachmentRef

    • getGroupName

      @Stability(Stable) @NotNull public String getGroupName()
      The name of the group that you want to add your user to.

    • setGroupName

      @Stability(Stable) public void setGroupName(@NotNull String value)
      The name of the group that you want to add your user to.

    • getUsername

      @Stability(Stable) @NotNull public String getUsername()
      The user's username.

    • setUsername

      @Stability(Stable) public void setUsername(@NotNull String value)
      The user's username.

    • getUserPoolId

      @Stability(Stable) @NotNull public String getUserPoolId()
      The ID of the user pool that contains the group that you want to add the user to.

    • setUserPoolId

      @Stability(Stable) public void setUserPoolId(@NotNull String value)
      The ID of the user pool that contains the group that you want to add the user to.