UserPoolDomainProps

class aws_cdk.aws_cognito.UserPoolDomainProps(*, cognito_domain=None, custom_domain=None, user_pool)

Bases: aws_cdk.aws_cognito.UserPoolDomainOptions

__init__(*, cognito_domain=None, custom_domain=None, user_pool)

Props for UserPoolDomain construct.

Parameters
  • cognito_domain (Optional[CognitoDomainOptions]) – Associate a cognito prefix domain with your user pool Either customDomain or cognitoDomain must be specified. Default: - not set if customDomain is specified, otherwise, throws an error.

  • custom_domain (Optional[CustomDomainOptions]) – Associate a custom domain with your user pool Either customDomain or cognitoDomain must be specified. Default: - not set if cognitoDomain is specified, otherwise, throws an error.

  • user_pool (IUserPool) – The user pool to which this domain should be associated.

stability :stability: experimental

Return type

None

Attributes

cognito_domain

Associate a cognito prefix domain with your user pool Either customDomain or cognitoDomain must be specified.

default :default: - not set if customDomain is specified, otherwise, throws an error.

see :see: https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-assign-domain-prefix.html stability :stability: experimental

Return type

Optional[CognitoDomainOptions]

custom_domain

Associate a custom domain with your user pool Either customDomain or cognitoDomain must be specified.

default :default: - not set if cognitoDomain is specified, otherwise, throws an error.

see :see: https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-add-custom-domain.html stability :stability: experimental

Return type

Optional[CustomDomainOptions]

user_pool

The user pool to which this domain should be associated.

stability :stability: experimental

Return type

IUserPool