libZSservicesZSamazonka-cognito-idpZSamazonka-cognito-idp
Copyright(c) 2013-2021 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone

Amazonka.CognitoIdentityProvider.CreateUserPoolDomain

Description

Creates a new domain for a user pool.

Synopsis

Creating a Request

data CreateUserPoolDomain Source #

See: newCreateUserPoolDomain smart constructor.

Constructors

CreateUserPoolDomain' 

Fields

Instances

Instances details
Eq CreateUserPoolDomain Source # 
Instance details

Defined in Amazonka.CognitoIdentityProvider.CreateUserPoolDomain

Methods

(==) :: CreateUserPoolDomain -> CreateUserPoolDomain -> Bool #

(/=) :: CreateUserPoolDomain -> CreateUserPoolDomain -> Bool #

Read CreateUserPoolDomain Source # 
Instance details

Defined in Amazonka.CognitoIdentityProvider.CreateUserPoolDomain

Methods

readsPrec :: Int -> ReadS CreateUserPoolDomain #

readList :: ReadS [CreateUserPoolDomain] #

readPrec :: ReadPrec CreateUserPoolDomain #

readListPrec :: ReadPrec [CreateUserPoolDomain] #

Show CreateUserPoolDomain Source # 
Instance details

Defined in Amazonka.CognitoIdentityProvider.CreateUserPoolDomain

Methods

showsPrec :: Int -> CreateUserPoolDomain -> ShowS #

show :: CreateUserPoolDomain -> String #

showList :: [CreateUserPoolDomain] -> ShowS #

Generic CreateUserPoolDomain Source # 
Instance details

Defined in Amazonka.CognitoIdentityProvider.CreateUserPoolDomain

Associated Types

type Rep CreateUserPoolDomain :: Type -> Type #

Methods

from :: CreateUserPoolDomain -> Rep CreateUserPoolDomain x #

to :: Rep CreateUserPoolDomain x -> CreateUserPoolDomain #

NFData CreateUserPoolDomain Source # 
Instance details

Defined in Amazonka.CognitoIdentityProvider.CreateUserPoolDomain

Methods

rnf :: CreateUserPoolDomain -> () #

Hashable CreateUserPoolDomain Source # 
Instance details

Defined in Amazonka.CognitoIdentityProvider.CreateUserPoolDomain

Methods

hashWithSalt :: Int -> CreateUserPoolDomain -> Int #

hash :: CreateUserPoolDomain -> Int #

ToJSON CreateUserPoolDomain Source # 
Instance details

Defined in Amazonka.CognitoIdentityProvider.CreateUserPoolDomain

Methods

toJSON :: CreateUserPoolDomain -> Value #

toEncoding :: CreateUserPoolDomain -> Encoding #

toJSONList :: [CreateUserPoolDomain] -> Value #

toEncodingList :: [CreateUserPoolDomain] -> Encoding #

AWSRequest CreateUserPoolDomain Source # 
Instance details

Defined in Amazonka.CognitoIdentityProvider.CreateUserPoolDomain

Associated Types

type AWSResponse CreateUserPoolDomain #

Methods

request :: CreateUserPoolDomain -> Request CreateUserPoolDomain #

response :: MonadResource m => Logger -> Service -> Proxy CreateUserPoolDomain -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse CreateUserPoolDomain))) #

ToHeaders CreateUserPoolDomain Source # 
Instance details

Defined in Amazonka.CognitoIdentityProvider.CreateUserPoolDomain

Methods

toHeaders :: CreateUserPoolDomain -> [Header] #

ToPath CreateUserPoolDomain Source # 
Instance details

Defined in Amazonka.CognitoIdentityProvider.CreateUserPoolDomain

Methods

toPath :: CreateUserPoolDomain -> ByteString #

ToQuery CreateUserPoolDomain Source # 
Instance details

Defined in Amazonka.CognitoIdentityProvider.CreateUserPoolDomain

Methods

toQuery :: CreateUserPoolDomain -> QueryString #

type Rep CreateUserPoolDomain Source # 
Instance details

Defined in Amazonka.CognitoIdentityProvider.CreateUserPoolDomain

type Rep CreateUserPoolDomain = D1 ('MetaData "CreateUserPoolDomain" "Amazonka.CognitoIdentityProvider.CreateUserPoolDomain" "libZSservicesZSamazonka-cognito-idpZSamazonka-cognito-idp" 'False) (C1 ('MetaCons "CreateUserPoolDomain'" 'PrefixI 'True) (S1 ('MetaSel ('Just "customDomainConfig") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe CustomDomainConfigType)) :*: (S1 ('MetaSel ('Just "domain") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "userPoolId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))
type AWSResponse CreateUserPoolDomain Source # 
Instance details

Defined in Amazonka.CognitoIdentityProvider.CreateUserPoolDomain

type AWSResponse CreateUserPoolDomain = CreateUserPoolDomainResponse

newCreateUserPoolDomain Source #

Arguments

:: Text

$sel:domain:CreateUserPoolDomain'

-> Text

$sel:userPoolId:CreateUserPoolDomain'

-> CreateUserPoolDomain 

