Class CfnUserPoolGroup

Namespace

Amazon.CDK.AWS.Cognito

Assembly

Amazon.CDK.AWS.Cognito.dll

A CloudFormation AWS::Cognito::UserPoolGroup.

public class CfnUserPoolGroup : CfnResource, IInspectable

Inheritance

object

CfnUserPoolGroup

Implements

IInspectable

Examples

// The code below shows an example of how to instantiate this type.
             // The values are placeholders you should change.
             using Amazon.CDK.AWS.Cognito;

             var cfnUserPoolGroup = new CfnUserPoolGroup(this, "MyCfnUserPoolGroup", new CfnUserPoolGroupProps {
                 UserPoolId = "userPoolId",

                 // the properties below are optional
                 Description = "description",
                 GroupName = "groupName",
                 Precedence = 123,
                 RoleArn = "roleArn"
             });

Remarks

Specifies a new group in the identified user pool.

Calling this action requires developer credentials.

If you don't specify a value for a parameter, Amazon Cognito sets it to a default value.

CloudformationResource: AWS::Cognito::UserPoolGroup

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpoolgroup.html

ExampleMetadata: fixture=_generated

Constructors

CfnUserPoolGroup(Construct, string, ICfnUserPoolGroupProps)

Create a new AWS::Cognito::UserPoolGroup.

public CfnUserPoolGroup(Construct scope, string id, ICfnUserPoolGroupProps props)

Parameters

scope Construct

• scope in which this resource is defined.

id string

• scoped id of the resource.

props ICfnUserPoolGroupProps

• resource properties.

Properties

CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

public static string CFN_RESOURCE_TYPE_NAME { get; }

Property Value

string

CfnProperties

protected override IDictionary<string, object> CfnProperties { get; }

Property Value

IDictionary<string, object>

Description

A string containing the description of the group.

public virtual string? Description { get; set; }

Property Value

string

Remarks

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpoolgroup.html#cfn-cognito-userpoolgroup-description

GroupName

The name of the group.

public virtual string? GroupName { get; set; }

Property Value

string

Remarks

Must be unique.

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpoolgroup.html#cfn-cognito-userpoolgroup-groupname

Precedence

A non-negative integer value that specifies the precedence of this group relative to the other groups that a user can belong to in the user pool.

public virtual double? Precedence { get; set; }

Property Value

double?

Remarks

Zero is the highest precedence value. Groups with lower Precedence values take precedence over groups with higher or null Precedence values. If a user belongs to two or more groups, it is the group with the lowest precedence value whose role ARN is given in the user's tokens for the cognito:roles and cognito:preferred_role claims.

Two groups can have the same Precedence value. If this happens, neither group takes precedence over the other. If two groups with the same Precedence have the same role ARN, that role is used in the cognito:preferred_role claim in tokens for users in each group. If the two groups have different role ARNs, the cognito:preferred_role claim isn't set in users' tokens.

The default Precedence value is null. The maximum Precedence value is 2^31-1 .

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpoolgroup.html#cfn-cognito-userpoolgroup-precedence

RoleArn

The role Amazon Resource Name (ARN) for the group.

public virtual string? RoleArn { get; set; }

Property Value

string

Remarks

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpoolgroup.html#cfn-cognito-userpoolgroup-rolearn

UserPoolId

The user pool ID for the user pool.

public virtual string UserPoolId { get; set; }

Property Value

string

Remarks

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpoolgroup.html#cfn-cognito-userpoolgroup-userpoolid

Methods

Inspect(TreeInspector)

Examines the CloudFormation resource and discloses attributes.

public virtual void Inspect(TreeInspector inspector)

Parameters

inspector TreeInspector

• tree inspector to collect and process attributes.

RenderProperties(IDictionary<string, object>)

protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)

Parameters

props IDictionary<string, object>

Returns

IDictionary<string, object>