aws-cdk-lib.aws_cognito.UserPoolResourceServerProps

interface UserPoolResourceServerProps

LanguageType name
.NETAmazon.CDK.AWS.Cognito.UserPoolResourceServerProps
Gogithub.com/aws/aws-cdk-go/awscdk/v2/awscognito#UserPoolResourceServerProps
Javasoftware.amazon.awscdk.services.cognito.UserPoolResourceServerProps
Pythonaws_cdk.aws_cognito.UserPoolResourceServerProps
TypeScript (source)aws-cdk-lib » aws_cognito » UserPoolResourceServerProps

Properties for the UserPoolResourceServer construct.

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';

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

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

Properties

NameTypeDescription
identifierstringA unique resource server identifier for the resource server.
userPoolIUserPoolThe user pool to add this resource server to.
scopes?ResourceServerScope[]Oauth scopes.
userPoolResourceServerName?stringA friendly name for the resource server.

identifier

Type: string

A unique resource server identifier for the resource server.


userPool

Type: IUserPool

The user pool to add this resource server to.


scopes?

Type: ResourceServerScope[] (optional, default: No scopes will be added)

Oauth scopes.


userPoolResourceServerName?

Type: string (optional, default: same as identifier)

A friendly name for the resource server.