ResourceServerType
The details of a resource server configuration and associated custom scopes in a user pool.
This data type is a request parameter of CreateResourceServer and a response parameter of DescribeResourceServer.
Contents
- Identifier
-
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 likehttps://solar-system-data-api.example.comas 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.Type: String
Length Constraints: Minimum length of 1. Maximum length of 256.
Pattern:
[\x21\x23-\x5B\x5D-\x7E]+Required: No
- Name
-
The name of the resource server.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 256.
Pattern:
[\w\s+=,.@-]+Required: No
- Scopes
-
A list of scopes that are defined for the resource server.
Type: Array of ResourceServerScopeType objects
Array Members: Maximum number of 100 items.
Required: No
- UserPoolId
-
The ID of the user pool that contains the resource server configuration.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 55.
Pattern:
[\w-]+_[0-9a-zA-Z]+Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
