aws-cdk-lib.aws_cognito.UserPoolResourceServerProps

UserPoolResourceServerProps Struct

Properties for the UserPoolResourceServer construct.

UserPoolResourceServerProps

extends

• UserPoolResourceServerOptions

used as props by

• UserPoolResourceServer

Source

aws-cognito/lib/user-pool-resource-server.ts

Type last changed

v2.235.0 · 15 Jan 2026

Example

// 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';
import { aws_cognito as interfaces_cognito } from 'aws-cdk-lib/interfaces';

declare const resourceServerScope: cognito.ResourceServerScope;
declare const userPoolRef: interfaces_cognito.IUserPoolRef;
const userPoolResourceServerProps: cognito.UserPoolResourceServerProps = {
  identifier: 'identifier',
  userPool: userPoolRef,

  // the properties below are optional
  scopes: [resourceServerScope],
  userPoolResourceServerName: 'userPoolResourceServerName',
};

Properties

identifierstringidentifierstridentifierStringIdentifierstringIdentifier*stringrequired#

A unique resource server identifier for the resource server.

scopes?optionalResourceServerScope[]scopes?optionaltyping.List[ResourceServerScope]scopes?optionalList<ResourceServerScope>Scopes?optionalResourceServerScope[]Scopes?optional*[]ResourceServerScope#

Oauth scopes.

Default: No scopes will be added

userPoolIUserPoolRefuser_poolIUserPoolRefuserPoolIUserPoolRefUserPoolIUserPoolRefUserPoolIUserPoolRefrequired#

The user pool to add this resource server to.

userPoolResourceServerName?optionalstringuser_pool_resource_server_name?optionalstruserPoolResourceServerName?optionalStringUserPoolResourceServerName?optionalstringUserPoolResourceServerName?optional*string#

A friendly name for the resource server.

Default: same as identifier