CfnUserPoolGroupProps¶

class aws_cdk.aws_cognito.CfnUserPoolGroupProps(*, user_pool_id, description=None, group_name=None, precedence=None, role_arn=None)¶

Bases: object

Properties for defining a AWS::Cognito::UserPoolGroup.

Parameters

user_pool_id (str) – AWS::Cognito::UserPoolGroup.UserPoolId.
description (Optional[str]) – AWS::Cognito::UserPoolGroup.Description.
group_name (Optional[str]) – AWS::Cognito::UserPoolGroup.GroupName.
precedence (Union[int, float, None]) – AWS::Cognito::UserPoolGroup.Precedence.
role_arn (Optional[str]) – AWS::Cognito::UserPoolGroup.RoleArn.

Link

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

Attributes

description¶

AWS::Cognito::UserPoolGroup.Description.

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpoolgroup.html#cfn-cognito-userpoolgroup-description
Return type: Optional[str]

group_name¶

AWS::Cognito::UserPoolGroup.GroupName.

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpoolgroup.html#cfn-cognito-userpoolgroup-groupname
Return type: Optional[str]

precedence¶

AWS::Cognito::UserPoolGroup.Precedence.

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpoolgroup.html#cfn-cognito-userpoolgroup-precedence
Return type: Union[int, float, None]

role_arn¶

AWS::Cognito::UserPoolGroup.RoleArn.

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpoolgroup.html#cfn-cognito-userpoolgroup-rolearn
Return type: Optional[str]

user_pool_id¶

AWS::Cognito::UserPoolGroup.UserPoolId.

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