UserPoolDomainProps¶
-
class
aws_cdk.aws_cognito.
UserPoolDomainProps
(*, cognito_domain=None, custom_domain=None, user_pool)¶ Bases:
aws_cdk.aws_cognito.UserPoolDomainOptions
Props for UserPoolDomain construct.
- Parameters
cognito_domain (
Optional
[CognitoDomainOptions
]) – Associate a cognito prefix domain with your user pool EithercustomDomain
orcognitoDomain
must be specified. Default: - not set ifcustomDomain
is specified, otherwise, throws an error.custom_domain (
Optional
[CustomDomainOptions
]) – Associate a custom domain with your user pool EithercustomDomain
orcognitoDomain
must be specified. Default: - not set ifcognitoDomain
is specified, otherwise, throws an error.user_pool (
IUserPool
) – The user pool to which this domain should be associated.
Attributes
-
cognito_domain
¶ Associate a cognito prefix domain with your user pool Either
customDomain
orcognitoDomain
must be specified.- Default
not set if
customDomain
is specified, otherwise, throws an error.
- See
- Return type
Optional
[CognitoDomainOptions
]
-
custom_domain
¶ Associate a custom domain with your user pool Either
customDomain
orcognitoDomain
must be specified.- Default
not set if
cognitoDomain
is specified, otherwise, throws an error.
- See
https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-add-custom-domain.html
- Return type
Optional
[CustomDomainOptions
]