CfnUserPoolUser
- class aws_cdk.aws_cognito.CfnUserPoolUser(scope, id, *, user_pool_id, client_metadata=None, desired_delivery_mediums=None, force_alias_creation=None, message_action=None, user_attributes=None, username=None, validation_data=None)
Bases:
CfnResource
A CloudFormation
AWS::Cognito::UserPoolUser
.The
AWS::Cognito::UserPoolUser
resource creates an Amazon Cognito user pool user.- CloudformationResource:
AWS::Cognito::UserPoolUser
- Link:
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpooluser.html
- ExampleMetadata:
fixture=_generated
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: Any cfn_user_pool_user = cognito.CfnUserPoolUser(self, "MyCfnUserPoolUser", 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" )] )
Create a new
AWS::Cognito::UserPoolUser
.- Parameters:
scope (
Construct
) –scope in which this resource is defined.
id (
str
) –scoped id of the resource.
user_pool_id (
str
) – The user pool ID for the user pool where the user will be created.client_metadata (
Optional
[Any
]) – A map of custom key-value pairs that you can provide as input for the custom workflow that is invoked by the pre sign-up trigger. You create custom workflows by assigning AWS Lambda functions to user pool triggers. When you create aUserPoolUser
resource and include theClientMetadata
property, Amazon Cognito invokes the function that is assigned to the pre sign-up trigger. When Amazon Cognito invokes this function, it passes a JSON payload, which the function receives as input. This payload contains aclientMetadata
attribute, which provides the data that you assigned to the ClientMetadata property. In your function code in AWS Lambda , you can process theclientMetadata
value to enhance your workflow for your specific needs. For more information, see Customizing User Pool Workflows with Lambda Triggers in the Amazon Cognito Developer Guide . .. epigraph:: Take the following limitations into consideration when you use the ClientMetadata parameter: - Amazon Cognito does not store the ClientMetadata value. This data is available only to AWS Lambda triggers that are assigned to a user pool to support custom workflows. If your user pool configuration does not include triggers, the ClientMetadata parameter serves no purpose. - Amazon Cognito does not validate the ClientMetadata value. - Amazon Cognito does not encrypt the the ClientMetadata value, so don’t use it to provide sensitive information.desired_delivery_mediums (
Optional
[Sequence
[str
]]) – Specify"EMAIL"
if email will be used to send the welcome message. Specify"SMS"
if the phone number will be used. The default value is"SMS"
. You can specify more than one value.force_alias_creation (
Union
[bool
,IResolvable
,None
]) – This parameter is used only if thephone_number_verified
oremail_verified
attribute is set toTrue
. Otherwise, it is ignored. If this parameter is set toTrue
and the phone number or email address specified in the UserAttributes parameter already exists as an alias with a different user, the API call will migrate the alias from the previous user to the newly created user. The previous user will no longer be able to log in using that alias. If this parameter is set toFalse
, the API throws anAliasExistsException
error if the alias already exists. The default value isFalse
.message_action (
Optional
[str
]) – Set toRESEND
to resend the invitation message to a user that already exists and reset the expiration limit on the user’s account. Set toSUPPRESS
to suppress sending the message. You can specify only one value.user_attributes (
Union
[IResolvable
,Sequence
[Union
[IResolvable
,AttributeTypeProperty
,Dict
[str
,Any
]]],None
]) – The user attributes and attribute values to be set for the user to be created. These are name-value pairs You can create a user without specifying any attributes other thanUsername
. However, any attributes that you specify as required (in ` <https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_CreateUserPool.html>`_ or in the Attributes tab of the console) must be supplied either by you (in your call toAdminCreateUser
) or by the user (when they sign up in response to your welcome message). For custom attributes, you must prepend thecustom:
prefix to the attribute name. To send a message inviting the user to sign up, you must specify the user’s email address or phone number. This can be done in your call to AdminCreateUser or in the Users tab of the Amazon Cognito console for managing your user pools. In your call toAdminCreateUser
, you can set theemail_verified
attribute toTrue
, and you can set thephone_number_verified
attribute toTrue
. (You can also do this by calling ` <https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_AdminUpdateUserAttributes.html>`_ .) - email : The email address of the user to whom the message that contains the code and user name will be sent. Required if theemail_verified
attribute is set toTrue
, or if"EMAIL"
is specified in theDesiredDeliveryMediums
parameter. - phone_number : The phone number of the user to whom the message that contains the code and user name will be sent. Required if thephone_number_verified
attribute is set toTrue
, or if"SMS"
is specified in theDesiredDeliveryMediums
parameter.username (
Optional
[str
]) – The username for the user. Must be unique within the user pool. Must be a UTF-8 string between 1 and 128 characters. After the user is created, the username can’t be changed.validation_data (
Union
[IResolvable
,Sequence
[Union
[IResolvable
,AttributeTypeProperty
,Dict
[str
,Any
]]],None
]) – The user’s validation data. This is an array of name-value pairs that contain user attributes and attribute values that you can use for custom validation, such as restricting the types of user accounts that can be registered. For example, you might choose to allow or disallow user sign-up based on the user’s domain. To configure custom validation, you must create a Pre Sign-up AWS Lambda trigger for the user pool as described in the Amazon Cognito Developer Guide. The Lambda trigger receives the validation data and uses it in the validation process. The user’s validation data isn’t persisted.
Methods
- add_deletion_override(path)
Syntactic sugar for
addOverride(path, undefined)
.- Parameters:
path (
str
) – The path of the value to delete.- Return type:
None
- add_depends_on(target)
Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope.
- Parameters:
target (
CfnResource
)- Return type:
None
- add_metadata(key, value)
Add a value to the CloudFormation Resource Metadata.
- Parameters:
key (
str
)value (
Any
)
- See:
- Return type:
None
https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html
Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.
- add_override(path, value)
Adds an override to the synthesized CloudFormation resource.
To add a property override, either use
addPropertyOverride
or prefixpath
with “Properties.” (i.e.Properties.TopicName
).If the override is nested, separate each nested level using a dot (.) in the path parameter. If there is an array as part of the nesting, specify the index in the path.
To include a literal
.
in the property name, prefix with a\
. In most programming languages you will need to write this as"\\."
because the\
itself will need to be escaped.For example:
cfn_resource.add_override("Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes", ["myattribute"]) cfn_resource.add_override("Properties.GlobalSecondaryIndexes.1.ProjectionType", "INCLUDE")
would add the overrides Example:
"Properties": { "GlobalSecondaryIndexes": [ { "Projection": { "NonKeyAttributes": [ "myattribute" ] ... } ... }, { "ProjectionType": "INCLUDE" ... }, ] ... }
The
value
argument toaddOverride
will not be processed or translated in any way. Pass raw JSON values in here with the correct capitalization for CloudFormation. If you pass CDK classes or structs, they will be rendered with lowercased key names, and CloudFormation will reject the template.- Parameters:
path (
str
) –The path of the property, you can use dot notation to override values in complex types. Any intermdediate keys will be created as needed.
value (
Any
) –The value. Could be primitive or complex.
- Return type:
None
- add_property_deletion_override(property_path)
Adds an override that deletes the value of a property from the resource definition.
- Parameters:
property_path (
str
) – The path to the property.- Return type:
None
- add_property_override(property_path, value)
Adds an override to a resource property.
Syntactic sugar for
addOverride("Properties.<...>", value)
.- Parameters:
property_path (
str
) – The path of the property.value (
Any
) – The value.
- Return type:
None
- apply_removal_policy(policy=None, *, apply_to_update_replace_policy=None, default=None)
Sets the deletion policy of the resource based on the removal policy specified.
The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you’ve removed it from the CDK application or because you’ve made a change that requires the resource to be replaced.
The resource can be deleted (
RemovalPolicy.DESTROY
), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN
).- Parameters:
policy (
Optional
[RemovalPolicy
])apply_to_update_replace_policy (
Optional
[bool
]) – Apply the same deletion policy to the resource’s “UpdateReplacePolicy”. Default: truedefault (
Optional
[RemovalPolicy
]) – The default policy to apply in case the removal policy is not defined. Default: - Default value is resource specific. To determine the default value for a resoure, please consult that specific resource’s documentation.
- Return type:
None
- get_att(attribute_name)
Returns a token for an runtime attribute of this resource.
Ideally, use generated attribute accessors (e.g.
resource.arn
), but this can be used for future compatibility in case there is no generated attribute.- Parameters:
attribute_name (
str
) – The name of the attribute.- Return type:
- get_metadata(key)
Retrieve a value value from the CloudFormation Resource Metadata.
- Parameters:
key (
str
)- See:
- Return type:
Any
https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html
Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.
- inspect(inspector)
Examines the CloudFormation resource and discloses attributes.
- Parameters:
inspector (
TreeInspector
) –tree inspector to collect and process attributes.
- Return type:
None
- override_logical_id(new_logical_id)
Overrides the auto-generated logical ID with a specific ID.
- Parameters:
new_logical_id (
str
) – The new logical ID to use for this stack element.- Return type:
None
- to_string()
Returns a string representation of this construct.
- Return type:
str
- Returns:
a string representation of this resource
Attributes
- CFN_RESOURCE_TYPE_NAME = 'AWS::Cognito::UserPoolUser'
- cfn_options
Options for this resource, such as condition, update policy etc.
- cfn_resource_type
AWS resource type.
- client_metadata
A map of custom key-value pairs that you can provide as input for the custom workflow that is invoked by the pre sign-up trigger.
You create custom workflows by assigning AWS Lambda functions to user pool triggers. When you create a
UserPoolUser
resource and include theClientMetadata
property, Amazon Cognito invokes the function that is assigned to the pre sign-up trigger. When Amazon Cognito invokes this function, it passes a JSON payload, which the function receives as input. This payload contains aclientMetadata
attribute, which provides the data that you assigned to the ClientMetadata property. In your function code in AWS Lambda , you can process theclientMetadata
value to enhance your workflow for your specific needs.For more information, see Customizing User Pool Workflows with Lambda Triggers in the Amazon Cognito Developer Guide . .. epigraph:
Take the following limitations into consideration when you use the ClientMetadata parameter: - Amazon Cognito does not store the ClientMetadata value. This data is available only to AWS Lambda triggers that are assigned to a user pool to support custom workflows. If your user pool configuration does not include triggers, the ClientMetadata parameter serves no purpose. - Amazon Cognito does not validate the ClientMetadata value. - Amazon Cognito does not encrypt the the ClientMetadata value, so don't use it to provide sensitive information.
- creation_stack
return:
the stack trace of the point where this Resource was created from, sourced from the +metadata+ entry typed +aws:cdk:logicalId+, and with the bottom-most node +internal+ entries filtered.
- desired_delivery_mediums
Specify
"EMAIL"
if email will be used to send the welcome message.Specify
"SMS"
if the phone number will be used. The default value is"SMS"
. You can specify more than one value.
- force_alias_creation
This parameter is used only if the
phone_number_verified
oremail_verified
attribute is set toTrue
.Otherwise, it is ignored.
If this parameter is set to
True
and the phone number or email address specified in the UserAttributes parameter already exists as an alias with a different user, the API call will migrate the alias from the previous user to the newly created user. The previous user will no longer be able to log in using that alias.If this parameter is set to
False
, the API throws anAliasExistsException
error if the alias already exists. The default value isFalse
.
- logical_id
The logical ID for this CloudFormation stack element.
The logical ID of the element is calculated from the path of the resource node in the construct tree.
To override this value, use
overrideLogicalId(newLogicalId)
.- Returns:
the logical ID as a stringified token. This value will only get resolved during synthesis.
- message_action
Set to
RESEND
to resend the invitation message to a user that already exists and reset the expiration limit on the user’s account.Set to
SUPPRESS
to suppress sending the message. You can specify only one value.
- node
The construct tree node associated with this construct.
- ref
Return a string that will be resolved to a CloudFormation
{ Ref }
for this element.If, by any chance, the intrinsic reference of a resource is not a string, you could coerce it to an IResolvable through
Lazy.any({ produce: resource.ref })
.
- stack
The stack in which this element is defined.
CfnElements must be defined within a stack scope (directly or indirectly).
- user_attributes
The user attributes and attribute values to be set for the user to be created.
These are name-value pairs You can create a user without specifying any attributes other than
Username
. However, any attributes that you specify as required (in ` <https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_CreateUserPool.html>`_ or in the Attributes tab of the console) must be supplied either by you (in your call toAdminCreateUser
) or by the user (when they sign up in response to your welcome message).For custom attributes, you must prepend the
custom:
prefix to the attribute name.To send a message inviting the user to sign up, you must specify the user’s email address or phone number. This can be done in your call to AdminCreateUser or in the Users tab of the Amazon Cognito console for managing your user pools.
In your call to
AdminCreateUser
, you can set theemail_verified
attribute toTrue
, and you can set thephone_number_verified
attribute toTrue
. (You can also do this by calling ` <https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_AdminUpdateUserAttributes.html>`_ .)email : The email address of the user to whom the message that contains the code and user name will be sent. Required if the
email_verified
attribute is set toTrue
, or if"EMAIL"
is specified in theDesiredDeliveryMediums
parameter.phone_number : The phone number of the user to whom the message that contains the code and user name will be sent. Required if the
phone_number_verified
attribute is set toTrue
, or if"SMS"
is specified in theDesiredDeliveryMediums
parameter.
- user_pool_id
The user pool ID for the user pool where the user will be created.
- username
The username for the user.
Must be unique within the user pool. Must be a UTF-8 string between 1 and 128 characters. After the user is created, the username can’t be changed.
- validation_data
The user’s validation data.
This is an array of name-value pairs that contain user attributes and attribute values that you can use for custom validation, such as restricting the types of user accounts that can be registered. For example, you might choose to allow or disallow user sign-up based on the user’s domain.
To configure custom validation, you must create a Pre Sign-up AWS Lambda trigger for the user pool as described in the Amazon Cognito Developer Guide. The Lambda trigger receives the validation data and uses it in the validation process.
The user’s validation data isn’t persisted.
Static Methods
- classmethod is_cfn_element(x)
Returns
true
if a construct is a stack element (i.e. part of the synthesized cloudformation template).Uses duck-typing instead of
instanceof
to allow stack elements from different versions of this library to be included in the same stack.- Parameters:
x (
Any
)- Return type:
bool
- Returns:
The construct as a stack element or undefined if it is not a stack element.
- classmethod is_cfn_resource(construct)
Check whether the given construct is a CfnResource.
- Parameters:
construct (
IConstruct
)- Return type:
bool
- classmethod is_construct(x)
Return whether the given object is a Construct.
- Parameters:
x (
Any
)- Return type:
bool
AttributeTypeProperty
- class CfnUserPoolUser.AttributeTypeProperty(*, name=None, value=None)
Bases:
object
Specifies whether the attribute is standard or custom.
- Parameters:
name (
Optional
[str
]) – The name of the attribute.value (
Optional
[str
]) – The value of the attribute.
- Link:
- ExampleMetadata:
fixture=_generated
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 attribute_type_property = cognito.CfnUserPoolUser.AttributeTypeProperty( name="name", value="value" )
Attributes
- name
The name of the attribute.