Skip to content

CreateResourceServerRequest

Source code in docs_src/capo_cognito_identity_provider/types/create_resource_server_request.py 
16
17
18
19
20
21
22
23
24
25
26
27
28
class CreateResourceServerRequest(TypedDict, closed=True):
    user_pool_id: (
        "capo_cognito_identity_provider.types.user_pool_id_type.UserPoolIdType"
    )
    """<p>The ID of the user pool where you want to create a resource server.</p>"""
    identifier: "capo_cognito_identity_provider.types.resource_server_identifier_type.ResourceServerIdentifierType"
    """<p>A unique resource server identifier for the resource server. The identifier can be an API friendly name like <code>solar-system-data</code>. You can also set an API URL like <code>https://solar-system-data-api.example.com</code> as your identifier.</p> <p>Amazon Cognito represents scopes in the access token in the format <code>$resource-server-identifier/$scope</code>. Longer scope-identifier strings increase the size of your access tokens.</p>"""
    name: "capo_cognito_identity_provider.types.resource_server_name_type.ResourceServerNameType"
    """<p>A friendly name for the resource server.</p>"""
    scopes: NotRequired[
        "capo_cognito_identity_provider.types.resource_server_scope_list_type.ResourceServerScopeListType"
    ]
    """<p>A list of custom scopes. Each scope is a key-value map with the keys <code>ScopeName</code> and <code>ScopeDescription</code>. The name of a custom scope is a combination of <code>ScopeName</code> and the resource server <code>Name</code> in this request, for example <code>MyResourceServerName/MyScopeName</code>.</p>"""

identifier instance-attribute 

identifier: ResourceServerIdentifierType

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.

name instance-attribute 

name: ResourceServerNameType

A friendly name for the resource server.

scopes instance-attribute 

scopes: NotRequired[ResourceServerScopeListType]

A list of custom scopes. Each scope is a key-value map with the keys ScopeName and ScopeDescription. The name of a custom scope is a combination of ScopeName and the resource server Name in this request, for example MyResourceServerName/MyScopeName.

user_pool_id instance-attribute 

user_pool_id: UserPoolIdType

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