interface SignInUrlOptions

Language	Type name
.NET	Amazon.CDK.AWS.Cognito.SignInUrlOptions
Java	software.amazon.awscdk.services.cognito.SignInUrlOptions
Python	aws_cdk.aws_cognito.SignInUrlOptions
TypeScript (source)	@aws-cdk/aws-cognito » SignInUrlOptions

Options to customize the behaviour of signInUrl().

Example

const userpool = new cognito.UserPool(this, 'UserPool', {
  // ...
});
const client = userpool.addClient('Client', {
  // ...
  oAuth: {
    flows: {
      implicitCodeGrant: true,
    },
    callbackUrls: [
      'https://myapp.com/home',
      'https://myapp.com/users',
    ],
  },
});
const domain = userpool.addDomain('Domain', {
  // ...
});
const signInUrl = domain.signInUrl(client, {
  redirectUri: 'https://myapp.com/home', // must be a URL configured under 'callbackUrls' with the client
});

Properties

Name	Type	Description
redirectUri	string	Where to redirect to after sign in.
fips?	boolean	Whether to return the FIPS-compliant endpoint.
signInPath?	string	The path in the URI where the sign-in page is located.

---

redirectUri

Type: string

Where to redirect to after sign in.

---

fips?

Type: boolean (optional, default: return the standard URL)

Whether to return the FIPS-compliant endpoint.

---

signInPath?

Type: string (optional, default: '/login')

The path in the URI where the sign-in page is located.