Network.AWS.CognitoIdentityProvider.CreateUserPool

Creates a new Amazon Cognito user pool and sets the password policy for the pool.

Creating a Request

createUserPool

Arguments

:: Text

cupPoolName

-> CreateUserPool

Creates a value of CreateUserPool with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• cupUserPoolTags - The cost allocation tags for the user pool. For more information, see Adding Cost Allocation Tags to Your User Pool
• cupVerificationMessageTemplate - The template for the verification message that the user sees when the app requests permission to access the user's information.
• cupEmailVerificationMessage - A string representing the email verification message.
• cupSmsAuthenticationMessage - A string representing the SMS authentication message.
• cupUserPoolAddOns - Used to enable advanced security risk detection. Set the key AdvancedSecurityMode to the value AUDIT.
• cupEmailVerificationSubject - A string representing the email verification subject.
• cupUsernameAttributes - Specifies whether email addresses or phone numbers can be specified as usernames when a user signs up.
• cupAliasAttributes - Attributes supported as an alias for this user pool. Possible values: phone_number , email , or preferred_username .
• cupSchema - An array of schema attributes for the new user pool. These attributes can be standard or custom attributes.
• cupEmailConfiguration - The email configuration.
• cupSmsVerificationMessage - A string representing the SMS verification message.
• cupMFAConfiguration - Specifies MFA configuration details.
• cupLambdaConfig - The Lambda trigger configuration information for the new user pool.
• cupSmsConfiguration - The SMS configuration.
• cupAdminCreateUserConfig - The configuration for AdminCreateUser requests.
• cupDeviceConfiguration - The device configuration.
• cupAutoVerifiedAttributes - The attributes to be auto-verified. Possible values: email , phone_number .
• cupPolicies - The policies associated with the new user pool.
• cupPoolName - A string used to name the user pool.

data CreateUserPool

Represents the request to create a user pool.

See: createUserPool smart constructor.

Instances

Eq CreateUserPool

Methods

(==) :: CreateUserPool -> CreateUserPool -> Bool

(/=) :: CreateUserPool -> CreateUserPool -> Bool

Data CreateUserPool

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> CreateUserPool -> c CreateUserPool

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c CreateUserPool

toConstr :: CreateUserPool -> Constr

dataTypeOf :: CreateUserPool -> DataType

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c CreateUserPool)

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c CreateUserPool)

gmapT :: (forall b. Data b => b -> b) -> CreateUserPool -> CreateUserPool

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> CreateUserPool -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> CreateUserPool -> r

gmapQ :: (forall d. Data d => d -> u) -> CreateUserPool -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> CreateUserPool -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> CreateUserPool -> m CreateUserPool

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> CreateUserPool -> m CreateUserPool

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> CreateUserPool -> m CreateUserPool

Read CreateUserPool

Methods

readsPrec :: Int -> ReadS CreateUserPool

readList :: ReadS [CreateUserPool]

readPrec :: ReadPrec CreateUserPool

readListPrec :: ReadPrec [CreateUserPool]

Show CreateUserPool

Methods

showsPrec :: Int -> CreateUserPool -> ShowS

show :: CreateUserPool -> String

showList :: [CreateUserPool] -> ShowS

Generic CreateUserPool

Associated Types

type Rep CreateUserPool :: * -> *

Methods

from :: CreateUserPool -> Rep CreateUserPool x

to :: Rep CreateUserPool x -> CreateUserPool

Hashable CreateUserPool

Methods

hashWithSalt :: Int -> CreateUserPool -> Int

hash :: CreateUserPool -> Int

ToJSON CreateUserPool

Methods

toJSON :: CreateUserPool -> Value

toEncoding :: CreateUserPool -> Encoding

toJSONList :: [CreateUserPool] -> Value

toEncodingList :: [CreateUserPool] -> Encoding

NFData CreateUserPool

Methods

rnf :: CreateUserPool -> ()

AWSRequest CreateUserPool

Associated Types

type Rs CreateUserPool :: *

Methods

request :: CreateUserPool -> Request CreateUserPool

response :: (MonadResource m, MonadThrow m) => Logger -> Service -> Proxy * CreateUserPool -> ClientResponse -> m (Response CreateUserPool)

ToHeaders CreateUserPool

Methods

toHeaders :: CreateUserPool -> [Header]

