SignInUrlOptions¶
-
class
aws_cdk.aws_cognito.
SignInUrlOptions
(*, fips=None, redirect_uri, sign_in_path=None)¶ Bases:
aws_cdk.aws_cognito.BaseUrlOptions
Options to customize the behaviour of
signInUrl()
.- Parameters
fips (
Optional
[bool
]) – Whether to return the FIPS-compliant endpoint. Default: return the standard URLredirect_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’
- 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" )
Attributes
-
fips
¶ Whether to return the FIPS-compliant endpoint.
- Default
return the standard URL
- Return type
Optional
[bool
]
-
redirect_uri
¶ Where to redirect to after sign in.
- Return type
str
-
sign_in_path
¶ The path in the URI where the sign-in page is located.
- Default
‘/login’
- Return type
Optional
[str
]