CfnUserPoolResourceServerProps Struct
Properties for defining a CfnUserPoolResourceServer.
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
A unique resource server identifier for the resource server.
notes
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.
A friendly name for the resource server.
scopesIResolvable | IResolvable | CfnUserPoolResourceServer.ResourceServerScopeTypeProperty[]scopestyping.Union[IResolvable, typing.List[typing.Union[IResolvable, ResourceServerScopeTypeProperty]]]scopesIResolvableScopesIResolvableScopesinterface{}#A list of scopes.
Each scope is a map with keys ScopeName and ScopeDescription .
userPoolIdstring | IUserPoolRefuser_pool_idtyping.Union[str, IUserPoolRef]userPoolIdStringUserPoolIdstringUserPoolIdinterface{}required#The ID of the user pool where you want to create a resource server.