Class CfnUserPoolUserToGroupAttachment

All Implemented Interfaces:
IConstruct, IDependable, IInspectable,, software.constructs.IConstruct

@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)", date="2023-06-19T16:30:44.005Z") @Stability(Stable) public class CfnUserPoolUserToGroupAttachment extends CfnResource implements IInspectable
A CloudFormation AWS::Cognito::UserPoolUserToGroupAttachment.

Adds the specified user to the specified group.

Calling this action requires developer credentials.


 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 CfnUserPoolUserToGroupAttachment cfnUserPoolUserToGroupAttachment = CfnUserPoolUserToGroupAttachment.Builder.create(this, "MyCfnUserPoolUserToGroupAttachment")
  • Field Details


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

    • CfnUserPoolUserToGroupAttachment

      protected CfnUserPoolUserToGroupAttachment( objRef)
    • CfnUserPoolUserToGroupAttachment

      protected CfnUserPoolUserToGroupAttachment( initializationMode)
    • CfnUserPoolUserToGroupAttachment

      @Stability(Stable) public CfnUserPoolUserToGroupAttachment(@NotNull Construct scope, @NotNull String id, @NotNull CfnUserPoolUserToGroupAttachmentProps props)
      Create a new AWS::Cognito::UserPoolUserToGroupAttachment.

      scope -
      • scope in which this resource is defined.
      This parameter is required.
      id -
      • scoped id of the resource.
      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
      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)
      renderProperties in class CfnResource
      props - This parameter is required.
    • getCfnProperties

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

      @Stability(Stable) @NotNull public String getGroupName()
      The group name.
    • setGroupName

      @Stability(Stable) public void setGroupName(@NotNull String value)
      The group name.
    • getUsername

      @Stability(Stable) @NotNull public String getUsername()
      The username for the user.
    • setUsername

      @Stability(Stable) public void setUsername(@NotNull String value)
      The username for the user.
    • getUserPoolId

      @Stability(Stable) @NotNull public String getUserPoolId()
      The user pool ID for the user pool.
    • setUserPoolId

      @Stability(Stable) public void setUserPoolId(@NotNull String value)
      The user pool ID for the user pool.