class CfnUserPoolUser (construct)
Language | Type name |
---|---|
.NET | Amazon.CDK.AWS.Cognito.CfnUserPoolUser |
Go | github.com/aws/aws-cdk-go/awscdk/v2/awscognito#CfnUserPoolUser |
Java | software.amazon.awscdk.services.cognito.CfnUserPoolUser |
Python | aws_cdk.aws_cognito.CfnUserPoolUser |
TypeScript | aws-cdk-lib » aws_cognito » CfnUserPoolUser |
Implements
IConstruct
, IDependable
, IInspectable
The AWS::Cognito::UserPoolUser
resource creates an Amazon Cognito user pool user.
See also: 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_cognito as cognito } from 'aws-cdk-lib';
const cfnUserPoolUser = new cognito.CfnUserPoolUser(this, 'MyCfnUserPoolUser', {
userPoolId: 'userPoolId',
// the properties below are optional
clientMetadata: {
clientMetadataKey: 'clientMetadata',
},
desiredDeliveryMediums: ['desiredDeliveryMediums'],
forceAliasCreation: false,
messageAction: 'messageAction',
userAttributes: [{
name: 'name',
value: 'value',
}],
username: 'username',
validationData: [{
name: 'name',
value: 'value',
}],
});
Initializer
new CfnUserPoolUser(scope: Construct, id: string, props: CfnUserPoolUserProps)
Parameters
- scope
Construct
— Scope in which this resource is defined. - id
string
— Construct identifier for this resource (unique in its scope). - props
Cfn
— Resource properties.User Pool User Props
Construct Props
Name | Type | Description |
---|---|---|
user | string | The user pool ID for the user pool where the user will be created. |
client | IResolvable | { [string]: string } | A map of custom key-value pairs that you can provide as input for any custom workflows that this action triggers. |
desired | string[] | Specify "EMAIL" if email will be used to send the welcome message. |
force | boolean | IResolvable | This parameter is used only if the phone_number_verified or email_verified attribute is set to True . |
message | string | Set to RESEND to resend the invitation message to a user that already exists and reset the expiration limit on the user's account. |
user | IResolvable | IResolvable | Attribute [] | An array of name-value pairs that contain user attributes and attribute values. |
username? | string | The value that you want to set as the username sign-in attribute. |
validation | IResolvable | IResolvable | Attribute [] | Temporary user attributes that contribute to the outcomes of your pre sign-up Lambda trigger. |
userPoolId
Type:
string
The user pool ID for the user pool where the user will be created.
clientMetadata?
Type:
IResolvable
| { [string]: string }
(optional)
A map of custom key-value pairs that you can provide as input for any custom workflows that this action triggers.
You create custom workflows by assigning AWS Lambda functions to user pool triggers. When you use the AdminCreateUser API action, 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 a clientMetadata
attribute, which provides the data that you assigned to the ClientMetadata parameter in your AdminCreateUser request. In your function code in AWS Lambda , you can process the clientMetadata
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 .
When you use the ClientMetadata parameter, remember that Amazon Cognito won't do the following:
- 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 doesn't include triggers, the ClientMetadata parameter serves no purpose.
- Validate the ClientMetadata value.
- Encrypt the ClientMetadata value. Don't use Amazon Cognito to provide sensitive information.
desiredDeliveryMediums?
Type:
string[]
(optional)
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.
forceAliasCreation?
Type:
boolean |
IResolvable
(optional)
This parameter is used only if the phone_number_verified
or email_verified
attribute is set to True
.
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 an AliasExistsException
error if the alias already exists. The default value is False
.
messageAction?
Type:
string
(optional)
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.
userAttributes?
Type:
IResolvable
|
IResolvable
|
Attribute
[]
(optional)
An array of name-value pairs that contain user attributes and attribute values.
username?
Type:
string
(optional)
The value that you want to set as the username sign-in attribute.
The following conditions apply to the username parameter.
- The username can't be a duplicate of another username in the same user pool.
- You can't change the value of a username after you create it.
- You can only provide a value if usernames are a valid sign-in attribute for your user pool. If your user pool only supports phone numbers or email addresses as sign-in attributes, Amazon Cognito automatically generates a username value. For more information, see Customizing sign-in attributes .
validationData?
Type:
IResolvable
|
IResolvable
|
Attribute
[]
(optional)
Temporary user attributes that contribute to the outcomes of your pre sign-up Lambda trigger.
This set of key-value pairs are for custom validation of information that you collect from your users but don't need to retain.
Your Lambda function can analyze this additional data and act on it. Your function might perform external API operations like logging user attributes and validation data to Amazon CloudWatch Logs. Validation data might also affect the response that your function returns to Amazon Cognito, like automatically confirming the user if they sign up from within your network.
For more information about the pre sign-up Lambda trigger, see Pre sign-up Lambda trigger .
Properties
Name | Type | Description |
---|---|---|
cfn | ICfn | Options for this resource, such as condition, update policy etc. |
cfn | { [string]: any } | |
cfn | string | AWS resource type. |
creation | string[] | |
logical | string | The logical ID for this CloudFormation stack element. |
node | Node | The tree node. |
ref | string | Return a string that will be resolved to a CloudFormation { Ref } for this element. |
stack | Stack | The stack in which this element is defined. |
user | string | The user pool ID for the user pool where the user will be created. |
client | IResolvable | { [string]: string } | A map of custom key-value pairs that you can provide as input for any custom workflows that this action triggers. |
desired | string[] | Specify "EMAIL" if email will be used to send the welcome message. |
force | boolean | IResolvable | This parameter is used only if the phone_number_verified or email_verified attribute is set to True . |
message | string | Set to RESEND to resend the invitation message to a user that already exists and reset the expiration limit on the user's account. |
user | IResolvable | IResolvable | Attribute [] | An array of name-value pairs that contain user attributes and attribute values. |
username? | string | The value that you want to set as the username sign-in attribute. |
validation | IResolvable | IResolvable | Attribute [] | Temporary user attributes that contribute to the outcomes of your pre sign-up Lambda trigger. |
static CFN_RESOURCE_TYPE_NAME | string | The CloudFormation resource type name for this resource class. |
cfnOptions
Type:
ICfn
Options for this resource, such as condition, update policy etc.
cfnProperties
Type:
{ [string]: any }
cfnResourceType
Type:
string
AWS resource type.
creationStack
Type:
string[]
logicalId
Type:
string
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)
.
node
Type:
Node
The tree node.
ref
Type:
string
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
Type:
Stack
The stack in which this element is defined.
CfnElements must be defined within a stack scope (directly or indirectly).
userPoolId
Type:
string
The user pool ID for the user pool where the user will be created.
clientMetadata?
Type:
IResolvable
| { [string]: string }
(optional)
A map of custom key-value pairs that you can provide as input for any custom workflows that this action triggers.
desiredDeliveryMediums?
Type:
string[]
(optional)
Specify "EMAIL"
if email will be used to send the welcome message.
forceAliasCreation?
Type:
boolean |
IResolvable
(optional)
This parameter is used only if the phone_number_verified
or email_verified
attribute is set to True
.
messageAction?
Type:
string
(optional)
Set to RESEND
to resend the invitation message to a user that already exists and reset the expiration limit on the user's account.
userAttributes?
Type:
IResolvable
|
IResolvable
|
Attribute
[]
(optional)
An array of name-value pairs that contain user attributes and attribute values.
username?
Type:
string
(optional)
The value that you want to set as the username sign-in attribute.
validationData?
Type:
IResolvable
|
IResolvable
|
Attribute
[]
(optional)
Temporary user attributes that contribute to the outcomes of your pre sign-up Lambda trigger.
static CFN_RESOURCE_TYPE_NAME
Type:
string
The CloudFormation resource type name for this resource class.
Methods
Name | Description |
---|---|
add | Syntactic sugar for addOverride(path, undefined) . |
add | Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. |
add | Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. |
add | Add a value to the CloudFormation Resource Metadata. |
add | Adds an override to the synthesized CloudFormation resource. |
add | Adds an override that deletes the value of a property from the resource definition. |
add | Adds an override to a resource property. |
apply | Sets the deletion policy of the resource based on the removal policy specified. |
get | Returns a token for an runtime attribute of this resource. |
get | Retrieve a value value from the CloudFormation Resource Metadata. |
inspect(inspector) | Examines the CloudFormation resource and discloses attributes. |
obtain | Retrieves an array of resources this resource depends on. |
obtain | Get a shallow copy of dependencies between this resource and other resources in the same stack. |
override | Overrides the auto-generated logical ID with a specific ID. |
remove | Indicates that this resource no longer depends on another resource. |
replace | Replaces one dependency with another. |
to | Returns a string representation of this construct. |
protected render |
DeletionOverride(path)
addpublic addDeletionOverride(path: string): void
Parameters
- path
string
— The path of the value to delete.
Syntactic sugar for addOverride(path, undefined)
.
Dependency(target)
addpublic addDependency(target: CfnResource): void
Parameters
- target
Cfn
Resource
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.
DependsOn(target)
addpublic addDependsOn(target: CfnResource): void
⚠️ Deprecated: use addDependency
Parameters
- target
Cfn
Resource
Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
Metadata(key, value)
addpublic addMetadata(key: string, value: any): void
Parameters
- key
string
- value
any
Add a value to the CloudFormation Resource Metadata.
See also: [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.](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.)
Override(path, value)
addpublic addOverride(path: string, value: any): void
Parameters
- path
string
— - The path of the property, you can use dot notation to override values in complex types. - value
any
— - The value.
Adds an override to the synthesized CloudFormation resource.
To add a
property override, either use addPropertyOverride
or prefix path
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,
cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']);
cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE');
would add the overrides
"Properties": {
"GlobalSecondaryIndexes": [
{
"Projection": {
"NonKeyAttributes": [ "myattribute" ]
...
}
...
},
{
"ProjectionType": "INCLUDE"
...
},
]
...
}
The value
argument to addOverride
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.
PropertyDeletionOverride(propertyPath)
addpublic addPropertyDeletionOverride(propertyPath: string): void
Parameters
- propertyPath
string
— The path to the property.
Adds an override that deletes the value of a property from the resource definition.
PropertyOverride(propertyPath, value)
addpublic addPropertyOverride(propertyPath: string, value: any): void
Parameters
- propertyPath
string
— The path of the property. - value
any
— The value.
Adds an override to a resource property.
Syntactic sugar for addOverride("Properties.<...>", value)
.
RemovalPolicy(policy?, options?)
applypublic applyRemovalPolicy(policy?: RemovalPolicy, options?: RemovalPolicyOptions): void
Parameters
- policy
Removal
Policy - options
Removal
Policy Options
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
). In some
cases, a snapshot can be taken of the resource prior to deletion
(RemovalPolicy.SNAPSHOT
). A list of resources that support this policy
can be found in the following link:
Att(attributeName, typeHint?)
getpublic getAtt(attributeName: string, typeHint?: ResolutionTypeHint): Reference
Parameters
- attributeName
string
— The name of the attribute. - typeHint
Resolution
Type Hint
Returns
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.
Metadata(key)
getpublic getMetadata(key: string): any
Parameters
- key
string
Returns
any
Retrieve a value value from the CloudFormation Resource Metadata.
See also: [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.](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)
public inspect(inspector: TreeInspector): void
Parameters
- inspector
Tree
— tree inspector to collect and process attributes.Inspector
Examines the CloudFormation resource and discloses attributes.
Dependencies()
obtainpublic obtainDependencies(): Stack | CfnResource[]
Returns
Stack
|
Cfn
Resource []
Retrieves an array of resources this resource depends on.
This assembles dependencies on resources across stacks (including nested stacks) automatically.
ResourceDependencies()
obtainpublic obtainResourceDependencies(): CfnResource[]
Returns
Get a shallow copy of dependencies between this resource and other resources in the same stack.
LogicalId(newLogicalId)
overridepublic overrideLogicalId(newLogicalId: string): void
Parameters
- newLogicalId
string
— The new logical ID to use for this stack element.
Overrides the auto-generated logical ID with a specific ID.
Dependency(target)
removepublic removeDependency(target: CfnResource): void
Parameters
- target
Cfn
Resource
Indicates that this resource no longer depends on another resource.
This can be used for resources across stacks (including nested stacks) and the dependency will automatically be removed from the relevant scope.
Dependency(target, newTarget)
replacepublic replaceDependency(target: CfnResource, newTarget: CfnResource): void
Parameters
- target
Cfn
— The dependency to replace.Resource - newTarget
Cfn
— The new dependency to add.Resource
Replaces one dependency with another.
String()
topublic toString(): string
Returns
string
Returns a string representation of this construct.
Properties(props)
protected renderprotected renderProperties(props: { [string]: any }): { [string]: any }
Parameters
- props
{ [string]: any }
Returns
{ [string]: any }