CognitoDomainOptions¶
-
class
aws_cdk.aws_cognito.
CognitoDomainOptions
(*, domain_prefix)¶ Bases:
object
Options while specifying a cognito prefix domain.
- Parameters
domain_prefix (
str
) – The prefix to the Cognito hosted domain name that will be associated with the user pool.- See
- ExampleMetadata
infused
Example:
pool = cognito.UserPool(self, "Pool") pool.add_domain("CognitoDomain", cognito_domain=cognito.CognitoDomainOptions( domain_prefix="my-awesome-app" ) ) certificate_arn = "arn:aws:acm:us-east-1:123456789012:certificate/11-3336f1-44483d-adc7-9cd375c5169d" domain_cert = certificatemanager.Certificate.from_certificate_arn(self, "domainCert", certificate_arn) pool.add_domain("CustomDomain", custom_domain=cognito.CustomDomainOptions( domain_name="user.myapp.com", certificate=domain_cert ) )
Attributes
-
domain_prefix
¶ The prefix to the Cognito hosted domain name that will be associated with the user pool.
- Return type
str