aws-cdk-lib.aws_cognito.CfnUserPoolResourceServerProps

interface CfnUserPoolResourceServerProps

LanguageType name
.NETAmazon.CDK.AWS.Cognito.CfnUserPoolResourceServerProps
Gogithub.com/aws/aws-cdk-go/awscdk/v2/awscognito#CfnUserPoolResourceServerProps
Javasoftware.amazon.awscdk.services.cognito.CfnUserPoolResourceServerProps
Pythonaws_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

NameTypeDescription
identifierstringA unique resource server identifier for the resource server.
namestringA friendly name for the resource server.
userPoolIdstringThe 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.

This could be an HTTPS endpoint where the resource server is located. For example: https://my-weather-api.example.com .


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 .