interface UserPoolResourceServerProps
Language | Type name |
---|---|
![]() | Amazon.CDK.AWS.Cognito.UserPoolResourceServerProps |
![]() | github.com/aws/aws-cdk-go/awscdk/v2/awscognito#UserPoolResourceServerProps |
![]() | software.amazon.awscdk.services.cognito.UserPoolResourceServerProps |
![]() | aws_cdk.aws_cognito.UserPoolResourceServerProps |
![]() | 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
Name | Type | Description |
---|---|---|
identifier | string | A unique resource server identifier for the resource server. |
user | IUser | The user pool to add this resource server to. |
scopes? | Resource [] | Oauth scopes. |
user | string | A friendly name for the resource server. |
identifier
Type:
string
A unique resource server identifier for the resource server.
userPool
Type:
IUser
The user pool to add this resource server to.
scopes?
Type:
Resource
[]
(optional, default: No scopes will be added)
Oauth scopes.
userPoolResourceServerName?
Type:
string
(optional, default: same as identifier
)
A friendly name for the resource server.