CfnUserPoolResourceServerProps

class aws_cdk.aws_cognito.CfnUserPoolResourceServerProps(*, identifier, name, user_pool_id, scopes=None)

Bases: object

Properties for defining a CfnUserPoolResourceServer.

Parameters:

identifier (str) – 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 (str) – A friendly name for the resource server.
user_pool_id (str) – The ID of the user pool where you want to create a resource server.
scopes (Union[IResolvable, Sequence[Union[IResolvable, ResourceServerScopeTypeProperty, Dict[str, Any]]], None]) – A list of scopes. Each scope is a map with keys ScopeName and ScopeDescription .

See:

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

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_cognito as cognito

cfn_user_pool_resource_server_props = cognito.CfnUserPoolResourceServerProps(
    identifier="identifier",
    name="name",
    user_pool_id="userPoolId",

    # the properties below are optional
    scopes=[cognito.CfnUserPoolResourceServer.ResourceServerScopeTypeProperty(
        scope_description="scopeDescription",
        scope_name="scopeName"
    )]
)

Attributes

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 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:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpoolresourceserver.html#cfn-cognito-userpoolresourceserver-identifier

name

A friendly name for the resource server.

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

scopes

A list of scopes.

Each scope is a map with keys ScopeName and ScopeDescription .

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

user_pool_id

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

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