user resource¶
Source: internal/service/cognitoidp/user_types.go:3
Example usage:
imports: {
aws-cognitoidp: 'github.com/cloudboss/unobin-library-aws//service/cognitoidp'
}
resources: {
example: aws-cognitoidp.user {
# Set input fields here.
}
}
Inputs¶
user-pool-id
string
username
string
attributes
optional(map(string))
client-metadata
optional(map(string))
validation-data
optional(map(string))
desired-delivery-mediums
optional(list(string))
enabled
optional(boolean)
force-alias-creation
optional(boolean)
message-action
optional(string)
temporary-password
optional(string)
password
optional(string)
Input Constraints¶
User pool id rules
user-pool-id must contain at least 1 character.
Rule logic
- Require
@core.length(input.user-pool-id) >= 1
Username rules
username must contain 1 to 128 characters.
Rule logic
- Require
@core.length(input.username) >= 1
&& @core.length(input.username) <= 128
Password rules
password must contain 6 to 256 characters.
Rule logic
- When
input.password != null- Require
@core.length(input.password) >= 6
&& @core.length(input.password) <= 256
Temporary password rules
temporary-password must contain 6 to 256 characters.
Rule logic
- When
input.temporary-password != null- Require
@core.length(input.temporary-password) >= 6
&& @core.length(input.temporary-password) <= 256
Field combinations
password conflicts with temporary-password.
Desired delivery mediums rules
desired-delivery-mediums values must be EMAIL or SMS.
Rule logic
- For each
input.desired-delivery-mediums ?? []- Require
@each.value == 'EMAIL'
|| @each.value == 'SMS'
Message action rules
message-action must be RESEND or SUPPRESS.
Rule logic
- When
input.message-action != null- Require
input.message-action == 'RESEND'
|| input.message-action == 'SUPPRESS'
Outputs¶
attributes
map(string)
creation-date
string
last-modified-date
string
enabled
boolean
mfa-setting-list
list(string)
preferred-mfa-setting
string
status
string
sub
string
user-pool-id
string
username
string