interface CfnUserPoolResourceServerProps

Language	Type name
.NET	`Amazon.CDK.AWS.Cognito.CfnUserPoolResourceServerProps`
Go	`github.com/aws/aws-cdk-go/awscdk/v2/awscognito#CfnUserPoolResourceServerProps`
Java	`software.amazon.awscdk.services.cognito.CfnUserPoolResourceServerProps`
Python	`aws_cdk.aws_cognito.CfnUserPoolResourceServerProps`
TypeScript	`aws-cdk-lib` » `aws_cognito` » `CfnUserPoolResourceServerProps`

Properties for defining a CfnUserPoolResourceServer.

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';
const cfnUserPoolResourceServerProps: cognito.CfnUserPoolResourceServerProps = {
  identifier: 'identifier',
  name: 'name',
  userPoolId: 'userPoolId',

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

Properties

Name	Type	Description
identifier	`string`	A unique resource server identifier for the resource server.
name	`string`	A friendly name for the resource server.
userPoolId	`string`	The user pool ID for the user pool.
scopes?	`IResolvable` `\|` `IResolvable` `\|` `ResourceServerScopeTypeProperty[]`	A list of scopes.

identifier

Type: string

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

Type: string

A friendly name for the resource server.

userPoolId

Type: string

The user pool ID for the user pool.

scopes?

Type: IResolvable | IResolvable | ResourceServerScopeTypeProperty[] (optional)

A list of scopes.

Each scope is a map with keys ScopeName and ScopeDescription .