UserPoolDomain¶
-
class
aws_cdk.aws_cognito.
UserPoolDomain
(scope, id, *, user_pool, cognito_domain=None, custom_domain=None)¶ Bases:
aws_cdk.core.Resource
Define a user pool domain.
- ExampleMetadata
infused
Example:
userpool = cognito.UserPool(self, "UserPool") client = userpool.add_client("Client", # ... o_auth=cognito.OAuthSettings( flows=cognito.OAuthFlows( implicit_code_grant=True ), callback_urls=["https://myapp.com/home", "https://myapp.com/users" ] ) ) domain = userpool.add_domain("Domain") sign_in_url = domain.sign_in_url(client, redirect_uri="https://myapp.com/home" )
- Parameters
scope (
Construct
) –id (
str
) –user_pool (
IUserPool
) – The user pool to which this domain should be associated.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.
Methods
-
apply_removal_policy
(policy)¶ Apply the given removal policy to this resource.
The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you’ve removed it from the CDK application or because you’ve made a change that requires the resource to be replaced.
The resource can be deleted (
RemovalPolicy.DESTROY
), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN
).- Parameters
policy (
RemovalPolicy
) –- Return type
None
-
base_url
(*, fips=None)¶ The URL to the hosted UI associated with this domain.
- Parameters
fips (
Optional
[bool
]) – Whether to return the FIPS-compliant endpoint. Default: return the standard URL- Return type
str
-
sign_in_url
(client, *, redirect_uri, sign_in_path=None, fips=None)¶ The URL to the sign in page in this domain using a specific UserPoolClient.
- Parameters
client (
UserPoolClient
) – [disable-awslint:ref-via-interface] the user pool client that the UI will use to interact with the UserPool.redirect_uri (
str
) – Where to redirect to after sign in.sign_in_path (
Optional
[str
]) – The path in the URI where the sign-in page is located. Default: ‘/login’fips (
Optional
[bool
]) – Whether to return the FIPS-compliant endpoint. Default: return the standard URL
- Return type
str
-
to_string
()¶ Returns a string representation of this construct.
- Return type
str
Attributes
-
cloud_front_domain_name
¶ The domain name of the CloudFront distribution associated with the user pool domain.
- Return type
str
-
domain_name
¶ The domain that was specified to be created.
If
customDomain
was selected, this holds the full domain name that was specified. If thecognitoDomain
was used, it contains the prefix to the Cognito hosted domain.- Return type
str
-
env
¶ The environment this resource belongs to.
For resources that are created and managed by the CDK (generally, those created by creating new class instances like Role, Bucket, etc.), this is always the same as the environment of the stack they belong to; however, for imported resources (those obtained from static methods like fromRoleArn, fromBucketName, etc.), that might be different than the stack they were imported into.
- Return type
-
node
¶ The construct tree node associated with this construct.
- Return type
Static Methods
-
classmethod
from_domain_name
(scope, id, user_pool_domain_name)¶ Import a UserPoolDomain given its domain name.
- Parameters
scope (
Construct
) –id (
str
) –user_pool_domain_name (
str
) –
- Return type
-
classmethod
is_construct
(x)¶ Return whether the given object is a Construct.
- Parameters
x (
Any
) –- Return type
bool
-
classmethod
is_resource
(construct)¶ Check whether the given construct is a Resource.
- Parameters
construct (
IConstruct
) –- Return type
bool