aws-cdk-lib.aws_cognito.UserPoolResourceServerOptions

UserPoolResourceServerOptions Struct

Options to create a UserPoolResourceServer.

Source

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

Example

const pool = new cognito.UserPool(this, 'Pool');

const readOnlyScope = new cognito.ResourceServerScope({ scopeName: 'read', scopeDescription: 'Read-only access' });
const fullAccessScope = new cognito.ResourceServerScope({ scopeName: '*', scopeDescription: 'Full access' });

const userServer = pool.addResourceServer('ResourceServer', {
  identifier: 'users',
  scopes: [ readOnlyScope, fullAccessScope ],
});

const readOnlyClient = pool.addClient('read-only-client', {
  // ...
  oAuth: {
    // ...
    scopes: [ cognito.OAuthScope.resourceServer(userServer, readOnlyScope) ],
  },
});

const fullAccessClient = pool.addClient('full-access-client', {
  // ...
  oAuth: {
    // ...
    scopes: [ cognito.OAuthScope.resourceServer(userServer, fullAccessScope) ],
  },
});

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

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

A friendly name for the resource server.

Default: same as identifier