Create a value of CreateUserPoolDomain with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:customDomainConfig:CreateUserPoolDomain', createUserPoolDomain_customDomainConfig - The configuration for a custom domain that hosts the sign-up and sign-in webpages for your application.

Provide this parameter only if you want to use a custom domain for your user pool. Otherwise, you can exclude this parameter and use the Amazon Cognito hosted domain instead.

For more information about the hosted domain and custom domains, see Configuring a User Pool Domain.

$sel:domain:CreateUserPoolDomain', createUserPoolDomain_domain - The domain string.

$sel:userPoolId:CreateUserPoolDomain', createUserPoolDomain_userPoolId - The user pool ID.

Request Lenses

createUserPoolDomain_customDomainConfig :: Lens' CreateUserPoolDomain (Maybe CustomDomainConfigType) Source #

The configuration for a custom domain that hosts the sign-up and sign-in webpages for your application.

Provide this parameter only if you want to use a custom domain for your user pool. Otherwise, you can exclude this parameter and use the Amazon Cognito hosted domain instead.

For more information about the hosted domain and custom domains, see Configuring a User Pool Domain.

createUserPoolDomain_domain :: Lens' CreateUserPoolDomain Text Source #

The domain string.

createUserPoolDomain_userPoolId :: Lens' CreateUserPoolDomain Text Source #

The user pool ID.

Destructuring the Response

data CreateUserPoolDomainResponse Source #

See: newCreateUserPoolDomainResponse smart constructor.

Constructors

CreateUserPoolDomainResponse' 

Fields

  • cloudFrontDomain :: Maybe Text

    The Amazon CloudFront endpoint that you use as the target of the alias that you set up with your Domain Name Service (DNS) provider.

  • httpStatus :: Int

    The response's http status code.

Instances

Instances details
Eq CreateUserPoolDomainResponse Source # 
Instance details

Defined in Amazonka.CognitoIdentityProvider.CreateUserPoolDomain

Methods

(==) :: CreateUserPoolDomainResponse -> CreateUserPoolDomainResponse -> Bool #

(/=) :: CreateUserPoolDomainResponse -> CreateUserPoolDomainResponse -> Bool #

Read CreateUserPoolDomainResponse Source # 
Instance details

Defined in Amazonka.CognitoIdentityProvider.CreateUserPoolDomain

Methods

readsPrec :: Int -> ReadS CreateUserPoolDomainResponse #

readList :: ReadS [CreateUserPoolDomainResponse] #

readPrec :: ReadPrec CreateUserPoolDomainResponse #

readListPrec :: ReadPrec [CreateUserPoolDomainResponse] #

Show CreateUserPoolDomainResponse Source # 
Instance details

Defined in Amazonka.CognitoIdentityProvider.CreateUserPoolDomain

Methods

showsPrec :: Int -> CreateUserPoolDomainResponse -> ShowS #

show :: CreateUserPoolDomainResponse -> String #

showList :: [CreateUserPoolDomainResponse] -> ShowS #

Generic CreateUserPoolDomainResponse Source # 
Instance details

Defined in Amazonka.CognitoIdentityProvider.CreateUserPoolDomain

Associated Types

type Rep CreateUserPoolDomainResponse :: Type -> Type #

Methods

from :: CreateUserPoolDomainResponse -> Rep CreateUserPoolDomainResponse x #

to :: Rep CreateUserPoolDomainResponse x -> CreateUserPoolDomainResponse #

NFData CreateUserPoolDomainResponse Source # 
Instance details

Defined in Amazonka.CognitoIdentityProvider.CreateUserPoolDomain

Methods

rnf :: CreateUserPoolDomainResponse -> () #

type Rep CreateUserPoolDomainResponse Source # 
Instance details

Defined in Amazonka.CognitoIdentityProvider.CreateUserPoolDomain

type Rep CreateUserPoolDomainResponse = D1 ('MetaData "CreateUserPoolDomainResponse" "Amazonka.CognitoIdentityProvider.CreateUserPoolDomain" "libZSservicesZSamazonka-cognito-idpZSamazonka-cognito-idp" 'False) (C1 ('MetaCons "CreateUserPoolDomainResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "cloudFrontDomain") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newCreateUserPoolDomainResponse Source #

Arguments

:: Int

$sel:httpStatus:CreateUserPoolDomainResponse'

-> CreateUserPoolDomainResponse 

Create a value of CreateUserPoolDomainResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:cloudFrontDomain:CreateUserPoolDomainResponse', createUserPoolDomainResponse_cloudFrontDomain - The Amazon CloudFront endpoint that you use as the target of the alias that you set up with your Domain Name Service (DNS) provider.

$sel:httpStatus:CreateUserPoolDomainResponse', createUserPoolDomainResponse_httpStatus - The response's http status code.

Response Lenses

createUserPoolDomainResponse_cloudFrontDomain :: Lens' CreateUserPoolDomainResponse (Maybe Text) Source #

The Amazon CloudFront endpoint that you use as the target of the alias that you set up with your Domain Name Service (DNS) provider.

createUserPoolDomainResponse_httpStatus :: Lens' CreateUserPoolDomainResponse Int Source #

The response's http status code.