# SignInUrlOptions

Options to customize the behaviour of `signInUrl()`.

Extends: SignInUrlOptions
Extends: BaseUrlOptions

- Source: [`aws-cognito/lib/user-pool-domain.ts`](https://github.com/aws/aws-cdk/blob/v2.275.0/packages/aws-cdk-lib/aws-cognito/lib/user-pool-domain.ts#L271)
- Type last changed: v2.24.0 · 12 May 2022

## Example

```ts
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

- `fips`: boolean — Whether to return the FIPS-compliant endpoint.

  **Default:** return the standard URL

- `redirectUri`: string (required) — Where to redirect to after sign in.

- `signInPath`: string = '/login' — The path in the URI where the sign-in page is located.