# CfnUserPoolResourceServerProps

Properties for defining a `CfnUserPoolResourceServer`.

Extends: CfnUserPoolResourceServerProps
Used as props by: CfnUserPoolResourceServer

- Source: Generated code
- Type last changed: v2.227.0 · 21 Nov 2025

## Example

```ts
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_cognito as cognito } from 'aws-cdk-lib';
const cfnUserPoolResourceServerProps: cognito.CfnUserPoolResourceServerProps = {
  identifier: 'identifier',
  name: 'name',
  userPoolId: 'userPoolId',

  // the properties below are optional
  scopes: [{
    scopeDescription: 'scopeDescription',
    scopeName: 'scopeName',
  }],
};
```

## Properties

- `identifier`: string (required) — A unique resource server identifier for the resource server.

  The identifier can be an API friendly name like `solar-system-data` . You can also set an API URL like `https://solar-system-data-api.example.com` as your identifier.

  Amazon Cognito represents scopes in the access token in the format `$resource-server-identifier/$scope` . Longer scope-identifier strings increase the size of your access tokens.

- `name`: string (required) — A friendly name for the resource server.

- `scopes`: [IResolvable](/cdk/api/v2/docs/aws-cdk-lib.IResolvable.html) | [IResolvable](/cdk/api/v2/docs/aws-cdk-lib.IResolvable.html) | [CfnUserPoolResourceServer.ResourceServerScopeTypeProperty](/cdk/api/v2/docs/aws-cdk-lib.aws_cognito.CfnUserPoolResourceServer.ResourceServerScopeTypeProperty.html)[] — A list of scopes.

  Each scope is a map with keys `ScopeName` and `ScopeDescription` .

- `userPoolId`: string | [IUserPoolRef](/cdk/api/v2/docs/aws-cdk-lib.interfaces.aws_cognito.IUserPoolRef.html) (required) — The ID of the user pool where you want to create a resource server.