Marketplace
BrowsePublish
Marketplace
You are viewing an outdated version of provider-aws.Go to Latest
upbound/provider-aws@v1.1.0
UserPool
cognitoidp.aws.upbound.io
UserPool
upbound/provider-aws@v1.1.0cognitoidp.aws.upbound.io

UserPool is the Schema for the UserPools API. Provides a Cognito User Pool resource.

Type

CRD

Group

cognitoidp.aws.upbound.io

Version

v1beta1

apiVersion: cognitoidp.aws.upbound.io/v1beta1

kind: UserPool

API Documentation
apiVersion
string
kind
string
metadata
object
spec
object
object

UserPoolSpec defines the desired state of UserPool

forProvider
requiredobject
requiredobject

No description provided.

array

Configuration block to define which verified available method a user can use to recover their forgotten password. Detailed below.

array

List of Account Recovery Options of the following structure:

name
string
priority
number
array

Configuration block for creating a new user profile. Detailed below.

array

Invite message template structure. Detailed below.

array

Attributes supported as an alias for this user pool. Valid values: phone_number, email, or preferred_username. Conflicts with username_attributes.

array

Attributes to be auto-verified. Valid values: email, phone_number.

array

Configuration block for the user pool's device tracking. Detailed below.

array

Configuration block for configuring email. Detailed below.

array

Configuration block for the AWS Lambda triggers associated with the user pool. Detailed below.

object

Reference to a Function in lambda to populate createAuthChallenge.

name
requiredstring
policy
object
object

Policies for referencing.

resolve
string
object

Selector for a Function in lambda to populate createAuthChallenge.

policy
object
object

Policies for selection.

resolve
string
array

A custom email sender AWS Lambda trigger. See custom_email_sender Below.

lambdaArn
string
object

Reference to a Function in lambda to populate lambdaArn.

name
requiredstring
policy
object
object

Policies for referencing.

resolve
string
object

Selector for a Function in lambda to populate lambdaArn.

policy
object
object

Policies for selection.

resolve
string
object

Reference to a Function in lambda to populate customMessage.

name
requiredstring
policy
object
object

Policies for referencing.

resolve
string
object

Selector for a Function in lambda to populate customMessage.

policy
object
object

Policies for selection.

resolve
string
array

A custom SMS sender AWS Lambda trigger. See custom_sms_sender Below.

lambdaArn
string
object

Reference to a Function in lambda to populate lambdaArn.

name
requiredstring
policy
object
object

Policies for referencing.

resolve
string
object

Selector for a Function in lambda to populate lambdaArn.

policy
object
object

Policies for selection.

resolve
string
object

Reference to a Function in lambda to populate defineAuthChallenge.

name
requiredstring
policy
object
object

Policies for referencing.

resolve
string
object

Selector for a Function in lambda to populate defineAuthChallenge.

policy
object
object

Policies for selection.

resolve
string
kmsKeyId
string
object

Reference to a Key in kms to populate kmsKeyId.

name
requiredstring
policy
object
object

Policies for referencing.

resolve
string
object

Selector for a Key in kms to populate kmsKeyId.

policy
object
object

Policies for selection.

resolve
string
object

Reference to a Function in lambda to populate postAuthentication.

name
requiredstring
policy
object
object

Policies for referencing.

resolve
string
object

Selector for a Function in lambda to populate postAuthentication.

policy
object
object

Policies for selection.

resolve
string
object

Reference to a Function in lambda to populate postConfirmation.

name
requiredstring
policy
object
object

Policies for referencing.

resolve
string
object

Selector for a Function in lambda to populate postConfirmation.

policy
object
object

Policies for selection.

resolve
string
object

Reference to a Function in lambda to populate preAuthentication.

name
requiredstring
policy
object
object

Policies for referencing.

resolve
string
object

Selector for a Function in lambda to populate preAuthentication.

policy
object
object

Policies for selection.

resolve
string
preSignUp
string
object

Reference to a Function in lambda to populate preSignUp.

name
requiredstring
policy
object
object

Policies for referencing.

resolve
string
object

Selector for a Function in lambda to populate preSignUp.

policy
object
object

Policies for selection.

resolve
string
object

Reference to a Function in lambda to populate preTokenGeneration.

name
requiredstring
policy
object
object

Policies for referencing.

resolve
string
object

Selector for a Function in lambda to populate preTokenGeneration.

policy
object
object

Policies for selection.

resolve
string
object

Reference to a Function in lambda to populate userMigration.

name
requiredstring
policy
object
object

Policies for referencing.

