CfnUserPoolUserPropsMixin

class aws_cdk.mixins_preview.aws_cognito.mixins.CfnUserPoolUserPropsMixin(props, *, strategy=None)

Bases: Mixin

The AWS::Cognito::UserPoolUser resource creates an Amazon Cognito user pool user.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpooluser.html
CloudformationResource:: AWS::Cognito::UserPoolUser
Mixin:: true
ExampleMetadata:: fixture=_generated

Example:

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

cfn_user_pool_user_props_mixin = cognito_mixins.CfnUserPoolUserPropsMixin(cognito_mixins.CfnUserPoolUserMixinProps(
    client_metadata={
        "client_metadata_key": "clientMetadata"
    },
    desired_delivery_mediums=["desiredDeliveryMediums"],
    force_alias_creation=False,
    message_action="messageAction",
    user_attributes=[cognito_mixins.CfnUserPoolUserPropsMixin.AttributeTypeProperty(
        name="name",
        value="value"
    )],
    username="username",
    user_pool_id="userPoolId",
    validation_data=[cognito_mixins.CfnUserPoolUserPropsMixin.AttributeTypeProperty(
        name="name",
        value="value"
    )]
),
    strategy=mixins.PropertyMergeStrategy.OVERRIDE
)

Create a mixin to apply properties to AWS::Cognito::UserPoolUser.

Parameters:

props (Union[CfnUserPoolUserMixinProps, Dict[str, Any]]) – L1 properties to apply.
strategy (Optional[PropertyMergeStrategy]) – (experimental) Strategy for merging nested properties. Default: - PropertyMergeStrategy.MERGE

Methods

apply_to(construct)

Apply the mixin properties to the construct.

Parameters:: construct (IConstruct)
Return type:: IConstruct

supports(construct)

Check if this mixin supports the given construct.

Parameters:: construct (IConstruct)
Return type:: bool

Attributes

CFN_PROPERTY_KEYS = ['clientMetadata', 'desiredDeliveryMediums', 'forceAliasCreation', 'messageAction', 'userAttributes', 'username', 'userPoolId', 'validationData']

Static Methods

classmethod is_mixin(x)

(experimental) Checks if x is a Mixin.

Parameters:: x (Any) – Any object.
Return type:: bool
Returns:: true if x is an object created from a class which extends Mixin.
Stability:: experimental

AttributeTypeProperty

class CfnUserPoolUserPropsMixin.AttributeTypeProperty(*, name=None, value=None)

Bases: object

The name and value of a user attribute.

Parameters:

name (Optional[str]) – The name of the attribute.
value (Optional[str]) – The value of the attribute.

See:

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

ExampleMetadata:

fixture=_generated

Example:

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

attribute_type_property = cognito_mixins.CfnUserPoolUserPropsMixin.AttributeTypeProperty(
    name="name",
    value="value"
)

Attributes

name

The name of the attribute.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpooluser-attributetype.html#cfn-cognito-userpooluser-attributetype-name

value

The value of the attribute.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpooluser-attributetype.html#cfn-cognito-userpooluser-attributetype-value