ToPath CreateUserPool

Methods

toPath :: CreateUserPool -> ByteString

ToQuery CreateUserPool

Methods

toQuery :: CreateUserPool -> QueryString

type Rep CreateUserPool

type Rep CreateUserPool = D1 * (MetaData "CreateUserPool" "Network.AWS.CognitoIdentityProvider.CreateUserPool" "amazonka-cognito-idp-1.6.0-JhJp6CX0k821Z1WSNBuBfd" False) (C1 * (MetaCons "CreateUserPool'" PrefixI True) ((:*:) * ((:*:) * ((:*:) * ((:*:) * (S1 * (MetaSel (Just Symbol "_cupUserPoolTags") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe (Map Text Text)))) (S1 * (MetaSel (Just Symbol "_cupVerificationMessageTemplate") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe VerificationMessageTemplateType)))) ((:*:) * (S1 * (MetaSel (Just Symbol "_cupEmailVerificationMessage") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) (S1 * (MetaSel (Just Symbol "_cupSmsAuthenticationMessage") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))))) ((:*:) * ((:*:) * (S1 * (MetaSel (Just Symbol "_cupUserPoolAddOns") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe UserPoolAddOnsType))) (S1 * (MetaSel (Just Symbol "_cupEmailVerificationSubject") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text)))) ((:*:) * (S1 * (MetaSel (Just Symbol "_cupUsernameAttributes") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe [UsernameAttributeType]))) ((:*:) * (S1 * (MetaSel (Just Symbol "_cupAliasAttributes") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe [AliasAttributeType]))) (S1 * (MetaSel (Just Symbol "_cupSchema") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe (List1 SchemaAttributeType)))))))) ((:*:) * ((:*:) * ((:*:) * (S1 * (MetaSel (Just Symbol "_cupEmailConfiguration") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe EmailConfigurationType))) (S1 * (MetaSel (Just Symbol "_cupSmsVerificationMessage") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text)))) ((:*:) * (S1 * (MetaSel (Just Symbol "_cupMFAConfiguration") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe UserPoolMFAType))) ((:*:) * (S1 * (MetaSel (Just Symbol "_cupLambdaConfig") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe LambdaConfigType))) (S1 * (MetaSel (Just Symbol "_cupSmsConfiguration") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe SmsConfigurationType)))))) ((:*:) * ((:*:) * (S1 * (MetaSel (Just Symbol "_cupAdminCreateUserConfig") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe AdminCreateUserConfigType))) (S1 * (MetaSel (Just Symbol "_cupDeviceConfiguration") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe DeviceConfigurationType)))) ((:*:) * (S1 * (MetaSel (Just Symbol "_cupAutoVerifiedAttributes") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe [VerifiedAttributeType]))) ((:*:) * (S1 * (MetaSel (Just Symbol "_cupPolicies") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe UserPoolPolicyType))) (S1 * (MetaSel (Just Symbol "_cupPoolName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * Text))))))))

type Rs CreateUserPool

type Rs CreateUserPool = CreateUserPoolResponse

Request Lenses

cupUserPoolTags :: Lens' CreateUserPool (HashMap Text Text)

The cost allocation tags for the user pool. For more information, see Adding Cost Allocation Tags to Your User Pool

cupVerificationMessageTemplate :: Lens' CreateUserPool (Maybe VerificationMessageTemplateType)

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

cupEmailVerificationMessage :: Lens' CreateUserPool (Maybe Text)

A string representing the email verification message.

cupSmsAuthenticationMessage :: Lens' CreateUserPool (Maybe Text)

A string representing the SMS authentication message.

cupUserPoolAddOns :: Lens' CreateUserPool (Maybe UserPoolAddOnsType)

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

cupEmailVerificationSubject :: Lens' CreateUserPool (Maybe Text)

A string representing the email verification subject.

cupUsernameAttributes :: Lens' CreateUserPool [UsernameAttributeType]

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

cupAliasAttributes :: Lens' CreateUserPool [AliasAttributeType]

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

cupSchema :: Lens' CreateUserPool (Maybe (NonEmpty SchemaAttributeType))

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

cupEmailConfiguration :: Lens' CreateUserPool (Maybe EmailConfigurationType)

The email configuration.

cupSmsVerificationMessage :: Lens' CreateUserPool (Maybe Text)

A string representing the SMS verification message.

cupMFAConfiguration :: Lens' CreateUserPool (Maybe UserPoolMFAType)

Specifies MFA configuration details.

cupLambdaConfig :: Lens' CreateUserPool (Maybe LambdaConfigType)

The Lambda trigger configuration information for the new user pool.

cupSmsConfiguration :: Lens' CreateUserPool (Maybe SmsConfigurationType)

The SMS configuration.

cupAdminCreateUserConfig :: Lens' CreateUserPool (Maybe AdminCreateUserConfigType)

The configuration for AdminCreateUser requests.

cupDeviceConfiguration :: Lens' CreateUserPool (Maybe DeviceConfigurationType)

The device configuration.

cupAutoVerifiedAttributes :: Lens' CreateUserPool [VerifiedAttributeType]

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

cupPolicies :: Lens' CreateUserPool (Maybe UserPoolPolicyType)

The policies associated with the new user pool.

cupPoolName :: Lens' CreateUserPool Text

A string used to name the user pool.

Destructuring the Response

createUserPoolResponse

Arguments

:: Int

cuprsResponseStatus

-> CreateUserPoolResponse

Creates a value of CreateUserPoolResponse with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• cuprsUserPool - A container for the user pool details.
• cuprsResponseStatus - -- | The response status code.

data CreateUserPoolResponse

Represents the response from the server for the request to create a user pool.

See: createUserPoolResponse smart constructor.

Instances

Eq CreateUserPoolResponse

Methods

(==) :: CreateUserPoolResponse -> CreateUserPoolResponse -> Bool

(/=) :: CreateUserPoolResponse -> CreateUserPoolResponse -> Bool

Data CreateUserPoolResponse

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> CreateUserPoolResponse -> c CreateUserPoolResponse

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c CreateUserPoolResponse

toConstr :: CreateUserPoolResponse -> Constr

dataTypeOf :: CreateUserPoolResponse -> DataType

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c CreateUserPoolResponse)

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c CreateUserPoolResponse)

gmapT :: (forall b. Data b => b -> b) -> CreateUserPoolResponse -> CreateUserPoolResponse

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> CreateUserPoolResponse -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> CreateUserPoolResponse -> r

gmapQ :: (forall d. Data d => d -> u) -> CreateUserPoolResponse -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> CreateUserPoolResponse -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> CreateUserPoolResponse -> m CreateUserPoolResponse

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> CreateUserPoolResponse -> m CreateUserPoolResponse

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> CreateUserPoolResponse -> m CreateUserPoolResponse

Read CreateUserPoolResponse

Methods

readsPrec :: Int -> ReadS CreateUserPoolResponse

readList :: ReadS [CreateUserPoolResponse]

readPrec :: ReadPrec CreateUserPoolResponse

readListPrec :: ReadPrec [CreateUserPoolResponse]

Show CreateUserPoolResponse

Methods

showsPrec :: Int -> CreateUserPoolResponse -> ShowS

show :: CreateUserPoolResponse -> String

showList :: [CreateUserPoolResponse] -> ShowS

Generic CreateUserPoolResponse

Associated Types

type Rep CreateUserPoolResponse :: * -> *

Methods

from :: CreateUserPoolResponse -> Rep CreateUserPoolResponse x

to :: Rep CreateUserPoolResponse x -> CreateUserPoolResponse

NFData CreateUserPoolResponse

Methods

rnf :: CreateUserPoolResponse -> ()

type Rep CreateUserPoolResponse

type Rep CreateUserPoolResponse = D1 * (MetaData "CreateUserPoolResponse" "Network.AWS.CognitoIdentityProvider.CreateUserPool" "amazonka-cognito-idp-1.6.0-JhJp6CX0k821Z1WSNBuBfd" False) (C1 * (MetaCons "CreateUserPoolResponse'" PrefixI True) ((:*:) * (S1 * (MetaSel (Just Symbol "_cuprsUserPool") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe UserPoolType))) (S1 * (MetaSel (Just Symbol "_cuprsResponseStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * Int))))

Response Lenses

cuprsUserPool :: Lens' CreateUserPoolResponse (Maybe UserPoolType)

A container for the user pool details.

cuprsResponseStatus :: Lens' CreateUserPoolResponse Int

• - | The response status code.