Class UserPoolGroup

Define a user pool group.

Inheritance

object

Resource

UserPoolGroup

Implements

IUserPoolGroup

IResource

IConstruct

IDependable

IEnvironmentAware

Inherited Members

Resource.IsOwnedResource(IConstruct)

Resource.IsResource(IConstruct)

Resource.ApplyRemovalPolicy(RemovalPolicy)

Resource.GeneratePhysicalName()

Resource.GetResourceArnAttribute(string, IArnComponents)

Resource.GetResourceNameAttribute(string)

Resource.Env

Resource.PhysicalName

Resource.Stack

Namespace: Amazon.CDK.AWS.Cognito

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public class UserPoolGroup : Resource, IUserPoolGroup, IResource, IConstruct, IDependable, IEnvironmentAware

Syntax (vb)

Public Class UserPoolGroup Inherits Resource Implements IUserPoolGroup, IResource, IConstruct, IDependable, IEnvironmentAware

Remarks

ExampleMetadata: infused

Examples

UserPool userPool;
            Role role;


            new UserPoolGroup(this, "UserPoolGroup", new UserPoolGroupProps {
                UserPool = userPool,
                GroupName = "my-group-name",
                Precedence = 1,
                Role = role
            });

            // You can also add a group by using addGroup method.
            userPool.AddGroup("AnotherUserPoolGroup", new UserPoolGroupOptions {
                GroupName = "another-group-name"
            });

Synopsis

Constructors

UserPoolGroup(Construct, string, IUserPoolGroupProps)

Define a user pool group.

Properties

GroupName	The user group name.
PROPERTY_INJECTION_ID	Uniquely identifies this class.

Methods

FromGroupName(Construct, string, string)

Import a UserPoolGroup given its group name.

Constructors

UserPoolGroup(Construct, string, IUserPoolGroupProps)

Define a user pool group.

public UserPoolGroup(Construct scope, string id, IUserPoolGroupProps props)

Parameters

scope Construct

id string

props IUserPoolGroupProps

Remarks

ExampleMetadata: infused

Examples

UserPool userPool;
            Role role;


            new UserPoolGroup(this, "UserPoolGroup", new UserPoolGroupProps {
                UserPool = userPool,
                GroupName = "my-group-name",
                Precedence = 1,
                Role = role
            });

            // You can also add a group by using addGroup method.
            userPool.AddGroup("AnotherUserPoolGroup", new UserPoolGroupOptions {
                GroupName = "another-group-name"
            });

Properties

GroupName

The user group name.

public virtual string GroupName { get; }

Property Value

string

Remarks

ExampleMetadata: infused

PROPERTY_INJECTION_ID

Uniquely identifies this class.

public static string PROPERTY_INJECTION_ID { get; }

Property Value

string

Remarks

ExampleMetadata: infused

Methods

FromGroupName(Construct, string, string)

Import a UserPoolGroup given its group name.

public static IUserPoolGroup FromGroupName(Construct scope, string id, string groupName)

Parameters

scope Construct

id string

groupName string

Returns

IUserPoolGroup

Remarks

ExampleMetadata: infused

Implements

IUserPoolGroup

IResource

Constructs.IConstruct

Constructs.IDependable

IEnvironmentAware