UserPoolResourceServerProps¶

class aws_cdk.aws_cognito.UserPoolResourceServerProps(*, identifier, scopes=None, user_pool_resource_server_name=None, user_pool)¶

Bases: aws_cdk.aws_cognito.UserPoolResourceServerOptions

Properties for the UserPoolResourceServer construct.

Parameters

identifier (str) – A unique resource server identifier for the resource server.
scopes (Optional[Sequence[ResourceServerScope]]) – Oauth scopes. Default: - No scopes will be added
user_pool_resource_server_name (Optional[str]) – A friendly name for the resource server. Default: - same as identifier
user_pool (IUserPool) – The user pool to add this resource server to.

ExampleMetadata

fixture=_generated

Example:

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

# resource_server_scope is of type ResourceServerScope
# user_pool is of type UserPool

user_pool_resource_server_props = cognito.UserPoolResourceServerProps(
    identifier="identifier",
    user_pool=user_pool,

    # the properties below are optional
    scopes=[resource_server_scope],
    user_pool_resource_server_name="userPoolResourceServerName"
)

Attributes

identifier¶

A unique resource server identifier for the resource server.

Return type: str

scopes¶

Oauth scopes.

Default

No scopes will be added

Return type

Optional[List[ResourceServerScope]]

user_pool¶

The user pool to add this resource server to.

Return type: IUserPool

user_pool_resource_server_name¶

A friendly name for the resource server.

Default

same as identifier

Return type

Optional[str]