1. Packages
  2. AWS Cloud Control
  3. API Docs
  4. cognito
  5. UserPoolUserToGroupAttachment

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.27.0 published on Monday, Apr 14, 2025 by Pulumi

aws-native.cognito.UserPoolUserToGroupAttachment

Explore with Pulumi AI

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.27.0 published on Monday, Apr 14, 2025 by Pulumi

Resource Type definition for AWS::Cognito::UserPoolUserToGroupAttachment

Create UserPoolUserToGroupAttachment Resource

Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

Constructor syntax

new UserPoolUserToGroupAttachment(name: string, args: UserPoolUserToGroupAttachmentArgs, opts?: CustomResourceOptions);
@overload
def UserPoolUserToGroupAttachment(resource_name: str,
                                  args: UserPoolUserToGroupAttachmentArgs,
                                  opts: Optional[ResourceOptions] = None)

@overload
def UserPoolUserToGroupAttachment(resource_name: str,
                                  opts: Optional[ResourceOptions] = None,
                                  group_name: Optional[str] = None,
                                  user_pool_id: Optional[str] = None,
                                  username: Optional[str] = None)
func NewUserPoolUserToGroupAttachment(ctx *Context, name string, args UserPoolUserToGroupAttachmentArgs, opts ...ResourceOption) (*UserPoolUserToGroupAttachment, error)
public UserPoolUserToGroupAttachment(string name, UserPoolUserToGroupAttachmentArgs args, CustomResourceOptions? opts = null)
public UserPoolUserToGroupAttachment(String name, UserPoolUserToGroupAttachmentArgs args)
public UserPoolUserToGroupAttachment(String name, UserPoolUserToGroupAttachmentArgs args, CustomResourceOptions options)
type: aws-native:cognito:UserPoolUserToGroupAttachment
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. UserPoolUserToGroupAttachmentArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. UserPoolUserToGroupAttachmentArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args This property is required. UserPoolUserToGroupAttachmentArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. UserPoolUserToGroupAttachmentArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. UserPoolUserToGroupAttachmentArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

UserPoolUserToGroupAttachment Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

The UserPoolUserToGroupAttachment resource accepts the following input properties:

GroupName This property is required. string
The name of the group that you want to add your user to.
UserPoolId This property is required. string
The ID of the user pool that contains the group that you want to add the user to.
Username This property is required. string
The user's username.
GroupName This property is required. string
The name of the group that you want to add your user to.
UserPoolId This property is required. string
The ID of the user pool that contains the group that you want to add the user to.
Username This property is required. string
The user's username.
groupName This property is required. String
The name of the group that you want to add your user to.
userPoolId This property is required. String
The ID of the user pool that contains the group that you want to add the user to.
username This property is required. String
The user's username.
groupName This property is required. string
The name of the group that you want to add your user to.
userPoolId This property is required. string
The ID of the user pool that contains the group that you want to add the user to.
username This property is required. string
The user's username.
group_name This property is required. str
The name of the group that you want to add your user to.
user_pool_id This property is required. str
The ID of the user pool that contains the group that you want to add the user to.
username This property is required. str
The user's username.
groupName This property is required. String
The name of the group that you want to add your user to.
userPoolId This property is required. String
The ID of the user pool that contains the group that you want to add the user to.
username This property is required. String
The user's username.

Outputs

All input properties are implicitly available as output properties. Additionally, the UserPoolUserToGroupAttachment resource produces the following output properties:

Id string
The provider-assigned unique ID for this managed resource.
Id string
The provider-assigned unique ID for this managed resource.
id String
The provider-assigned unique ID for this managed resource.
id string
The provider-assigned unique ID for this managed resource.
id str
The provider-assigned unique ID for this managed resource.
id String
The provider-assigned unique ID for this managed resource.

Package Details

Repository
AWS Native pulumi/pulumi-aws-native
License
Apache-2.0

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.27.0 published on Monday, Apr 14, 2025 by Pulumi