| Copyright | (c) 2013-2023 Brendan Hay |
|---|---|
| License | Mozilla Public License, v. 2.0. |
| Maintainer | Brendan Hay |
| Stability | auto-generated |
| Portability | non-portable (GHC extensions) |
| Safe Haskell | Safe-Inferred |
| Language | Haskell2010 |
Amazonka.CognitoIdentityProvider.CreateUserPoolDomain
Description
Creates a new domain for a user pool.
Synopsis
- data CreateUserPoolDomain = CreateUserPoolDomain' {}
- newCreateUserPoolDomain :: Text -> Text -> CreateUserPoolDomain
- createUserPoolDomain_customDomainConfig :: Lens' CreateUserPoolDomain (Maybe CustomDomainConfigType)
- createUserPoolDomain_domain :: Lens' CreateUserPoolDomain Text
- createUserPoolDomain_userPoolId :: Lens' CreateUserPoolDomain Text
- data CreateUserPoolDomainResponse = CreateUserPoolDomainResponse' {}
- newCreateUserPoolDomainResponse :: Int -> CreateUserPoolDomainResponse
- createUserPoolDomainResponse_cloudFrontDomain :: Lens' CreateUserPoolDomainResponse (Maybe Text)
- createUserPoolDomainResponse_httpStatus :: Lens' CreateUserPoolDomainResponse Int
Creating a Request
data CreateUserPoolDomain Source #
See: newCreateUserPoolDomain smart constructor.
Constructors
| CreateUserPoolDomain' | |
Fields
| |
Instances
newCreateUserPoolDomain Source #
Arguments
| :: Text | |
| -> Text | |
| -> 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:
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.
CreateUserPoolDomain, createUserPoolDomain_domain - The domain string. For custom domains, this is the fully-qualified
domain name, such as auth.example.com. For Amazon Cognito prefix
domains, this is the prefix alone, such as auth.
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. For custom domains, this is the fully-qualified
domain name, such as auth.example.com. For Amazon Cognito prefix
domains, this is the prefix alone, such as auth.
createUserPoolDomain_userPoolId :: Lens' CreateUserPoolDomain Text Source #
The user pool ID.
Destructuring the Response
data CreateUserPoolDomainResponse Source #
See: newCreateUserPoolDomainResponse smart constructor.
Constructors
| CreateUserPoolDomainResponse' | |
Fields
| |
Instances
newCreateUserPoolDomainResponse Source #
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.