Marketplace
BrowsePublish
Marketplace
You are viewing an outdated version of provider-aws.Go to Latest
upbound/provider-aws@v0.26.0
UserPool
cognitoidp.aws.upbound.io
UserPool
upbound/provider-aws@v0.26.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.

recoveryMechanism
requiredarray
requiredarray

List of Account Recovery Options of the following structure:

name
requiredstring
priority
requirednumber
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.

array

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

lambdaArn
requiredstring
lambdaVersion
requiredstring
array

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

lambdaArn
requiredstring
lambdaVersion
requiredstring
kmsKeyId
string
preSignUp
string
name
requiredstring
array

Configuration blocked 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.

attributeDataType
requiredstring
mutable
boolean
name
requiredstring
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.

externalId
requiredstring
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
array

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

enabled
requiredboolean
tags
object
array

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

advancedSecurityMode
requiredstring
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.

caseSensitive
requiredboolean
array

Configuration block for verification message templates. Detailed below.

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

No description provided.

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.