resolve
string
object

Selector for a Function in lambda to populate userMigration.

policy
object
object

Policies for selection.

resolve
string
object

Reference to a Function in lambda to populate verifyAuthChallengeResponse.

name
requiredstring
policy
object
object

Policies for referencing.

resolve
string
object

Selector for a Function in lambda to populate verifyAuthChallengeResponse.

policy
object
object

Policies for selection.

resolve
string
name
string
array

Configuration block for information about the user pool password policy. Detailed below.

region
requiredstring
schema
array
array

Configuration block for the schema attributes of a user pool. Detailed below. Schema attributes from the standard attribute set only need to be specified if they are different from the default configuration. Attributes can be added, but not modified or removed. Maximum of 50 attributes.

mutable
boolean
name
string
array

Configuration block for the constraints for an attribute of the number type. Detailed below.

maxValue
string
minValue
string
required
boolean
array

Constraints for an attribute of the string type. Detailed below.

maxLength
string
minLength
string
array

Configuration block for Short Message Service (SMS) settings. Detailed below. These settings apply to SMS user verification and SMS Multi-Factor Authentication (MFA). Due to Cognito API restrictions, the SMS configuration cannot be removed without recreating the Cognito User Pool. For user data safety, this resource will ignore the removal of this configuration by disabling drift detection. To force resource recreation after this configuration has been applied, see the taint command.

object

Reference to a Role in iam to populate snsCallerArn.

name
requiredstring
policy
object
object

Policies for referencing.

resolve
string
object

Selector for a Role in iam to populate snsCallerArn.

policy
object
object

Policies for selection.

resolve
string
snsRegion
string
array

Configuration block for software token Mult-Factor Authentication (MFA) settings. Detailed below.

enabled
boolean
tags
object
array

Configuration block for user attribute update settings. Detailed below.

array

A list of attributes requiring verification before update. If set, the provided value(s) must also be set in auto_verified_attributes. Valid values: email, phone_number.

array

Configuration block for user pool add-ons to enable user pool advanced security mode features. Detailed below.

array

Whether email addresses or phone numbers can be specified as usernames when a user signs up. Conflicts with alias_attributes.

array

Configuration block for username configuration. Detailed below.

array

Configuration block for verification message templates. Detailed below.

object

THIS IS A BETA FIELD. It will be honored unless the Management Policies feature flag is disabled. InitProvider holds the same fields as ForProvider, with the exception of Identifier and other resource reference fields. The fields that are in InitProvider are merged into ForProvider when the resource is created. The same fields are also added to the terraform ignore_changes hook, to avoid updating them after creation. This is useful for fields that are required on creation, but we do not desire to update them after creation, for example because of an external controller is managing them, like an autoscaler.

array

Configuration block to define which verified available method a user can use to recover their forgotten password. Detailed below.

array

List of Account Recovery Options of the following structure:

name
string
priority
number
array

Configuration block for creating a new user profile. Detailed below.

array

Invite message template structure. Detailed below.

array

Attributes supported as an alias for this user pool. Valid values: phone_number, email, or preferred_username. Conflicts with username_attributes.

array

Attributes to be auto-verified. Valid values: email, phone_number.

array

Configuration block for the user pool's device tracking. Detailed below.

array

Configuration block for configuring email. Detailed below.

array

Configuration block for the AWS Lambda triggers associated with the user pool. Detailed below.

object

Reference to a Function in lambda to populate createAuthChallenge.

name
requiredstring
policy
object
object

Policies for referencing.

resolve
string
object

Selector for a Function in lambda to populate createAuthChallenge.

policy
object
object

Policies for selection.

resolve
string
array

A custom email sender AWS Lambda trigger. See custom_email_sender Below.

lambdaArn
string
object

Reference to a Function in lambda to populate lambdaArn.

name
requiredstring
policy
object
object

Policies for referencing.

resolve
string
object

Selector for a Function in lambda to populate lambdaArn.

policy
object
object

Policies for selection.

resolve
string
object

Reference to a Function in lambda to populate customMessage.

name
requiredstring
policy
object
object

Policies for referencing.

resolve
string
object

Selector for a Function in lambda to populate customMessage.

policy
object
object

Policies for selection.

resolve
string
array

A custom SMS sender AWS Lambda trigger. See custom_sms_sender Below.

lambdaArn
string
object

Reference to a Function in lambda to populate lambdaArn.

name
requiredstring
policy
object
object

Policies for referencing.

resolve
string
object

Selector for a Function in lambda to populate lambdaArn.

policy
object
object

