UserInGroup class
Adds the specified user to the specified group.
Example Usage
import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";
const example = new aws.cognito.UserPool("example", {
passwordPolicy: {
temporaryPasswordValidityDays: 7,
minimumLength: 6,
requireUppercase: false,
requireSymbols: false,
requireNumbers: false,
},
name: "example",
});
const exampleUser = new aws.cognito.User("example", {
userPoolId: example.id,
username: "example",
});
const exampleUserGroup = new aws.cognito.UserGroup("example", {
userPoolId: example.id,
name: "example",
});
const exampleUserInGroup = new aws.cognito.UserInGroup("example", {
userPoolId: example.id,
groupName: exampleUserGroup.name,
username: exampleUser.username,
});
import pulumi
import pulumi_aws as aws
example = aws.cognito.UserPool("example",
password_policy={
"temporary_password_validity_days": 7,
"minimum_length": 6,
"require_uppercase": False,
"require_symbols": False,
"require_numbers": False,
},
name="example")
example_user = aws.cognito.User("example",
user_pool_id=example.id,
username="example")
example_user_group = aws.cognito.UserGroup("example",
user_pool_id=example.id,
name="example")
example_user_in_group = aws.cognito.UserInGroup("example",
user_pool_id=example.id,
group_name=example_user_group.name,
username=example_user.username)
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;
return await Deployment.RunAsync(() =>
{
var example = new Aws.Cognito.UserPool("example", new()
{
PasswordPolicy = new Aws.Cognito.Inputs.UserPoolPasswordPolicyArgs
{
TemporaryPasswordValidityDays = 7,
MinimumLength = 6,
RequireUppercase = false,
RequireSymbols = false,
RequireNumbers = false,
},
Name = "example",
});
var exampleUser = new Aws.Cognito.User("example", new()
{
UserPoolId = example.Id,
Username = "example",
});
var exampleUserGroup = new Aws.Cognito.UserGroup("example", new()
{
UserPoolId = example.Id,
Name = "example",
});
var exampleUserInGroup = new Aws.Cognito.UserInGroup("example", new()
{
UserPoolId = example.Id,
GroupName = exampleUserGroup.Name,
Username = exampleUser.Username,
});
});
package main
import (
"github.com/pulumi/pulumi-aws/sdk/v7/go/aws/cognito"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
example, err := cognito.NewUserPool(ctx, "example", &cognito.UserPoolArgs{
PasswordPolicy: &cognito.UserPoolPasswordPolicyArgs{
TemporaryPasswordValidityDays: pulumi.Int(7),
MinimumLength: pulumi.Int(6),
RequireUppercase: pulumi.Bool(false),
RequireSymbols: pulumi.Bool(false),
RequireNumbers: pulumi.Bool(false),
},
Name: pulumi.String("example"),
})
if err != nil {
return err
}
exampleUser, err := cognito.NewUser(ctx, "example", &cognito.UserArgs{
UserPoolId: example.ID().ToIDOutput().ToStringOutput(),
Username: pulumi.String("example"),
})
if err != nil {
return err
}
exampleUserGroup, err := cognito.NewUserGroup(ctx, "example", &cognito.UserGroupArgs{
UserPoolId: example.ID().ToIDOutput().ToStringOutput(),
Name: pulumi.String("example"),
})
if err != nil {
return err
}
_, err = cognito.NewUserInGroup(ctx, "example", &cognito.UserInGroupArgs{
UserPoolId: example.ID().ToIDOutput().ToStringOutput(),
GroupName: exampleUserGroup.Name,
Username: exampleUser.Username,
})
if err != nil {
return err
}
return nil
})
}
pulumi {
required_providers {
aws = {
source = "pulumi/aws"
}
}
}
resource "aws_cognito_userpool" "example" {
password_policy = {
temporary_password_validity_days = 7
minimum_length = 6
require_uppercase = false
require_symbols = false
require_numbers = false
}
name = "example"
}
resource "aws_cognito_user" "example" {
user_pool_id = aws_cognito_userpool.example.id
username = "example"
}
resource "aws_cognito_usergroup" "example" {
user_pool_id = aws_cognito_userpool.example.id
name = "example"
}
resource "aws_cognito_useringroup" "example" {
user_pool_id = aws_cognito_userpool.example.id
group_name = aws_cognito_usergroup.example.name
username = aws_cognito_user.example.username
}
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.cognito.UserPool;
import com.pulumi.aws.cognito.UserPoolArgs;
import com.pulumi.aws.cognito.inputs.UserPoolPasswordPolicyArgs;
import com.pulumi.aws.cognito.User;
import com.pulumi.aws.cognito.UserArgs;
import com.pulumi.aws.cognito.UserGroup;
import com.pulumi.aws.cognito.UserGroupArgs;
import com.pulumi.aws.cognito.UserInGroup;
import com.pulumi.aws.cognito.UserInGroupArgs;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
public static void main(String[] args) {
Pulumi.run(App::stack);
}
public static void stack(Context ctx) {
var example = new UserPool("example", UserPoolArgs.builder()
.passwordPolicy(UserPoolPasswordPolicyArgs.builder()
.temporaryPasswordValidityDays(7)
.minimumLength(6)
.requireUppercase(false)
.requireSymbols(false)
.requireNumbers(false)
.build())
.name("example")
.build());
var exampleUser = new User("exampleUser", UserArgs.builder()
.userPoolId(example.id())
.username("example")
.build());
var exampleUserGroup = new UserGroup("exampleUserGroup", UserGroupArgs.builder()
.userPoolId(example.id())
.name("example")
.build());
var exampleUserInGroup = new UserInGroup("exampleUserInGroup", UserInGroupArgs.builder()
.userPoolId(example.id())
.groupName(exampleUserGroup.name())
.username(exampleUser.username())
.build());
}
}
resources:
example:
type: aws:cognito:UserPool
properties:
passwordPolicy:
temporaryPasswordValidityDays: 7
minimumLength: 6
requireUppercase: false
requireSymbols: false
requireNumbers: false
name: example
exampleUser:
type: aws:cognito:User
name: example
properties:
userPoolId: ${example.id}
username: example
exampleUserGroup:
type: aws:cognito:UserGroup
name: example
properties:
userPoolId: ${example.id}
name: example
exampleUserInGroup:
type: aws:cognito:UserInGroup
name: example
properties:
userPoolId: ${example.id}
groupName: ${exampleUserGroup.name}
username: ${exampleUser.username}
Import
Using pulumi import, import a Cognito Group User using a comma-delimited string concatenating the userPoolId, groupName, and username arguments. For example:
$ pulumi import aws:cognito/userInGroup:UserInGroup example us-east-1_vG78M4goG,example-group,example-user
Constructors
- UserInGroup(String name, {UserInGroupArgs? args, CustomResourceOptions? options})
-
Creates a new UserInGroup.
nameThe Pulumi resource name.argsArguments used to configure this UserInGroup. The set of arguments for UserInGroup.optionsResource options controlling this resource's behavior. - UserInGroup.reference(String urn)
- Creates a typed reference to an existing UserInGroup resource.
Properties
-
childResources
→ Set<
Resource> -
finalinherited
-
completionSources
↔ Map<
String, IOutputCompletionSource> -
latefinalinherited
-
groupName
↔ Output<
String> -
The name of the group to which the user is to be added.
latefinal
- hashCode → int
-
The hash code for this object.
no setterinherited
-
id
↔ Output<
String> -
getter/setter pairinherited
- isCustom → bool
-
Returns whether this resource is provider-managed.
no setterinherited
- isProtected → bool
-
Returns whether this resource is protected from deletion.
no setterinherited
- isRemote → bool
-
Whether this resource is registered as remote.
no setterinherited
- isResourceReference → bool
-
Whether this instance represents a resource value returned over RPC.
finalinherited
-
region
↔ Output<
String> -
Region where this resource will be managed. Defaults to the Region set in the provider configuration.
latefinal
-
resourceTransforms
→ List<
ResourceTransform> -
Inherited/explicit async transforms.
no setterinherited
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
-
transformations
→ List<
ResourceTransformation> -
Inherited/explicit legacy transformations.
no setterinherited
-
urn
↔ Output<
String> -
latefinalinherited
-
username
↔ Output<
String> -
The username of the user to be added to the group.
latefinal
-
userPoolId
↔ Output<
String> -
The user pool ID of the user and group.
latefinal
Methods
-
failId(
Object error) → void -
Completes this resource ID with an error when registration fails.
inherited
-
failOutputs(
Object error) → void -
Completes all output properties with
error.inherited -
failUrn(
Object error) → void -
Completes this resource URN with an error when registration fails.
inherited
-
getProvider(
String moduleMember) → ProviderResource? -
Returns provider for
moduleMember's package, if configured.inherited -
getResourceName(
) → String -
Returns this resource's logical name.
inherited
-
getResourceType(
) → String -
Returns this resource's Pulumi type token.
inherited
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
registerOutput<
T> (String propertyName, {Object? decoder(Object?)?, bool isSecret = false}) → Output< T> -
Registers a dynamic output property for this resource.
inherited
-
resolveId(
String? value, {required bool isKnown}) → void -
Resolves the provider-assigned ID for this resource.
inherited
-
resolveOutputs(
Struct outputs) → void -
Resolves all output properties from a monitor response payload.
inherited
-
resolveUrn(
String value) → void -
Resolves this resource's URN once assigned by the engine.
inherited
-
serializeProperties(
Map< String, dynamic> properties) → Future<Struct> -
Serializes resource properties for RPC transmission.
inherited
-
toString(
) → String -
A string representation of this object.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited
Static Methods
-
get(
String name, Input< String> id, {UserInGroupState? state, CustomResourceOptions? options}) → UserInGroup -
Gets an existing UserInGroup resource's state with the given
nameandid.