interface ResourceServerScopeTypeProperty
| Language | Type name |
|---|---|
 .NET | Amazon.CDK.CfnPropertyMixins.AWS.Cognito.CfnUserPoolResourceServerPropsMixin.ResourceServerScopeTypeProperty |
 Go | github.com/aws/aws-cdk-go/awscdkcfnpropertymixins/v2/awscognito#CfnUserPoolResourceServerPropsMixin_ResourceServerScopeTypeProperty |
 Java | software.amazon.awscdk.cfnpropertymixins.services.cognito.CfnUserPoolResourceServerPropsMixin.ResourceServerScopeTypeProperty |
 Python | aws_cdk.cfn_property_mixins.aws_cognito.CfnUserPoolResourceServerPropsMixin.ResourceServerScopeTypeProperty |
 TypeScript | @aws-cdk/cfn-property-mixins » aws_cognito » CfnUserPoolResourceServerPropsMixin » ResourceServerScopeTypeProperty |
One custom scope associated with a user pool resource server.
This data type is a member of ResourceServerScopeType . For more information, see Scopes, M2M, and API authorization with resource servers .
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/cfn-property-mixins';
const resourceServerScopeTypeProperty: cognito.CfnUserPoolResourceServerPropsMixin.ResourceServerScopeTypeProperty = {
scopeDescription: 'scopeDescription',
scopeName: 'scopeName',
};
Properties
| Name | Type | Description |
|---|---|---|
| scope | string | A friendly description of a custom scope. |
| scope | string | The name of the scope. |
scopeDescription?
Type:
string
(optional)
A friendly description of a custom scope.
scopeName?
Type:
string
(optional)
The name of the scope.
Amazon Cognito renders custom scopes in the format resourceServerIdentifier/ScopeName . For example, if this parameter is exampleScope in the resource server with the identifier exampleResourceServer , you request and receive the scope exampleResourceServer/exampleScope .