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
UserPoolSpec defines the desired state of UserPool
No description provided.
Configuration block to define which verified available method a user can use to recover their forgotten password. Detailed below.
Configuration block for creating a new user profile. Detailed below.
Invite message template structure. Detailed below.
Attributes supported as an alias for this user pool. Valid values: phone_number, email, or preferred_username. Conflicts with username_attributes.
Attributes to be auto-verified. Valid values: email, phone_number.
Configuration block for the user pool's device tracking. Detailed below.
Configuration block for configuring email. Detailed below.
Configuration block for the AWS Lambda triggers associated with the user pool. Detailed below.
Reference to a Function in lambda to populate createAuthChallenge.
Policies for referencing.
Selector for a Function in lambda to populate createAuthChallenge.
Policies for selection.
A custom email sender AWS Lambda trigger. See custom_email_sender Below.
Reference to a Function in lambda to populate lambdaArn.
Policies for referencing.
Selector for a Function in lambda to populate lambdaArn.
Policies for selection.
Reference to a Function in lambda to populate customMessage.
Policies for referencing.
Selector for a Function in lambda to populate customMessage.
Policies for selection.
A custom SMS sender AWS Lambda trigger. See custom_sms_sender Below.
Reference to a Function in lambda to populate lambdaArn.
Policies for referencing.
Selector for a Function in lambda to populate lambdaArn.
Policies for selection.
Reference to a Function in lambda to populate defineAuthChallenge.
Policies for referencing.
Selector for a Function in lambda to populate defineAuthChallenge.
Policies for selection.
Reference to a Key in kms to populate kmsKeyId.
Policies for referencing.
Selector for a Key in kms to populate kmsKeyId.
Policies for selection.
Reference to a Function in lambda to populate postAuthentication.
Policies for referencing.
Selector for a Function in lambda to populate postAuthentication.
Policies for selection.
Reference to a Function in lambda to populate postConfirmation.
Policies for referencing.
Selector for a Function in lambda to populate postConfirmation.
Policies for selection.
Reference to a Function in lambda to populate preAuthentication.
Policies for referencing.
Selector for a Function in lambda to populate preAuthentication.
Policies for selection.
Reference to a Function in lambda to populate preSignUp.
Policies for referencing.
Selector for a Function in lambda to populate preSignUp.
Policies for selection.
Reference to a Function in lambda to populate preTokenGeneration.
Policies for referencing.
Selector for a Function in lambda to populate preTokenGeneration.
Policies for selection.
Reference to a Function in lambda to populate userMigration.
Policies for referencing.
Selector for a Function in lambda to populate userMigration.
Policies for selection.
Reference to a Function in lambda to populate verifyAuthChallengeResponse.
Policies for referencing.
Selector for a Function in lambda to populate verifyAuthChallengeResponse.
Policies for selection.
Configuration block for information about the user pool password policy. Detailed below.
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.
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.
Reference to a Role in iam to populate snsCallerArn.
Policies for referencing.
Selector for a Role in iam to populate snsCallerArn.
Policies for selection.
Configuration block for software token Mult-Factor Authentication (MFA) settings. Detailed below.
Configuration block for user attribute update settings. Detailed below.
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.
Configuration block for user pool add-ons to enable user pool advanced security mode features. Detailed below.
Whether email addresses or phone numbers can be specified as usernames when a user signs up. Conflicts with alias_attributes.
Configuration block for username configuration. Detailed below.
Configuration block for verification message templates. Detailed below.
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.
Configuration block to define which verified available method a user can use to recover their forgotten password. Detailed below.
Configuration block for creating a new user profile. Detailed below.
Invite message template structure. Detailed below.
Attributes supported as an alias for this user pool. Valid values: phone_number, email, or preferred_username. Conflicts with username_attributes.
Attributes to be auto-verified. Valid values: email, phone_number.
Configuration block for the user pool's device tracking. Detailed below.
Configuration block for configuring email. Detailed below.
Configuration block for the AWS Lambda triggers associated with the user pool. Detailed below.
Reference to a Function in lambda to populate createAuthChallenge.
Policies for referencing.
Selector for a Function in lambda to populate createAuthChallenge.
Policies for selection.
A custom email sender AWS Lambda trigger. See custom_email_sender Below.
Reference to a Function in lambda to populate lambdaArn.
Policies for referencing.
Selector for a Function in lambda to populate lambdaArn.
Policies for selection.
Reference to a Function in lambda to populate customMessage.
Policies for referencing.
Selector for a Function in lambda to populate customMessage.
Policies for selection.
A custom SMS sender AWS Lambda trigger. See custom_sms_sender Below.
Reference to a Function in lambda to populate lambdaArn.
Policies for referencing.
Selector for a Function in lambda to populate lambdaArn.
Policies for selection.
Reference to a Function in lambda to populate defineAuthChallenge.
Policies for referencing.
Selector for a Function in lambda to populate defineAuthChallenge.
Policies for selection.
Reference to a Key in kms to populate kmsKeyId.
Policies for referencing.
Selector for a Key in kms to populate kmsKeyId.
Policies for selection.
Reference to a Function in lambda to populate postAuthentication.
Policies for referencing.
Selector for a Function in lambda to populate postAuthentication.
Policies for selection.
Reference to a Function in lambda to populate postConfirmation.
Policies for referencing.
Selector for a Function in lambda to populate postConfirmation.
Policies for selection.
Reference to a Function in lambda to populate preAuthentication.
Policies for referencing.
Selector for a Function in lambda to populate preAuthentication.
Policies for selection.
Reference to a Function in lambda to populate preSignUp.
Policies for referencing.
Selector for a Function in lambda to populate preSignUp.
Policies for selection.
Reference to a Function in lambda to populate preTokenGeneration.
Policies for referencing.
Selector for a Function in lambda to populate preTokenGeneration.
Policies for selection.
Reference to a Function in lambda to populate userMigration.
Policies for referencing.
Selector for a Function in lambda to populate userMigration.
Policies for selection.
Reference to a Function in lambda to populate verifyAuthChallengeResponse.
Policies for referencing.
Selector for a Function in lambda to populate verifyAuthChallengeResponse.
Policies for selection.
Configuration block for information about the user pool password policy. Detailed below.
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.
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.
Reference to a Role in iam to populate snsCallerArn.
Policies for referencing.
Selector for a Role in iam to populate snsCallerArn.
Policies for selection.
Configuration block for software token Mult-Factor Authentication (MFA) settings. Detailed below.
Configuration block for user attribute update settings. Detailed below.
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.
Configuration block for user pool add-ons to enable user pool advanced security mode features. Detailed below.
Whether email addresses or phone numbers can be specified as usernames when a user signs up. Conflicts with alias_attributes.
Configuration block for username configuration. Detailed below.
Configuration block for verification message templates. Detailed below.
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
ProviderConfigReference specifies how the provider that will be used to create, observe, update, and delete this managed resource should be configured.
Policies for referencing.
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.
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.
UserPoolStatus defines the observed state of UserPool.
No description provided.
Configuration block to define which verified available method a user can use to recover their forgotten password. Detailed below.
Configuration block for creating a new user profile. Detailed below.
Invite message template structure. Detailed below.
Attributes supported as an alias for this user pool. Valid values: phone_number, email, or preferred_username. Conflicts with username_attributes.
Attributes to be auto-verified. Valid values: email, phone_number.
Configuration block for the user pool's device tracking. Detailed below.
Configuration block for configuring email. Detailed below.
Configuration block for the AWS Lambda triggers associated with the user pool. Detailed below.
A custom email sender AWS Lambda trigger. See custom_email_sender Below.
A custom SMS sender AWS Lambda trigger. See custom_sms_sender Below.
Configuration block for information about the user pool password policy. Detailed below.
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.
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.
Configuration block for software token Mult-Factor Authentication (MFA) settings. Detailed below.
Configuration block for user attribute update settings. Detailed below.
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.
Configuration block for user pool add-ons to enable user pool advanced security mode features. Detailed below.
Whether email addresses or phone numbers can be specified as usernames when a user signs up. Conflicts with alias_attributes.
Configuration block for username configuration. Detailed below.
Configuration block for verification message templates. Detailed below.
Conditions of the resource.
example
apiVersion: cognitoidp.aws.upbound.io/v1beta1
kind: UserPool
metadata:
labels:
testing.upbound.io/example-name: example
name: example
spec:
forProvider:
autoVerifiedAttributes:
- email
name: user pool
region: us-west-1
example
apiVersion: cognitoidp.aws.upbound.io/v1beta1
kind: UserPool
metadata:
annotations:
meta.upbound.io/example-id: cognitoidp/v1beta1/useringroup
uptest.upbound.io/pre-delete-hook: testhooks/delete-userpool-dependents.sh
labels:
testing.upbound.io/example-name: example
name: example
spec:
forProvider:
name: example
passwordPolicy:
- minimumLength: 6
requireNumbers: false
requireSymbols: false
requireUppercase: false
temporaryPasswordValidityDays: 7
region: us-west-1
main
apiVersion: cognitoidp.aws.upbound.io/v1beta1
kind: UserPool
metadata:
annotations:
meta.upbound.io/example-id: sagemaker/v1beta1/workteam
labels:
testing.upbound.io/example-name: main
name: main
spec:
forProvider:
name: identity pool
region: us-west-2
lambda-example
apiVersion: cognitoidp.aws.upbound.io/v1beta1
kind: UserPool
metadata:
annotations:
meta.upbound.io/example-id: cognitoidp/v1beta1/userpool
labels:
testing.upbound.io/example-name: lambda-example
name: lambda-example
spec:
forProvider:
lambdaConfig:
- createAuthChallengeSelector:
matchLabels:
testing.upbound.io/example-name: lambda-example
customEmailSender:
- lambdaArnSelector:
matchLabels:
testing.upbound.io/example-name: lambda-example
lambdaVersion: V1_0
customMessageSelector:
matchLabels:
testing.upbound.io/example-name: lambda-example
customSmsSender:
- lambdaArnSelector:
matchLabels:
testing.upbound.io/example-name: lambda-example
lambdaVersion: V1_0
defineAuthChallengeSelector:
matchLabels:
testing.upbound.io/example-name: lambda-example
kmsKeyIdSelector:
matchLabels:
testing.upbound.io/example-name: lambda-example
postAuthenticationSelector:
matchLabels:
testing.upbound.io/example-name: lambda-example
postConfirmationSelector:
matchLabels:
testing.upbound.io/example-name: lambda-example
preAuthenticationSelector:
matchLabels:
testing.upbound.io/example-name: lambda-example
preSignUpSelector:
matchLabels:
testing.upbound.io/example-name: lambda-example
preTokenGenerationSelector:
matchLabels:
testing.upbound.io/example-name: lambda-example
userMigrationSelector:
matchLabels:
testing.upbound.io/example-name: lambda-example
verifyAuthChallengeResponseSelector:
matchLabels:
testing.upbound.io/example-name: lambda-example
name: lambda-example
region: eu-west-1
example
apiVersion: cognitoidp.aws.upbound.io/v1beta1
kind: UserPool
metadata:
annotations:
meta.upbound.io/example-id: cognitoidp/v1beta1/riskconfiguration
labels:
testing.upbound.io/example-name: example
name: example
spec:
forProvider:
name: example
passwordPolicy:
- minimumLength: 6
requireNumbers: false
requireSymbols: false
requireUppercase: false
temporaryPasswordValidityDays: 7
region: us-west-1
example
apiVersion: cognitoidp.aws.upbound.io/v1beta1
kind: UserPool
metadata:
labels:
testing.upbound.io/example-name: example
name: example
spec:
forProvider:
name: example
passwordPolicy:
- minimumLength: 6
requireNumbers: false
requireSymbols: false
requireUppercase: false
temporaryPasswordValidityDays: 7
region: us-west-1
example
apiVersion: cognitoidp.aws.upbound.io/v1beta1
kind: UserPool
metadata:
labels:
testing.upbound.io/example-name: example
name: example
spec:
forProvider:
autoVerifiedAttributes:
- email
name: example-pool
region: us-west-1
userpoolclient
apiVersion: cognitoidp.aws.upbound.io/v1beta1
kind: UserPool
metadata:
annotations:
meta.upbound.io/example-id: cognitoidp/v1beta1/userpoolclient
labels:
testing.upbound.io/example-name: userpoolclient
name: userpoolclient
spec:
forProvider:
name: userpoolclient
region: us-west-1
example
apiVersion: cognitoidp.aws.upbound.io/v1beta1
kind: UserPool
metadata:
labels:
testing.upbound.io/example-name: example
name: example
spec:
forProvider:
name: example
region: us-west-1
example
apiVersion: cognitoidp.aws.upbound.io/v1beta1
kind: UserPool
metadata:
annotations:
meta.upbound.io/example-id: sagemaker/v1beta1/workforce
labels:
testing.upbound.io/example-name: example
name: example
spec:
forProvider:
name: example
region: us-west-2
pool
apiVersion: cognitoidp.aws.upbound.io/v1beta1
kind: UserPool
metadata:
labels:
testing.upbound.io/example-name: pool
name: pool
spec:
forProvider:
name: pool
region: us-west-1
main
apiVersion: cognitoidp.aws.upbound.io/v1beta1
kind: UserPool
metadata:
annotations:
meta.upbound.io/example-id: cognitoidp/v1beta1/usergroup
uptest.upbound.io/pre-delete-hook: testhooks/delete-userpool-dependents.sh
labels:
testing.upbound.io/example-name: main
name: main
spec:
forProvider:
name: identity pool
region: us-west-1
© 2022 Upbound, Inc.
Discover the building blocksfor your internal cloud platform.