You are viewing an outdated version of provider-aws.Go to Latest
crossplane-contrib/provider-aws@v0.33.0
UserPool
cognitoidentityprovider.aws.crossplane.io
UserPool
crossplane-contrib/provider-aws@v0.33.0cognitoidentityprovider.aws.crossplane.io

UserPool is the Schema for the UserPools API

Type

CRD

Group

cognitoidentityprovider.aws.crossplane.io

Version

v1alpha1

apiVersion: cognitoidentityprovider.aws.crossplane.io/v1alpha1

kind: UserPool

API Documentation
apiVersion
string
kind
string
metadata
object
spec
object
object

UserPoolSpec defines the desired state of UserPool

forProvider
requiredobject
requiredobject

UserPoolParameters defines the desired state of UserPool

object

Use this setting to define which verified available method a user can use to recover their password when they call ForgotPassword. It allows you to define a preferred method when a user has more than one method available. With this setting, SMS does not qualify for a valid password recovery mechanism if the user also has SMS MFA enabled. In the absence of this setting, Cognito uses the legacy behavior to determine the recovery method where SMS is preferred over email.

array

No description provided.

name
string
priority
integer
object

The configuration for AdminCreateUser requests.

object

The message template structure.

array

Attributes supported as an alias for this user pool. Possible values: phone_number, email, or preferred_username.

array

The attributes to be auto-verified. Possible values: email, phone_number.

object

The email configuration.

object

The Lambda trigger configuration information for the new user pool. In a push model, event sources (such as Amazon S3 and custom applications) need permission to invoke a function. So you will need to make an extra call to add permission for these event sources to invoke your Lambda function. For more information on using the Lambda API to add permission, see AddPermission (https://docs.aws.amazon.com/lambda/latest/dg/API_AddPermission.html). For adding permission using the CLI, see add-permission (https://docs.aws.amazon.com/cli/latest/reference/lambda/add-permission.html).

object

A custom email sender Lambda configuration type.

object

A custom SMS sender Lambda configuration type.

kmsKeyID
string
preSignUp
string
policies
object
object

The policies associated with the new user pool.

object

The password policy type.

poolName
requiredstring
region
requiredstring
schema
array
array

An array of schema attributes for the new user pool. These attributes can be standard or custom attributes.

mutable
boolean
name
string
object

The minimum and maximum value of an attribute that is of the number data type.

maxValue
string
minValue
string
required
boolean
object

The constraints associated with a string attribute.

maxLength
string
minLength
string
object

The SMS configuration.

object

Used to enable advanced security risk detection. Set the key AdvancedSecurityMode to the value "AUDIT".

array

Specifies whether email addresses or phone numbers can be specified as usernames when a user signs up.

object

You can choose to set case sensitivity on the username input for the selected sign-in option. For example, when this is set to False, users will be able to sign in using either "username" or "Username". This configuration is immutable once it has been set. For more information, see UsernameConfigurationType (https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_UsernameConfigurationType.html).

object

The template for the verification message that the user sees when the app requests permission to access the user's information.

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

ProviderReference specifies the provider that will be used to create, observe, update, and delete this managed resource. Deprecated: Please use ProviderConfigReference, i.e. providerConfigRef

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

UserPoolObservation defines the observed state of UserPool

arn
string
domain
string
id
string
name
string
array

A container with the schema attributes of a user pool.

mutable
boolean
name
string
object

The minimum and maximum value of an attribute that is of the number data type.

maxValue
string
minValue
string
required
boolean
object

The constraints associated with a string attribute.

maxLength
string
minLength
string
status
string
array

Conditions of the resource.

lastTransitionTime
requiredstring
message
string
reason
requiredstring
status
requiredstring
type
requiredstring
Discover the building blocks for your internal cloud platform.
© 2024 Upbound, Inc.
Solutions