interface CfnUserPoolResourceServerMixinProps

Language	Type name
.NET	Amazon.CDK.Mixins.Preview.AWS.Cognito.Mixins.CfnUserPoolResourceServerMixinProps
Go	github.com/aws/aws-cdk-go/awscdkmixinspreview/v2/awscognito/mixins#CfnUserPoolResourceServerMixinProps
Java	software.amazon.awscdk.mixins.preview.services.cognito.mixins.CfnUserPoolResourceServerMixinProps
Python	aws_cdk.mixins_preview.aws_cognito.mixins.CfnUserPoolResourceServerMixinProps
TypeScript	@aws-cdk/mixins-preview » aws_cognito » mixins » CfnUserPoolResourceServerMixinProps

Properties for CfnUserPoolResourceServerPropsMixin.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpoolresourceserver.html

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { mixins as cognito_mixins } from '@aws-cdk/mixins-preview/aws-cognito';
const cfnUserPoolResourceServerMixinProps: cognito_mixins.CfnUserPoolResourceServerMixinProps = {
  identifier: 'identifier',
  name: 'name',
  scopes: [{
    scopeDescription: 'scopeDescription',
    scopeName: 'scopeName',
  }],
  userPoolId: 'userPoolId',
};

Properties

Name	Type	Description
identifier?	string	A unique resource server identifier for the resource server.
name?	string	A friendly name for the resource server.
scopes?	IResolvable | (IResolvable | ResourceServerScopeTypeProperty)[]	A list of scopes.
userPoolId?	string	The ID of the user pool where you want to create a resource server.

---

identifier?

Type: string (optional)

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.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpoolresourceserver.html#cfn-cognito-userpoolresourceserver-identifier

---

name?

Type: string (optional)

A friendly name for the resource server.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpoolresourceserver.html#cfn-cognito-userpoolresourceserver-name

---

scopes?

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

A list of scopes.

Each scope is a map with keys ScopeName and ScopeDescription .

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpoolresourceserver.html#cfn-cognito-userpoolresourceserver-scopes

---

userPoolId?

Type: string (optional)

The ID of the user pool where you want to create a resource server.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpoolresourceserver.html#cfn-cognito-userpoolresourceserver-userpoolid