AWS::Cognito::UserPoolResourceServer ResourceServerScopeType
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.
Syntax
To declare this entity in your AWS CloudFormation template, use the following syntax:
JSON
{ "ScopeDescription" :
String
, "ScopeName" :String
}
YAML
ScopeDescription:
String
ScopeName:String
Properties
ScopeDescription
-
A friendly description of a custom scope.
Required: Yes
Type: String
Minimum:
1
Maximum:
256
Update requires: No interruption
ScopeName
-
The name of the scope. Amazon Cognito renders custom scopes in the format
resourceServerIdentifier/ScopeName
. For example, if this parameter isexampleScope
in the resource server with the identifierexampleResourceServer
, you request and receive the scopeexampleResourceServer/exampleScope
.Required: Yes
Type: String
Pattern:
[\x21\x23-\x2E\x30-\x5B\x5D-\x7E]+
Minimum:
1
Maximum:
256
Update requires: No interruption