Policies for selection.

resolve
string
object

Reference to a Function in lambda to populate defineAuthChallenge.

name
requiredstring
policy
object
object

Policies for referencing.

resolve
string
object

Selector for a Function in lambda to populate defineAuthChallenge.

policy
object
object

Policies for selection.

resolve
string
kmsKeyId
string
object

Reference to a Key in kms to populate kmsKeyId.

name
requiredstring
policy
object
object

Policies for referencing.

resolve
string
object

Selector for a Key in kms to populate kmsKeyId.

policy
object
object

Policies for selection.

resolve
string
object

Reference to a Function in lambda to populate postAuthentication.

name
requiredstring
policy
object
object

Policies for referencing.

resolve
string
object

Selector for a Function in lambda to populate postAuthentication.

policy
object
object

Policies for selection.

resolve
string
object

Reference to a Function in lambda to populate postConfirmation.

name
requiredstring
policy
object
object

Policies for referencing.

resolve
string
object

Selector for a Function in lambda to populate postConfirmation.

policy
object
object

Policies for selection.

resolve
string
object

Reference to a Function in lambda to populate preAuthentication.

name
requiredstring
policy
object
object

Policies for referencing.

resolve
string
object

Selector for a Function in lambda to populate preAuthentication.

policy
object
object

Policies for selection.

resolve
string
preSignUp
string
object

Reference to a Function in lambda to populate preSignUp.

name
requiredstring
policy
object
object

Policies for referencing.

resolve
string
object

Selector for a Function in lambda to populate preSignUp.

policy
object
object

Policies for selection.

resolve
string
object

Reference to a Function in lambda to populate preTokenGeneration.

name
requiredstring
policy
object
object

Policies for referencing.

resolve
string
object

Selector for a Function in lambda to populate preTokenGeneration.

policy
object
object

Policies for selection.

resolve
string
object

Reference to a Function in lambda to populate userMigration.

name
requiredstring
policy
object
object

Policies for referencing.

resolve
string
object

Selector for a Function in lambda to populate userMigration.

policy
object
object

Policies for selection.

resolve
string
object

Reference to a Function in lambda to populate verifyAuthChallengeResponse.

name
requiredstring
policy
object
object

Policies for referencing.

resolve
string
object

Selector for a Function in lambda to populate verifyAuthChallengeResponse.

policy
object
object

Policies for selection.

resolve
string
name
string
array

Configuration block for information about the user pool password policy. Detailed below.

schema
array
array

Configuration block for the schema attributes of a user pool. Detailed below. Schema attributes from the standard attribute set only need to be specified if they are different from the default configuration. Attributes can be added, but not modified or removed. Maximum of 50 attributes.

mutable
boolean
name
string
array

Configuration block for the constraints for an attribute of the number type. Detailed below.

maxValue
string
minValue
string
required
boolean
array

Constraints for an attribute of the string type. Detailed below.

maxLength
string
minLength
string
array

Configuration block for Short Message Service (SMS) settings. Detailed below. These settings apply to SMS user verification and SMS Multi-Factor Authentication (MFA). Due to Cognito API restrictions, the SMS configuration cannot be removed without recreating the Cognito User Pool. For user data safety, this resource will ignore the removal of this configuration by disabling drift detection. To force resource recreation after this configuration has been applied, see the taint command.

object

Reference to a Role in iam to populate snsCallerArn.

name
requiredstring
policy
object
object

Policies for referencing.

resolve
string
object

Selector for a Role in iam to populate snsCallerArn.

policy
object
object

Policies for selection.

resolve
string
snsRegion
string
array

Configuration block for software token Mult-Factor Authentication (MFA) settings. Detailed below.

enabled
boolean
tags
object
array

Configuration block for user attribute update settings. Detailed below.

array

A list of attributes requiring verification before update. If set, the provided value(s) must also be set in auto_verified_attributes. Valid values: email, phone_number.

array

Configuration block for user pool add-ons to enable user pool advanced security mode features. Detailed below.

array

Whether email addresses or phone numbers can be specified as usernames when a user signs up. Conflicts with alias_attributes.

array

Configuration block for username configuration. Detailed below.

array

Configuration block for verification message templates. Detailed below.

array

