CfnUserPoolUserProps

class aws_cdk.aws_cognito.CfnUserPoolUserProps(*, client_metadata=None, desired_delivery_mediums=None, force_alias_creation=None, message_action=None, user_attributes=None, username=None, user_pool_id, validation_data=None)

Bases: object

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

Parameters
  • client_metadata (Optional[Any]) – AWS::Cognito::UserPoolUser.ClientMetadata.

  • desired_delivery_mediums (Optional[Sequence[str]]) – AWS::Cognito::UserPoolUser.DesiredDeliveryMediums.

  • force_alias_creation (Union[bool, IResolvable, None]) – AWS::Cognito::UserPoolUser.ForceAliasCreation.

  • message_action (Optional[str]) – AWS::Cognito::UserPoolUser.MessageAction.

  • user_attributes (Union[IResolvable, Sequence[Union[IResolvable, AttributeTypeProperty]], None]) – AWS::Cognito::UserPoolUser.UserAttributes.

  • username (Optional[str]) – AWS::Cognito::UserPoolUser.Username.

  • user_pool_id (str) – AWS::Cognito::UserPoolUser.UserPoolId.

  • validation_data (Union[IResolvable, Sequence[Union[IResolvable, AttributeTypeProperty]], None]) – AWS::Cognito::UserPoolUser.ValidationData.

Link

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

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
import aws_cdk.aws_cognito as cognito

# client_metadata is of type object

cfn_user_pool_user_props = cognito.CfnUserPoolUserProps(
    user_pool_id="userPoolId",

    # the properties below are optional
    client_metadata=client_metadata,
    desired_delivery_mediums=["desiredDeliveryMediums"],
    force_alias_creation=False,
    message_action="messageAction",
    user_attributes=[cognito.CfnUserPoolUser.AttributeTypeProperty(
        name="name",
        value="value"
    )],
    username="username",
    validation_data=[cognito.CfnUserPoolUser.AttributeTypeProperty(
        name="name",
        value="value"
    )]
)

Attributes

client_metadata

AWS::Cognito::UserPoolUser.ClientMetadata.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpooluser.html#cfn-cognito-userpooluser-clientmetadata

Return type

Any

desired_delivery_mediums

AWS::Cognito::UserPoolUser.DesiredDeliveryMediums.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpooluser.html#cfn-cognito-userpooluser-desireddeliverymediums

Return type

Optional[List[str]]

force_alias_creation

AWS::Cognito::UserPoolUser.ForceAliasCreation.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpooluser.html#cfn-cognito-userpooluser-forcealiascreation

Return type

Union[bool, IResolvable, None]

message_action

AWS::Cognito::UserPoolUser.MessageAction.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpooluser.html#cfn-cognito-userpooluser-messageaction

Return type

Optional[str]

user_attributes

AWS::Cognito::UserPoolUser.UserAttributes.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpooluser.html#cfn-cognito-userpooluser-userattributes

Return type

Union[IResolvable, List[Union[IResolvable, AttributeTypeProperty]], None]

user_pool_id

AWS::Cognito::UserPoolUser.UserPoolId.

Link

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

Return type

str

username

AWS::Cognito::UserPoolUser.Username.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpooluser.html#cfn-cognito-userpooluser-username

Return type

Optional[str]

validation_data

AWS::Cognito::UserPoolUser.ValidationData.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpooluser.html#cfn-cognito-userpooluser-validationdata

Return type

Union[IResolvable, List[Union[IResolvable, AttributeTypeProperty]], None]