THIS IS A BETA FIELD. It is on by default but can be opted out through a Crossplane feature flag. ManagementPolicies specify the array of actions Crossplane is allowed to take on the managed and external resources. This field is planned to replace the DeletionPolicy field in a future release. Currently, both could be set independently and non-default values would be honored if the feature flag is enabled. If both are custom, the DeletionPolicy field will be ignored. See the design doc for more information: https://github.com/crossplane/crossplane/blob/499895a25d1a1a0ba1604944ef98ac7a1a71f197/design/design-doc-observe-only-resources.md?plain=1#L223 and this one: https://github.com/crossplane/crossplane/blob/444267e84783136daa93568b364a5f01228cacbe/design/one-pager-ignore-changes.md

object

ProviderConfigReference specifies how the provider that will be used to create, observe, update, and delete this managed resource should be configured.

name
requiredstring
policy
object
object

Policies for referencing.

resolve
string
object

PublishConnectionDetailsTo specifies the connection secret config which contains a name, metadata and a reference to secret store config to which any connection details for this managed resource should be written. Connection details frequently include the endpoint, username, and password required to connect to the managed resource.

configRef
object
object

SecretStoreConfigRef specifies which secret store config should be used for this ConnectionSecret.

name
requiredstring
policy
object
object

Policies for referencing.

resolve
string
metadata
object
object

Metadata is the metadata for connection secret.

labels
object
type
string
name
requiredstring
object

WriteConnectionSecretToReference specifies the namespace and name of a Secret to which any connection details for this managed resource should be written. Connection details frequently include the endpoint, username, and password required to connect to the managed resource. This field is planned to be replaced in a future release in favor of PublishConnectionDetailsTo. Currently, both could be set independently and connection details would be published to both without affecting each other.

name
requiredstring
namespace
requiredstring
status
object
object

UserPoolStatus defines the observed state of UserPool.

object

No description provided.

array

Configuration block to define which verified available method a user can use to recover their forgotten password. Detailed below.

array

List of Account Recovery Options of the following structure:

name
string
priority
number
array

Configuration block for creating a new user profile. Detailed below.

array

Invite message template structure. Detailed below.

array

Attributes supported as an alias for this user pool. Valid values: phone_number, email, or preferred_username. Conflicts with username_attributes.

arn
string
array

Attributes to be auto-verified. Valid values: email, phone_number.

array

Configuration block for the user pool's device tracking. Detailed below.

domain
string
array

Configuration block for configuring email. Detailed below.

endpoint
string
id
string
array

Configuration block for the AWS Lambda triggers associated with the user pool. Detailed below.

array

A custom email sender AWS Lambda trigger. See custom_email_sender Below.

array

A custom SMS sender AWS Lambda trigger. See custom_sms_sender Below.

kmsKeyId
string
preSignUp
string
name
string
array

Configuration block for information about the user pool password policy. Detailed below.

schema
array
array

Configuration block for the schema attributes of a user pool. Detailed below. Schema attributes from the standard attribute set only need to be specified if they are different from the default configuration. Attributes can be added, but not modified or removed. Maximum of 50 attributes.

mutable
boolean
name
string
array

Configuration block for the constraints for an attribute of the number type. Detailed below.

maxValue
string
minValue
string
required
boolean
array

Constraints for an attribute of the string type. Detailed below.

maxLength
string
minLength
string
array

Configuration block for Short Message Service (SMS) settings. Detailed below. These settings apply to SMS user verification and SMS Multi-Factor Authentication (MFA). Due to Cognito API restrictions, the SMS configuration cannot be removed without recreating the Cognito User Pool. For user data safety, this resource will ignore the removal of this configuration by disabling drift detection. To force resource recreation after this configuration has been applied, see the taint command.

array

Configuration block for software token Mult-Factor Authentication (MFA) settings. Detailed below.

enabled
boolean
tags
object
tagsAll
object
array

Configuration block for user attribute update settings. Detailed below.

array

A list of attributes requiring verification before update. If set, the provided value(s) must also be set in auto_verified_attributes. Valid values: email, phone_number.

array

Configuration block for user pool add-ons to enable user pool advanced security mode features. Detailed below.

array

Whether email addresses or phone numbers can be specified as usernames when a user signs up. Conflicts with alias_attributes.

array

Configuration block for username configuration. Detailed below.

array

Configuration block for verification message templates. Detailed below.

array

Conditions of the resource.

lastTransitionTime
requiredstring
message
string
reason
requiredstring
status
requiredstring
type
requiredstring
Marketplace

Discover the building blocks for your internal cloud platform.

© 2022 Upbound, Inc.

SolutionsProvidersConfigurations
LearnDocumentationTry for Free
MorePrivacy PolicyTerms & Conditions
Marketplace

© 2022 Upbound, Inc.

Marketplace

Discover the building blocksfor your internal cloud platform.